feat(install): warn about hooks that won't run with the installed shims - #2205
feat(install): warn about hooks that won't run with the installed shims#2205BitWeaverDev wants to merge 7 commits into
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ada96bec03
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cc3a27032d
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: eec0f0e94c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: eec0f0e94c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2205 +/- ##
==========================================
+ Coverage 93.16% 93.38% +0.21%
==========================================
Files 127 129 +2
Lines 28182 27681 -501
==========================================
- Hits 26257 25849 -408
+ Misses 1925 1832 -93 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
📦 Cargo Bloat ComparisonBinary size change: +0.00% (29.1 MiB → 29.1 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ Hyperfine BenchmarksSummary: 1 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.6 ± 0.1 | 2.5 | 2.9 | 1.09 ± 0.04 |
prek-head --version |
2.4 ± 0.1 | 2.3 | 2.6 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
10.7 ± 0.3 | 10.1 | 11.3 | 1.00 |
prek-head list |
11.1 ± 1.2 | 10.3 | 18.0 | 1.04 ± 0.11 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.8 ± 0.1 | 3.7 | 4.1 | 1.10 ± 0.04 |
prek-head validate-config .pre-commit-config.yaml |
3.5 ± 0.1 | 3.3 | 3.6 | 1.00 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.9 ± 0.1 | 2.7 | 3.2 | 1.07 ± 0.04 |
prek-head sample-config |
2.7 ± 0.1 | 2.6 | 2.8 | 1.00 |
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 |
77.9 ± 2.3 | 74.1 | 82.3 | 1.00 |
prek-head run --all-files |
78.9 ± 2.9 | 74.4 | 83.5 | 1.01 ± 0.05 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
78.8 ± 2.7 | 75.2 | 85.2 | 1.00 |
prek-head run --all-files |
80.0 ± 2.4 | 75.8 | 85.5 | 1.02 ± 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 |
79.7 ± 3.5 | 75.2 | 92.6 | 1.00 |
prek-head run --all-files |
81.1 ± 3.8 | 75.7 | 95.6 | 1.02 ± 0.07 |
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 |
22.2 ± 0.4 | 21.6 | 23.1 | 1.00 ± 0.03 |
prek-head run trailing-whitespace --all-files |
22.2 ± 0.4 | 21.5 | 23.3 | 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 |
28.2 ± 2.2 | 25.7 | 34.7 | 1.00 |
prek-head run end-of-file-fixer --all-files |
28.6 ± 2.2 | 25.4 | 34.1 | 1.01 ± 0.11 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
9.0 ± 0.3 | 8.4 | 9.9 | 1.04 ± 0.05 |
prek-head run check-json --all-files |
8.7 ± 0.3 | 8.2 | 9.4 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
8.8 ± 0.1 | 8.6 | 9.0 | 1.00 ± 0.02 |
prek-head run check-yaml --all-files |
8.8 ± 0.2 | 8.5 | 9.2 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
9.2 ± 0.3 | 8.5 | 9.9 | 1.05 ± 0.05 |
prek-head run check-toml --all-files |
8.7 ± 0.3 | 8.2 | 9.4 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
8.6 ± 0.3 | 8.1 | 9.6 | 1.01 ± 0.05 |
prek-head run check-xml --all-files |
8.5 ± 0.3 | 7.8 | 9.1 | 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 |
14.5 ± 1.0 | 13.0 | 16.8 | 1.00 |
prek-head run detect-private-key --all-files |
15.0 ± 1.3 | 12.9 | 17.7 | 1.03 ± 0.11 |
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 |
19.7 ± 0.8 | 18.3 | 21.1 | 1.04 ± 0.07 |
prek-head run fix-byte-order-marker --all-files |
19.0 ± 0.9 | 17.5 | 21.2 | 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.3 ± 0.1 | 5.2 | 5.3 | 1.06 ± 0.02 |
prek-head install-hooks |
5.0 ± 0.1 | 4.9 | 5.1 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
5.3 ± 0.1 | 5.3 | 5.4 | 1.06 ± 0.02 |
prek-head install-hooks |
5.0 ± 0.1 | 4.9 | 5.1 | 1.00 |
File Filtering/Scoping Performance
Testing different file selection modes:
Closes #2056
What
prek installonly installs shims for the hook types you ask for —--hook-type, ordefault_install_hook_types, falling back topre-commit. If the config has hooks pinned to a different stage (the classic case being a slowerstages: [pre-push]hook), those hooks just silently never run after a plainprek install, and it's easy not to notice.This adds a warning at install time that names the hooks whose stages aren't covered and points at the fix:
Notes on the approach
stages→default_stages→ all), soinstallstays offline and fast. The trade-off is that a remote hook narrowed only by its manifest (not by the project config) won't be flagged — that's the conservative choice: no false positives, no new network I/O, and it covers the case from the issue.manualis skipped, since manual-only hooks have no Git shim and aren't meant to run automatically.Stages::resolvesoinstallandHookSpec::apply_project_defaultsshare one implementation instead of duplicating the fallback rules.Tests
Added integration coverage in
tests/install.rs: an unmatched hook warns (while an all-stages sibling does not), installing the matching--hook-typesilences it, manual-only never warns, anddefault_stagesinheritance is taken into account.