记录代码格式化风格、git提交规范
缘由应该是本人在开发过程中代码格式差异导致git提交冲突,对于团队开发协作,编码风格也是重要得一环。于是想着记录下代码格式化风格和git提交规范的整理过程,开整。
- eslint:代码质量检测;
- prettier:代码格式化风格;
- commitlint:git提交强制约束;
- husky:增强的 git hook 工具;
安装以上库
npm i prettier eslint-config-prettier eslint-plugin-prettier eslint commitlint husky@4.0.0 --save-dev
或者vscode安装插件prettier
- 初始化eslint
eslint --init,会自动生成.eslintrc.js, 添加校验则"plugin:prettier/recommended"使用prettier校验风格
新建.prettierrc.js文件,配置项
-
git提交限制
安装commitlint成功后
-
npx husky install //生成.husky文件夹
-
npx husky add .husky/pre-commit "npm run lint-staged" //生成husky配置文件 会自动
-
安装conventional规范
npm i @commitlint/config-conventional -D
- 建commitlint.config.js
module.exports = {
extends: [
"@commitlint/config-conventional"
],
rules: {
'type-enum': [2, 'always', ['update', 'feat', 'fix', 'style', 'merge', 'revert', 'build', 'ci', 'docs', 'perf', 'refactor', 'test', 'chore']],
'type-case': [0],
'type-empty': [0],
'scope-empty': [0],
'scope-case': [0],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never'],
'header-max-length': [0, 'always', 72]
}
};