Eslint:
代码质量的检查(extends: 直接使用extends中约定好的编码规范)
1、npm install eslint --save-dev
2、vscode安装插件 ESLint
3、根目录添加.eslintrc.js文件,在其中添加规则
4、 配置eslint忽略文件
Prettier:
代码风格的约束工具
1、npm install prettier --save-dev
2、vscode安装插件
3、在项目根目录中新建 .prettierrc.js 文件,该文件为 perttier 默认配置文件:
eg:
Eslint和Prettier规则冲突:
1、eg:
2、解决冲突
npm install eslint-config-prettier --save-dev
npm install eslint-plugin-prettier --save-dev
Husky + Commitlint + lint-staged:
1、
commitlint: 制定提交规范, 用于检查提交信息
husky: 是git hooks工具, 继承了Git下所有的钩子,在触发钩子的时候,husky可以阻止不合法的commit,push等等
2、
安装commitlint:
npm install @commitlint/config-conventional @commitlint/cli --save-dev
在根目录创建 commitlint.config.js 文件:
eg:
3、
安装husky
npm install husky --save-dev
在控制台输入命令,生成.husky文件夹
npx husky install
4、使用 commit-msg 钩子规范化提交信息
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
window 10(执行后需对文件修改成npx --no-install commitlint --edit “$1”):
npx husky add .husky/commit-msg "npm-run-test"
4.1、提交:
5、使用 pre-commit 检测提交时代码规范
npx husky add .husky/pre-commit “npm run eslint”
window 10(执行后需对文件指令进行修改eg: npm run lint):
npx husky add .husky/pre-commit “npm-run-test”
5.1、提交
6、使用lint-staged检测暂存区代码
npm install lint-staged --save-dev
6.1、在package.json中添加配置,如:
6.2、修改 .husky/pre-commit 文件:
eslint和prettier冲突
https://blog.csdn.net/jatej/article/details/124490084
eslint+prettier+husky+commitlint
https://juejin.cn/post/7041768022284976165#heading-8