npm 包 prepush-hook 使用教程

前言

在开发过程中，代码提交前的检查和校验确保了代码的质量和一致性。为了达到这个目标，开发者通常需要在本地机器上运行一些自动化的校验工具，如 ESLint、Prettier 和 Stylelint 等。这些校验工具需要手动运行，很容易被开发者遗忘或者忽略。同时，也有些错误是很难被人为发现的，例如缺少测试、代码风格不一致等。

为了解决这个问题，我们可以使用 prepush-hook npm 包。该包可以帮助我们在执行 git push 命令之前自动运行我们配置的校验工具。

安装

全局安装 prepush-hook：

npm install -g prepush-hook

或者本地安装：

npm install --save-dev prepush-hook

配置

在 package.json 文件中添加如下配置：

{
  "scripts": {
    "prepush": "npm run lint && npm run test"
  },
  "prepush": "npm run prepush"
}

上述配置意为在执行 git push 命令时，会先执行 npm run lint 命令和 npm run test 命令。

示例代码

比如我们项目使用了 ESLint、Prettier 和 Jest，并且我们想在每次 push 时校验代码、格式化代码并且运行测试覆盖率。我们可以做如下配置：

{
  "scripts": {
    "lint": "eslint src",
    "prettier": "prettier --check \"src/**/*.{js,jsx}\"",
    "test": "jest --coverage"
  },
  "prepush": "npm run lint && npm run prettier && npm run test"
}

配置完成后，每次使用 git push 命令时，就会先执行 npm run lint，由于我们在 .eslintrc.json 文件中配置了使用 airbnb 的规范并且在 package.json 文件中安装了相关依赖，所以会使用 airbnb 的规范校验代码。如果代码规范不符合规范，则会提示错误并中断 push。

接着会运行 npm run prettier 命令来格式化代码，如果代码格式不符合要求，则同样会提示错误并中断 push。

最终会运行 npm run test 命令来运行 Jest 测试。

结语

使用 prepush-hook 工具可以帮助我们在 push 前进行代码校验，降低了部分代码错误的风险。此外，prepush-hook 也可用于在 push 前自动运行其他打包、编译等必要操作。当然，prepush-hook 并不是万能的，为了确保代码质量，我们还需要其他多项工具的协助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcae8b5cbfe1ea0612501