https://github.com/legend80s/git-commit-msg-linter

git commit message linter hook
https://github.com/legend80s/git-commit-msg-linter

conventions git-commit hook linter

Last synced: 15 days ago
JSON representation

git commit message linter hook

• Host: GitHub
• URL: https://github.com/legend80s/git-commit-msg-linter
• Owner: legend80s
• License: mit
• Created: 2019-05-12T11:19:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T15:28:28.000Z (6 months ago)
• Last Synced: 2024-07-23T10:01:55.966Z (4 months ago)
• Topics: conventions, git-commit, hook, linter
• Language: JavaScript
• Homepage:
• Size: 2.57 MB
• Stars: 327
• Watchers: 6
• Forks: 21
• Open Issues: 4
• Metadata Files:
  • Readme: README-zh-CN.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-commit-msg-linter



  



> 👀 规范开发者的每一行提交信息，为团队定制专属的 Git 提交信息规范

## 安装

```sh

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

```

**只需安装无需配置**，提交信息已处于 lint 状态，现在去提交代码试试。

## 设置提示语言

默认使用系统设置语言（`$ node -p 'Intl.DateTimeFormat().resolvedOptions().locale'`），可通过以下两种方式自定义语言，支持中文（zh-CN）、英文（en-US）葡萄牙语（pt-BR）和 es-ES。以下配置顺序优先级从高到低：

### 通过 commitlinterrc.json 设置

```json

{

  "lang": "zh-CN"

}

```

### 通过环境变量设置

```sh

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

```

profile 文件可以是 `.bash_profile`, `.zshrc` 等。

## 优点

1. 可视化，低学习成本

2. 零配置，易上手

3. 错误提交对症提示，对不熟悉提交信息规范习惯的开发者友好

4. i18，支持中文、英文、葡萄牙

5. 可自定义团队规范

6. 使用模糊匹配自动纠正 type