Skip to content

Add --exclude option and pin config field for auto-update#1863

Open
thatmlopsguy wants to merge 3 commits intoj178:masterfrom
thatmlopsguy:master
Open

Add --exclude option and pin config field for auto-update#1863
thatmlopsguy wants to merge 3 commits intoj178:masterfrom
thatmlopsguy:master

Conversation

@thatmlopsguy
Copy link
Copy Markdown

This PR adds two complementary ways to skip repositories during prek auto-update. Inspired by similar project pre-commit-update.

  • -e, --exclude — Exclude repos by substring match at runtime
  • pin config field — Permanently pin a repo to skip it during auto-update

Both are useful when you need to stay on a specific version of a hook repository — for example, while upgrading your codebase to be compatible with a newer release.

# Exclude a single repo
prek auto-update --exclude ruff

# Exclude multiple repos
prek auto-update --exclude ruff --exclude isort

# Exclude all repos (useful for dry-testing other flags)
prek auto-update --exclude '*'

Using --exclude '*' also prevents combining with --bleeding-edge, since updating nothing to bleeding edge is contradictory.

A per-repo boolean field that causes auto-update to silently skip the repository:

[[repos]]
repo = "https://github.com/psf/black"
rev = "24.1.0"
pin = true
hooks = [{ id = "black" }]
repos:
  - repo: https://github.com/psf/black
    rev: v24.1.0
    pin: true
    hooks:
      - id: black

@thatmlopsguy thatmlopsguy requested a review from j178 as a code owner March 25, 2026 19:02
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.17%. Comparing base (b13d378) to head (e345bc9).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1863      +/-   ##
==========================================
+ Coverage   92.16%   92.17%   +0.01%     
==========================================
  Files         109      109              
  Lines       21855    21874      +19     
==========================================
+ Hits        20142    20162      +20     
+ Misses       1713     1712       -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.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e345bc94b7

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Mar 25, 2026

📦 Cargo Bloat Comparison

Binary size change: +0.00% (25.4 MiB → 25.4 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_39_0_aes_gcm_encrypt_avx512
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  83.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  76.1KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  71.1KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.5%  56.8KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  47.6KiB              prek prek::run::{{closure}}
 0.2%   0.3%  41.9KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  32.6KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_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_39_0_edwards25519_scalarmuldouble
 0.1%   0.2%  25.8KiB             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%  25.8KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  24.2KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{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%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
 0.1%   0.2%  21.5KiB         [Unknown] Lp384_montjscalarmul_p384_montjadd
41.5%  86.2%  10.5MiB                   And 23934 smaller methods. Use -n N to show more.
48.2% 100.0%  12.2MiB                   .text section size, the file size is 25.4MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_encrypt_avx512
 1.3%   2.7% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  83.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  76.1KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  70.5KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.5%  56.8KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  47.3KiB              prek prek::run::{{closure}}
 0.2%   0.3%  42.3KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  32.4KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_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_39_0_edwards25519_scalarmuldouble
 0.1%   0.2%  27.1KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  25.8KiB             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%  24.2KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{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%  21.5KiB              prek prek::workspace::Project::init_hooks::{{closure}}
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.5%  86.2%  10.5MiB                   And 23948 smaller methods. Use -n N to show more.
48.1% 100.0%  12.2MiB                   .text section size, the file size is 25.4MiB

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Mar 25, 2026

⚡️ Hyperfine Benchmarks

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

Environment
  • OS: Linux 6.14.0-1017-azure
  • CPU: 4 cores
  • prek version: prek 0.3.8+9 (bfa312b 2026-03-25)
  • 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.4 ± 0.1 2.3 3.3 1.00
prek-head --version 2.4 ± 0.1 2.3 2.8 1.00 ± 0.07

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.0 ± 0.1 8.7 9.2 1.00
prek-head list 9.0 ± 0.1 8.8 9.5 1.00 ± 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.2 ± 0.1 3.1 3.4 1.00
prek-head validate-config .pre-commit-config.yaml 3.2 ± 0.1 3.1 3.6 1.01 ± 0.03

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.7 ± 0.2 2.6 4.0 1.03 ± 0.07
prek-head sample-config 2.6 ± 0.0 2.5 2.7 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 154.6 ± 2.6 150.8 159.9 1.00
prek-head run --all-files 156.6 ± 2.4 153.0 160.3 1.01 ± 0.02

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 156.5 ± 2.0 153.0 159.2 1.00
prek-head run --all-files 157.1 ± 2.9 153.4 164.3 1.00 ± 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 156.7 ± 2.6 152.8 164.2 1.00
prek-head run --all-files 157.5 ± 7.1 151.1 201.6 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 22.0 ± 0.5 21.3 23.1 1.00 ± 0.03
prek-head run trailing-whitespace --all-files 21.9 ± 0.5 21.2 23.0 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.6 ± 2.2 25.3 34.5 1.00
prek-head run end-of-file-fixer --all-files 28.9 ± 2.4 25.3 34.1 1.01 ± 0.11

prek run check-json --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-json --all-files 13.2 ± 0.4 12.7 14.1 1.07 ± 0.04
prek-head run check-json --all-files 12.4 ± 0.4 11.9 13.5 1.00

prek run check-yaml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-yaml --all-files 11.9 ± 0.2 11.6 12.4 1.00
prek-head run check-yaml --all-files 12.1 ± 0.3 11.7 13.5 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 12.3 ± 0.3 11.8 13.0 1.00 ± 0.03
prek-head run check-toml --all-files 12.2 ± 0.2 11.8 12.8 1.00

prek run check-xml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-xml --all-files 12.3 ± 0.3 11.7 13.0 1.00
prek-head run check-xml --all-files 12.4 ± 0.4 11.7 13.7 1.01 ± 0.04

prek run detect-private-key --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run detect-private-key --all-files 19.4 ± 4.9 16.3 44.3 1.08 ± 0.28
prek-head run detect-private-key --all-files 18.0 ± 1.2 16.2 21.6 1.00

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 23.7 ± 1.5 20.8 26.7 1.00
prek-head run fix-byte-order-marker --all-files 24.1 ± 1.3 21.4 26.5 1.02 ± 0.09
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.0 ± 0.1 4.9 5.0 1.00
prek-head install-hooks 5.0 ± 0.0 5.0 5.1 1.01 ± 0.01

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 4.9 ± 0.1 4.8 5.0 1.01 ± 0.02
prek-head install-hooks 4.8 ± 0.1 4.8 4.9 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 53.7 ± 1.3 52.2 57.2 1.01 ± 0.03
prek-head run 53.3 ± 0.8 52.0 54.8 1.00

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 9.1 ± 0.1 8.9 9.4 1.01 ± 0.02
prek-head run --files '*.json' 9.1 ± 0.1 8.9 9.2 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 14.1 ± 0.2 13.8 14.4 1.00
prek-head run --dry-run --all-files 14.1 ± 0.1 13.9 14.3 1.00 ± 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 14.3 ± 0.1 14.1 14.5 1.08 ± 0.06
prek-head run check-hooks-apply --all-files 13.3 ± 0.7 12.7 14.4 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 12.7 ± 0.2 12.5 13.4 1.00
prek-head run check-useless-excludes --all-files 12.7 ± 0.2 12.5 13.1 1.00 ± 0.02

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 11.2 ± 0.1 11.0 11.5 1.00
prek-head run identity --all-files 11.3 ± 0.1 11.1 11.6 1.01 ± 0.02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant