Skip to content

Silently ignore x- extension keys in configuration - #2482

Merged
j178 merged 3 commits into
j178:masterfrom
udaya2899:issue-2481
Aug 4, 2026
Merged

Silently ignore x- extension keys in configuration#2482
j178 merged 3 commits into
j178:masterfrom
udaya2899:issue-2481

Conversation

@udaya2899

@udaya2899 udaya2899 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Following the convention used by tools like Docker Compose, OpenAPI, and GitLab CI, ignore any configuration keys starting with x- at any level (top-level config, repository entries, and hook entries). This allows users to define custom metadata and YAML anchors without triggering unexpected key warnings.

Fixes #2481

@udaya2899
Silently ignore x- extension keys in configuration files
8192630 
Following the convention used by tools like Docker Compose, OpenAPI,
and GitLab CI, ignore any configuration keys starting with `x-` at any
level (top-level config, repository entries, and hook entries). This
allows users to define custom metadata and YAML anchors without triggering
unexpected key warnings.

Fixes j178#2481
@udaya2899
udaya2899 requested a review from j178 as a code owner August 4, 2026 13:23
@udaya2899

udaya2899 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Verification

• Ran the snapshot review test suite (cargo test --test validate), confirming all tests pass.
• Verified code formatting with cargo fmt --check and linting with cargo clippy --workspace --all-targets -- -D warnings (zero warnings).

@codecov

codecov Bot commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.60%. Comparing base (3840c4d) to head (7a56c49).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #2482   +/-   ##
=======================================
  Coverage   93.60%   93.60%           
=======================================
  Files         131      131           
  Lines       28212    28215    +3     
=======================================
+ Hits        26407    26410    +3     
  Misses       1805     1805

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@prek-ci-bot

prek-ci-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

