Rename `prek install-hooks` to `prek prepare-hooks`, `prek install --install-hooks` to `prek install --prepare-hooks` by j178 · Pull Request #1766 · j178/prek

j178 · 2026-03-10T04:11:06Z

This renames the hook environment setup surface from install-hooks to prepare-hooks to make the distinction between two different actions clearer:

prek install installs Git hook shims under .git/hooks
prek prepare-hooks prepares the managed hook environments and caches

The old naming used "install" for both concepts, which was easy to misread, especially in forms like prek install --install-hooks. The new names make the behavior more explicit:

prek install --prepare-hooks
prek prepare-hooks

Compatibility is preserved, so existing workflows continue to work.

Closes #1762

…install-hooks` to `prek install --prepare-hooks` This renames the hook environment setup surface from `install-hooks` to `prepare-hooks` to make the distinction between two different actions clearer: - `prek install` installs Git hook shims under .git/hooks - `prek prepare-hooks` prepares the managed hook environments and caches The old naming used "install" for both concepts, which was easy to misread, especially in forms like `prek install --install-hooks`. The new names make the behavior more explicit: - prek install --prepare-hooks - prek prepare-hooks Compatibility is preserved, so existing workflows continue to work.

codecov · 2026-03-10T04:12:55Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.56%. Comparing base (9028e0d) to head (49dd4b6).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1766      +/-   ##
==========================================
- Coverage   91.66%   91.56%   -0.11%     
==========================================
  Files          98       98              
  Lines       19847    19847              
==========================================
- Hits        18193    18172      -21     
- Misses       1654     1675      +21

☔ 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

Pull request overview

This PR renames the hook-environment setup surface from install-hooks to prepare-hooks to better distinguish “installing Git hook shims” from “preparing managed hook environments”, while keeping compatibility via aliases.

Changes:

Renames the install-hooks subcommand to prepare-hooks and updates dispatch/wiring.
Renames prek install --install-hooks to prek install --prepare-hooks (with --install-hooks preserved as an alias).
Updates docs and integration test snapshots to reflect the new naming and clarified semantics.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
docs/faq.md	Updates FAQ wording and clarifies `--prepare-hooks` behavior and hook-type/stages semantics.
docs/cli.md	Updates CLI reference for renamed command/flag and revised help text.
docs/benchmark.md	Updates benchmark command/examples to `prek prepare-hooks`.
crates/prek/tests/run.rs	Updates completion snapshot output for renamed subcommand/description.
crates/prek/tests/install.rs	Updates install-related snapshots/docs to use `--prepare-hooks` and `prepare-hooks`.
crates/prek/tests/common/mod.rs	Renames test helper from `install_hooks()` to `prepare_hooks()`.
crates/prek/src/main.rs	Updates command matching and passes `prepare_hooks` into install flow.
crates/prek/src/cli/mod.rs	Renames clap subcommand/args, adds aliases for backward compatibility, updates help text.
crates/prek/src/cli/install.rs	Renames `install_hooks` CLI entrypoint to `prepare_hooks` and updates call sites.

crates/prek/src/cli/mod.rs

docs/cli.md

prek-ci-bot · 2026-03-10T04:18:05Z

📦 Cargo Bloat Comparison

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

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_38_0_aes_gcm_encrypt_avx512
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_38_0_aes_gcm_decrypt_avx512
 0.3%   0.6%  77.6KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  71.7KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.3%   0.6%  69.8KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  50.6KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  46.4KiB              prek prek::run::{{closure}}
 0.2%   0.3%  41.8KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  32.0KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_38_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.8KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_38_0_edwards25519_scalarmuldouble
 0.1%   0.2%  25.8KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  24.9KiB             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%  23.1KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  22.4KiB      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%  22.0KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  21.5KiB              prek prek::workspace::Project::init_hooks::{{closure}}
41.1%  85.9%  10.2MiB                   And 23253 smaller methods. Use -n N to show more.
47.8% 100.0%  11.8MiB                   .text section size, the file size is 24.7MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_38_0_aes_gcm_encrypt_avx512
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_38_0_aes_gcm_decrypt_avx512
 0.3%   0.6%  77.6KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  71.4KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.3%   0.6%  69.8KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  50.6KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  46.4KiB              prek prek::run::{{closure}}
 0.2%   0.3%  41.8KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  32.0KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_38_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.8KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_38_0_edwards25519_scalarmuldouble
 0.1%   0.2%  25.8KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  24.9KiB             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%  23.1KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  22.4KiB      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%  22.0KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  21.5KiB              prek prek::workspace::Project::init_hooks::{{closure}}
41.1%  85.9%  10.2MiB                   And 23252 smaller methods. Use -n N to show more.
47.8% 100.0%  11.8MiB                   .text section size, the file size is 24.7MiB

prek-ci-bot · 2026-03-10T04:18:05Z

⚡️ Hyperfine Performance

Environment

OS: Linux 6.14.0-1017-azure
CPU: 4 cores
prek version: prek 0.3.5+4 (bffcd7d 2026-03-10)
Rust version: rustc 1.94.0 (4a4ef493e 2026-03-02)
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.6 ± 0.1	2.5	2.9	1.00
`prek-head --version`	2.6 ± 0.1	2.5	2.9	1.00 ± 0.05

`prek list`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base list`	9.5 ± 0.1	9.3	10.0	1.00
`prek-head list`	9.6 ± 0.1	9.4	10.3	1.01 ± 0.02

