Skip to content

A simple CLI tool for generating and standardizing commit messages.

License

Notifications You must be signed in to change notification settings

pandresvaldivia/commitcraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Config example:

export default {
  format: '{type}({scope}): {message}',
  questions: [
    {
      name: 'type',
      description: "Select the type of change that you're committing:",
      type: 'select',
      options: [
        {
          name: 'feat',
          value: 'feat',
          description: 'A new feature',
        },
        {
          name: 'fix',
          value: 'fix',
          description: 'A bug fix',
        },
        {
          name: 'docs',
          value: 'docs',
          description: 'Documentation changes',
        },
        {
          name: 'style',
          value: 'style',
          description: 'Code style changes (formatting, no logic changes)',
        },
        {
          name: 'refactor',
          value: 'refactor',
          description: 'Code refactoring',
        },
        {
          name: 'test',
          value: 'test',
          description: 'Adding or fixing tests',
        },
      ],
    },
    {
      name: 'scope',
      description:
        'What is the scope of this change (e.g. component or file name):',
      type: 'select',
      options: ['frontend', 'backend', 'docs', 'infra'],
    },
    {
      name: 'message',
      description: 'Write a short, imperative tense description of the change:',
      type: 'input',
    },
  ],
};

About

A simple CLI tool for generating and standardizing commit messages.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published