yaml_path_equals

Query a structured document with a JSONPath expression and assert every match deep-equals the supplied value.

- id: workflow-contents-read
  kind: yaml_path_equals
  paths: ".github/workflows/*.yml"
  path: "$.permissions.contents"
  equals: "read"
  level: error

- id: require-mit-license
  kind: json_path_equals
  paths: "packages/*/package.json"
  path: "$.license"
  equals: "MIT"
  level: error

- id: rust-edition-2024
  kind: toml_path_equals
  paths: "crates/*/Cargo.toml"
  path: "$.package.edition"
  equals: "2024"
  level: warning

- id: csproj-targets-net8
  kind: xml_path_equals
  paths: "**/*.csproj"
  path: "$.Project.PropertyGroup.TargetFramework"
  equals: "net8.0"
  level: error

Semantics:

Multiple matches — every match must equal the expected value.
Zero matches — counts as a violation (the key the rule is enforcing doesn’t exist).
Unparseable files — one violation per file (not silently skipped).

XML mapping (xml_path_*): XML is mapped to the queryable tree with the xmltodict-style convention so the JSONPath reads like the XML — the document is { <root-element>: … } ($.Project…, $.project…); attributes are @name keys (['@Version']); a leaf element collapses to its text (<TargetFramework>net8.0</TargetFramework> → "net8.0"); repeated sibling elements become an array (use dependency[*], which works for one or many); namespaces flatten to the local name (Maven’s default pom.xml namespace just works). Every XML leaf value is a string — quote the expected value (equals: "4.0.0", not equals: 4.0.0) or use xml_path_matches. Full rationale and edge cases: docs/design/v0.10/xml_path.md.

Options

Option	Type	Required	Default	Description
`equals`	any value	yes		Expected value. Any JSON type (string, number, boolean, null, array, object).
`if_present`	boolean		`false`	When true, a query returning zero matches is silently OK - only real matches that fail the op produce violations.
`path`	string	yes		`JSONPath` expression rooted at `$`. Supports dot-access (`$.foo.bar`), array index (`$.deps[0]`), wildcards (`$.deps[*]`), filters, and every other RFC 9535 construct.

Plus the common paths, level, id, and when fields. This table is generated from the JSON Schema; option types and defaults are authoritative.

yaml_path_equals

Options

See also