`prek validate-config .pre-commit-config.yaml`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base validate-config .pre-commit-config.yaml`	3.5 ± 0.1	3.4	3.7	1.01 ± 0.03
`prek-head validate-config .pre-commit-config.yaml`	3.5 ± 0.1	3.4	3.6	1.00

`prek sample-config`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base sample-config`	2.9 ± 0.1	2.8	3.1	1.00
`prek-head sample-config`	3.0 ± 0.1	2.8	3.1	1.01 ± 0.03

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`	165.0 ± 6.7	158.3	181.9	1.02 ± 0.04
`prek-head run --all-files`	162.1 ± 1.4	160.1	164.1	1.00

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

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run --all-files`	163.9 ± 2.8	159.7	168.8	1.00
`prek-head run --all-files`	164.9 ± 2.0	162.3	169.9	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`	164.1 ± 2.7	159.0	170.8	1.00
`prek-head run --all-files`	169.3 ± 3.8	161.6	179.4	1.03 ± 0.03

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`	24.4 ± 0.6	23.3	25.1	1.00
`prek-head run trailing-whitespace --all-files`	24.5 ± 0.7	23.4	26.4	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`	31.0 ± 2.4	27.9	36.4	1.00
`prek-head run end-of-file-fixer --all-files`	31.4 ± 2.1	28.0	35.0	1.01 ± 0.10

`prek run check-json --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run check-json --all-files`	14.9 ± 0.3	14.4	15.6	1.06 ± 0.04
`prek-head run check-json --all-files`	14.1 ± 0.5	13.1	15.1	1.00

`prek run check-yaml --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run check-yaml --all-files`	13.4 ± 0.3	13.0	14.6	1.00
`prek-head run check-yaml --all-files`	13.4 ± 0.2	13.1	14.1	1.00 ± 0.03

`prek run check-toml --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run check-toml --all-files`	13.8 ± 0.3	13.2	14.4	1.01 ± 0.03
`prek-head run check-toml --all-files`	13.7 ± 0.4	13.2	14.7	1.00

`prek run check-xml --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run check-xml --all-files`	13.6 ± 0.3	13.2	14.2	1.01 ± 0.03
`prek-head run check-xml --all-files`	13.5 ± 0.3	13.0	14.1	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`	5.4 ± 0.1	5.2	5.5	1.01 ± 0.02
`prek-head install-hooks`	5.4 ± 0.1	5.3	5.5	1.00

