npm 包 Yorkie 使用教程

简介

Yorkie 是一个轻量级的 Git Hooks 库，可以用于在 Git Hooks 中运行任意脚本。它可以用来帮助开发者执行代码风格检查、单元测试等操作。

安装

你可以通过 npm 安装 Yorkie：

npm install yorkie --save-dev

使用

添加 Git Hooks

安装完成之后，需要在 package.json 文件中添加 gitHooks 字段，并且指定使用 Yorkie：

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "My Package",
  "gitHooks": {
    "pre-commit": "yorkie pre-commit"
  }
}

上面的配置将会在每次执行 git commit 命令时，自动执行 yorkie pre-commit 命令。

配置文件

在项目根目录下创建 .yorkierc.js 文件，该文件为 Yorkie 的配置文件。下面是一个示例配置文件：

module.exports = {
  hooks: {
    'pre-commit': 'lint-staged',
    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS'
  }
}

上述示例配置了 pre-commit 和 commit-msg 两个 Git Hooks。

钩子脚本

钩子脚本为在 Git Hooks 中要执行的脚本，例如在 pre-commit 钩子中执行代码风格检查和单元测试：

module.exports = {
  hooks: {
    'pre-commit': 'npm run eslint && npm run test:unit',
    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS'
  }
}

上述示例在 pre-commit 钩子中依次执行了 npm run eslint 和 npm run test:unit 命令。

总结

通过使用 Yorkie，我们可以方便地在 Git Hooks 中执行自动化脚本，在项目开发过程中提高代码质量和开发效率。希望这篇文章能够帮助你学习并正确使用 Yorkie。

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