返回
Husky v7.0.1:让代码优雅规范不再是难题
前端
2023-12-17 08:03:50
近年来,随着 DevOps 的兴起,代码规范和自动化测试变得越来越重要。使用像 Husky 这样的工具,我们可以轻松地对代码进行格式化、检查和测试,从而确保代码的质量和一致性。
而 Husky v7.0.1 的发布则为我们带来了更多新特性和改进,让代码优雅规范不再是难题。
本文将带领你一步步上手 Husky v7.0.1,让你快速了解如何使用它来提升代码质量。
安装 Husky
首先,我们需要安装 Husky:
npm install husky -D
安装完成后,在项目根目录下创建一个名为 .husky
的文件夹,并在这个文件夹下创建配置文件 .husky/husky.config.js
:
module.exports = {
hooks: {
'pre-commit': 'npm run lint',
'commit-msg': 'npm run commitlint'
}
};
在这个配置文件中,我们指定了在提交前需要运行的命令。
格式化代码
可以使用 Prettier 来格式化代码。安装 Prettier:
npm install prettier -D
并创建一个 .prettierrc
文件,指定代码格式化规则:
{
"singleQuote": true,
"trailingComma": "all"
}
然后在 .husky/husky.config.js
中添加以下代码:
'pre-commit': 'prettier --write .',
检查代码风格
使用 ESLint 检查代码风格。安装 ESLint:
npm install eslint -D
并创建一个 .eslintrc.js
文件,指定代码风格规则:
module.exports = {
"extends": "eslint:recommended",
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "single"]
}
};
然后在 .husky/husky.config.js
中添加以下代码:
'pre-commit': 'eslint .',
检查提交信息
可以使用 Commitlint 检查提交信息。安装 Commitlint:
npm install commitlint -D
并创建一个 .commitlintrc.js
文件,指定提交信息规则:
module.exports = {
rules: {
"body-leading-blank": [1, "always"],
"footer-leading-blank": [1, "always"],
"subject-empty": [2, "never"]
}
};
然后在 .husky/husky.config.js
中添加以下代码:
'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS'
总结
通过使用 Husky v7.0.1,我们可以在提交代码前轻松地格式化代码、检查代码风格和提交信息,从而确保代码的质量和一致性。这对于团队协作和代码维护非常有帮助。