`prek install-hooks (warm - with cache)`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base install-hooks`	5.5 ± 0.1	5.3	5.6	1.00
`prek-head install-hooks`	5.6 ± 0.2	5.5	5.9	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`	21.2 ± 0.2	20.9	21.7	1.00
`prek-head run`	21.2 ± 0.2	20.7	21.8	1.00 ± 0.01

`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.4	8.9	1.02 ± 0.02
`prek-head run --files '*.json'`	8.4 ± 0.1	8.2	8.6	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`	13.7 ± 0.2	13.4	14.0	1.00
`prek-head run --dry-run --all-files`	13.9 ± 0.2	13.5	14.2	1.01 ± 0.02

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`	16.2 ± 0.2	16.0	16.6	1.00
`prek-head run check-hooks-apply --all-files`	16.6 ± 0.6	16.1	17.8	1.02 ± 0.04

`prek run check-useless-excludes --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run check-useless-excludes --all-files`	15.9 ± 2.9	14.0	25.0	1.11 ± 0.20
`prek-head run check-useless-excludes --all-files`	14.3 ± 0.1	14.2	14.5	1.00

`prek run identity --all-files`

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`prek-base run identity --all-files`	12.5 ± 0.2	12.2	12.9	1.00
`prek-head run identity --all-files`	12.5 ± 0.1	12.3	12.7	1.01 ± 0.02

Copilot AI review requested due to automatic review settings March 10, 2026 04:11

j178 added the enhancement New feature or request label Mar 10, 2026

Copilot started reviewing on behalf of j178 March 10, 2026 04:11 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

crates/prek/src/cli/mod.rs Show resolved Hide resolved

docs/cli.md Show resolved Hide resolved

Add tests

49dd4b6

j178 merged commit 9009dc0 into master Mar 10, 2026
50 of 51 checks passed

j178 deleted the rename branch March 10, 2026 05:06

BrewTestBot mentioned this pull request Mar 16, 2026

prek 0.3.6 Homebrew/homebrew-core#272532

Merged

Conversation

j178 commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

prek-ci-bot bot commented Mar 10, 2026

📦 Cargo Bloat Comparison

Head Branch Results

Base Branch Results

Uh oh!

prek-ci-bot bot commented Mar 10, 2026

⚡️ Hyperfine Performance

prek --version

prek list

prek validate-config .pre-commit-config.yaml

prek sample-config

prek run --all-files (cold - no cache)

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

prek run --all-files (full builtin hook suite)

prek run trailing-whitespace --all-files

prek run end-of-file-fixer --all-files

prek run check-json --all-files

prek run check-yaml --all-files

prek run check-toml --all-files

prek run check-xml --all-files

prek install-hooks (cold - no cache)

prek install-hooks (warm - with cache)

prek run (staged files only)

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

prek run --dry-run --all-files (measures init overhead)

prek run check-hooks-apply --all-files

prek run check-useless-excludes --all-files

prek run identity --all-files

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

j178 commented Mar 10, 2026 •

edited

Loading

codecov bot commented Mar 10, 2026 •

edited

Loading

`prek --version`

`prek list`

`prek validate-config .pre-commit-config.yaml`

`prek sample-config`

`prek run --all-files (cold - no cache)`

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

`prek run --all-files (full builtin hook suite)`

`prek run trailing-whitespace --all-files`

`prek run end-of-file-fixer --all-files`

`prek run check-json --all-files`

`prek run check-yaml --all-files`

`prek run check-toml --all-files`

`prek run check-xml --all-files`

`prek install-hooks (cold - no cache)`

`prek install-hooks (warm - with cache)`

`prek run (staged files only)`

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

`prek run --dry-run --all-files (measures init overhead)`

`prek run check-hooks-apply --all-files`

`prek run check-useless-excludes --all-files`

`prek run identity --all-files`