Document combined group filtering - #2495
Conversation
There was a problem hiding this comment.
Pull request overview
Documents and regression-tests how prek run composes --group, --require-group, and --no-group filters (OR for repeated --group, AND for repeated --require-group, exclusion wins), addressing the clarification requested in #2493.
Changes:
- Add consistent “combined filtering” explanation + concrete example to the hook-groups proposal and configuration reference.
- Expand CLI option docs for
--group/--require-groupto spell out OR/AND composition and interaction with--no-group/ argument order. - Add a regression test that exercises combined filters and verifies argument-order independence.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/configuration.md | Adds an explicit example showing fast AND (format OR lint-only) selection semantics. |
| docs/reference/cli.md | Clarifies --group (OR semantics) and --require-group (AND semantics) and their composition with --no-group. |
| docs/proposals/hook-groups.md | Adds an equivalent boolean-style description and the same concrete example for clarity/consistency. |
| crates/prek/tests/run.rs | Adds a snapshot covering combined --group/--require-group/--no-group filtering and order independence. |
| crates/prek/src/cli/mod.rs | Updates Clap help text so generated CLI docs reflect the clarified semantics. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2495 +/- ##
==========================================
+ Coverage 93.39% 93.61% +0.22%
==========================================
Files 131 131
Lines 28359 28359
==========================================
+ Hits 26486 26549 +63
+ Misses 1873 1810 -63 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
📦 Cargo Bloat ComparisonBinary size change: +0.00% (29.6 MiB → 29.6 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ Hyperfine BenchmarksSummary: 0 regressions, 1 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.2 ± 0.1 | 2.1 | 2.6 | 1.03 ± 0.05 |
prek-head --version |
2.1 ± 0.1 | 2.0 | 2.3 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.4 ± 0.3 | 9.0 | 11.4 | 1.00 |
prek-head list |
9.6 ± 0.4 | 9.0 | 11.5 | 1.02 ± 0.05 |
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.5 | 1.00 |
prek-head validate-config .pre-commit-config.yaml |
3.5 ± 0.6 | 3.1 | 7.5 | 1.09 ± 0.20 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.5 ± 0.1 | 2.4 | 2.7 | 1.01 ± 0.06 |
prek-head sample-config |
2.5 ± 0.1 | 2.4 | 3.4 | 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 |
37.6 ± 1.1 | 36.2 | 39.4 | 1.01 ± 0.04 |
prek-head run --all-files |
37.3 ± 0.8 | 36.0 | 38.2 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
37.9 ± 1.2 | 35.4 | 39.7 | 1.00 ± 0.04 |
prek-head run --all-files |
37.8 ± 1.1 | 36.7 | 41.0 | 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 |
37.6 ± 1.2 | 35.6 | 39.5 | 1.00 |
prek-head run --all-files |
38.1 ± 1.2 | 35.2 | 40.2 | 1.01 ± 0.04 |
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 |
12.9 ± 0.3 | 12.4 | 13.7 | 1.00 |
prek-head run trailing-whitespace --all-files |
13.0 ± 0.5 | 12.3 | 14.4 | 1.00 ± 0.05 |
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 |
10.8 ± 0.5 | 10.0 | 12.1 | 1.00 |
prek-head run end-of-file-fixer --all-files |
11.2 ± 0.5 | 10.5 | 12.4 | 1.04 ± 0.06 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
7.7 ± 0.3 | 7.0 | 8.3 | 1.01 ± 0.05 |
prek-head run check-json --all-files |
7.7 ± 0.3 | 7.2 | 8.5 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
7.6 ± 0.5 | 7.3 | 10.3 | 1.01 ± 0.08 |
prek-head run check-yaml --all-files |
7.6 ± 0.2 | 7.2 | 7.9 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
7.6 ± 0.2 | 7.1 | 8.2 | 1.01 ± 0.05 |
prek-head run check-toml --all-files |
7.6 ± 0.3 | 6.9 | 8.2 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
7.6 ± 0.8 | 7.0 | 11.4 | 1.00 ± 0.12 |
prek-head run check-xml --all-files |
7.6 ± 0.5 | 7.1 | 8.8 | 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 |
10.9 ± 0.5 | 10.1 | 12.1 | 1.00 |
prek-head run detect-private-key --all-files |
11.2 ± 0.7 | 10.3 | 13.8 | 1.03 ± 0.08 |
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 |
12.6 ± 0.8 | 11.5 | 14.4 | 1.00 |
prek-head run fix-byte-order-marker --all-files |
12.6 ± 0.9 | 11.2 | 14.6 | 1.00 ± 0.09 |
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.5 ± 2.0 | 4.5 | 9.2 | 1.20 ± 0.44 |
prek-head install-hooks |
4.6 ± 0.0 | 4.6 | 4.6 | 1.00 |
✅ Performance improvement for prek install-hooks (cold - no cache): 16.7300% faster
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.6 ± 0.0 | 4.6 | 4.6 | 1.01 ± 0.02 |
prek-head install-hooks |
4.6 ± 0.1 | 4.4 | 4.6 | 1.00 |
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 |
23.7 ± 0.5 | 22.9 | 25.0 | 1.01 ± 0.03 |
prek-head run |
23.6 ± 0.4 | 23.1 | 24.3 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
5.1 ± 0.1 | 5.0 | 5.2 | 1.01 ± 0.02 |
prek-head run --files '*.json' |
5.0 ± 0.1 | 4.9 | 5.1 | 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 |
6.7 ± 0.1 | 6.6 | 6.9 | 1.00 |
prek-head run --dry-run --all-files |
6.9 ± 0.5 | 6.6 | 8.5 | 1.02 ± 0.07 |
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 |
8.0 ± 0.1 | 7.8 | 8.1 | 1.00 |
prek-head run check-hooks-apply --all-files |
8.2 ± 0.2 | 8.0 | 8.7 | 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 |
8.2 ± 0.2 | 8.0 | 8.8 | 1.01 ± 0.03 |
prek-head run check-useless-excludes --all-files |
8.2 ± 0.1 | 8.0 | 8.4 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
7.0 ± 0.1 | 6.8 | 7.4 | 1.00 |
prek-head run identity --all-files |
7.1 ± 0.1 | 6.9 | 7.3 | 1.00 ± 0.03 |
This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [prek](https://github.com/j178/prek) | tools | patch | `0.4.10` → `0.4.13` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>j178/prek (prek)</summary> ### [`v0.4.13`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0413) [Compare Source](j178/prek@v0.4.12...v0.4.13) Released on 2026-08-10. ##### Highlights ##### Manage hook tools with mise The new `language: mise` support lets hooks install tools using [`mise`](https://mise.jdx.dev/) in an isolated environment: ```yaml repos: - repo: local hooks: - id: golangci-lint name: golangci-lint language: mise additional_dependencies: ["aqua:golangci/golangci-lint@2"] entry: golangci-lint run --fast-only ./... pass_filenames: false ``` ##### Run commands in hook environments The new `prek exec` subcommand can run an explicit command in a configured hook's prepared environment. For example, the hook above makes its managed binary available to this command: ```console $ prek exec golangci-lint -- golangci-lint --version ``` ##### Enhancements - Add `mise` language support ([#​2540](j178/prek#2540)) - Add `deny-filename-pattern` and `require-filename-pattern` hooks ([#​2488](j178/prek#2488)) - Add `prek exec` for running commands in a hook environment ([#​2478](j178/prek#2478)) - Add `yaml-language-server:` comment to YAML sample config ([#​2486](j178/prek#2486)) - Make `prek cache size` output terminal-aware ([#​2508](j178/prek#2508)) - Match file regexes against path bytes ([#​2541](j178/prek#2541)) - Show hook aliases in run output ([#​2497](j178/prek#2497)) - Show hook descriptions in run output ([#​2490](j178/prek#2490)) ##### Performance - Avoid env cache scans for skipped hooks ([#​2502](j178/prek#2502)) - Cache Node version queries ([#​2500](j178/prek#2500)) ##### Bug fixes - Fix Node hook installation with npm 11 ([#​2487](j178/prek#2487)) - Isolate dependency installs from inherited Git repository state ([#​2506](j178/prek#2506)) ##### Documentation - Document combined group filtering ([#​2495](j178/prek#2495)) - Explain what prek does in README ([#​2507](j178/prek#2507)) - Refresh "Why prek" highlights ([#​2474](j178/prek#2474)) ##### Contributors - [@​will-wright-eng](https://github.com/will-wright-eng) - [@​Repiteo](https://github.com/Repiteo) - [@​j178](https://github.com/j178) ### [`v0.4.12`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0412) [Compare Source](j178/prek@v0.4.11...v0.4.12) Released on 2026-08-03. ##### Enhancements - Add `--require-group` for hook group intersections ([#​2472](j178/prek#2472)) - Align fast-path and builtin pre-commit hooks ([#​2433](j178/prek#2433)) - Do not shuffle file list for verbose output ([#​2431](j178/prek#2431)) - Improve top-level command descriptions ([#​2429](j178/prek#2429)) - Install `uv` from Astral CDN and drop source racing ([#​2455](j178/prek#2455)) - Make `prek install --force` bypass external hooks paths ([#​2437](j178/prek#2437)) - Show builtin hook flags in verbose list output ([#​2427](j178/prek#2427)) - Verify uv release archive checksums ([#​2456](j178/prek#2456)) ##### Performance - Precompute file tags in parallel ([#​2440](j178/prek#2440)) - Skip diffs after known hook modifications ([#​2447](j178/prek#2447)) - Skip worktree diffs for read-only languages ([#​2432](j178/prek#2432)) - Track builtin hook file changes directly ([#​2404](j178/prek#2404)) ##### Bug fixes - Use full object IDs in diff snapshots ([#​2448](j178/prek#2448)) ##### Documentation - Add a multi-repository configuration example ([#​2434](j178/prek#2434)) - Rewrite benchmark documentation ([#​2469](j178/prek#2469)) ##### Contributors - [@​j178](https://github.com/j178) - [@​BitWeaverDev](https://github.com/BitWeaverDev) - [@​allanlewis](https://github.com/allanlewis) ### [`v0.4.11`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0411) [Compare Source](j178/prek@v0.4.10...v0.4.11) Released on 2026-07-25. ##### Highlights - This release adds two new builtin hooks, `deny-pattern` and `require-pattern`, as native alternatives for `pygrep` use cases. `deny-pattern` fails when a configured pattern is found, while `require-pattern` ensures every selected file contains a match. By matching natively without spawning a Python subprocess, they run over 4x faster than `pygrep` in benchmarks. Note that they use [Rust `regex` syntax](https://docs.rs/regex/latest/regex/#syntax), which does not support look-around features such as negative lookbehind. - `prek run` now supports `--glob <PATTERN>` to run hooks on tracked files matching a glob. It can be repeated or combined with `--files` and `--directory`. - Hook priorities now support reusable aliases: ```toml [priorities] checks = 10 [[repos]] repo = "builtin" hooks = [ { id = "check-json", priority = "checks" }, { id = "check-yaml", priority = "checks" }, ] ``` This makes parallel scheduling easier to read and maintain. ##### Enhancements - Add `deny-pattern` and `require-pattern` builtin hooks ([#​2359](j178/prek#2359)) - Support `--glob` patterns in `prek run` ([#​2381](j178/prek#2381)) - Support reusable aliases for hook priorities ([#​2331](j178/prek#2331)) - Implement `requirements-txt-fixer` as a builtin hook ([#​2390](j178/prek#2390)) - Improve user-facing warnings and errors ([#​2380](j178/prek#2380)) - Install Node hooks through git url ([#​2394](j178/prek#2394)) ##### Performance - Reduce blocking-pool overhead in file hooks ([#​2384](j178/prek#2384)) - Speed up mixed-line-ending scans with memchr2 ([#​2391](j178/prek#2391)) ##### Bug fixes - Honor filenames in builtin hook entry and args ([#​2389](j178/prek#2389)) - Match identify tags across filename parts ([#​2399](j178/prek#2399)) - Preserve hook output order with a shared pipe ([#​2385](j178/prek#2385)) - Preserve system download policy when applying metadata ([#​2395](j178/prek#2395)) ##### Contributors - [@​j178](https://github.com/j178) - [@​chrisoro](https://github.com/chrisoro) </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yODYuMSIsInVwZGF0ZWRJblZlciI6IjQzLjI4OC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiLCJhdXRvbWF0aW9uOmJvdC1hdXRob3JlZCIsImRlcGVuZGVuY3ktdHlwZTo6cGF0Y2giXX0=-->
Closes #2493