Skip to content

Add group filters to list#2152

Open
j178 wants to merge 2 commits into
skip-clonefrom
list-groups
Open

Add group filters to list#2152
j178 wants to merge 2 commits into
skip-clonefrom
list-groups

Conversation

@j178
Copy link
Copy Markdown
Owner

@j178 j178 commented Jun 4, 2026

Adds --group and --no-group to prek list.

Copilot AI review requested due to automatic review settings June 4, 2026 12:27
@j178 j178 added the enhancement New feature or request label Jun 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.51%. Comparing base (ab78d18) to head (5c2cef9).

Additional details and impacted files
@@              Coverage Diff               @@
##           skip-clone    #2152      +/-   ##
==============================================
+ Coverage       92.48%   92.51%   +0.02%     
==============================================
  Files             122      122              
  Lines           26102    26106       +4     
==============================================
+ Hits            24141    24152      +11     
+ Misses           1961     1954       -7     

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

This PR extends prek list to support the same hook group filtering capabilities already available in prek run, by introducing --group and --no-group selectors and wiring them through hook initialization and filtering.

Changes:

  • Add --group / --no-group CLI flags to prek list and plumb them into the cli::list entrypoint.
  • Apply group filtering both during hook listing and during pre-clone repo initialization (so excluded remote repos need not be cloned).
  • Add integration tests and update CLI reference docs to reflect the new options.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/reference/cli.md Documents prek list --group/--no-group options.
crates/prek/tests/list.rs Adds coverage for group include/exclude behavior, unused selector warnings, validation errors, and “don’t clone excluded remotes”.
crates/prek/src/workspace.rs Generalizes HookInitFilters constructor to accept optional selectors and group filters, enabling pre-clone filtering by group.
crates/prek/src/main.rs Passes groups / no_groups args into the cli::list call.
crates/prek/src/cli/run/run.rs Updates call site to the new HookInitFilters::new(...) constructor.
crates/prek/src/cli/mod.rs Adds groups / no_groups fields to ListArgs for clap wiring.
crates/prek/src/cli/list.rs Parses group filters, applies them to hook output, and reports unused group selectors.
crates/prek/src/cli/install.rs Updates call site to the new HookInitFilters::new(...) constructor.

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot Bot commented Jun 4, 2026

📦 Cargo Bloat Comparison

