在提交代码时自动格式化

本文内空由 chatGPT 生成,用于记录,还未实践
要在本地配置 pre-commit 钩子,请按照以下步骤进行操作:

安装 pre-commit:在命令行中运行以下命令安装 pre-commit:

pip install pre-commit

在项目根目录下添加 .pre-commit-config.yaml 文件:在项目根目录下创建 .pre-commit-config.yaml 文件,并按照以下格式配置:

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v4.0.1
  hooks:
  - id: flake8
  - id: black
  - id: isort

在这个例子中,我们添加了三个钩子,分别是 flake8、black 和 isort。这些钩子都是 pre-commit 默认提供的钩子,可以帮助我们在提交代码时进行代码格式检查和风格校验。

运行 pre-commit install:在命令行中进入到项目根目录,并运行以下命令:

copy code

pre-commit install

这将在项目的 .git/hooks 目录下创建钩子脚本,以便在执行 git commit 时运行 pre-commit 钩子。

现在,当你执行 git commit 时,pre-commit 将会运行在 .pre-commit-config.yaml 中定义的所有钩子。如果任何一个钩子检测到代码格式或风格错误,git commit 将会失败,并提示你修改代码以符合规范。这可以帮助你在提交代码之前自动检查代码,以确保代码风格的一致性和可读性。

你可能感兴趣的:(linux积累,git)