Skip to content

Simplify hook progress folding#2125

Merged
j178 merged 2 commits into
masterfrom
hook-progress-folding
May 26, 2026
Merged

Simplify hook progress folding#2125
j178 merged 2 commits into
masterfrom
hook-progress-folding

Conversation

@j178
Copy link
Copy Markdown
Owner

@j178 j178 commented May 26, 2026

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.

Copilot AI review requested due to automatic review settings May 26, 2026 06:07
@codecov
Copy link
Copy Markdown

codecov Bot commented May 26, 2026

Codecov Report

❌ Patch coverage is 94.57364% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.42%. Comparing base (e908f82) to head (733b45c).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
crates/prek/src/cli/reporter.rs 94.57% 14 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@j178 j178 added the enhancement New feature or request label May 26, 2026
@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot Bot commented May 26, 2026

📦 Cargo Bloat Comparison

Binary size change: -0.38% (26.3 MiB → 26.2 MiB)

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_41_0_aes_gcm_encrypt_avx512
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_41_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  90.4KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  81.5KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.5%  69.9KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.5%  60.9KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  51.3KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.3%  43.0KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  35.9KiB              prek prek::run::{{closure}}
 0.1%   0.3%  33.1KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  30.4KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  29.6KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  28.1KiB      serde_saphyr granit_parser::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_41_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_41_0_edwards25519_scalarmuldouble
 0.1%   0.2%  26.4KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  23.9KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  23.0KiB      serde_saphyr granit_parser::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.6%  86.4%  10.9MiB                   And 24018 smaller methods. Use -n N to show more.
48.1% 100.0%  12.6MiB                   .text section size, the file size is 26.2MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.2%   2.5% 332.0KiB        aws_lc_sys aws_lc_0_41_0_aes_gcm_encrypt_avx512
 1.2%   2.5% 332.0KiB        aws_lc_sys aws_lc_0_41_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  90.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  81.1KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  75.2KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.3%   0.5%  69.8KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  51.3KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  48.2KiB              prek prek::run::{{closure}}
 0.2%   0.3%  41.7KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  33.1KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  30.6KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  29.6KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  28.1KiB      serde_saphyr granit_parser::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_41_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_41_0_edwards25519_scalarmuldouble
 0.1%   0.2%  26.0KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  23.9KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  23.0KiB      serde_saphyr granit_parser::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.8%  86.3%  11.0MiB                   And 24090 smaller methods. Use -n N to show more.
48.4% 100.0%  12.8MiB                   .text section size, the file size is 26.3MiB

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot Bot commented May 26, 2026

⚡️ Hyperfine Benchmarks

Summary: 0 regressions, 0 improvements above the 10% threshold.

Environment
  • OS: Linux 6.17.0-1013-azure
  • CPU: 4 cores
  • prek version: prek 0.4.1+14 (1750632 2026-05-26)
  • Rust version: rustc 1.95.0 (59807616e 2026-04-14)
  • Hyperfine version: hyperfine 1.20.0
CLI Commands

Benchmarking basic commands in the main repo:

prek --version

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

@j178 j178 merged commit c54be46 into master May 26, 2026
33 checks passed
@j178 j178 deleted the hook-progress-folding branch May 26, 2026 06:25
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment on lines 124 to +127
self.visible
.iter()
.any(|completed| completed.passed.is_some())
.take_while(|completed| completed.passed.is_some())
.count()
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants