Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1851 +/- ##
==========================================
+ Coverage 91.91% 91.93% +0.02%
==========================================
Files 106 107 +1
Lines 20994 21159 +165
==========================================
+ Hits 19296 19453 +157
- Misses 1698 1706 +8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds the upstream pre-commit-hooks destroyed-symlinks hook as a repo: builtin hook in prek, including implementation, registration, docs, schema, and test coverage.
Changes:
- Implement
destroyed-symlinkshook logic (viagit status --porcelain=v2+ blob comparisons) and wire it into builtin hook dispatch. - Document the new builtin hook and add it to the JSON schema enum.
- Update integration/snapshot tests for builtin listing and hook behavior.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
crates/prek/src/hooks/pre_commit_hooks/destroyed_symlinks.rs |
New hook implementation: parses porcelain v2 output and detects destroyed symlinks by comparing HEAD symlink blob vs staged file blob. |
crates/prek/src/hooks/pre_commit_hooks/mod.rs |
Registers DestroyedSymlinks in the pre-commit-hooks fast-path enum and dispatch. |
crates/prek/src/hooks/builtin_hooks/mod.rs |
Adds destroyed-symlinks to builtin hook enum, dispatch, and builtin hook metadata (id/name/description/etc.). |
crates/prek/tests/builtin_hooks.rs |
Adds an integration test exercising the hook behavior (including newline tolerance). |
crates/prek/tests/list_builtins.rs |
Updates snapshots for util list-builtins (basic/verbose/json) to include the new hook. |
docs/builtin.md |
Adds documentation entry and per-hook section for destroyed-symlinks. |
prek.schema.json |
Adds destroyed-symlinks to the BuiltinHooks enum in the generated schema. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b93fea172f
ℹ️ 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".
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
📦 Cargo Bloat ComparisonBinary size change: -0.40% (25.1 MiB → 25.0 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ 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.6 | 1.03 ± 0.05 |
prek-head --version |
2.3 ± 0.1 | 2.2 | 2.7 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
8.8 ± 0.1 | 8.7 | 10.0 | 1.01 ± 0.02 |
prek-head list |
8.8 ± 0.1 | 8.6 | 9.0 | 1.00 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.2 ± 0.3 | 3.1 | 5.6 | 1.02 ± 0.11 |
prek-head validate-config .pre-commit-config.yaml |
3.1 ± 0.0 | 3.1 | 3.2 | 1.00 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.6 ± 0.0 | 2.5 | 2.7 | 1.00 |
prek-head sample-config |
2.6 ± 0.0 | 2.6 | 2.7 | 1.01 ± 0.02 |
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 |
153.6 ± 1.6 | 151.7 | 156.8 | 1.00 |
prek-head run --all-files |
154.1 ± 1.5 | 152.2 | 157.1 | 1.00 ± 0.01 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
154.5 ± 2.2 | 151.2 | 158.3 | 1.01 ± 0.02 |
prek-head run --all-files |
153.5 ± 2.6 | 148.6 | 160.7 | 1.00 |
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 |
153.0 ± 2.3 | 149.3 | 159.5 | 1.00 |
prek-head run --all-files |
158.1 ± 26.5 | 148.5 | 336.1 | 1.03 ± 0.17 |
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 |
21.5 ± 0.4 | 20.4 | 22.0 | 1.02 ± 0.03 |
prek-head run trailing-whitespace --all-files |
21.1 ± 0.4 | 20.3 | 21.9 | 1.00 |
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 |
27.4 ± 1.9 | 25.0 | 31.2 | 1.01 ± 0.09 |
prek-head run end-of-file-fixer --all-files |
27.1 ± 1.5 | 24.9 | 30.9 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
12.8 ± 0.3 | 12.3 | 13.5 | 1.05 ± 0.04 |
prek-head run check-json --all-files |
12.2 ± 0.3 | 11.6 | 13.0 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
11.7 ± 0.2 | 11.5 | 12.3 | 1.00 |
prek-head run check-yaml --all-files |
11.8 ± 0.2 | 11.5 | 12.2 | 1.00 ± 0.02 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
12.0 ± 0.2 | 11.5 | 12.5 | 1.00 ± 0.03 |
prek-head run check-toml --all-files |
12.0 ± 0.3 | 11.4 | 12.6 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
12.0 ± 0.2 | 11.5 | 12.6 | 1.00 |
prek-head run check-xml --all-files |
12.2 ± 0.5 | 11.5 | 13.9 | 1.01 ± 0.05 |
prek run detect-private-key --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run detect-private-key --all-files |
17.9 ± 1.1 | 16.3 | 20.8 | 1.00 ± 0.09 |
prek-head run detect-private-key --all-files |
17.8 ± 1.0 | 16.0 | 20.2 | 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 |
23.4 ± 1.5 | 20.6 | 25.9 | 1.01 ± 0.09 |
prek-head run fix-byte-order-marker --all-files |
23.1 ± 1.5 | 20.4 | 25.8 | 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 |
4.8 ± 0.1 | 4.7 | 4.9 | 1.01 ± 0.02 |
prek-head install-hooks |
4.7 ± 0.1 | 4.7 | 4.8 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.8 ± 0.0 | 4.7 | 4.8 | 1.00 |
prek-head install-hooks |
4.8 ± 0.1 | 4.7 | 4.8 | 1.00 ± 0.01 |
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 |
52.5 ± 1.0 | 51.2 | 54.9 | 1.00 ± 0.03 |
prek-head run |
52.4 ± 1.0 | 51.0 | 54.3 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
8.9 ± 0.1 | 8.8 | 9.2 | 1.00 |
prek-head run --files '*.json' |
9.0 ± 0.1 | 8.9 | 9.3 | 1.01 ± 0.02 |
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 |
13.9 ± 0.2 | 13.6 | 14.4 | 1.00 |
prek-head run --dry-run --all-files |
13.9 ± 0.2 | 13.6 | 14.6 | 1.00 ± 0.02 |
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 |
13.9 ± 0.1 | 13.8 | 14.1 | 1.00 |
prek-head run check-hooks-apply --all-files |
14.0 ± 0.1 | 13.9 | 14.2 | 1.01 ± 0.01 |
prek run check-useless-excludes --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-useless-excludes --all-files |
12.4 ± 0.1 | 12.3 | 12.5 | 1.00 ± 0.01 |
prek-head run check-useless-excludes --all-files |
12.4 ± 0.1 | 12.2 | 12.6 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
10.8 ± 0.1 | 10.7 | 11.0 | 1.00 |
prek-head run identity --all-files |
10.9 ± 0.1 | 10.7 | 11.2 | 1.00 ± 0.01 |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
b8567d0 to
3a79c5b
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fd6acccea2
ℹ️ 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".
fd6accc to
ad7b40f
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ad7b40f74b
ℹ️ 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".
Closes #1848