Binary size change: +0.00% (26.3 MiB → 26.3 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.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.7%  89.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.5%  69.8KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.5%  65.4KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  49.1KiB              prek prek::run::{{closure}}
 0.2%   0.3%  43.9KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.2%  31.9KiB             prek? <prek::cli::RunOptions 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.2KiB              prek prek::cli::try_repo::try_repo::{{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.8KiB     serde_saphyr? <serde_saphyr::de::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.7%  86.3%  11.0MiB                   And 24116 smaller methods. Use -n N to show more.
48.3% 100.0%  12.7MiB                   .text section size, the file size is 26.3MiB

Base 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.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.7%  89.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.5%  69.8KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.5%  62.0KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  48.2KiB              prek prek::run::{{closure}}
 0.2%   0.3%  44.5KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.2%  31.1KiB             prek? <prek::cli::RunOptions 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.1KiB              prek prek::cli::try_repo::try_repo::{{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.9KiB     serde_saphyr? <serde_saphyr::de::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.7%  86.3%  11.0MiB                   And 24066 smaller methods. Use -n N to show more.
48.3% 100.0%  12.7MiB                   .text section size, the file size is 26.3MiB

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot Bot commented Jun 4, 2026

⚡️ Hyperfine Benchmarks

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

Environment
  • OS: Linux 6.17.0-1015-azure
  • CPU: 4 cores
  • prek version: prek 0.4.4+4 (b75399d 2026-06-04)
  • Rust version: rustc 1.96.0 (ac68faa20 2026-05-25)
  • 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.3 ± 0.1 2.2 2.6 1.00
prek-head --version 2.3 ± 0.1 2.2 2.9 1.00 ± 0.05

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.1 ± 0.1 8.8 9.5 1.00
prek-head list 9.1 ± 0.2 8.9 10.8 1.00 ± 0.03

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.1 3.0 3.4 1.00
prek-head validate-config .pre-commit-config.yaml 3.2 ± 0.1 3.1 3.3 1.00 ± 0.03

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.6 ± 0.1 2.5 2.8 1.00
prek-head sample-config 2.6 ± 0.0 2.5 2.7 1.01 ± 0.03
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 78.7 ± 2.7 74.8 82.8 1.01 ± 0.05
prek-head run --all-files 78.0 ± 2.6 72.6 82.3 1.00

prek run --all-files (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 80.3 ± 3.5 74.6 86.3 1.03 ± 0.06
prek-head run --all-files 78.2 ± 3.3 73.0 85.6 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 77.6 ± 3.4 72.2 84.5 1.00
prek-head run --all-files 77.6 ± 3.2 72.3 85.0 1.00 ± 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.8 ± 0.3 20.2 21.4 1.01 ± 0.03
prek-head run trailing-whitespace --all-files 20.7 ± 0.4 19.9 21.8 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.5 ± 1.8 24.2 29.8 1.02 ± 0.10
prek-head run end-of-file-fixer --all-files 27.0 ± 1.9 24.0 30.1 1.00

prek run check-json --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-json --all-files 8.1 ± 0.3 7.7 8.7 1.00
prek-head run check-json --all-files 9.3 ± 6.3 7.8 42.6 1.15 ± 0.78

⚠️ Warning: Performance regression for prek run check-json --all-files: 15.0300% slower

prek run check-yaml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-yaml --all-files 7.8 ± 0.2 7.5 8.2 1.00
prek-head run check-yaml --all-files 8.0 ± 0.2 7.8 8.9 1.02 ± 0.04

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 7.9 ± 0.3 7.5 8.7 1.00
prek-head run check-toml --all-files 8.1 ± 0.3 7.7 8.7 1.02 ± 0.05

prek run check-xml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-xml --all-files 8.2 ± 0.3 7.8 8.9 1.00
prek-head run check-xml --all-files 8.3 ± 0.3 7.8 8.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 14.0 ± 1.5 11.7 16.9 1.00
prek-head run detect-private-key --all-files 14.4 ± 1.5 12.2 17.4 1.03 ± 0.15

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 22.3 ± 1.5 19.9 26.0 1.00
prek-head run fix-byte-order-marker --all-files 22.8 ± 1.5 19.9 25.9 1.02 ± 0.10
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.7 ± 0.1 4.7 4.9 1.00
prek-head install-hooks 4.7 ± 0.1 4.7 4.8 1.00 ± 0.02

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 4.9 1.01 ± 0.02
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 44.1 ± 16.8 39.1 115.4 1.09 ± 0.42
prek-head run 40.5 ± 0.8 38.9 41.6 1.00

prek run --files '*.json' (specific file type)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 9.7 ± 1.1 8.5 11.6 1.11 ± 0.13
prek-head run --files '*.json' 8.7 ± 0.3 8.4 9.5 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.2 7.6 1.00
prek-head run --dry-run --all-files 7.3 ± 0.1 7.2 7.7 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.0 ± 0.2 12.8 13.8 1.00
prek-head run check-hooks-apply --all-files 13.3 ± 0.4 12.9 14.0 1.02 ± 0.03

prek run check-useless-excludes --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-useless-excludes --all-files 11.6 ± 0.5 11.2 12.8 1.00
prek-head run check-useless-excludes --all-files 11.8 ± 0.8 11.3 14.5 1.02 ± 0.08

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 11.2 ± 0.4 10.7 12.0 1.04 ± 0.04
prek-head run identity --all-files 10.8 ± 0.1 10.6 11.0 1.00

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