for_each_dir
For every matching directory / file, evaluate a nested require: block with the entry as context. Template tokens ({dir}, {stem}, {ext}, {basename}, {path}, {parent_name}) expand against each match. select: is a single glob or a list with !-prefixed excludes (e.g. ["src/*", "!src/internal"]).
- id: every-pkg-has-readme kind: for_each_dir select: "packages/*" require: - kind: file_exists paths: "{path}/README.md"when_iter: — per-iteration filter. Optional expression in the when: grammar, with one extra namespace: iter.* references the entry currently being iterated. Iterations whose verdict is false are skipped before any nested rule is built — the canonical use case for monorepos shaped like Cargo / pnpm / Bazel workspaces:
- id: workspace-member-has-readme kind: for_each_dir select: "crates/*" when_iter: 'iter.has_file("Cargo.toml")' require: - kind: file_exists paths: "{path}/README.md" level: errorThe iter namespace exposes:
| Reference | Type | Notes |
|---|---|---|
iter.path | string | Relative path of the iterated entry. |
iter.basename | string | Basename. |
iter.parent_name | string | Parent dir name. |
iter.stem | string | Basename minus the final extension (mainly useful for files). |
iter.ext | string | Final extension without the dot. |
iter.is_dir | bool | True for for_each_dir, false for for_each_file; always available. |
iter.has_file(pattern) | bool | Glob match relative to the iterated dir. iter.has_file("Cargo.toml"), iter.has_file("**/*.bzl"). Always false for file iteration. |
when_iter: composes with the rule’s outer when: (whole-rule gate, evaluated once) and with each nested rule’s when: (which now also sees the same iter.* context). Same field is available on for_each_file and every_matching_has.
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
require | list of nested rule | yes | Nested rules evaluated against each matched directory. | |
select | string or list of string | yes | Glob(s) selecting the directories to iterate — a single glob, or a list with !-prefixed excludes (e.g. [“src/*”, “!src/internal”]). | |
when_iter | string | Per-iteration when: filter — evaluated against iter.* in the iterated entry’s context. Iterations whose verdict is false are skipped before any nested rule is built. Examples: iter.has_file("Cargo.toml"), iter.basename matches "^pkg-". |
Plus the common level, id, and when fields. This rule analyses the whole repository, so it takes no paths. This table is generated from the JSON Schema; option types and defaults are authoritative.