stormqx / hawkeye

🦉👀Run scripts on git diff files

hawkeye

🦉👀Run scripts on git diff files

About

npm依赖管理那些事一文中描述了npm依赖管理方案的最佳实践。其中聊到了：

任何时候有人提交了 package.json, package-lock.json 更新后，团队其他成员应在 git pull 拉取更新后执行 npm install 脚本安装更新后的依赖包。

hawkeye的设计意图就是将这步操作自动化：通过比较git头来获取git diff files(git diff-tree -r --name-only --no-commit-id HEAD@{1} HEAD)，尝试匹配配置文件中声明的文件和命令。 实现方式参考了lint-staged。

Installation

npm install --save-dev hawkeye

// package.json
{
  "hawkeye": {
    "package.json": "npm install"
  }
}
{
  "husky": {
    "hooks": {
      "post-merge": "hawkeye"
    }
  }
}

hawkeye一般和husky配合着使用，借助husky改造git钩子的能力，允许你在不同的时机做你想做的事情。所以请保证package.json的依赖中安装(npm install --save-dev)了hawkeye和husky。

Command line flags

$ npx hawkeye --help
Usage: hawkeye [options]

Options:
  -V, --version  output the version number
  -d, --debug    Enable debug mode
  -h, --help     output usage information

Configuration

hawkeye支持多种方式编辑配置文件：

• hawkeye object in your package.json
• .hawkeyerc file in JSON/JS/YML format
• hawkeye.config.js file in JS format

关于format的更多细节可以查看cosmiconfig。

配置文件为Object形式，其中key为用于匹配文件的glob pattern，value为匹配成功后执行的命令。hawkeye使用micromatch匹配glob pattern。

.hawkeyerc.json配置例子：

{
  "package.json": "your-cmd"
}

filtering files

hawkeye使用micromatch匹配glob pattern。使用下列规则：

• 默认开启了micromatch的matchBase选项。这意味着如果你提供的glob pattern不包含/，hawkeye尝试去匹配文件名，不关心文件的目录:
  • *.json会匹配所有的json文件，比如/package.json，/app/public/src/package.json
• 如果glob pattern包含了/，hawkeye会匹配路径：
  • /*.json会匹配根目录(process.cwd)的json文件，因此会匹配/package.json，不会匹配/app/public/src/package.json

多package仓库如何使用hawkeye？

• 如果想在多package仓库中使用hawkeye，推荐将hawkeye和[husky](https://github.com/typicode/husky)安装在根目录的package.json，因为husky每次安装会重置git hooks脚本，多次安装会互相覆盖。在hawkeye配置文件中配置的命令的默认执行位置是process.cwd。

• 如果是使用[lerna](https://github.com/lerna/lerna)的monorepo，会在所有的子包中执行命令。如果没有使用lerna，则需要你通过npm scripts手动处理在子包中的操作。

publish

$ npm adduser
... input username password email

$ npm publish --access public

flow chart

Changelog

TODO

• [✓] debug mode
• unit test
• [✓] travis.ci
• codecov
• changelog
• [✓] npm publish
• TypeScript
• validating config
• windows support

License

MIT