pre-commit简介

pre-commit简介

💡 原文英文,约600词,阅读约需3分钟。
📝

内容提要

pre-commit是一个多语言预提交钩子管理框架,允许在本地提交前运行工具(如Flake8和Ruff)。安装后,通过YAML文件配置要运行的钩子。使用`pre-commit run --all-files`命令检查所有文件,确保代码质量。

🎯

关键要点

  • pre-commit是一个多语言预提交钩子管理框架,允许在本地提交前运行工具。
  • 可以使用pip安装pre-commit,安装后可通过命令确认其版本。
  • 在本地GitHub代码库中运行pre-commit install命令以添加git钩子。
  • 需要在代码库根目录添加.pre-commit-config.yaml文件以定义要运行的钩子。
  • 可以使用pre-commit sample-config命令生成简单的配置文件。
  • 添加新规则后,需运行pre-commit run --all-files命令以确保所有文件符合新规则。
  • 可以添加多种钩子,如Mypy和pytest,但要注意不要添加过多以免运行时间过长。
  • 在本地运行CI钩子通常比等待CI队列更快。
➡️

继续阅读