开源项目pre-commit的安装与使用指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00066/article/details/141076492

开源项目pre-commit的安装与使用指南

pre-commitAutomatically installs a git pre-commit script in your git repository which runs your `npm test` on pre-commit项目地址:https://gitcode.com/gh_mirrors/pre/pre-commit

项目介绍

pre-commit是一个多功能框架，专为管理和维护多种编程语言的预提交（pre-commit）钩子而设计。它简化了开发人员的工作流，在每次向仓库提交代码前自动化执行一系列代码检查和修复操作。这有助于保证代码质量和遵守既定的编码标准，无论是Python还是其他语言的项目。

特点：

跨平台兼容性: 适用于各种操作系统。
多语言支持: 不局限于一种语言，支持广泛的编程语言。
灵活的扩展: 用户可以通过添加自定义钩子来适应特定的开发需求。

项目快速启动

环境准备

确保你的环境中已安装以下依赖：

pip: Python包管理器。
virtualenv 或 venv: 用于创建隔离的Python环境。

安装Pre-commit

推荐使用pip全局安装Pre-commit，这样无需在每一个项目中重复安装。

pip install pre-commit

创建虚拟环境并激活

(可选) 如果你想在一个隔离的环境下安装pre-commit，可以使用下面的命令来创建并激活虚拟环境:

python -m venv .venv
source .venv/bin/activate

初始化pre-commit

在你的项目根目录下初始化pre-commit配置文件pre-commit-config.yaml:

pre-commit init

添加钩子

编辑pre-commit-config.yaml文件，向其中添加你需要的钩子。这里举几个常见的例子：

flake8: Python代码风格检查器。
black: Python代码格式化工具。
isort: Python导入排序工具。

配置文件可能看起来像这样：

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.4.0
    hooks:
    -   id: trailing-whitespace # 删除末尾空格
    -   id: end-of-file-fixer # 清除不必要的EOF换行符
    -   id: check-yaml # 验证YAML格式是否有效
    -   id: check-json # 验证JSON格式是否有效
    -   id: pretty-format-json # 格式化JSON
        args: ['--autofix'] # 参数说明：自动修复

-   repo: local
    hooks:
    -   id: black
        name: black
        entry: black # 黑色代码格式化入口点
        types: [python]
        language: system # 使用系统命令

-   repo: https://github.com/asottile/blacken-docs
    rev: v1.12.0
    hooks:
    -   id: blacken-docs
        additional_dependencies: [black==22.3.0]

-   repo: https://github.com/pycqa/isort
    rev: 5.10.1
    hooks:
    -   id: isort
        name: isort
        entry: isort
        language: python
        types: [python]
        stages: [manual] # 执行阶段

保存配置文件并退出。