Git钩子工具lefthook

lefthook 是什么

lefthook是由 Go 语言开发的实用于多种编程语言项目标快速且强大的 Git 钩子管理器，它可以在项目构建过程中实行一些使命，比方查抄代码格式、查抄依靠、测试、覆盖率查抄、静态分析、连续集成等。官方先容它的几个特点：
快速，它是用 Go 编写的，可以并行运行下令。
强大，它可以控制实行通过下令通报的实行和文件。
简单，它是一个无依靠的二进制文件，可以在任何情况中工作。
下面看看我们怎样在 Git 堆栈中利用 lefthook。
安装 lefthook

1. npm install lefthook --save-dev

复制代码

安装完成后会在项目标根目次下创建一个 lefthook.yml 文件，如果没有产生的话也可以自己创建一个。lefthook 的设置文件可以利用下面这些文件名。

• lefthook.yml
  
• .lefthook.yml
  
• lefthook.yaml
  
• .lefthook.yaml
  
• lefthook.toml
  
• .lefthook.toml
  
• lefthook.json
  
• .lefthook.json
  

一个例子

看一个简单的例子，看看 lefthook 怎么利用，修改 lefthook.yml 文件，界说 pre-commit，post-commit，pre-push 三个钩子，如下所示：

1. pre-commit:
2.   parallel: true
3.   scripts:
4.     "pre-commit.sh":
5.       runner: bash
7. post-commit:
8.   parallel: true
9.   scripts:
10.     "post-commit.sh":
11.       runner: bash
13. pre-push:
14.   parallel: true
15.   scripts:
16.     "pre-push.js":
17.       runner: node

复制代码

这里界说了三个钩子，分别对应 .lefthook/pre-commit/pre-commit.sh，.lefthook/post-commit/post-commit.sh，.lefthook/pre-push/pre-push.js 三个脚本。这里脚本路径必须放在对应的钩子文件夹下，内容如下：

• .lefthook/pre-commit/pre-commit.sh
  

1. #!/bin/sh
3. echo 'pre-commiit ...'

复制代码

• .lefthook/post-commit/post-commit.sh
  

1. #!/bin/sh
3. echo 'post-commiit ...'

复制代码

• .lefthook/pre-push/pre-push.js
  

1. console.log('pre-push ...');

复制代码

接下来，实行 git commit 下令，来触发 pre-commit 和 post-commit hooks。

1. $ git commit -m 'test' src/index.ts
3. ╭──────────────────────────────────────╮
4. │ 🥊 lefthook v1.6.7  hook: pre-commit │
5. ╰──────────────────────────────────────╯
6. sync hooks: ✔️ (pre-commit, pre-push, post-commit, post-push)
7. ┃  pre-commit.sh ❯
9. pre-commiit ...
12.   ────────────────────────────────────
13. summary: (done in 0.05 seconds)      
14. ✔️  pre-commit.sh
15. ╭───────────────────────────────────────╮
16. │ 🥊 lefthook v1.6.7  hook: post-commit │
17. ╰───────────────────────────────────────╯
18. ┃  post-commit.sh ❯
20. post-commiit ...
23.   ────────────────────────────────────
24. summary: (done in 0.13 seconds)      
25. ✔️  post-commit.sh
26. [main 98d62d5] test
27. 1 file changed, 1 insertion(+), 1 deletion(-)

复制代码

实行 git push 下令，来触发 pre-push hook。

1. $ git push
3. ╭────────────────────────────────────╮
4. │ 🥊 lefthook v1.6.7  hook: pre-push │
5. ╰────────────────────────────────────╯
6. ┃  pre-push.js ❯
8. pre-push ...
11.   ────────────────────────────────────
12. summary: (done in 1.98 seconds)      
13. ✔️  pre-push.js
14. ...

复制代码

上面例子仅仅演示了 lefthook 怎么在 Git 下令的差异阶段触发钩子脚本，这里只界说了三个钩子并简单的打印了一些字符串，在实际应用中，你可以利用 lefthook 的差异钩子来自动实行一些使命，这些使命可以直接写在 lefthook 的设置文件中，也可以写成一个单独的脚本文件，然后通过 lefthook 调用。
又一个例子

下面看一个实际的应用场景，在利用 Git 下令提交接码时，利用 eslint 静态分析代码质量，利用 prettier 格式化代码。
设置 lefthook

修改 lefthook.yml 文件，内容如下：

1. pre-commit:
2.     parallel: true
3.     commands:
4.         eslint:
5.             glob: "*.{js,ts,jsx,tsx}"
6.             run: yarn eslint "{staged_files}"
7.         prettier:
8.             glob: "*{js,ts,jsx,tsx,html,md,yml,yaml,json}"
9.             run: yarn prettier --write "{staged_files}"

复制代码

安装设置 eslint

ESLint 是一个代码静态分析工具，静态分析代码以快速发现标题。ESLint 做了两件事,一件是修复代码质量,另一件就是修复代码格式。但 ESlint 的代码格式做的不敷彻底，以是反面会利用 prettier 来增强。

• 安装 eslint
  

1. $ npm install -D eslint eslint-config-prettier

复制代码

• 设置 eslint
  

1. $ npm init @eslint/config (根据自己项目情况选择，命令执行后会在根目录下生成 .eslintrc.js 文件)

复制代码

安装设置 prettier

• 安装 prettier
  

1. $ npm install --save-dev --save-exact prettier

复制代码

• 设置 prettier
  

在项目根目次下创建 .prettierrc 文件，这里简单设置了几项

1. {
2.     "printWidth": 120,
3.     "tabWidth": 4,
4.     "useTabs": false,
5.     "endOfLine": "lf",
6.     "trailingComma": "es5"
7. }

复制代码

在项目根目次下创建 .prettierignore 文件

1. node_modules/
2. dist/

复制代码

测试

实行 git commit 下令，可以看到 eslint 和 prettier 自动实行了，而且代码已经自动修复和格式化了。

1. $ git commit -m 'test' src/index.ts
2. ╭──────────────────────────────────────╮
3. │ 🥊 lefthook v1.6.7  hook: pre-commit │
4. ╰──────────────────────────────────────╯
5. │  pre-commit.sh (skip) not specified in config file
6. ┃  prettier ❯
8. yarn run v1.22.19
9. $ /Users/fkong/workspace/GitHub/kongxx/my-express/node_modules/.bin/prettier --write src/index.ts
10. src/index.ts 296ms
11. ✨  Done in 0.78s.
13. ┃  eslint ❯
15. yarn run v1.22.19
16. $ /Users/fkong/workspace/GitHub/kongxx/my-express/node_modules/.bin/eslint src/index.ts
17. ✨  Done in 1.86s.
19.                                       
20.   ────────────────────────────────────
21. summary: (done in 2.15 seconds)      
22. ✔️  prettier
23. ✔️  eslint
24. ╭──────────────────────────────────────╮
25. │ 🥊 lefthook v1.6.7  hook: commit-msg │
26. ╰──────────────────────────────────────╯
27. ╭───────────────────────────────────────╮
28. │ 🥊 lefthook v1.6.7  hook: post-commit │
29. ╰───────────────────────────────────────╯
30. [main efed81d] test
31. 1 file changed, 2 insertions(+), 2 deletions(-)

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！qidao123.com:ToB企服之家，中国第一个企服评测及软件市场,开放入驻,技术点评得现金