良好的代码规范,不仅结构清晰,可读性高,而且风格同一,减少沟通成本。
规范
工具
使用 ESLint 检查代码
ESLint 是一款 JavaScript 检查工具。
使用 Perettier 格式化代码
Perettier 是代码格式化工具,对 HTML/CSS/JavaScript/Vue 都有效果。
使用 Git Hook 检查提交代码
项目要使用 Git 进行代码提交时,使用 pre-commit 的 Git Hook。在调用 git commit 命令时,自动执行某些脚本检查代码。若检查出错,则阻止 commit 代码提交,也将无法 push,保证了出错代码只能在我们本地,不会把问题提交到远程仓库。
1. 使用 vue-cli-service + lint-staged
使用 lint-staged,首先需要安装依赖:
npm install lint-staged --save-dev
在安装之后,@vue-cli-service 也会安装 yorkie,它会让你在 package.json 的 gitHooks 字段中方便地指定 Git hook:
"gitHooks": {"pre-commit": "lint-staged"},"lint-staged": {"*.{js, vue}": ["vue-cli-service lint","git add"],}
2.使用 husky + lint-staged
对于非 Vue 项目使用 husky + lint-staged 来构建钩子。
除了上述需要安装的 lint-staged 依赖之外,需要安装 husky。
npm install husky --save-dev
在 package.json 文件中,修改配置如下:
"husky": {"hooks": {"pre-commit": "lint-staged"}},"lint-staged": {"*.js": ["eslint --fix", "git add"]}
