Repository navigation
Add normalize-indentation builtin hook - #2967
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
I saw something close was recently added in commit 0cd15be. I hadn't seen that yet, but I wanted to create the PR anyway because this does a bit more than |
cd89012 to
6f08ed2
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2967 +/- ##
==========================================
+ Coverage 94.18% 94.23% +0.04%
==========================================
Files 146 147 +1
Lines 31024 31286 +262
==========================================
+ Hits 29220 29481 +261
- Misses 1804 1805 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Convert the leading indentation of non-blank lines to spaces or tabs, with --indent, --tab-size and --check. Line endings, a UTF-8 BOM and the final newline state are preserved, and --check stops at the first violation. Co-authored-by: Copilot
6f08ed2 to
fe3d72d
Compare
📦 Cargo Bloat ComparisonBuild:
Largest symbol changesIncreases
Decreases
|
⚡️ Hyperfine BenchmarksSummary: 2 regressions, 0 improvements above the 10% threshold. Environment
CLI CommandsBenchmarking basic commands in the main repo:
|
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base --version |
1.8 ± 0.1 | ||
prek-head --version |
1.8 ± 0.1 | -0.2% |
prek list
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base list |
7.6 ± 0.2 | ||
prek-head list |
7.8 ± 0.2 | +2.5% |
prek validate-config .pre-commit-config.yaml
⏭️ Skipped: .pre-commit-config.yaml not found
prek sample-config
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base sample-config |
2.2 ± 0.1 | ||
prek-head sample-config |
2.3 ± 0.6 | +7.1% |
Cold vs Warm Runs
Comparing first run (cold) vs subsequent runs (warm cache):
prek run --all-files (cold - no cache)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run --all-files |
14.6 ± 0.3 | ||
prek-head run --all-files |
14.6 ± 0.4 | +0.2% |
prek run --all-files (warm - with cache)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run --all-files |
14.8 ± 0.4 | ||
prek-head run --all-files |
14.4 ± 0.3 | -2.4% |
Full Hook Suite
Running the builtin hook suite on the benchmark workspace:
prek run --all-files (full builtin hook suite)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run --all-files |
14.6 ± 0.3 | ||
prek-head run --all-files |
14.4 ± 0.3 | -1.3% |
Individual Hook Performance
Benchmarking each hook individually on the test repo:
prek run trailing-whitespace --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run trailing-whitespace --all-files |
7.3 ± 0.2 | ||
prek-head run trailing-whitespace --all-files |
7.5 ± 1.5 | +3.7% |
prek run end-of-file-fixer --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run end-of-file-fixer --all-files |
6.4 ± 0.1 | ||
prek-head run end-of-file-fixer --all-files |
6.4 ± 0.1 | +0.4% |
prek run check-json --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-json --all-files |
5.6 ± 0.1 | ||
prek-head run check-json --all-files |
6.1 ± 2.8 | +8.2% |
prek run check-yaml --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-yaml --all-files |
5.7 ± 0.1 | ||
prek-head run check-yaml --all-files |
5.9 ± 0.9 | +2.8% |
prek run check-toml --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-toml --all-files |
5.8 ± 0.9 | ||
prek-head run check-toml --all-files |
5.9 ± 1.2 | +1.9% |
prek run check-xml --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-xml --all-files |
5.6 ± 0.1 | ||
prek-head run check-xml --all-files |
5.7 ± 0.1 | +1.0% |
prek run detect-private-key --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run detect-private-key --all-files |
6.0 ± 0.1 | ||
prek-head run detect-private-key --all-files |
6.0 ± 0.1 | +0.2% |
prek run fix-byte-order-marker --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run fix-byte-order-marker --all-files |
6.4 ± 1.9 | ||
prek-head run fix-byte-order-marker --all-files |
6.2 ± 0.2 | -2.1% |
Installation Performance
Benchmarking hook installation (fast path hooks skip Python setup):
prek install-hooks (cold - no cache)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base install-hooks |
3.8 ± 0.1 | ||
prek-head install-hooks |
3.8 ± 0.1 | +1.7% |
prek install-hooks (warm - with cache)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base install-hooks |
3.8 ± 0.1 | ||
prek-head install-hooks |
3.8 ± 0.1 | +1.1% |
File Filtering/Scoping Performance
Testing different file selection modes:
prek run (staged files only)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run |
9.0 ± 0.6 | ||
prek-head run |
8.9 ± 0.2 | -1.4% |
prek run --files '*.json' (specific file type)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run --files '*.json' |
4.5 ± 0.1 | ||
prek-head run --files '*.json' |
9.5 ± 21.7 | +112.8% | (2.1x slower) |
prek run --files '*.json' (specific file type): 112.7700% slower
Workspace Discovery & Initialization
Benchmarking hook discovery and initialization overhead:
prek run --dry-run --all-files (measures init overhead)
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run --dry-run --all-files |
5.9 ± 0.1 | ||
prek-head run --dry-run --all-files |
6.8 ± 3.9 | +16.0% |
prek run --dry-run --all-files (measures init overhead): 16.0200% slower
Meta Hooks Performance
Benchmarking meta hooks separately:
prek run check-hooks-apply --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-hooks-apply --all-files |
7.2 ± 0.2 | ||
prek-head run check-hooks-apply --all-files |
7.4 ± 0.6 | +2.8% |
prek run check-useless-excludes --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run check-useless-excludes --all-files |
7.3 ± 0.1 | ||
prek-head run check-useless-excludes --all-files |
7.4 ± 0.2 | +1.7% |
prek run identity --all-files
| Command | Mean Wall Time [ms] | Change | Factor |
|---|---|---|---|
prek-base run identity --all-files |
6.3 ± 0.1 | ||
prek-head run identity --all-files |
6.3 ± 0.1 | -0.3% |
normalize-indentation builtin hook
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
|
Thanks! |
Adds a
normalize-indentationbuiltin hook that converts leading indentation to spaces or tabs, with--indent,--tab-sizeand--check. This is useful due to many developers preferring one format over the other in their editor of choice, and a project needing to enforce a common style.