golang 存储库预提交挂钩运行时遇到错误

大家好，今天本人给大家带来文章《golang 存储库预提交挂钩运行时遇到错误》，文中内容主要涉及到，如果你对Golang方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

这是我的 .pre-commit-config.yaml 文件的内容，

repos:
- repo: local
  hooks:
    - id: static-checks-pramod
      name: static analysis
      description: this hook does static analysis
      entry: staticcheck -tests=false ./...
      language: golang
      types: [text]

在本地为所有本地文件运行挂钩时，我遇到以下错误，

pramodchoudhari@pramods-macbook-pro-2 my-repo % pre-commit run --all-files
static analysis..........................................................failed
- hook id: static-checks-pramod
- exit code: 1

-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...
-: named files must be .go files: ./...

但是如果我在本地运行 staticcheck 命令，它可以正常工作，如下所示，

pramodchoudhari@Pramods-MacBook-Pro-2 my-repo % staticcheck -tests=false ./...         
pramodchoudhari@Pramods-MacBook-Pro-2 my-repo %

我不确定我在预提交配置中做错了什么。

ps：我正在使用这个 linter 对我的存储库进行静态分析

正确答案

您的配置接近，但有一些可以改进的地方。现在，您正在安装一个 noop golang 存储库，然后针对 ./... （golang 语言中的所有内容）和存储库中的所有 text 文件运行（可能不是您想要的！）

首先让我们解决 noop 存储库 -- language: golang 指示 pre-commit 如何安装挂钩本身 -- 在这种情况下，你没有告诉它安装任何东西（repo: local 挂钩通常使用 additional_dependency 来安装东西）

假设您想要预提交来管理安装（这毕竟是预提交要点的一部分 - 它管理您的安装，因此您无需指导贡献者如何安装所有内容） -- 为此，您需要告诉预提交安装如下内容：

    # ...
    language: golang
    additional_dependencies: [honnef.co/go/tools/cmd/[email protected]]
    # ...

现在让我们处理正在传递的文件 - 上面的 @jkittner 击中了这一点，但我会详细说明一下。

pre-commit 的 argument pattern：

您的钩子应该会收到 args 值，然后是暂存文件列表。

然后来自 filtering files with types：

text - 文件是否看起来像文本文件

将它们放在一起，您当前的配置类似于运行 staticcheck -tests=false ./... $(git ls-files) （假设您只有文本文件，实际上没有一个好的 shell 方法我知道过滤掉二进制文件）

您可能想要过滤出 go 文件，并且您可能不想对每个文件进行双重检查 - 请尝试以下操作：

    # ...
    entry: staticcheck -tests=false
    types: [go]
    # ...

或者，如果您总是想运行所有内容（我不建议这样做，它会一直变慢！），您可以关闭预提交的文件处理

    # ...
    entry: staticcheck -tests=false ./...
    pass_filenames: false
    always_run: true
    # ...

免责声明：我写了预提交

在您的 .pre-commit-config.yaml 中，您的 types 设置为 text ，这会将所有文本（如文件）传递给 staticcheck ，但它只期望 go -files。

您可能需要 types: [go]。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。