Fix pretty-format-json CRLF handling#2210
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2210 +/- ##
==========================================
- Coverage 92.59% 92.52% -0.08%
==========================================
Files 125 125
Lines 26587 26698 +111
==========================================
+ Hits 24617 24701 +84
- Misses 1970 1997 +27 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR fixes the pretty-format-json hook’s behavior on CRLF (Windows) files by ensuring newline-style-only differences don’t trigger a failure and by preserving the original file’s newline style when autofixing, aligning behavior with upstream Python’s text-mode newline normalization.
Changes:
- Compare original vs prettified JSON while treating
\r\n/\ras equivalent to\nto avoid false positives on Windows. - Preserve the file’s original newline style (e.g., CRLF) when
--autofixrewrites the file. - Normalize newlines only for diff output, and add tests covering CRLF, mixed line endings, and CRLF-preserving autofix.
📦 Cargo Bloat ComparisonBinary size change: -0.38% (26.6 MiB → 26.5 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.1 ± 0.1 | 2.0 | 2.8 | 1.00 |
prek-head --version |
2.2 ± 0.1 | 2.0 | 2.5 | 1.02 ± 0.06 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
8.9 ± 0.1 | 8.7 | 9.4 | 1.00 |
prek-head list |
9.4 ± 0.6 | 8.7 | 10.5 | 1.05 ± 0.07 |
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.4 | 1.06 ± 0.04 |
prek-head validate-config .pre-commit-config.yaml |
3.0 ± 0.1 | 2.8 | 3.2 | 1.00 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.5 ± 0.5 | 2.3 | 5.8 | 1.03 ± 0.21 |
prek-head sample-config |
2.4 ± 0.0 | 2.3 | 2.5 | 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 |
74.2 ± 3.2 | 69.2 | 77.8 | 1.01 ± 0.07 |
prek-head run --all-files |
73.4 ± 4.3 | 69.3 | 81.4 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
73.1 ± 5.8 | 69.1 | 95.7 | 1.00 |
prek-head run --all-files |
73.6 ± 2.9 | 69.4 | 78.3 | 1.01 ± 0.09 |
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 |
73.0 ± 2.5 | 69.0 | 77.1 | 1.00 |
prek-head run --all-files |
73.4 ± 2.7 | 68.6 | 81.2 | 1.00 ± 0.05 |
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 |
19.7 ± 0.4 | 18.9 | 20.4 | 1.00 |
prek-head run trailing-whitespace --all-files |
19.8 ± 0.4 | 19.1 | 20.5 | 1.01 ± 0.03 |
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 |
26.2 ± 2.2 | 23.5 | 30.0 | 1.02 ± 0.11 |
prek-head run end-of-file-fixer --all-files |
25.6 ± 1.6 | 23.4 | 28.7 | 1.00 |
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.1 | 8.3 | 1.01 ± 0.05 |
prek-head run check-json --all-files |
7.6 ± 0.2 | 7.2 | 8.1 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
7.5 ± 0.2 | 7.2 | 7.8 | 1.02 ± 0.03 |
prek-head run check-yaml --all-files |
7.3 ± 0.2 | 7.1 | 7.7 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
7.5 ± 0.2 | 7.1 | 8.1 | 1.00 |
prek-head run check-toml --all-files |
7.5 ± 0.3 | 7.1 | 8.5 | 1.01 ± 0.05 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
7.5 ± 0.3 | 7.0 | 8.2 | 1.00 |
prek-head run check-xml --all-files |
7.6 ± 0.3 | 7.1 | 8.4 | 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 |
13.3 ± 1.1 | 11.6 | 15.8 | 1.00 |
prek-head run detect-private-key --all-files |
14.2 ± 1.4 | 11.8 | 18.5 | 1.07 ± 0.14 |
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 |
18.6 ± 0.8 | 17.2 | 20.2 | 1.01 ± 0.06 |
prek-head run fix-byte-order-marker --all-files |
18.4 ± 0.7 | 17.0 | 19.6 | 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.4 ± 0.1 | 4.3 | 4.4 | 1.01 ± 0.02 |
prek-head install-hooks |
4.3 ± 0.1 | 4.3 | 4.4 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.4 ± 0.1 | 4.3 | 4.5 | 1.02 ± 0.03 |
prek-head install-hooks |
4.3 ± 0.1 | 4.2 | 4.4 | 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 |
37.7 ± 1.2 | 35.8 | 39.7 | 1.00 |
prek-head run |
39.3 ± 8.7 | 35.3 | 75.7 | 1.04 ± 0.23 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
7.8 ± 0.1 | 7.6 | 8.1 | 1.00 |
prek-head run --files '*.json' |
8.0 ± 0.2 | 7.8 | 8.8 | 1.03 ± 0.03 |
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.8 | 1.00 |
prek-head run --dry-run --all-files |
6.8 ± 0.2 | 6.6 | 7.4 | 1.01 ± 0.03 |
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 |
11.8 ± 0.1 | 11.7 | 12.1 | 1.00 ± 0.01 |
prek-head run check-hooks-apply --all-files |
11.8 ± 0.1 | 11.6 | 12.1 | 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 |
11.7 ± 0.1 | 11.5 | 11.9 | 1.12 ± 0.02 |
prek-head run check-useless-excludes --all-files |
10.5 ± 0.1 | 10.2 | 10.7 | 1.00 |
✅ Performance improvement for prek run check-useless-excludes --all-files: 10.7500% faster
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
9.9 ± 0.3 | 9.5 | 10.4 | 1.02 ± 0.03 |
prek-head run identity --all-files |
9.7 ± 0.1 | 9.5 | 10.0 | 1.00 |
Fixes
pretty-format-jsonhandling for CRLF files by ignoring newline-style-only differences during comparison and preserving the original newline style on autofix.Closes #2207