Allow selectors for hook ids containing colons#1782
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1782 +/- ##
==========================================
+ Coverage 91.66% 91.74% +0.07%
==========================================
Files 98 98
Lines 19878 19999 +121
==========================================
+ Hits 18222 18348 +126
+ Misses 1656 1651 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
💡 Codex Review
prek/crates/prek/src/cli/run/selector.rs
Line 417 in dc64061
: selectors through normalization
Allowing additional : in selectors here means :lint:ruff is now parsed as a valid hook-id selector, but when this selector is persisted for installed hooks we normalize via Selector::as_normalized_flag()/Display (in selector.rs and used from install.rs), which drops the leading : and emits lint:ruff. On the next invocation that value is re-parsed by this split_once(':') path as project=lint, hook=ruff, so prek install --include :lint:ruff can silently stop matching the intended hook (often matching nothing). Please preserve the explicit hook-id form when serializing selectors so round-tripping keeps semantics.
ℹ️ 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".
There was a problem hiding this comment.
Pull request overview
Updates prek’s selector parsing and documentation to support hook IDs that contain colons (:), while preserving the existing workspace selector form <project-path>:<hook-id>.
Changes:
- Removed the “only one
:” restriction in selector parsing soproject:hook:with:colonscan be interpreted asproject+hook:with:colons. - Added tests and documentation describing the
:<hook-id>escape syntax for hook IDs that themselves contain:. - Refactored legacy hook path computation in uninstall logic.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/configuration.md | Documents how to select hook IDs that contain : using a leading : escape. |
| crates/prek/src/cli/run/selector.rs | Allows multiple : by splitting project:hook on the first colon; adds test coverage for colon-containing hook IDs. |
| crates/prek/src/cli/install.rs | Changes how the legacy hook script path is derived (*.legacy). |
📦 Cargo Bloat ComparisonBinary size change: +0.00% (24.7 MiB → 24.7 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.2 | 2.2 | 3.3 | 1.02 ± 0.08 |
prek-head --version |
2.3 ± 0.1 | 2.2 | 3.0 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.0 ± 0.4 | 8.6 | 12.2 | 1.00 ± 0.05 |
prek-head list |
8.9 ± 0.2 | 8.7 | 10.4 | 1.00 |
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.0 | 3.2 | 1.00 |
prek-head validate-config .pre-commit-config.yaml |
3.1 ± 0.2 | 3.0 | 4.5 | 1.00 ± 0.07 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.6 ± 0.1 | 2.5 | 2.9 | 1.00 |
prek-head sample-config |
2.8 ± 0.7 | 2.5 | 7.3 | 1.05 ± 0.25 |
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 |
152.2 ± 1.7 | 150.3 | 155.5 | 1.01 ± 0.02 |
prek-head run --all-files |
150.5 ± 1.7 | 148.1 | 154.4 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
151.0 ± 1.6 | 148.5 | 153.9 | 1.00 |
prek-head run --all-files |
153.2 ± 3.5 | 149.7 | 164.1 | 1.01 ± 0.03 |
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 |
153.0 ± 2.0 | 149.5 | 157.5 | 1.00 |
prek-head run --all-files |
157.1 ± 29.1 | 146.5 | 347.7 | 1.03 ± 0.19 |
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.1 ± 0.5 | 21.1 | 23.2 | 1.00 |
prek-head run trailing-whitespace --all-files |
22.5 ± 0.8 | 21.4 | 25.5 | 1.02 ± 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 |
28.6 ± 2.1 | 25.3 | 32.3 | 1.01 ± 0.09 |
prek-head run end-of-file-fixer --all-files |
28.3 ± 1.7 | 26.1 | 32.7 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
12.4 ± 0.3 | 11.8 | 13.0 | 1.00 |
prek-head run check-json --all-files |
12.4 ± 0.4 | 11.6 | 13.2 | 1.00 ± 0.04 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
11.9 ± 0.2 | 11.6 | 12.2 | 1.00 |
prek-head run check-yaml --all-files |
12.0 ± 0.2 | 11.8 | 12.3 | 1.00 ± 0.02 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
12.4 ± 0.8 | 11.6 | 15.6 | 1.01 ± 0.08 |
prek-head run check-toml --all-files |
12.3 ± 0.6 | 11.7 | 15.4 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
12.4 ± 0.3 | 11.7 | 13.2 | 1.01 ± 0.04 |
prek-head run check-xml --all-files |
12.3 ± 0.3 | 11.7 | 13.0 | 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.9 ± 2.6 | 4.7 | 10.5 | 1.23 ± 0.53 |
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.8 ± 0.0 | 4.7 | 4.8 | 1.00 |
prek-head install-hooks |
4.9 ± 0.1 | 4.7 | 4.9 | 1.02 ± 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 |
18.8 ± 0.2 | 18.5 | 19.1 | 1.00 |
prek-head run |
18.8 ± 0.2 | 18.6 | 19.1 | 1.00 ± 0.01 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
7.7 ± 0.6 | 7.4 | 10.0 | 1.00 ± 0.13 |
prek-head run --files '*.json' |
7.7 ± 0.8 | 7.4 | 11.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 |
12.6 ± 0.5 | 12.3 | 14.5 | 1.00 |
prek-head run --dry-run --all-files |
12.6 ± 0.2 | 12.4 | 13.0 | 1.00 ± 0.04 |
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 |
14.5 ± 0.2 | 14.3 | 14.8 | 1.01 ± 0.02 |
prek-head run check-hooks-apply --all-files |
14.3 ± 0.2 | 14.1 | 14.8 | 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 |
13.8 ± 0.6 | 12.7 | 14.4 | 1.09 ± 0.05 |
prek-head run check-useless-excludes --all-files |
12.6 ± 0.1 | 12.5 | 12.8 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
11.0 ± 0.1 | 10.8 | 11.2 | 1.00 |
prek-head run identity --all-files |
11.1 ± 0.1 | 10.9 | 11.4 | 1.00 ± 0.01 |
Closes #1781