git-cz

Without installation

1npx git-cz
2# or
3npx git-cz -e

Install globally standalone

1npm install -g git-cz
2git-cz
3# or
4git-cz -e

Install locally with Commitizen

1npm install -g commitizen
2npm install --save-dev git-cz

package.json:

1{
2  "config": {
3    "commitizen": {
4      "path": "git-cz"
5    }
6  }
7}

run:

1git cz

Install globally with Commitizen

1npm install -g commitizen git-cz
2commitizen init git-cz --save-dev --save-exact

run:

1git cz

Custom config

You can provide a custom configuration in a changelog.config.js file in your repo, or in any parent folder. git-cz will search for the closest config file. Below is default config:

1module.exports = {
2  disableEmoji: false,
3  format: '{type}{scope}: {emoji}{subject}',
4  list: ['test', 'feat', 'fix', 'chore', 'docs', 'refactor', 'style', 'ci', 'perf'],
5  maxMessageLength: 64,
6  minMessageLength: 3,
7  questions: ['type', 'scope', 'subject', 'body', 'breaking', 'issues', 'lerna'],
8  scopes: [],
9  types: {
10    chore: {
11      description: 'Build process or auxiliary tool changes',
12      emoji: '🤖',
13      value: 'chore'
14    },
15    ci: {
16      description: 'CI related changes',
17      emoji: '🎡',
18      value: 'ci'
19    },
20    docs: {
21      description: 'Documentation only changes',
22      emoji: '✏️',
23      value: 'docs'
24    },
25    feat: {
26      description: 'A new feature',
27      emoji: '🎸',
28      value: 'feat'
29    },
30    fix: {
31      description: 'A bug fix',
32      emoji: '🐛',
33      value: 'fix'
34    },
35    perf: {
36      description: 'A code change that improves performance',
37      emoji: '⚡️',
38      value: 'perf'
39    },
40    refactor: {
41      description: 'A code change that neither fixes a bug or adds a feature',
42      emoji: '💡',
43      value: 'refactor'
44    },
45    release: {
46      description: 'Create a release commit',
47      emoji: '🏹',
48      value: 'release'
49    },
50    style: {
51      description: 'Markup, white-space, formatting, missing semi-colons...',
52      emoji: '💄',
53      value: 'style'
54    },
55    test: {
56      description: 'Adding missing tests',
57      emoji: '💍',
58      value: 'test'
59    },
60    messages: {
61      type: 'Select the type of change that you\'re committing:',
62      customScope: 'Select the scope this component affects:',
63      subject: 'Write a short, imperative mood description of the change:\n',
64      body: 'Provide a longer description of the change:\n ',
65      breaking: 'List any breaking changes:\n',
66      footer: 'Issues this commit closes, e.g #123:',
67      confirmCommit: 'The packages that this commit has affected\n',
68    },
69  }
70};

Non-interactive mode

Using --non-interactive flag you can run git-cz non-interactive mode.

For example:

1git-cz --non-interactive --type=feat --subject="add onClick prop to component"

CLI parameters:

• --type
• --subject
• --scope
• --body
• --breaking
• --issues
• --lerna

Disable Emoji

Using --disable-emoji flag will disable emoji.

For example:

1git-cz --disable-emoji

Commit message format

• A commit message consists of a header, body and footer.
• The header has a type and a subject:

1<type>[(<scope>)]: <emoji> <subject>
2[BLANK LINE]
3[body]
4[BLANK LINE]
5[breaking changes]
6[BLANK LINE]
7[footer]

The header is the only mandatory part of the commit message.

The first line (type + subject) is limited to 50 characters [enforced]

Any other line should be limited to 72 character [automatic wrapping]

This allows the message to be easier to read on GitHub as well as in various git tools.

Format

By default the subject format is: {type}{scope}: {subject}

Configuring the format field in .git-cz.json you can customize your own:

• {type}{scope}: {emoji}{subject}
• {emoji}{scope} {subject}

Type

Must be one of the following:

• test — Adding missing tests
• feat — A new feature
• fix — A bug fix
• chore — Build process or auxiliary tool changes
• docs — Documentation only changes
• refactor — A code change that neither fixes a bug or adds a feature
• style — Markup, white-space, formatting, missing semi-colons...
• ci — CI related changes
• perf — A code change that improves performance

Subject

The subject contains succinct description of the change:

• Use the imperative, present tense: "change" not "changed" nor "changes"
• No dot (.) at the end.

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Affects [only on lerna environments]

Select the packages the commit affected.

Breaking Changes

Breaking Changes must start with the words BREAKING CHANGE: .

Footer

The footer is the place to reference any tasks related to this commit.

Why this Fork?

1npm i -g git-cz
2added 1 package in 0.612s

Installs in 0.6s vs 31.1s.

1npm i -g mol-conventional-changelog
2added 345 packages in 31.076s