Skip to content

Expand tilde in --config, --cd, --log-file and --git-dir#2063

Merged
j178 merged 2 commits into
masterfrom
tilde-paths
May 9, 2026
Merged

Expand tilde in --config, --cd, --log-file and --git-dir#2063
j178 merged 2 commits into
masterfrom
tilde-paths

Conversation

@j178

@j178 j178 commented May 9, 2026

Copy link
Copy Markdown
Owner

Expands leading ~ for path-valued CLI flags including --config, --cd, --log-file, and --git-dir so quoted shell values resolve consistently.

Closes #2062

Copilot AI review requested due to automatic review settings May 9, 2026 06:50
@j178 j178 added the enhancement New feature or request label May 9, 2026
@j178 j178 changed the title Expand tilde in path flags Expand tilde in --config, --cd, --log-file and --git-dir May 9, 2026
@codecov

codecov Bot commented May 9, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 92.32%. Comparing base (ece6887) to head (b2240b6).

Files with missing lines Patch % Lines
crates/prek/src/fs.rs 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2063      +/-   ##
==========================================
- Coverage   92.33%   92.32%   -0.01%     
==========================================
  Files         119      119              
  Lines       24429    24429              
==========================================
- Hits        22556    22555       -1     
- Misses       1873     1874       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes prek consistently expand a leading ~ in path-valued CLI flags (so quoted values like "~/foo" resolve the same as unquoted shell-expanded values), aligning behavior across --config, --cd, --log-file, and --git-dir.

Changes:

  • Add a PathBufValueParser mapping to expand a leading ~ for several CLI path flags.
  • Centralize tilde expansion into crate::fs::expand_tilde and reuse it from the store path resolution.
  • Add an integration snapshot test verifying tilde expansion for --config and --cd via --show-settings.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
crates/prek/src/cli/mod.rs Applies tilde-expanding value_parser to global and install/uninstall path flags.
crates/prek/src/fs.rs Introduces shared expand_tilde helper (currently using a deprecated API).
crates/prek/src/store.rs Reuses shared tilde expansion for $PREK_HOME resolution.
crates/prek/tests/run.rs Adds a snapshot test asserting --config / --cd tilde expansion.

Comment thread crates/prek/src/fs.rs
Comment thread crates/prek/src/cli/mod.rs
Comment thread crates/prek/src/cli/mod.rs
@prek-ci-bot

prek-ci-bot Bot commented May 9, 2026

Copy link
Copy Markdown

📦 Cargo Bloat Comparison

Binary size change: +0.00% (26.1 MiB → 26.1 MiB)

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_1_aes_gcm_encrypt_avx512
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_1_aes_gcm_decrypt_avx512
 0.3%   0.7%  91.6KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.7%  86.2KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  74.5KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.5%  65.4KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  53.3KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  48.7KiB              prek prek::run::{{closure}}
 0.2%   0.3%  43.8KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  33.1KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  32.1KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  29.0KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_1_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.6KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_39_1_edwards25519_scalarmuldouble
 0.1%   0.2%  26.2KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  23.9KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  22.5KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.5%  86.2%  10.8MiB                   And 23918 smaller methods. Use -n N to show more.
48.1% 100.0%  12.6MiB                   .text section size, the file size is 26.1MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_1_aes_gcm_encrypt_avx512
 1.2%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_1_aes_gcm_decrypt_avx512
 0.3%   0.7%  91.7KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  83.6KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.2%   0.5%  65.4KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.5%  60.3KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  53.3KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  48.8KiB              prek prek::run::{{closure}}
 0.2%   0.3%  43.8KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  32.5KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  32.1KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  28.3KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_1_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.6KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_39_1_edwards25519_scalarmuldouble
 0.1%   0.2%  26.4KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  24.5KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  23.5KiB             prek? <prek::cli::Command as clap_builder::derive::FromArgMatches>::from_arg_matches_mut
 0.1%   0.2%  22.5KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
41.6%  86.3%  10.9MiB                   And 23888 smaller methods. Use -n N to show more.
48.1% 100.0%  12.6MiB                   .text section size, the file size is 26.1MiB

@prek-ci-bot

prek-ci-bot Bot commented May 9, 2026

Copy link
Copy Markdown

⚡️ Hyperfine Benchmarks

Summary: 0 regressions, 0 improvements above the 10% threshold.

Environment
  • OS: Linux 6.17.0-1010-azure
  • CPU: 4 cores
  • prek version: prek 0.3.13+8 (0d40b95 2026-05-09)
  • Rust version: rustc 1.95.0 (59807616e 2026-04-14)
  • Hyperfine version: hyperfine 1.20.0
CLI Commands

Benchmarking basic commands in the main repo:

prek --version

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base --version 2.4 ± 0.1 2.2 2.9 1.00
prek-head --version 2.4 ± 0.1 2.2 3.0 1.02 ± 0.07

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.7 ± 0.2 9.3 10.3 1.02 ± 0.03
prek-head list 9.6 ± 0.2 9.1 10.6 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.2 ± 0.1 3.1 3.5 1.00
prek-head validate-config .pre-commit-config.yaml 3.3 ± 0.4 3.1 5.7 1.02 ± 0.12

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.7 ± 0.1 2.6 2.8 1.00
prek-head sample-config 2.7 ± 0.1 2.5 3.3 1.00 ± 0.05
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 147.7 ± 3.2 141.2 151.6 1.03 ± 0.04
prek-head run --all-files 143.7 ± 4.6 139.1 151.5 1.00

