j178 / prek

#10

4,234126+61 todayRust

⚡ 更强大的 `pre-commit`，采用 Rust 重构实现

prek 是一个用 Rust 重写的 `pre-commit` 替代工具，旨在提供更强大、更高效的代码提交前检查体验。它完全兼容原有的 `pre-commit` 配置和钩子，用户无需修改现有设置即可无缝切换。该项目将多个依赖整合为单一二进制文件，无需 Python 或其他运行时环境，显著提升了执行速度并减少了磁盘空间占用。此外，prek 内置了对 monorepo 工作区的支持，并优化了 Python、Node.js 等语言的工具链安装流程，使依赖管理更高效。其集成的 `uv` 支持进一步简化了 Python 虚拟环境管理。目前，prek 已被 CPython、Apache Airflow 等大型项目采用，适合寻求更快、更轻量级提交前检查工具的开发者。

💡 应用场景

适合需要高性能、多语言支持且希望简化依赖管理的Git钩子场景，特别是从pre-commit迁移的项目。

加速现有项目CI/CD

问题：使用Python编写的pre-commit工具在大型项目中运行缓慢，特别是在CI/CD流水线中拖慢构建速度。

方案：用prek替换pre-commit，利用Rust实现的性能优势，显著减少钩子运行时间，同时保持配置完全兼容。

示例：在Apache Airflow或FastAPI这样的Python项目中，将.pre-commit-config.yaml保持不变，只需将pre-commit命令替换为prek run，即可获得2-5倍的性能提升。

简化多语言项目配置

问题：在多语言项目中，不同钩子需要各自的语言环境（Python、Node.js、Go等），安装和管理这些依赖很繁琐。

方案：prek内置了多语言工具链管理，可以自动安装和共享Python、Node.js、Go等运行环境，减少重复配置。

示例：一个同时包含Python后端和JavaScript前端的项目，prek可以统一管理flake8、prettier、gofmt等钩子的运行环境，无需手动安装多个语言工具。

无Python环境的Git钩子

问题：在Docker容器或CI环境中，不想为了运行pre-commit而安装完整的Python运行时和依赖。

方案：prek是单个二进制文件，无需Python或其他运行时，可以直接下载运行，简化部署。

示例：在GitHub Actions中，使用j178/prek-action可以直接运行prek，无需先安装Python和pre-commit包，减少CI配置复杂度。

优化Monorepo工作流

问题：在Monorepo中，pre-commit需要为每个子项目单独运行，导致重复检查和性能浪费。

方案：prek内置了workspace模式，可以智能识别变更文件所属的子项目，只运行相关钩子，提高效率。

示例：一个包含多个微服务的Monorepo，当只修改了service-a的代码时，prek只会运行service-a相关的代码检查钩子，跳过其他服务的检查。

📊 项目信息

语言: Rust
Stars: ⭐ 4,234
Forks: 126
今日新增: +61
排名: #10
收录: 总榜
趋势日期: 2026年2月1日

🏷️ 标签

RustGit钩子代码检查自动化高性能轻量级开发者DevOps

5分钟上手 prek

本指南将帮助你在5分钟内安装prek并运行第一个代码提交前检查

🖥️ 操作系统

macOSWindowsLinux

⚙️ 运行环境

Git>= 2.0

📝 操作步骤

安装 prek

选择适合你操作系统的安装方式。这里推荐使用独立安装脚本（Linux/macOS）或PyPI安装

下载并安装prek

$ # Linux/macOS 使用独立安装脚本
curl -fsSL https://github.com/j178/prek/raw/main/install.sh | sh

使用uv安装prek（需要Python环境）

$ # 或者使用PyPI安装（推荐使用uv）
uv pip install prek

Windows系统安装命令

$ # Windows PowerShell
irm https://github.com/j178/prek/raw/main/install.ps1 | iex

✓预期输出：安装完成后，终端会显示安装成功信息

💡如果遇到权限问题，可以尝试使用sudo（Linux/macOS）或以管理员身份运行（Windows）

验证安装

检查prek是否正确安装

查看prek版本

$ prek --version

✓预期输出：显示prek版本号，例如：prek 0.1.0

💡如果命令未找到，请确保prek已添加到系统PATH环境变量中

创建配置文件

在项目根目录创建.pre-commit-config.yaml文件

创建一个简单的配置文件，包含三个常用检查

$ # 创建配置文件
cat > .pre-commit-config.yaml << 'EOF'
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
EOF

✓预期输出：在项目根目录生成.pre-commit-config.yaml文件

💡如果你已有pre-commit配置文件，可以直接使用，prek完全兼容

运行prek检查

首次运行会自动安装钩子工具，然后检查所有文件

运行所有钩子检查所有文件

$ prek run --all-files

✓预期输出：显示钩子安装进度，然后运行检查并显示结果

💡首次运行会下载钩子仓库和工具链，可能需要一些时间

安装Git钩子

将prek设置为Git提交前钩子，这样每次git commit时都会自动运行检查

安装Git钩子

$ prek install

✓预期输出：显示成功安装钩子的信息

💡安装后，每次执行git commit时都会自动运行prek检查

✅ 验证成功

完成以下操作确认prek已正确配置

✓prek --version 显示版本号
✓prek run --all-files 成功运行并显示检查结果
✓prek install 显示钩子安装成功
✓执行 git commit 时自动触发prek检查

⚡ 快速提示

配置使用 prek run 检查特定文件：prek run --files 文件名1 文件名2

调试跳过检查：git commit --no-verify 或设置 SKIP=钩子ID git commit

配置prek完全兼容pre-commit配置，无需修改现有配置文件

性能使用 prek autoupdate 更新钩子到最新版本

🔍 常见问题排查

❓ prek: command not found

→ 确保prek已正确安装并添加到PATH环境变量，或使用完整路径运行

❓ 钩子安装失败或超时

→ 检查网络连接，或尝试设置国内镜像源，使用 --verbose 查看详细错误

❓ Git钩子未触发

→ 确认在正确的Git仓库中运行 prek install，检查.git/hooks/pre-commit文件是否存在

❓ 与现有pre-commit冲突

→ 卸载原有pre-commit：pre-commit uninstall，然后重新安装prek

🎯 下一步

探索更多钩子

查看pre-commit-hooks仓库或其他钩子仓库，添加更多检查

配置并行运行

在配置文件中设置priority字段，让多个钩子并行运行提高速度

集成到CI/CD

将prek集成到GitHub Actions或其他CI/CD流程中

查看高级功能

了解monorepo支持、uv集成、内置钩子等高级功能