在提交代码时自动格式化

本文内空由 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 将会失败,并提示你修改代码以符合规范。这可以帮助你在提交代码之前自动检查代码,以确保代码风格的一致性和可读性。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值