在软件开发流程里,代码风格检查(Code Linting)几乎是保证代码质量和一致性的标配动作。不过,传统的做法往往把 Lint 放在 Code Review 或者 CI 阶段去跑,这就意味着问题发现得晚,反馈链条拉得长,修改起来也费劲。更理想的做法是:在开发者提交代码之前就把这些检查跑一遍,有问题当场解决,别让它们流到后面去。而利用 Git 的 Pre Commit 钩子,配合几个小工具,就能轻松实现这个目标。

gitcommit前自动执行lint检查怎么设置?husky+lint-staged详解

简介

先快速认识一下三个主角:

整个流程可以这样理解:

安装

用 npm 或 yarn 把这两个工具装到项目的 devDependencies 里就行:

npm install husky lint-staged --sa ve-dev

或者

yarn add husky lint-staged --dev

配置package.json(无prettier)

如果项目里暂时不需要 Prettier,只做 ESLint 检查,可以在 package.json 里追加以下配置:

"scripts": {
    "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --open",
    ...
    "eslint": "eslint --ext .js,.vue src",
    "eslintfix": "eslint --fix --ext .js,.vue src",
    "lint-staged": "lint-staged"
  },
  "husky": {
    "hooks": {
      "pre-commit": "npm run lint-staged"
    }
  },
  "lint-staged": {
    "**/*.{js,vue}": [
      "npm run eslint"
    ]
  },

注意,这里没有加 prettier,只对 .js 和 .vue 文件执行 ESLint 检查。

配置package.json(有prettier)

如果打算同时使用 Prettier 来自动格式化代码,再配合 ESLint 检查,可以参考下面的配置(这是 Vue 项目中比较常见的组合):

{
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,vue}": [
      "prettier --write",
      "vue-cli-service lint",
      "git add"
    ]
  }
}

解释一下每个步骤的作用:

当然,如果你用的是其他技术栈,只要把对应检查命令替换进去即可。

.prettierrc文件

新建一个 .prettierrc 文件,把下面的规则放进去,就能定义你想要的代码风格:

{
  "trailingComma": "es5", // 尾随逗号
  "tabWidth": 2,         // 缩进宽度
  "semi": false,         // 不要句尾分号
  "singleQuote": true,   // 使用单引号
  "end-of-line": "lf"    // 换行符统一为 LF
}

完成以上配置后,当你执行 git commit 时,Lint 程序就会自动检查本次提交所涉及的文件。一旦代码不符合规范,commit 会被直接拒绝,并给出错误提示。如果遇到特殊情况想跳过检查,在提交时加上 --no-verify 参数即可:git commit -no-verify

总结

通过 husky + lint-staged 的组合,把代码检查提前到 commit 之前,能有效减少后期修复的成本,也能让团队代码风格更统一。配置起来并不复杂,但收益却很明显——代码质量的门槛一下就提高了。

本文转载于:https://www.jb51.net/program/368324xoj.htm 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。