如何在自定义预提交挂钩中返回状态“Skipped”？

Question

我有一个自定义的预提交挂钩，如果较早的挂钩失败，我想跳过该挂钩。如果较早的挂钩失败，则会生成名为 pre-commit.log 的日志文件。

.pre-commit-config.yaml 可能如下所示：

repos:
-   repo: https://gitlab.com/pycqa/flake8
    rev: 3.9.2
    hooks:
    - id: flake8
      log_file: pre-commit.log
-   repo: local
    hooks:
    - id: skript
      name: skript
      entry: bash skript.sh
      language: system
      log_file: pre-commit.log

我的 bash skript.sh 如下所示：

if [ -f "pre-commit.log" ]; then
  echo "Error in earlier pre-commit! We skip this script."
  echo "See 'pre-commit.log' for detailed information."
  exit 1
else
  echo "All pre-commits successful."
  # some other code
fi

现在我检查“pre-commit.log”是否存在，如果存在，我返回exit 1。因此，该挂钩的输出为 Failed。但我更喜欢 Skipped 状态，因为没有失败。

我的目标是在控制台或日志文件中看到文本 Skipped，就像此图中的 jupyter-notebook-cleanup 一样。 如果我写 exit 0 我会得到 Passed 就像 isort 和 black 一样，如果我返回 exit 1 或其他大于 1 的数字，我会得到 Failed，就像 flake8 一样。

如何获取消息已跳过？

Answer 1

无法影响文本被 Skipped

Skipped 仅在以下情况下出现：

• 钩子未运行，因为其 hookid 出现在 SKIP 中> 环境变量
• 没有与 files / types / types_or 和 pass_filenames 匹配的文件 true< /code> （默认）和always_run 为 false（默认值），

您最好的选择是在非失败情况下 exit 0，这将显示为 Passed输出

---

免责声明中的 ：我编写了您正在使用的预提交工具