prek run --all-files (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 141.6 ± 3.8 133.1 149.2 1.00
prek-head run --all-files 143.1 ± 4.4 135.2 151.1 1.01 ± 0.04
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 143.5 ± 4.8 135.8 155.9 1.00
prek-head run --all-files 147.8 ± 34.9 137.2 388.6 1.03 ± 0.25
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 21.9 ± 1.3 20.6 26.6 1.02 ± 0.07
prek-head run trailing-whitespace --all-files 21.4 ± 0.6 20.4 22.5 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 28.2 ± 2.4 24.3 32.2 1.00 ± 0.13
prek-head run end-of-file-fixer --all-files 28.2 ± 2.8 24.2 35.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.2 ± 0.5 11.3 13.3 1.06 ± 0.05
prek-head run check-json --all-files 11.4 ± 0.2 11.0 11.9 1.00

prek run check-yaml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-yaml --all-files 11.4 ± 0.2 11.1 11.9 1.00
prek-head run check-yaml --all-files 11.9 ± 0.2 11.6 12.4 1.05 ± 0.03

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 12.1 ± 0.3 11.6 13.0 1.01 ± 0.05
prek-head run check-toml --all-files 12.0 ± 0.4 11.1 13.0 1.00

prek run check-xml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-xml --all-files 12.2 ± 0.4 11.6 13.1 1.00 ± 0.04
prek-head run check-xml --all-files 12.1 ± 0.3 11.6 12.7 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 18.3 ± 1.2 16.4 21.0 1.00
prek-head run detect-private-key --all-files 18.6 ± 1.3 16.3 20.9 1.02 ± 0.10

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 24.1 ± 2.1 20.8 27.2 1.02 ± 0.12
prek-head run fix-byte-order-marker --all-files 23.8 ± 2.0 20.7 27.7 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.9 ± 0.1 4.8 5.1 1.00
prek-head install-hooks 4.9 ± 0.1 4.8 5.0 1.00 ± 0.03

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 4.8 ± 0.1 4.6 4.9 1.03 ± 0.03
prek-head install-hooks 4.7 ± 0.1 4.5 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 48.5 ± 1.1 46.9 50.7 1.00
prek-head run 49.2 ± 0.8 47.6 50.5 1.01 ± 0.03

prek run --files '*.json' (specific file type)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 8.5 ± 0.1 8.3 8.9 1.00
prek-head run --files '*.json' 8.6 ± 0.3 8.4 9.8 1.01 ± 0.04
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 10.7 ± 0.2 10.5 11.2 1.00
prek-head run --dry-run --all-files 10.8 ± 0.3 10.5 11.8 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 12.8 ± 0.2 12.6 13.3 1.04 ± 0.05
prek-head run check-hooks-apply --all-files 12.3 ± 0.6 11.3 12.9 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.4 ± 0.2 11.1 11.7 1.00 ± 0.03
prek-head run check-useless-excludes --all-files 11.4 ± 0.3 11.0 12.2 1.00

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 10.4 ± 0.1 10.2 10.7 1.00
prek-head run identity --all-files 10.5 ± 0.2 10.2 11.0 1.01 ± 0.02

Copilot AI review requested due to automatic review settings May 9, 2026 07:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread crates/prek/tests/run.rs
@j178 j178 merged commit a50ac8d into master May 9, 2026
38 checks passed
@j178 j178 deleted the tilde-paths branch May 9, 2026 07:35
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request May 19, 2026
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [prek](https://github.com/j178/prek) | minor | `0.3.13` → `0.4.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>j178/prek (prek)</summary>

### [`v0.4.0`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#040)

[Compare Source](j178/prek@v0.3.13...v0.4.0)

Released on 2026-05-14.

##### Breaking changes

These are narrow cleanup breaks in behavior that was either temporary or never worked correctly. Most users should not need to change anything.

- Generated hook scripts no longer preserve `-q`, `-v`, or `--no-progress` passed to `prek install`. This only affects users who expected those global flags to be baked into installed hooks. ([#&#8203;1966](j178/prek#1966))
- `language_version` no longer accepts direct executable paths. Use `language_version: system` for a system toolchain, or use a supported version request instead. This path form did not work reliably before, so existing working configs should be unaffected. ([#&#8203;1831](j178/prek#1831))

##### Enhancements

- Expand tilde in `--config`, `--cd`, `--log-file` and `--git-dir` ([#&#8203;2063](j178/prek#2063))
- Prevent auto-update cooldown downgrades ([#&#8203;2055](j178/prek#2055))
- Use managed npm cache for node hooks ([#&#8203;2075](j178/prek#2075))

##### Bug fixes

- Fix npm config env overrides for node hooks ([#&#8203;2074](j178/prek#2074))

##### Documentation

- Add cookbook page for enabling Git 2.54 config-based global hooks ([#&#8203;2061](j178/prek#2061))

##### Contributors

- [@&#8203;j178](https://github.com/j178)

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xNzguMCIsInVwZGF0ZWRJblZlciI6IjQzLjE3OC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiLCJhdXRvbWF0aW9uOmJvdC1hdXRob3JlZCIsImRlcGVuZGVuY3ktdHlwZTo6bWlub3IiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

prek hook-impl cannot find config file if you use --config=<path>

2 participants