conventional-committer v0.3.0

conventional-committer

Conventional Committer is a git commit formatter, it formats your commits into the conventional commit style, but with extra information embedded:

<TYPE>([SCOPE]): <TITLE> <EMOJI>

[BODY] [ISSUE]

Where elements like <*> are required and elements like [*] are optional:

• TYPE is one of build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test.
• SCOPE is the part of the project the commit changes.
• TITLE commit message.
• EMOJI see gitmoji for full list.
• BODY commit description
• ISSUE issue or PR commit is in reference to.

Emojis come from gitmoji and outline the commit type, so you can quickly see what the commit is in reference to. Committing in this style allows you to use tools like conventional-changelog-cli to generate changelogs, like this project's.

Install

npm install -g conventional-committer

Use

To commit, run

conventional-committer

Options

• Auto add untracked changes with a -a flag.
• Sign commits with -s, requires setting a gpg key for git.
• Push after commit with -p.

Options can be stacked, you can sign and push with -sp for example.

Test

npm run test:local