Repository navigation
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2736 +/- ##
==========================================
+ Coverage 94.33% 94.36% +0.03%
==========================================
Files 143 144 +1
Lines 30865 31013 +148
==========================================
+ Hits 29117 29266 +149
+ Misses 1748 1747 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
📦 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.2 ± 0.1 | 2.1 | 3.1 | 1.02 ± 0.07 |
prek-head --version |
2.2 ± 0.1 | 2.1 | 2.4 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.1 ± 0.1 | 8.9 | 9.7 | 1.00 ± 0.02 |
prek-head list |
9.1 ± 0.1 | 8.9 | 9.8 | 1.00 |
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.4 | 2.7 | 1.01 ± 0.04 |
prek-head sample-config |
2.5 ± 0.1 | 2.4 | 3.0 | 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 |
17.1 ± 0.5 | 16.5 | 18.5 | 1.01 ± 0.04 |
prek-head run --all-files |
17.0 ± 0.3 | 16.5 | 17.6 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
16.9 ± 0.2 | 16.5 | 17.3 | 1.00 |
prek-head run --all-files |
17.0 ± 0.3 | 16.5 | 17.5 | 1.01 ± 0.02 |
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 |
17.3 ± 0.4 | 16.5 | 18.4 | 1.00 ± 0.03 |
prek-head run --all-files |
17.2 ± 0.4 | 16.6 | 18.0 | 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 |
8.5 ± 0.2 | 8.1 | 9.2 | 1.00 |
prek-head run trailing-whitespace --all-files |
8.5 ± 0.3 | 8.3 | 10.0 | 1.00 ± 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 |
7.8 ± 0.1 | 7.5 | 8.0 | 1.01 ± 0.02 |
prek-head run end-of-file-fixer --all-files |
7.7 ± 0.1 | 7.6 | 7.9 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
6.7 ± 0.1 | 6.6 | 6.9 | 1.00 |
prek-head run check-json --all-files |
6.7 ± 0.1 | 6.6 | 7.0 | 1.01 ± 0.02 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
7.0 ± 0.1 | 6.8 | 7.3 | 1.00 |
prek-head run check-yaml --all-files |
7.1 ± 0.2 | 6.9 | 7.7 | 1.02 ± 0.03 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
6.8 ± 0.0 | 6.7 | 6.9 | 1.00 |
prek-head run check-toml --all-files |
6.9 ± 0.2 | 6.8 | 7.5 | 1.02 ± 0.03 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
6.8 ± 0.1 | 6.7 | 7.1 | 1.01 ± 0.02 |
prek-head run check-xml --all-files |
6.8 ± 0.1 | 6.7 | 6.9 | 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 |
7.2 ± 0.1 | 7.1 | 7.4 | 1.00 |
prek-head run detect-private-key --all-files |
7.3 ± 0.1 | 7.1 | 7.6 | 1.02 ± 0.02 |
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 |
7.7 ± 0.2 | 7.3 | 8.3 | 1.00 |
prek-head run fix-byte-order-marker --all-files |
7.8 ± 0.2 | 7.5 | 8.4 | 1.01 ± 0.04 |
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.8 ± 0.2 | 4.6 | 5.0 | 1.04 ± 0.04 |
prek-head install-hooks |
4.6 ± 0.1 | 4.5 | 4.7 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.6 ± 0.1 | 4.6 | 4.7 | 1.00 |
prek-head install-hooks |
4.7 ± 0.1 | 4.6 | 5.0 | 1.02 ± 0.04 |
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 |
11.0 ± 0.3 | 10.6 | 11.6 | 1.05 ± 0.04 |
prek-head run |
10.4 ± 0.3 | 10.0 | 11.0 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
5.3 ± 0.1 | 5.2 | 5.5 | 1.02 ± 0.02 |
prek-head run --files '*.json' |
5.2 ± 0.1 | 5.0 | 5.4 | 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.7 ± 0.4 | 7.0 | 8.3 | 1.09 ± 0.05 |
prek-head run --dry-run --all-files |
7.1 ± 0.1 | 6.9 | 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.1 ± 0.1 | 7.9 | 8.5 | 1.00 |
prek-head run check-hooks-apply --all-files |
8.2 ± 0.2 | 8.0 | 8.8 | 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.1 ± 0.1 | 7.9 | 8.3 | 1.00 |
prek-head run check-useless-excludes --all-files |
8.3 ± 0.5 | 8.0 | 10.2 | 1.02 ± 0.07 |
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.3 | 1.03 ± 0.02 |
prek-head run identity --all-files |
6.9 ± 0.1 | 6.8 | 7.0 | 1.00 |
888bb20 to
630b27a
Compare
Add a build-in checker: DCO sign off .
this is an addition of the issue #2725 and the PR #2725 (signed commit).
Usage
Example of error: