somucheffort/chorefeatfix

CLI app that will help you to create semantic commit messages

chorefeatfix

CLI app that will help you to create semantic commit messages

Installing

npm

$ npm i https://github.com/redcarti/chorefeatfix -g

yarn

$ yarn global add https://github.com/redcarti/chorefeatfix

Usage

$ cff
Usage: cff [options] <command>

Commands:
  cff chore [message]       updating grunt tasks etc; no production code change 
  cff feat [message]        new feature for the user, not a new feature for     
                            build script
  cff fix [message]         bug fix for the user, not a fix to a build script   
  cff docs [message]        changes to the documentation
  cff style [message]       formatting, missing semi colons, etc; no production 
                            code change
  cff refactor [message]    refactoring production code, eg. renaming a variable
  cff test [message]        adding missing tests, refactoring tests; no
                            production code change

Options:
      --version  Show version number                                   [boolean]
  -h, --help     Show help                                             [boolean]
  -s, --scope    Set scope of a commit                                  [string]
  -a, --add      Perform `git add` command                             [boolean]

by redcarti

Commit message

You must use quotes in your message, if you are going to write more than one word.

Example

One word:

$ cff chore test

More than one word:

$ cff chore 'test. simple test. dont use test. something...'

-s or --scope option

You can use -s option to provide scope of your fix, chore, feat, etc.

Example

$ cff -s deps fix 'updated discord.js to last version'

-a or --add option

If you provide -a option, chorefeatfix will execute git add . command, so you don't need to type it yourself!

Example

$ cff -a fix 'fixed dependabot'

Works as

$ git add .
$ cff fix 'fixed dependabot'