• Install
• Recommended Commit Message Format
• Zero Configurations
  • commitlinterrc.json
  • Set Linting Prompter's Language
    • Set in commitlinterrc.json
    • Set in bash profiles
• Features
• Why yet a new linter
• How it works
• FAQs
  • 1. Why not conventional-changelog/commitlint?
  • 2. Work With Husky 5
  • 3. git-commit-msg-linter badge
• TODO
• Development
  • Publish
• References
• 🤝 Contributing
• Show your support
• 📝 License

Except for default types, you can add, overwrite or forbid certain types and so does the max-len.

For example if you have this commitlinterrc.json file below in the root directory of your project:

{
  "types": {
    "feat": "ユーザーが知覚できる新機能",
    "build": "ビルドシステムまたは外部の依存関係に影響する変更（スコープの例：gulp、broccoli、npm）",
    "deps": "依存関係を追加、アップグレード、削除",
    "temp": false,
    "chore": false
  },
  "max-len": 80,
  "debug": true
}

Which means:

• Modify existing type feat's description to "ユーザーが知覚できる新機能".
• Add two new types: build and deps.
• temp is not allowed.
• chore is forbidden as build covers the same scope.
• Maximum length of a commit message is adjusted to 80.
• Display verbose information about the commit message.

A more detailed commitlinterrc.json：

{
  "lang": "en-US", // or "zh-CN". Set linter prompt's language
  "types": {
    "feat": "ユーザーが知覚できる新機能",
    "build": "ビルドシステムまたは外部の依存関係に影響する変更（スコープの例：gulp、broccoli、npm）",
    "deps": "依存関係を追加、アップグレード、削除",
    "docs": "ドキュメントのみ変更",
    "fix": false,
    "style": false,
    "refactor": false,
    "test": false,
    "perf": false,
    "ci": false,
    "temp": false,
    "chore": false
  },
  "min-len": 10,
  "max-len": 80,
  "example": "feat: 新機能",
  "scopeDescriptions": [
    "オプションで、コミット変更の場所を指定するものであれば何でもかまいません。",
    "たとえば、$ location、$ browser、$ compile、$ rootScope、ngHref、ngClick、ngViewなど。",
    "アプリ開発では、スコープはページ、モジュール、またはコンポーネントです。"
  ],
  "validScopes": ["workspace", "package1", "package2", "package3", ...],
  "invalidScopeDescriptions": [
    "`scope`はオプションですが、括弧が存在する場合は空にすることはできません。"
  ],
  "subjectDescriptions": [
    "1行での変更の非常に短い説明。"
  ],
  "invalidSubjectDescriptions": [
    "最初の文字を大文字にしないでください",
    "最後にドット「。」なし"
  ],
  "showInvalidHeader": false,
  "debug": false
}

In this config, the one-line example and scope, subject's description section are modified as what your write in the commitlinterrc.json. And the the invalid header is hidden by set "showInvalidHeader": false。

Set Linting Prompter's Language

It will use your system's language as the default language. But two ways are provided also. Priority from high to low.

Set in commitlinterrc.json

{
  "lang": "zh-CN"
}

lang in ["en-US", "zh-CN", "pt-BR", "es-ES"].

Set in bash profiles

echo 'export COMMIT_MSG_LINTER_LANG=zh-CN' >> ~/.zshrc

profiles such as .bash_profile, .zshrc etc.

Firstly it's very important to follow certain git commit message conventions and we recommend Angular's.

Secondly no simple git commit message hook ever exists right now. To Add, to overwrite or to remove types is not so friendly supported. Why not conventional-changelog/commitlint or husky, read the FAQs.

> The commit-msg hook takes one parameter, which again is the path to a temporary file that contains the commit message written by the developer. If this script exits non-zero, Git aborts the commit process, so you can use it to validate your project state or commit message before allowing a commit to go through. > > https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

After installed, it will copy the hook {PROJECT_ROOT}/.git/hooks/commit-msg if it exists to {PROJECT_ROOT}/.git/hooks/commit-msg.old then the commit-msg will be overwritten by our linting rules.

To uninstall run the uninstall script instead of removing it manually because only in this way, the old commit-msg hook can be restored, so that your next commit messages will be ignored by the linter.

npm uninstall git-commit-msg-linter --save-dev

Before uninstalling, the commit-msg file will be restored and the commit-msg.old will be removed.

Why not conventional-changelog/commitlint?

• Configurations are relatively complex.
• No description for type, unfriendly to commit newbies. Because every time your are wondering which type should I use, you must jump out of you commit context to seek documentation in the wild web.
• To modify type description is also not supported. Unfriendly to non-english speakers. For example, all my team members are Japanese, isn't it more productive to change all the descriptions to Japanese?
• To add more types is also impossible. This is unacceptable for project with different types already existed.

This linter can work by standalone. But if you have husky 5 installed, because husky 5 will ignore the .git/hooks/commit-msg so a .husky/commit-msg need to be added manually:

npx husky add .husky/commit-msg ".git/hooks/commit-msg \$1"

Show the file content of .husky/commit-msg to make sure it has been added successfully otherwise do it manually.

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

.git/hooks/commit-msg $1

More details at issues 8.

<a href="https://www.npmjs.com/package/git-commit-msg-linter">
  <img alt="commit msg linted by git-commit-msg-linter" src="https://badgen.net/badge/git-commit-msg-linter/3.0.0/yellow">
</a>