@colorless/commitlint-config

commitlint是用来校验提交代码时git commit message的书写规范

本项目提供了开箱即用的团队内部的统一规范，通过规范来固化团队内部编写git commit message的格式，形成统一的风格。

技术栈：

• commitizen; 为开发者提供一个可交互式的命令行，使得无需手动记得约定式提交规范，即可编写出符合团队规范的git commit message
• commitlint; 是一个为提供提交时校验git commit message是否符合规范的静态扫描工具，它通常需要配合git hooks来使用

如何使用

Step.1 安装包

pnpm add commitizen @colorless/commitlint-config @commitlint/cli @commitlint/cz-commitlint inquirer@8 -D

Step.2 配置commitlint.config.cjs

module.exports = {
  extends: "@colorless"
}

Step.3 设置commitizen的适配器@commitlint/cz-commitlint

在package.json中添加配置

{
  "config": {
    "commitizen": {
      "path": "@commitlint/cz-commitlint"
    }
  }
}