commitizen

commitizen

Command line utility to standardize git commit messages, golang version. Forked from commitizen-go.

Fixes some issues of commitizen-go and supports more new features.

Features

• Multi-template support.
• More powerful and flexible template.
• Support more options of git commit.
• Use huh instead of survey (survey is no longer maintained).

Getting Started

Command line utility to standardize git commit messages.

Usage:
  commitizen

Available Commands:
  init        Install this tool to git-core as git-cz.
  version     Print the CLI version information.      
  help        Help about any command

Git Commit flags:
  -a, --all
                commit all changed files.
      --amend
                amend previous commit
      --author string
                override author for commit
      --date string
                override date for commit
      --no-verify
                bypass pre-commit and commit-msg hooks
  -q, --quiet
                suppress summary after successful commit
  -s, --signoff
                add a Signed-off-by trailer.
  -v, --verbose
                show diff in commit message template

Commitizen flags:
  -d, --default
                use the default template, '--default' has a higher priority than '--template'.
      --dry-run
                do not create a commit, but show the message and list of paths
                that are to be committed.
  -t, --template string
                template name to use when multiple templates exist.

Use "commitizen [command] --help" for more information about a command.

Commit with commitizen:

$ git cz

Installation

From the Binary Releases

Download the pre-compiled binaries from the releases page and copy them to the desired location.

Then install this tool to git-core as git-cz:

$ commitizen init

Go Install

You must have a working Go environment:

$ go install github.com/onyourmarks-agency/commitizen@latest
$ commitizen init

From Source

You must have a working Go environment:

$ git clone https://github.com/onyourmarks-agency/commitizen.git
$ cd commitizen
$ make && ./_output/$(GOOS)/$(GOARCH)/bin/commitizen init

Configuration

You can set configuration file that .czrc at repository root or home directory. The configuration file that located in repository root have a priority over the one in home directory. The format is the same as the following:

name: default
default: true
groups:
  - name: hasbreaking
    depends_on:
      and_conditions:
        - parameter_name: page2.isbreaking
          value_equals: true
  - name: nobreaking
    depends_on:
      and_conditions:
        - parameter_name: page2.isbreaking
          value_equals: false
items:
  - name: type
    group: page1
    label: "Select the type of change that you're committing:"
    type: list
    options:
      - value: feat
        key: "feat:      A new feature"
      - value: fix
        key: "fix:       A bug fix"
      - value: docs
        key: "docs:      Documentation only changes"
      - value: test
        key: "test:      Adding missing or correcting existing tests"
      - value: chore
        key: "chore:     Changes to the build process or auxiliary tools and libraries such as documentation generation"
      - value: style
        key: "style:     Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)"
      - value: refactor
        key: "refactor:  A code change that neither fixes a bug nor adds a feature"
      - value: perf
        key: "perf:      A code change that improves performance"
      - value: revert
        key: "revert:    Reverts a previous commit"
  - name: scope
    group: page2
    label: "Scope. What is the scope of this change? (class or file name):"
    type: string
    trim: true
  - name: subject
    group: page2
    label: "Subject. Write a short and imperative summary of the code change (lower case and no period):"
    type: string
    required: true
    trim: true
  - name: isbreaking
    group: page2
    label: "Are there any breaking changes?"
    type: boolean
  - name: hasbreakingbody
    group: hasbreaking
    label: "A BREAKING CHANGE commit requires a body. Provide additional contextual information about the code changes:"
    type: text
    required: true
  - name: nobreakingbody
    group: nobreaking
    label: "Body. Provide additional contextual information about the code changes:"
    type: text
  - name: footer
    group: page3
    label: "Footer. Information about Breaking Changes and reference issues that this commit closes:"
    type: text
format: "{{.type}}{{with .scope}}({{.}}){{end}}: {{.subject}}{{with .hasbreakingbody}}\n\n{{.}}{{end}}{{with .nobreakingbody}}\n\n{{.}}{{end}}{{with .footer}}\n\n{{.}}{{end}}"

Default

Optional. If true, the template will be used as the default template, note that there can only be one default template.

Format

Commit message format:

format: "{{.type}}{{with .scope}}({{.}}){{end}}: {{.subject}}{{with .body}}\n\n{{.}}{{end}}{{with .footer}}\n\n{{.}}{{end}}"

Items

Common Item Properties

Item Types

• string
• text
• integer
• boolean
• secret
• list
• multi_list

string

string are single line text parameters.

Properties:

text

Properties:

integer

integer is a number.

Properties:

boolean

boolean are true or false values.

Properties:

secret

secret is used for sensitive data that should not be echoed in the UI, for example, passwords.

Properties:

list

list is predefined lists of values that can be picked by the user.

Properties:

multi_list

Similar to list, but with multiple selection.

Properties:

list/multi_list Options

Properties:

Groups (Optional)

Group Properties:

DependsOn Properties:

DependsOn Conditions:

• ValueEqualsCondition
• ValueNotEqualsCondition
• ValueContainsCondition
• ValueNotContainsCondition
• ValueEmptyCondition

ValueEqualsCondition

Properties:

ValueNotEqualsCondition

Properties:

ValueContainsCondition

Properties:

ValueNotContainsCondition

Properties:

ValueEmptyCondition

Properties:

Multiple Templates

You can define multiple templates in the .czrc file, separated by ---：

name: angular-template
items:
# ...  
format: "{{.type}}{{with .scope}}({{.}}){{end}}: {{.subject}}{{with .body}}\n\n{{.}}{{end}}{{with .footer}}\n\n{{.}}{{end}}"`

---

name: my-template
items:
# ...  
format: "{{.type}}{{with .scope}}({{.}}){{end}}: {{.subject}}{{with .body}}\n\n{{.}}{{end}}{{with .footer}}\n\n{{.}}{{end}}"`