Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4ae2cb46c4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
📦 Cargo Bloat ComparisonBinary size change: +0.00% (25.0 MiB → 25.0 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
There was a problem hiding this comment.
Pull request overview
This PR extends prek’s builtin hook set and improves workspace-mode path handling so hooks operate on project-relative filenames correctly, even in nested projects.
Changes:
- Added support for the
destroyed-symlinksbuiltin hook (implementation, docs, schema, and list-builtins output). - Fixed workspace-mode path semantics for staged “added files” and git-lfs attribute lookups (project-relative).
- Added/updated integration tests covering the new hook and the workspace-relative path regressions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| prek.schema.json | Adds destroyed-symlinks to the allowed builtin hook IDs in the JSON schema. |
| docs/builtin.md | Documents the new destroyed-symlinks hook and includes it in builtin hook lists. |
| crates/prek/tests/list_builtins.rs | Updates snapshots so list-builtins outputs include destroyed-symlinks. |
| crates/prek/tests/builtin_hooks.rs | Adds regression tests for workspace-mode path handling and adds a test for destroyed-symlinks. |
| crates/prek/src/hooks/pre_commit_hooks/mod.rs | Wires the new destroyed_symlinks fast-path hook module into the dispatcher. |
| crates/prek/src/hooks/pre_commit_hooks/destroyed_symlinks.rs | Implements the destroyed-symlinks hook logic via git status + blob comparisons. |
| crates/prek/src/hooks/pre_commit_hooks/check_added_large_files.rs | Runs git-lfs attribute lookup from the project root to respect nested .gitattributes. |
| crates/prek/src/hooks/builtin_hooks/mod.rs | Registers the destroyed-symlinks builtin hook (id/name/entry/metadata). |
| crates/prek/src/git.rs | Makes get_added_files project-relative in subdirectories and adds current_dir to get_lfs_files. |
⚡️ Hyperfine BenchmarksSummary: 0 regressions, 0 improvements above the 10% threshold. Environment
CLI CommandsBenchmarking basic commands in the main repo:
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base --version |
2.4 ± 0.1 | 2.2 | 2.8 | 1.00 |
prek-head --version |
2.4 ± 0.1 | 2.2 | 3.2 | 1.01 ± 0.06 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.3 ± 0.2 | 8.8 | 9.8 | 1.00 |
prek-head list |
9.5 ± 0.3 | 9.0 | 11.5 | 1.02 ± 0.04 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.3 ± 0.1 | 3.2 | 3.7 | 1.01 ± 0.04 |
prek-head validate-config .pre-commit-config.yaml |
3.3 ± 0.1 | 3.2 | 3.5 | 1.00 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.7 ± 0.0 | 2.6 | 2.8 | 1.00 |
prek-head sample-config |
2.7 ± 0.2 | 2.6 | 3.9 | 1.01 ± 0.07 |
Cold vs Warm Runs
Comparing first run (cold) vs subsequent runs (warm cache):
prek run --all-files (cold - no cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
162.5 ± 4.5 | 155.9 | 169.0 | 1.00 |
prek-head run --all-files |
163.1 ± 2.6 | 160.1 | 168.8 | 1.00 ± 0.03 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
161.3 ± 5.9 | 154.4 | 181.9 | 1.00 |
prek-head run --all-files |
167.1 ± 4.2 | 162.2 | 179.8 | 1.04 ± 0.05 |
Full Hook Suite
Running the builtin hook suite on the benchmark workspace:
prek run --all-files (full builtin hook suite)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
164.6 ± 4.7 | 154.1 | 172.8 | 1.00 ± 0.08 |
prek-head run --all-files |
164.5 ± 11.7 | 153.7 | 238.9 | 1.00 |
Individual Hook Performance
Benchmarking each hook individually on the test repo:
prek run trailing-whitespace --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run trailing-whitespace --all-files |
23.9 ± 0.8 | 22.8 | 25.6 | 1.00 |
prek-head run trailing-whitespace --all-files |
24.2 ± 0.6 | 22.9 | 25.4 | 1.01 ± 0.04 |
prek run end-of-file-fixer --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run end-of-file-fixer --all-files |
31.0 ± 2.0 | 27.6 | 34.4 | 1.01 ± 0.09 |
prek-head run end-of-file-fixer --all-files |
30.7 ± 1.8 | 28.0 | 34.3 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
13.0 ± 0.5 | 12.2 | 14.0 | 1.00 |
prek-head run check-json --all-files |
13.2 ± 0.5 | 12.6 | 14.2 | 1.02 ± 0.05 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
13.6 ± 0.7 | 12.7 | 15.2 | 1.06 ± 0.06 |
prek-head run check-yaml --all-files |
12.8 ± 0.3 | 12.1 | 13.5 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
12.5 ± 0.3 | 12.0 | 13.4 | 1.00 |
prek-head run check-toml --all-files |
12.5 ± 0.3 | 11.7 | 13.2 | 1.00 ± 0.04 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
12.8 ± 0.5 | 12.1 | 14.3 | 1.04 ± 0.05 |
prek-head run check-xml --all-files |
12.3 ± 0.3 | 11.8 | 13.0 | 1.00 |
prek run detect-private-key --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run detect-private-key --all-files |
20.0 ± 1.0 | 17.9 | 22.2 | 1.02 ± 0.09 |
prek-head run detect-private-key --all-files |
19.7 ± 1.5 | 17.0 | 22.6 | 1.00 |
prek run fix-byte-order-marker --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run fix-byte-order-marker --all-files |
25.3 ± 1.8 | 22.3 | 28.2 | 1.02 ± 0.10 |
prek-head run fix-byte-order-marker --all-files |
25.0 ± 1.7 | 22.4 | 28.5 | 1.00 |
Installation Performance
Benchmarking hook installation (fast path hooks skip Python setup):
prek install-hooks (cold - no cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
5.1 ± 0.0 | 5.0 | 5.1 | 1.00 ± 0.03 |
prek-head install-hooks |
5.1 ± 0.2 | 4.9 | 5.3 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
5.0 ± 0.1 | 4.9 | 5.2 | 1.00 ± 0.03 |
prek-head install-hooks |
5.0 ± 0.0 | 5.0 | 5.0 | 1.00 |
File Filtering/Scoping Performance
Testing different file selection modes:
prek run (staged files only)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run |
54.7 ± 1.5 | 52.6 | 58.1 | 1.01 ± 0.03 |
prek-head run |
54.4 ± 1.2 | 53.2 | 57.6 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
9.4 ± 0.1 | 9.2 | 9.6 | 1.00 ± 0.03 |
prek-head run --files '*.json' |
9.4 ± 0.2 | 9.1 | 9.9 | 1.00 |
Workspace Discovery & Initialization
Benchmarking hook discovery and initialization overhead:
prek run --dry-run --all-files (measures init overhead)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --dry-run --all-files |
14.7 ± 0.3 | 14.3 | 15.3 | 1.00 |
prek-head run --dry-run --all-files |
15.7 ± 1.8 | 14.7 | 23.0 | 1.07 ± 0.12 |
Meta Hooks Performance
Benchmarking meta hooks separately:
prek run check-hooks-apply --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-hooks-apply --all-files |
14.4 ± 0.2 | 14.2 | 14.8 | 1.05 ± 0.07 |
prek-head run check-hooks-apply --all-files |
13.8 ± 0.9 | 12.7 | 15.4 | 1.00 |
prek run check-useless-excludes --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-useless-excludes --all-files |
12.8 ± 0.4 | 12.5 | 13.9 | 1.00 |
prek-head run check-useless-excludes --all-files |
13.3 ± 0.2 | 12.9 | 13.7 | 1.04 ± 0.04 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
11.6 ± 0.2 | 11.4 | 11.9 | 1.00 ± 0.02 |
prek-head run identity --all-files |
11.6 ± 0.2 | 11.4 | 12.1 | 1.00 |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ef76f9e7ec
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
This reverts commit ef76f9e.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1852 +/- ##
==========================================
+ Coverage 91.93% 91.98% +0.04%
==========================================
Files 107 107
Lines 21159 21164 +5
==========================================
+ Hits 19452 19467 +15
+ Misses 1707 1697 -10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Fix workspace relative path for
check-case-conflictandcheck-added-large-files