如何在预提交挂钩之前运行自定义 shell 脚本文件

Question

在我的 python 项目中，我有 pre-commit-config.YAML，我想在其中创建我的自定义文件。

如果 python lint 错误大于特定数字，则此文件的目的是使 git commit 失败。以下命令将用于计算行数

pylint api/ | wc -l

有人可以建议一些方法。我是 MAC 和 Python 生态系统的新手？

编辑 sh 文件看起来像这样。

#!/bin/sh
a=$(pylint source/ | wc -l)
b=20

errorsCount="$(echo "${a}" | tr -d '[:space:]')"

if [ $errorsCount -gt $b ]
then
    exit 1
fi

我试过

repos:
- repo: local
  hooks:
    - id: custom-script-file
      name: custom-script-file
      entry: hooks/pre-commit.sh
      language: script
      types: [python]
      pass_filenames: false

但它不会奏效。

Answer 1

以下是使用内联 bash 命令作为预提交挂钩条目的方法

- repo: local
  hooks:
    - id: pylint-error-count
      name: pylint-error-count
      entry: bash -c 'lines=$(pylint api/ | wc -l) && (( lines > 10)) && exit 1'
      language: system
      types: [python]
      pass_filenames: false

您还可以编写脚本并以这种方式调用它：

      entry: path/relavite/to/repo/root/pylint_validator.sh
      language: script

注意：wc -l不是准确的错误计数。

编辑：添加更多选项

- repo: local
  hooks:
    - id: simple-pylint
      name: simple-pylint
      entry: pylint
      args: ["api/"]
      language: system
      types: [python]
      pass_filenames: false

    - id: inline-pylint-with-bash
      name: inline-pylint-with-bash
      entry: bash -c 'lines=$(pylint api/ | wc -l) && (( lines > 10)) && exit 1'
      language: system
      types: [python]
      pass_filenames: false

    - id: custom-script-file
      name: custom-script-file
      entry: relative/path/to/repo/root/check_pylint.sh
      language: script
      types: [python]
      pass_filenames: false