98. 使用 Husky 和 Commitizen 进行代码规范和提交规范
在团队开发中，保持代码的一致性和提交信息的规范性非常重要。为了实现这一目标，我们可以使用 Husky 和 Commitizen 这两个工具来规范代码和提交信息的格式。
什么是 Husky
Husky 是一个 Git 钩子工具，它可以在 Git 操作的不同阶段执行自定义的脚本。通过 Husky，我们可以在提交代码之前或之后执行一些操作，比如代码风格检查、单元测试等。
什么是 Commitizen
Commitizen 是一个优化提交信息的工具。它提供了一个交互式的界面，引导开发者按照指定的规范书写提交信息。使用 Commitizen，可以保证提交信息的格式统一，并提供更多有意义的信息，方便团队成员之间的沟通和代码审查。
安装和配置 Husky
首先，我们需要在项目中安装 Husky：
npm install husky --save-dev
安装完成后，在项目的 package.json 文件中添加以下配置：
{
"husky": {
"hooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}
上述配置中，我们将 pre-commit 钩子设置为在提交前运行 lint-staged 命令，commit-msg 钩子设置为在编写提交信息后运行 commitlint 命令。
安装和配置 Commitizen
接下来，我们需要安装 Commitizen：
npm install commitizen --save-dev
安装完成后，在项目的根目录下执行以下命令进行初始化：
npx commitizen init cz-conventional-changelog --save-dev --save-exact
上述命令会在项目中添加 Commitizen 的配置文件，并将提交信息的格式设置为符合常见的规范（如 Conventional Commits）。
使用 lint-staged 和 commitlint
除了 Husky 和 Commitizen，我们还可以使用 lint-staged 和 commitlint 进一步规范代码和提交信息。
安装 lint-staged 和 commitlint：
npm install lint-staged commitlint --save-dev
在 package.json 文件中添加以下配置：
{
"lint-staged": {
"*.js": [
"eslint --fix",
"git add"
]
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
}
}
上述配置中，我们使用 lint-staged 配置了对 .js 文件的代码风格检查，并自动修复错误。commitlint 配置了提交信息的规范，使用了 @commitlint/config-conventional 插件。
提交代码和信息
现在，我们
可以使用 Commitizen 提供的命令行工具来提交代码和信息了：
npx cz
执行以上命令后，会出现一个交互式界面，引导你填写提交信息。按照要求填写信息后，即可完成代码提交。
示例代码
以下是示例代码，展示了如何使用 Husky 和 Commitizen 进行代码规范和提交规范。
{
"name": "my-project",
"version": "1.0.0",
"scripts": {
"lint": "eslint src",
"test": "jest"
},
"devDependencies": {
"commitizen": "^4.2.4",
"husky": "^7.0.2",
"lint-staged": "^11.1.2",
"eslint": "^7.32.0",
"jest": "^27.4.7",
"commitlint": "^14.3.1",
"@commitlint/cli": "^14.3.1",
"@commitlint/config-conventional": "^14.3.1"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
},
"lint-staged": {
"*.js": [
"eslint --fix",
"git add"
]
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
}
}
希望本文对您了解如何使用 Husky 和 Commitizen 进行代码规范和提交规范有所帮助。通过合理配置和使用这些工具，我们可以建立起一套统一的开发流程，确保团队代码的质量和一致性。