pre-commit用法说明

说明

项目要使用git进行代码提交时，使用叫pre-commit的git钩子，在调用git commit 命令时自动执行某些脚本检测代码，若检测出错，则阻止commit代码，也就无法push，保证了出错代码只在我们本地，不会把问题提交到远程仓库

安装

【1】安装husky

npm i husky -save-dev

【2】安装list-staged

npm i lint-staged husky -save-dev

package.json文件

安装好之后，会自动在项目.git目录生成一个hock，这个hock会读取package.json中的内容

  "husky": {
    "hooks": {
      "pre-commit": "npm run lint-staged"
    }
  },
  "lint-staged": {
    "**/*.js": "eslint --ext .js",
    "**/*.vue": "eslint --ext .vue"
  }

测试

首先，故意触犯eslint报错

再执行git commit提交代码

上面代码提交失败说明配置成功生效，每次执行git commit命令，都会自动调用package.json中的precommit命令，在本项目中precommit命令就会执行eslint的代码校验，若校验失败，则无法将代码commit，避免不规范代码提交到远程仓库，特别是在多人协作中能够强制规范代码