📦 Cargo Bloat Comparison

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

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.1%   2.3% 332.0KiB        aws_lc_sys aws_lc_0_43_0_aes_gcm_encrypt_avx512
 1.1%   2.3% 332.0KiB        aws_lc_sys aws_lc_0_43_0_aes_gcm_decrypt_avx512
 0.2%   0.5%  70.9KiB              prek <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  58.0KiB              prek <<prek::config::Config as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.2%   0.4%  56.6KiB              prek prek::run::{closure#0}
 0.2%   0.3%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.1%   0.3%  38.4KiB              prek prek::cli::run::run::run::{closure#0}
 0.1%   0.2%  34.3KiB              prek <prek::cli::RunOptions as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  33.5KiB              prek <prek::languages::ruby::installer::RubyInstaller>::install::{closure#0}
 0.1%   0.2%  30.1KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  29.4KiB              prek <<prek::config::RemoteHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  28.9KiB    cargo_metadata <&mut serde_json::de::Deserializer<serde_json::read::StrRead> as serde_core::de::Deserializer>::deserialize_struct::<<cargo_metadata::Package as serde_core::de::Deserialize>::deserialize::__Visitor>
 0.1%   0.2%  28.7KiB              prek <prek::languages::node::installer::NodeInstaller>::install::{closure#0}
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_43_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_43_0_edwards25519_scalarmuldouble
 0.1%   0.2%  26.9KiB              prek <prek::languages::deno::installer::DenoInstaller>::download::{closure#0}
 0.1%   0.2%  25.7KiB              prek prek::cli::try_repo::try_repo::{closure#0}
 0.1%   0.2%  25.6KiB              prek <<prek::config::LocalHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  25.2KiB              prek <<prek::config::UpdateOptions as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  24.9KiB               xml <xml::reader::parser::PullParser>::dispatch_token
42.3%  88.2%  12.5MiB                   And 26309 smaller methods. Use -n N to show more.
47.9% 100.0%  14.2MiB                   .text section size, the file size is 29.6MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.1%   2.3% 332.0KiB        aws_lc_sys aws_lc_0_43_0_aes_gcm_encrypt_avx512
 1.1%   2.3% 332.0KiB        aws_lc_sys aws_lc_0_43_0_aes_gcm_decrypt_avx512
 0.2%   0.5%  70.9KiB              prek <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  58.0KiB              prek <<prek::config::Config as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.2%   0.4%  56.6KiB              prek prek::run::{closure#0}
 0.2%   0.3%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.1%   0.3%  38.4KiB              prek prek::cli::run::run::run::{closure#0}
 0.1%   0.2%  34.3KiB              prek <prek::cli::RunOptions as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  33.5KiB              prek <prek::languages::ruby::installer::RubyInstaller>::install::{closure#0}
 0.1%   0.2%  30.1KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  29.4KiB              prek <<prek::config::RemoteHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  28.9KiB    cargo_metadata <&mut serde_json::de::Deserializer<serde_json::read::StrRead> as serde_core::de::Deserializer>::deserialize_struct::<<cargo_metadata::Package as serde_core::de::Deserialize>::deserialize::__Visitor>
 0.1%   0.2%  28.7KiB              prek <prek::languages::node::installer::NodeInstaller>::install::{closure#0}
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_43_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_43_0_edwards25519_scalarmuldouble
 0.1%   0.2%  26.9KiB              prek <prek::languages::deno::installer::DenoInstaller>::download::{closure#0}
 0.1%   0.2%  25.7KiB              prek prek::cli::try_repo::try_repo::{closure#0}
 0.1%   0.2%  25.6KiB              prek <<prek::config::LocalHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  25.2KiB              prek <<prek::config::UpdateOptions as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  24.9KiB               xml <xml::reader::parser::PullParser>::dispatch_token
42.3%  88.2%  12.5MiB                   And 26309 smaller methods. Use -n N to show more.
47.9% 100.0%  14.2MiB                   .text section size, the file size is 29.6MiB

@prek-ci-bot

prek-ci-bot Bot commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown

⚡️ Hyperfine Benchmarks

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

Environment
  • OS: Linux 6.17.0-1020-azure
  • CPU: 4 cores
  • prek version: prek 0.4.12+7 (cabd87b 2026-08-04)
  • Rust version: rustc 1.97.1 (8bab26f4f 2026-07-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.3 ± 0.1 2.2 2.7 1.05 ± 0.05
prek-head --version 2.2 ± 0.1 2.0 2.4 1.00

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.4 ± 0.1 9.2 9.8 1.03 ± 0.02
prek-head list 9.1 ± 0.1 8.9 9.4 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.3 ± 0.0 3.2 3.4 1.09 ± 0.02
prek-head validate-config .pre-commit-config.yaml 3.0 ± 0.0 3.0 3.1 1.00

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.5 ± 0.0 2.4 2.7 1.06 ± 0.03
prek-head sample-config 2.4 ± 0.0 2.3 2.5 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 38.2 ± 1.5 36.4 40.8 1.04 ± 0.05
prek-head run --all-files 36.8 ± 1.0 34.7 38.1 1.00

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 37.4 ± 0.9 35.8 39.0 1.01 ± 0.03
prek-head run --all-files 36.9 ± 0.7 35.8 38.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 37.5 ± 1.2 35.8 41.4 1.01 ± 0.04
prek-head run --all-files 37.1 ± 1.0 33.5 39.5 1.00
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 12.5 ± 0.4 11.9 13.8 1.01 ± 0.04
prek-head run trailing-whitespace --all-files 12.5 ± 0.3 11.9 13.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 10.9 ± 0.4 10.2 12.0 1.02 ± 0.05
prek-head run end-of-file-fixer --all-files 10.7 ± 0.3 10.1 11.3 1.00

prek run check-json --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-json --all-files 7.8 ± 0.3 7.2 8.3 1.03 ± 0.05
prek-head run check-json --all-files 7.5 ± 0.2 7.1 8.0 1.00

prek run check-yaml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-yaml --all-files 7.6 ± 0.1 7.4 7.9 1.01 ± 0.05
prek-head run check-yaml --all-files 7.5 ± 0.3 7.2 8.7 1.00

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 7.7 ± 0.3 7.3 8.3 1.03 ± 0.05
prek-head run check-toml --all-files 7.4 ± 0.2 6.9 7.8 1.00

prek run check-xml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-xml --all-files 7.6 ± 0.4 7.2 8.8 1.03 ± 0.06
prek-head run check-xml --all-files 7.3 ± 0.3 6.9 8.2 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 11.1 ± 0.8 10.0 13.3 1.04 ± 0.08
prek-head run detect-private-key --all-files 10.6 ± 0.4 9.8 11.3 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 12.6 ± 0.7 11.4 14.0 1.00
prek-head run fix-byte-order-marker --all-files 12.7 ± 0.8 11.3 14.2 1.01 ± 0.08
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.6 ± 0.1 4.6 4.7 1.05 ± 0.01
prek-head install-hooks 4.4 ± 0.0 4.4 4.5 1.00

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 4.7 ± 0.0 4.6 4.7 1.05 ± 0.02
prek-head install-hooks 4.4 ± 0.1 4.4 4.5 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 23.4 ± 0.4 22.6 24.2 1.00 ± 0.02
prek-head run 23.4 ± 0.4 22.7 24.0 1.00

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 5.2 ± 0.0 5.1 5.3 1.04 ± 0.02
prek-head run --files '*.json' 5.0 ± 0.1 4.9 5.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 7.0 ± 0.1 6.9 7.2 1.04 ± 0.02
prek-head run --dry-run --all-files 6.7 ± 0.1 6.6 7.1 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 8.1 ± 0.0 8.1 8.2 1.02 ± 0.01
prek-head run check-hooks-apply --all-files 7.9 ± 0.1 7.8 8.1 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 8.2 ± 0.1 8.0 8.3 1.02 ± 0.02
prek-head run check-useless-excludes --all-files 8.0 ± 0.1 7.8 8.3 1.00

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 7.1 ± 0.1 7.0 7.2 1.04 ± 0.01
prek-head run identity --all-files 6.8 ± 0.0 6.7 6.9 1.00

j178
j178 reviewed Aug 4, 2026
View reviewed changes
Comment thread docs/reference/configuration.md Outdated
Comment thread crates/prek/src/config.rs
@j178 j178 added the enhancement New feature or request label Aug 4, 2026
udaya2899 and others added 2 commits August 4, 2026 16:25
@udaya2899 @j178
Reduce verbosity of text
a91a979 
Co-authored-by: Jo <10510431+j178@users.noreply.github.com>
@udaya2899
Add comment explaining why x- extension keys are ignored
7a56c49
@udaya2899
udaya2899 requested a review from j178 August 4, 2026 14:31
@j178 j178 changed the title Silently ignore x- extension keys (#2481) Silently ignore x- extension keys in configuration Aug 4, 2026
@udaya2899

udaya2899 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

CI failure seems to be a github flake:

+[stderr]
+fatal: unable to access 'https://github.com/oven-sh/bun/': Failed to connect to github.com port 443 after 75010 ms: Couldn't connect to server

Can we retry?

@j178
j178 merged commit b5a98bb into j178:master Aug 4, 2026
67 of 69 checks passed
@j178

j178 commented Aug 4, 2026

Copy link
Copy Markdown
Owner

Thanks!

@udaya2899

udaya2899 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Really appreciate the quick turnaround. We'd like to use #2478 and this PR in our setup. Can I propose a new release with the next patch version 0.4.13?

@udaya2899
udaya2899 deleted the issue-2481 branch August 4, 2026 15:53
j178 pushed a commit that referenced this pull request Aug 4, 2026
@udaya2899 @j178
Silently ignore x- extension keys in configuration files (#2482)
1126236 
Following the convention used by tools like Docker Compose, OpenAPI,
and GitLab CI, ignore any configuration keys starting with `x-` at any
level (top-level config, repository entries, and hook entries). This
allows users to define custom metadata and YAML anchors without triggering
unexpected key warnings.

Fixes #2481

Reduce verbosity of text

Co-authored-by: Jo <10510431+j178@users.noreply.github.com>

Add comment explaining why x- extension keys are ignored
@j178

j178 commented Aug 4, 2026

Copy link
Copy Markdown
Owner

I'd like to wait until we've accumulated a few more changes before making the next release. This usually takes one or two weeks.

@udaya2899 udaya2899 mentioned this pull request Aug 4, 2026
Closed
@udaya2899

udaya2899 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Ah okay. That makes sense. Until then, it has to be built from source to use?

@udaya2899

udaya2899 commented Aug 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

https://github.com/udaya2899/prek/releases/tag/v0.4.13-dev I made a pre-release with 0.4.13-dev on the fork I used to make the contribution. This works for now to share with our developers until an official 0.4.13 release comes out including this. Thanks again for your support. :)

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

Reviewers

@j178 j178 Awaiting requested review from j178 j178 is a code owner

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Silently ignore top-level x- extension keys to support YAML anchors

2 participants

@udaya2899 @j178