使用pre-commit检查代码风格

最新推荐文章于 2025-04-05 10:31:06 发布
最新推荐文章于 2025-04-05 10:31:06 发布
阅读量842 收藏 1
点赞数
分类专栏： 开发工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/junior_programmer/article/details/112654077
版权
本文介绍了如何通过pip安装pre-commit，并配置.git-pre-commit-config.yaml文件来设定代码检查规则，包括使用pre-commit-hooks和black、flake8进行yaml、json格式检查、代码格式化和风格检查。设置最大行长度、忽略特定警告代码，并在git commit时自动执行这些检查，确保代码风格符合规范。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

安装pre-commit

pip install pre-commit

配置文件指定使用的hooks

在git项目根目录创建如下内容的配置文件： .pre-commit-config.yaml 。

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

  - repo: https://gitee.com/mirrors/black
    rev: 19.3b0
    hooks:
    - id: black
      args:
        - --line-length=120 #设置代码行最大长度

  - repo: https://gitee.com/mirrors_PyCQA/flake8.git
    rev: 3.8.4
    hooks:
    - id: flake8
      args:
      - --max-line-length=120 #设置代码行最大长度
      - --extend-ignore=E1,E203,E722,E402,F401,F403,F405 #设置忽略的警告代码
      #- --max-complexity=12   # 设置代码复杂度
      exclude: ^.*test/
      additional_dependencies:
        - "pep8-naming"

安装hooks

pre-commit install

这样在git commit 的时候会自动执行配置文件中的hooks，检查代码风格是否符合规范。也可以手动执行pre-commit run --all-files进行代码风格检查。

文档

pre-commit

black

flake8

flake8简明中文参考博文

