Skip to content

Improve file pattern parse errors#1829

Merged
j178 merged 3 commits intomasterfrom
untagged
Mar 19, 2026
Merged

Improve file pattern parse errors#1829
j178 merged 3 commits intomasterfrom
untagged

Conversation

@j178
Copy link
Copy Markdown
Owner

@j178 j178 commented Mar 19, 2026

No description provided.

@j178 j178 added the enhancement New feature or request label Mar 19, 2026
Copilot AI review requested due to automatic review settings March 19, 2026 06:27
@j178 j178 added the error message Better error message label Mar 19, 2026
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: 9055186240

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 improves the user-facing error message produced when parsing invalid files/exclude file-pattern values in .pre-commit-config.yaml, making the expected formats clearer within prek’s config parsing layer.

Changes:

  • Add a custom serde deserializer for FilePatternWire to provide clearer “expected …” parse errors for file patterns.
  • Extend the invalid_config integration test snapshot to assert the new, more specific parse error text.
  • Update this repo’s .pre-commit-config.yaml top-level exclude to use prek’s glob-mapping form.

Reviewed changes

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

File Description
crates/prek/src/config.rs Implements a custom Deserialize for file-pattern wire types to improve parse error messaging.
crates/prek/tests/run.rs Adds a snapshot assertion covering invalid files pattern type errors.
.pre-commit-config.yaml Switches snapshot exclusion from a regex string to a glob: mapping.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 19, 2026

Codecov Report

❌ Patch coverage is 91.66667% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.78%. Comparing base (8b8f1c5) to head (f55eb32).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
crates/prek/src/config.rs 91.66% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1829      +/-   ##
==========================================
- Coverage   91.81%   91.78%   -0.04%     
==========================================
  Files          98       98              
  Lines       20059    20119      +60     
==========================================
+ Hits        18418    18467      +49     
- Misses       1641     1652      +11     

☔ 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.

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Mar 19, 2026

📦 Cargo Bloat Comparison

Binary size change: +0.00% (24.8 MiB → 24.8 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.0KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  72.6KiB             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%  47.1KiB              prek prek::run::{{closure}}
 0.2%   0.3%  41.9KiB              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%  26.2KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  25.3KiB             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.6KiB              prek prek::workspace::Project::init_hooks::{{closure}}
41.2%  86.0%  10.2MiB                   And 23349 smaller methods. Use -n N to show more.
47.9% 100.0%  11.9MiB                   .text section size, the file size is 24.8MiB

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.7%  82.4KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.3%   0.6%  77.5KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 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%  47.1KiB              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%  26.2KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  25.3KiB             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.0KiB              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.6KiB              prek prek::workspace::Project::init_hooks::{{closure}}
41.0%  85.9%  10.2MiB                   And 23317 smaller methods. Use -n N to show more.
47.8% 100.0%  11.9MiB                   .text section size, the file size is 24.8MiB

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Mar 19, 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.6+19 (fefc37f 2026-03-19)
  • 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.5 ± 0.2 2.2 3.2 1.04 ± 0.08
prek-head --version 2.4 ± 0.1 2.2 2.6 1.00

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.1 ± 0.2 8.8 9.8 1.01 ± 0.03
prek-head list 9.0 ± 0.2 8.8 11.1 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.4 1.02 ± 0.02
prek-head validate-config .pre-commit-config.yaml 3.2 ± 0.0 3.0 3.3 1.00

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.6 ± 0.1 2.6 3.2 1.00 ± 0.04
prek-head sample-config 2.6 ± 0.0 2.5 2.8 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 156.8 ± 2.1 153.9 160.2 1.00
prek-head run --all-files 157.9 ± 2.5 154.0 161.2 1.01 ± 0.02

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 158.6 ± 2.7 153.4 164.8 1.01 ± 0.02
prek-head run --all-files 156.2 ± 2.4 151.9 162.4 1.00
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 157.5 ± 3.7 152.6 170.5 1.00
prek-head run --all-files 161.4 ± 23.3 153.5 321.1 1.02 ± 0.15
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.2 ± 0.4 21.3 23.0 1.01 ± 0.03
prek-head run trailing-whitespace --all-files 21.9 ± 0.4 21.1 22.8 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.9 ± 1.9 26.1 32.8 1.00 ± 0.10
prek-head run end-of-file-fixer --all-files 28.8 ± 2.0 25.9 35.5 1.00

prek run check-json --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-json --all-files 12.3 ± 0.4 11.8 13.4 1.00 ± 0.04
prek-head run check-json --all-files 12.2 ± 0.3 11.7 12.7 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.7 12.8 1.00 ± 0.03
prek-head run check-yaml --all-files 11.9 ± 0.3 11.5 12.8 1.00

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 12.2 ± 0.3 11.7 13.0 1.01 ± 0.03
prek-head run check-toml --all-files 12.1 ± 0.2 11.7 12.5 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.9 13.1 1.01 ± 0.03
prek-head run check-xml --all-files 12.2 ± 0.2 11.7 12.6 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.9 ± 1.1 16.7 21.6 1.01 ± 0.08
prek-head run detect-private-key --all-files 18.8 ± 1.2 16.6 21.4 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 24.2 ± 1.4 21.4 27.2 1.01 ± 0.08
prek-head run fix-byte-order-marker --all-files 24.0 ± 1.4 21.1 26.8 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.0 1.00 ± 0.02
prek-head install-hooks 4.9 ± 0.1 4.8 4.9 1.00

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 4.8 ± 0.0 4.8 4.9 1.00 ± 0.01
prek-head install-hooks 4.8 ± 0.0 4.7 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 53.2 ± 0.8 52.0 54.9 1.00
prek-head run 53.5 ± 1.1 52.0 55.6 1.01 ± 0.02

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.3 1.01 ± 0.02
prek-head run --files '*.json' 9.0 ± 0.1 8.8 9.3 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 15.3 ± 1.8 14.0 19.9 1.07 ± 0.12
prek-head run --dry-run --all-files 14.3 ± 0.2 14.0 14.6 1.00
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.1 ± 0.1 13.8 14.2 1.00
prek-head run check-hooks-apply --all-files 14.2 ± 0.1 14.0 14.5 1.01 ± 0.01

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-useless-excludes --all-files 13.7 ± 0.6 12.5 14.2 1.10 ± 0.05
prek-head run check-useless-excludes --all-files 12.5 ± 0.2 12.3 13.0 1.00

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 11.0 ± 0.1 10.9 11.2 1.00 ± 0.01
prek-head run identity --all-files 11.0 ± 0.1 10.9 11.2 1.00

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 19, 2026 06:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 improves how prek reports configuration parse errors for file pattern fields (e.g., files / exclude) by customizing deserialization and adding coverage to lock in the new error message behavior.

Changes:

  • Implement custom serde deserialization for FilePatternWire to produce clearer “expected …” errors for invalid types.
  • Add an integration test snapshot asserting the improved parse error when files has an invalid type.
  • Update this repo’s .pre-commit-config.yaml to use the glob mapping form for exclude.

Reviewed changes

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

File Description
crates/prek/src/config.rs Adds a custom Deserialize impl for FilePatternWire to improve parse error messages for file patterns.
crates/prek/tests/run.rs Adds a snapshot test covering invalid files type error messaging.
.pre-commit-config.yaml Switches exclude to the glob mapping form (prek-only glob support).

@j178 j178 merged commit c09510e into master Mar 19, 2026
50 checks passed
@j178 j178 deleted the untagged branch March 19, 2026 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request error message Better error message

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants