提升代码质量的小方法


2018-10-24 代码规范

关于代码规范这一块,有自己尝试写过eslint规则,最后发现还是用网上盛传的"最严格的代码规范"—— Airbnb 较为合适,毕竟经历过很多团队的检验了,现在在GitHub已经有7万多颗星星了。GitHub地址:Airbnb

另外在做代码规范时加入了一套代码格式化的工具,比如 prettierhuskylint-staged,是一套较为合适的团队代码规范工具。

prettier实际上是在git commit之时,重新格式化代码,同时进行代码检查预防一些低级错误。最终期待项目中的开发人员提交到线上的代码符合代码规范、风格统一,看起来像是一个人写的。

流程

  1. 编辑代码
  2. git add将改动添加到暂存区
  3. git commit
  4. husky注册在git pre-commit的钩子调起lint-staged
  5. lint-staged取得所有被提交的文件依次执行写好的任务Prettier
  6. 如果有错误则停止任务并且打印错误信息
  7. 以上流程都通过了就会成功提交

注册勾子

  • 首先安装依赖
npm i --save-dev husky lint-staged
  • package.json文件中添加hook函数
{
  "scripts": {
    "precommit": "lint-staged"
  },
  "lint-staged": {
    "src/**/*.{php,js,css}": [
      "prettier --tab-width 2 --write",
      "eslint --fix",
      "git add"
    ]
  }
}

上面配置的意思是,在执行git commit命令时会触发precommit,然后执行lint-staged,这里会将src目录下所有的php、js、css文件先用prettier工具以两个缩进格式化,再使用eslint修复错误,最后提交代码。

prettier 官网: Prettier

上次更新: 2019-3-6 14:33:08