Git pre-commit hook：提交前自动检查代码质量
项目管理的博客
05-12 794
本文旨在帮助开发者理解和使用Git pre-commit hook来提高代码质量。我们将覆盖从基础概念到高级应用的完整知识体系，包括hook的创建、配置、调试以及在团队项目中的共享方法。介绍Git hook和pre-commit的基本概念详细讲解pre-commit hook的工作原理展示如何配置和使用pre-commit hook提供实际应用案例和代码示例讨论高级主题和最佳实践Git Hook：Git在特定重要动作发生时触发的自定义脚本。
基于 Pre-commit 的 Python项目代码风格统一实践
易迟的专栏
05-27 1334
Pre commit是 git 提供的预提交机制，可以在创建 commit 之前执行预定义的钩子程序，从而方便执行必要的代码检查。而在实践中可能会需要执行大量的钩子程序，如果来管理这些钩子程序呢，Pre-commit就是其中一个应用较多的框架，通过这个框架可以比较方便地管理大量的预提交钩子程序，这样简化了维护成本。如何来使用 Pre-commit 框架呢？安装 Pre-commit框架，一般情况下 pip 安装下即可；在工程中添加文件，需要安装的钩子程序都是维护在这个配置文件中的；通过。
Checkstyle整合pre-commit实现代码规范检测
杨海吉
01-17 919
对于Spring Boot项目使用Maven作为构建工具，采用类似的方式配置Git的。在提交代码之前，进行一次测试。如果Checkstyle检查不通过，提交将被阻止。钩子，它将触发Maven Checkstyle插件，以确保代码符合规范。的文件，其中包含运行Maven Checkstyle插件的命令。文件中，添加Checkstyle插件的配置。钩子来运行Checkstyle。中定义了你期望的代码规范。这样配置后，每次在提交代码时，Git将运行。阶段执行Checkstyle检查。请注意，这里使用的是。
git commit前进行checkstyle --pre-commit并优化了checkstyle速度
山鬼谣的专栏
10-03 2050
java: 1.8+
预提交钩子自动化：pre-commit GitHub Action使用教程
最新发布
gitblog_00249的博客
04-05 838
预提交钩子自动化：pre-commit GitHub Action使用教程 action a GitHub action to run `pre-commit` 项目地址: https://gitcode.com/gh_mirro...
checkstyle + gradle + git pre-commit 实现代码提交前对代码规范的检查
单行线的专栏
07-11 4509
我们的目的是想在代码commit之前去做这个检查，把不符合规范的代码标记出来，直到修改完成之后才允许提交。脚本涉及到几个重要的文件：1.pre-commit， 这个是git的一个hook文件，可以帮助我们在commit前去做一些事情，比如，调用我们第二步定义的checkstyle。2.checkstyle.gradle，这里面主要包含gradle的一个task，通过依赖checkstyle插件，然...
pre-commit-golang：用于预提交的Golang钩子
02-03
pre-commit-golang：用于预提交的Golang钩子
pre-commit-golang:Golang的Pre-Commit钩子，支持模块
05-04
提交前GoLang 一组用于Golang的git pre-commit挂钩，支持模块。 需要挂钩管理框架。 安装 您可以将以下代码段复制/粘贴到.pre-commit-config.yaml文件中。 注意可以在找到更加充实的版本 # ========================================================================== # Golang Pre-Commit Hooks | https://github.com/tekwizely/pre-commit-golang # # !! ALL Hooks enabled by default - Comment out hooks you are not using # # Visit the project home page
java-git-pre-commit-hook:用于Java Java EE项目的带有正则表达式的简单预提交钩子
05-03
预提交钩子是Git版本控制系统中的一种自定义脚本，它在代码提交到仓库之前运行，可以用来检查代码质量、格式化代码、运行测试等，确保提交的代码符合一定的规范。 描述中提到的“一个简单的（愚蠢的）带有regex的...
SVN钩子 之 pre-commit
07-25
1. **保证代码质量**：通过强制执行代码风格和格式规范，可以保持代码库的一致性。 2. **防止错误提交**：例如，检查是否存在未解决的合并冲突，避免提交无效的代码。 3. **保护数据安全**：可以实施权限控制，阻止...
pre-commit
zengweii386的博客
12-26 889
代码规范利器——pre-commit准备工作钩子blackflack8bandit 毫无疑问，git已经成为代码托管工具的主力军。最近研究了一个基于git的代码规范利器——pre-commit，已应用到我们项目组。pre-commit用于commit 之前触发git钩子来做一系列动作，这个时候就可以做代码检查，如果不符合规范则commit失败。下面就以我们项目用到的三个钩子(black、flake...
pre-receive:一个简单的gitlab commit消息检查钩子
05-19
预先接收 一个简单的gitlab commit消息检查钩子。
golang模板template自定义函数用法示例
09-21
主要介绍了golang模板template自定义函数用法,结合实例形式分析了Go语言模板自定义函数的基本定义与使用方法,需要的朋友可以参考下
pre-commit-golang:预先提交golang
04-08
提交前的golang 用于golang钩子 使用这些钩子 将此添加到您的.pre-commit-config.yaml - repo: git://github.com/joker8023/pre-commit-golang rev: master hooks: - id: go-fmt - id: go-vet - id: go-lint - id: go-imports - id: go-cyclo args: [-over=15] - id: validate-toml - id: no-go-testing - id: gometalinter - id: golangci-lint - id: go-critic - id: go-unit-tests - id
pre-commit 的配置文件
qq_45762996的博客
09-27 1581
pre-commit 是一个用于管理和维护多种预提交钩子的框架，旨在在代码提交（git commit）之前自动执行一系列检查和格式化任务，以确保代码质量和一致性。
pre-commit用法
一枚很low得程序猿
07-17 4947
安装 pre-commit pip install pre-commit 写 .pre-commit-config.yaml配置文件 # See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks # pre-commit==2.13.0 repos: - repo: https://github.com/pre-commit/pre-commit-hook
Git技巧：Pre-commit
Topsort的博客
08-06 3043
简单了解pre-commit的作用，如何选取hook，如何自定义hook，辅以一个小样例
借助pre-commit 落地Python项目代码提交规范
主要分享测试的学习资源，帮助快速了解测试行业，帮助想转行、进阶、小白成长为高级测试工程师。
05-29 1060
一个项目整体的代码，拥有统一并且规范的代码风格无疑是非常重要的，特别是在使用Python这种动态语言开发的项目中。
使用 pre-commit 实现代码检查
清欢
09-21 8329
文章目录0. 前言1. pre-commit 原理2. pre-commit 的使用2.1. 基本流程2.2. 配置文件编写2.3. 问题与疑问3. mmaction2 的配置文件举例 0. 前言 需求：希望在提交代码时，对代码的规范进行排查，不符合要求的不让提交。 参考资料：官方文档 1. pre-commit 原理 在 git commit 前进行代码检查的解决方案思路 git本身提供了 hook 功能（可参考git相关内容），其中一类就是在commit前调用的，即 .git/hooks/p
在Git项目中使用pre-commit统一管理hooks
DoneSpeak的博客
07-04 7793
Unix 哲学 提供”锋利“的小工具、其中每一把都意在把一件事情做好。 –《程序员修炼之道 - 从小工到专家》 写在前面 如果你使用Git，那你一定懂得纯文本的魅力并喜爱上shell这样的脚本语言。 在很多时候，我更喜欢能够通过脚本语言进行配置的工具，而不是直接安装到编辑器的工具。一是因为脚本可以放在项目中与更多的人共享，以保持规范一直；二是脚本自动触发的操作无需要记更多的快捷键或者点击一点鼠标；再来则是脚本语言可以做更多灵活的操作，而不受软件开发者的约束。这大概也是我一直喜欢用Git指令，而不是编译器.
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值