Remove legacy init-template-dir command - #2623
Conversation
e2dc982 to
c5b8e32
Compare
3fe2835 to
c8faca9
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## drop-hook-schema-v0 #2623 +/- ##
====================================================
Coverage 93.99% 93.99%
====================================================
Files 140 140
Lines 29460 29460
====================================================
Hits 27691 27691
Misses 1769 1769 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
init-template-dir command
📦 Cargo Bloat Comparison
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.8 | 1.00 ± 0.06 |
prek-head --version |
2.4 ± 0.1 | 2.2 | 2.8 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.3 ± 0.3 | 8.9 | 10.5 | 1.00 |
prek-head list |
10.0 ± 0.4 | 9.3 | 10.8 | 1.07 ± 0.05 |
prek validate-config .pre-commit-config.yaml
⏭️ Skipped: .pre-commit-config.yaml not found
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.7 ± 0.1 | 2.5 | 3.0 | 1.01 ± 0.04 |
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 |
38.7 ± 1.3 | 37.2 | 41.7 | 1.01 ± 0.05 |
prek-head run --all-files |
38.4 ± 1.1 | 36.0 | 39.8 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
38.3 ± 1.4 | 36.5 | 41.3 | 1.02 ± 0.05 |
prek-head run --all-files |
37.7 ± 1.3 | 35.5 | 40.7 | 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.9 ± 3.2 | 34.7 | 58.8 | 1.01 ± 0.09 |
prek-head run --all-files |
37.6 ± 1.3 | 33.9 | 40.1 | 1.00 |
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 |
13.0 ± 0.5 | 12.2 | 14.2 | 1.01 ± 0.05 |
prek-head run trailing-whitespace --all-files |
13.0 ± 0.4 | 12.1 | 13.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 |
11.6 ± 0.7 | 10.7 | 13.2 | 1.03 ± 0.07 |
prek-head run end-of-file-fixer --all-files |
11.3 ± 0.4 | 10.7 | 12.2 | 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.4 | 7.7 | 9.6 | 1.01 ± 0.06 |
prek-head run check-json --all-files |
8.2 ± 0.3 | 7.8 | 8.7 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
8.3 ± 0.2 | 7.9 | 8.6 | 1.00 |
prek-head run check-yaml --all-files |
8.5 ± 0.2 | 8.1 | 9.1 | 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 |
8.7 ± 0.4 | 8.2 | 10.8 | 1.01 ± 0.06 |
prek-head run check-toml --all-files |
8.6 ± 0.2 | 8.2 | 9.1 | 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.2 | 8.0 | 8.9 | 1.00 |
prek-head run check-xml --all-files |
8.3 ± 0.3 | 7.9 | 8.9 | 1.00 ± 0.04 |
prek run detect-private-key --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run detect-private-key --all-files |
11.8 ± 0.7 | 10.7 | 14.0 | 1.04 ± 0.08 |
prek-head run detect-private-key --all-files |
11.3 ± 0.6 | 10.6 | 13.5 | 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 |
13.0 ± 0.9 | 11.5 | 15.5 | 1.00 ± 0.09 |
prek-head run fix-byte-order-marker --all-files |
13.0 ± 0.6 | 11.9 | 14.4 | 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 |
4.7 ± 0.1 | 4.7 | 4.8 | 1.00 |
prek-head install-hooks |
4.8 ± 0.1 | 4.7 | 4.9 | 1.02 ± 0.02 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.9 ± 0.1 | 4.7 | 4.9 | 1.03 ± 0.02 |
prek-head install-hooks |
4.7 ± 0.1 | 4.6 | 4.8 | 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 |
25.5 ± 0.5 | 24.7 | 26.1 | 1.00 |
prek-head run |
25.5 ± 0.4 | 25.0 | 26.7 | 1.00 ± 0.02 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
5.5 ± 0.1 | 5.3 | 5.8 | 1.01 ± 0.03 |
prek-head run --files '*.json' |
5.4 ± 0.1 | 5.2 | 5.7 | 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.2 ± 0.1 | 7.1 | 7.7 | 1.01 ± 0.02 |
prek-head run --dry-run --all-files |
7.2 ± 0.1 | 7.0 | 7.4 | 1.00 |
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.6 ± 0.1 | 8.4 | 8.8 | 1.01 ± 0.02 |
prek-head run check-hooks-apply --all-files |
8.6 ± 0.1 | 8.4 | 8.7 | 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 |
8.4 ± 0.1 | 8.3 | 8.7 | 1.00 ± 0.02 |
prek-head run check-useless-excludes --all-files |
8.4 ± 0.1 | 8.3 | 8.6 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
7.6 ± 0.1 | 7.4 | 7.9 | 1.01 ± 0.03 |
prek-head run identity --all-files |
7.5 ± 0.2 | 7.3 | 8.0 | 1.00 |
Removes the deprecated top-level
prek init-template-dirspelling.