pre-commit

官网-使用介绍

官网-可使用的钩子列表

简介

pre-commit：帮助你提高代码质量的工具

pre-commit是一个帮助开发人员提高代码质量的工具。它通过在提交代码之前运行一系列检查来实现这一点。这些检查可以包括格式检查、静态分析和 linting。

pre-commit可以帮助你发现并修复代码中的错误，从而提高代码的质量和可维护性。它还可以帮助你遵循代码风格指南，并确保你的代码符合特定的标准。

pre-commit会在你提交代码之前运行你指定的检查。如果检查发现任何错误，它会阻止你提交代码。你需要修复错误后才能提交代码。

pre-commit是一个非常有用的工具，可以帮助你提高代码质量。如果你正在寻找一种提高代码质量的方法，我建议你使用pre-commit。

以下是一些使用pre-commit的优势：

• 提高代码质量：pre-commit可以帮助你发现并修复代码中的错误，从而提高代码的质量和可维护性。
• 遵循代码风格指南：pre-commit可以帮助你遵循代码风格指南，从而使你的代码更易于阅读和维护。
• 确保代码符合特定的标准：pre-commit可以帮助你确保你的代码符合特定的标准，例如PEP8或Google风格指南。
• 节省时间：pre-commit可以帮助你节省时间，因为它可以自动执行检查，而你不需要手动检查代码。

如果你正在寻找一种提高代码质量的方法，我建议你使用pre-commit。它是一个非常有用的工具，可以帮助你提高代码质量，节省时间。

安装

pip install pre-commit

使用

手动在项目根路径常见文件： .pre-commit-config.yaml

可以使用 pre-commit sample-config生成一个简单的配置格式

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
    -   id: check-yaml
    -   id: end-of-file-fixer
    -   id: trailing-whitespace

安装pre-commit脚本

 pre-commit install

如果是新增的钩子，可以将全部的文件都跑一次，一般后续则默认只会对修改的文件进行检查。

pre-commit run --all-files

寻找可用的钩子工具： 官网-可使用的钩子列表