vscode下的commitlint的提交规范
时间: 2024-09-20 09:09:29 浏览: 103
Visual Studio Code (VSCode) 下的 commitlint 可以帮助开发者设置统一的 Git 提交消息格式,确保每次提交都遵循一定的规则。它通常结合 git-commit-msg 或 husky 配置文件来工作,如`.husky/pre-commit`,并配合`commitizen`或`cz-conventional-changelog`等工具。
commitlint 的配置通常包括以下几个部分:
1. **规则配置**:定义了提交信息应该包含哪些字段(比如 `type`, `scope`, `subject`, `body`, 和 `footer`),以及它们的格式要求。常见的规范如Angular的`@angular/convention-commits`或GitHub的`conventional-changelog-angular`.
```json
{
"rules": {
"body-max-line-length": ["error", {"max": 72}],
"header-max-length": ["error", {"max": 50}]
}
}
```
2. **配置文件**:例如`.commitlintrc.json`,里面会指定上述规则集。
3. **脚本执行**:pre-commit钩子会在提交前运行commitlint检查提交消息是否符合规定。
安装步骤通常是这样的:
1. 安装依赖:`npm install commitizen commitlint @commitlint/config-conventional`
2. 初始化配置:`npx commitlint init`
3. 编辑 `.commitlintrc.json` 根据需求定制规则。
阅读全文