Simplify hook progress folding#2125
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2125 +/- ##
==========================================
+ Coverage 92.16% 92.42% +0.25%
==========================================
Files 121 121
Lines 25358 25469 +111
==========================================
+ Hits 23372 23540 +168
+ Misses 1986 1929 -57 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Simplifies hook progress reporting by replacing separate standalone/project completion tracking with a unified HookGroup model and by folding completed hook bars only when a new progress bar would exceed terminal height.
Changes:
- Introduces grouped hook progress state for both project-header and standalone output.
- Reworks completed-bar hiding to free one terminal line at a time and update hidden summaries consistently.
- Updates reporter unit tests for the new hidden-summary wording and folding behavior.
📦 Cargo Bloat ComparisonBinary size change: -0.38% (26.3 MiB → 26.2 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.7 | 1.03 ± 0.05 |
prek-head --version |
2.3 ± 0.1 | 2.2 | 2.6 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.2 ± 0.1 | 8.9 | 9.5 | 1.00 |
prek-head list |
9.3 ± 0.1 | 9.1 | 9.8 | 1.01 ± 0.02 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.1 ± 0.1 | 3.1 | 3.3 | 1.00 |
prek-head validate-config .pre-commit-config.yaml |
3.2 ± 0.0 | 3.1 | 3.3 | 1.01 ± 0.02 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.7 ± 0.0 | 2.6 | 2.8 | 1.01 ± 0.03 |
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 | 75.0 | 81.2 | 1.03 ± 0.03 |
prek-head run --all-files |
75.7 ± 1.0 | 74.3 | 77.6 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
78.4 ± 2.7 | 74.6 | 83.8 | 1.00 ± 0.05 |
prek-head run --all-files |
78.3 ± 3.1 | 74.0 | 86.2 | 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 |
78.5 ± 2.6 | 73.8 | 84.5 | 1.00 |
prek-head run --all-files |
79.3 ± 3.9 | 74.2 | 92.8 | 1.01 ± 0.06 |
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 |
20.7 ± 0.4 | 19.6 | 21.3 | 1.00 |
prek-head run trailing-whitespace --all-files |
21.0 ± 0.7 | 20.0 | 22.6 | 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 |
27.4 ± 2.5 | 23.8 | 32.1 | 1.02 ± 0.12 |
prek-head run end-of-file-fixer --all-files |
26.8 ± 2.0 | 24.2 | 29.9 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
8.3 ± 0.2 | 8.0 | 9.0 | 1.01 ± 0.04 |
prek-head run check-json --all-files |
8.3 ± 0.2 | 7.9 | 8.6 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
8.1 ± 0.3 | 7.8 | 9.1 | 1.03 ± 0.04 |
prek-head run check-yaml --all-files |
7.9 ± 0.1 | 7.6 | 8.2 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
8.2 ± 0.2 | 7.8 | 8.8 | 1.01 ± 0.04 |
prek-head run check-toml --all-files |
8.1 ± 0.2 | 7.8 | 8.6 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
8.3 ± 0.3 | 7.7 | 8.8 | 1.00 ± 0.05 |
prek-head run check-xml --all-files |
8.3 ± 0.3 | 7.8 | 9.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 |
13.9 ± 1.2 | 11.9 | 15.7 | 1.01 ± 0.12 |
prek-head run detect-private-key --all-files |
13.8 ± 1.2 | 12.0 | 16.1 | 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 |
21.9 ± 1.7 | 19.7 | 25.6 | 1.00 |
prek-head run fix-byte-order-marker --all-files |
23.6 ± 6.7 | 19.4 | 51.6 | 1.08 ± 0.32 |
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.9 ± 0.1 | 4.7 | 5.0 | 1.02 ± 0.02 |
prek-head install-hooks |
4.8 ± 0.1 | 4.7 | 4.9 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.7 ± 0.1 | 4.6 | 4.8 | 1.00 |
prek-head install-hooks |
4.8 ± 0.1 | 4.7 | 5.0 | 1.02 ± 0.03 |
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 |
40.5 ± 0.9 | 39.3 | 42.4 | 1.01 ± 0.03 |
prek-head run |
40.2 ± 1.0 | 39.0 | 42.6 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
9.3 ± 0.9 | 8.3 | 11.1 | 1.09 ± 0.11 |
prek-head run --files '*.json' |
8.5 ± 0.1 | 8.4 | 8.8 | 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 |
7.3 ± 0.1 | 7.1 | 7.7 | 1.00 |
prek-head run --dry-run --all-files |
7.4 ± 0.1 | 7.2 | 7.7 | 1.02 ± 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 |
12.1 ± 1.4 | 11.2 | 15.5 | 1.05 ± 0.12 |
prek-head run check-hooks-apply --all-files |
11.5 ± 0.1 | 11.3 | 11.6 | 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 |
11.4 ± 0.1 | 11.3 | 11.7 | 1.00 |
prek-head run check-useless-excludes --all-files |
11.5 ± 0.5 | 11.1 | 13.4 | 1.00 ± 0.05 |
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 | 10.9 | 1.01 ± 0.01 |
prek-head run identity --all-files |
10.7 ± 0.1 | 10.5 | 10.8 | 1.00 |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 733b45c455
ℹ️ 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".
| self.visible | ||
| .iter() | ||
| .any(|completed| completed.passed.is_some()) | ||
| .take_while(|completed| completed.passed.is_some()) | ||
| .count() |
There was a problem hiding this comment.
Allow collapsing when earliest completed hook has no result
can_hide_one_line only looks at a prefix of visible entries with passed.is_some(). In practice, skipped hooks never get on_run_result updates, so they stay passed = None; if one of those sits at the front, this function returns false forever and collapse_to_fit_new_progress cannot reclaim any lines for that group even when many later completed hooks are pass/fail. This causes the new folding logic to stop working in common (no files to check) flows and can still overflow terminal height.
Useful? React with 👍 / 👎.
Simplifies hook progress rendering by using one grouped model for standalone and workspace output, and folds completed hooks only when inserting a new progress bar would exceed terminal height.