pre-commit

本文介绍了如何使用pre-commit工具在git commit前触发钩子进行代码规范检查,包括black、flake8和bandit三个python项目的配置和使用。通过这些钩子,可以自动格式化代码、检测代码风格和发现潜在的安全漏洞,确保代码质量。
摘要由CSDN通过智能技术生成

代码规范利器——pre-commit

毫无疑问,git已经成为代码托管工具的主力军。最近研究了一个基于git的代码规范利器——pre-commit,已应用到我们项目组。pre-commit用于commit 之前触发git钩子来做一系列动作,这个时候就可以做代码检查,如果不符合规范则commit失败。下面就以我们项目用到的三个钩子(black、flake、bandit)来介绍一下它的骚操作,由于这个项目是python项目,所以是基于python来介绍的,其它的语言也有相应的方法去使用:

准备工作

  • 准备一个git仓库
    在这里插入图片描述
  • 执行pip install pre-commit 安装pre-commit,并在项目根目录下创建一个名为.pre-commit-config.yaml的文件作为pre-commit的配置文件:
    在这里插入图片描述
  • 注意,这时候我们还并未安装成功,目前pre-commit还只是作为python的一个模块安装到python环境中来,我们需要应用到git中来。接下来,我们可以在配置文件中添加我们需要安装的钩子,在这里我们先看一下格式,首次安装可以不作配置,后面我们添加完配置后在commit的时候会自安装我们新配置的钩子,配置格式如下:
    repos:
    -   repo:       # 来源
        rev:        # 版本
        hooks:
    - id:        # 钩子 id
     args:      # 执行钩子时候可以添加参数
        language_version:         # python 版本
    
  • 如下图,执行pre-commit install完成应用:在这里插入图片描述

钩子

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值