git - 带有预提交的 Pylint 和带有 husky 的 EsLlint

Question

我有一个项目，前端是 JS，后端是 Python。
前端已经配置了 husky 预提交钩子(Hook)。
今天我已经用预提交库配置了 Pylint，但是 husky 钩子(Hook)已经被那个 Action 覆盖了。
是否可以结合 pre-commit 和 husky 库？
如果不是...解决问题的最佳方法是什么？

Answer 1

pre-commit 有一个“迁移模式”，用于运行其他现有的钩子(Hook)框架。似乎 husky 在他们的钩子(Hook)实现中有点太聪明了，无法检测你正在运行的钩子(Hook)——他们基于正在执行的文件名
pre-commit 的迁移模式的工作方式是它采用任何现有的钩子(Hook)脚本(在这种情况下，husky 编写的钩子(Hook)脚本到 .git/hooks/pre-commit )并添加扩展名 .legacy .然后在执行期间它运行该脚本。
但对于哈士奇来说，它看起来像 pre-commit.legacy钩子(Hook)正在运行(!)
一个小技巧是定义 pre-commit.legacy在 package.json这似乎有效:
包.json

{
  "husky": {
    "hooks": {
      "pre-commit.legacy": "echo hello world"
    }
  },
  "dependencies": {
    "husky": "^4.3.0"
  }
}

.pre-commit-config.yaml

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.2.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files
$ git commit -m "both"
husky > pre-commit.legacy (node v12.18.3)
hello world
Trim Trailing Whitespace.................................................Passed
Fix End of Files.........................................................Passed
Check Yaml...........................................(no files to check)Skipped
Check for added large files..............................................Passed
[master 7bd8807] both
 1 file changed, 1 insertion(+), 1 deletion(-)

也就是说，这似乎很脆弱。 pre-commit 旨在支持许多不同的编程语言(即使它是用 python 编写的，它也原生支持 10+ programming languages( 包括 javascript ))

第一个替换可能是直接从 local 调用 husky预提交钩子(Hook):
包.json

{
  "husky": {
    "hooks": {
      "pre-commit": "echo hello world"
    }
  },
  "dependencies": {
    "husky": "^4.3.0"
  }
}

.pre-commit-config.yaml

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.2.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files
-   repo: local
    hooks:
    -   id: husky-run-pre-commit
        name: husky
        language: system
        entry: node_modules/.bin/husky-run pre-commit
        pass_filenames: false
        always_run: true

执行

$ pre-commit run --all-files --verbose
Trim Trailing Whitespace.................................................Passed
- hook id: trailing-whitespace
- duration: 0.03s
Fix End of Files.........................................................Passed
- hook id: end-of-file-fixer
- duration: 0.03s
Check Yaml...............................................................Passed
- hook id: check-yaml
- duration: 0.05s
Check for added large files..............................................Passed
- hook id: check-added-large-files
- duration: 0.05s
husky....................................................................Passed
- hook id: husky-run-pre-commit
- duration: 0.07s

husky > pre-commit (node v12.18.3)
hello world

然而，这个解决方案没有利用 pre-commit 的 js 支持，它只是调用了已经存在的 husky 钩子(Hook)

一个更原生的解决方案是使用 pre-commit 直接安装 js 钩子(Hook)，例如，如果您使用的是 eslint:

repos:
-   repo: https://github.com/pre-commit/mirrors-eslint
    rev: 'v7.9.0'  # Use the sha / tag you want to point at
    hooks:
    -   id: eslint

$ pre-commit  run --all-files
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-eslint.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-eslint:eslint@7.9.0.
[INFO] Installing environment for https://github.com/pre-commit/mirrors-eslint.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
eslint...................................................................Passed

免责声明:我是 pre-commit 的作者