Skip to content

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"]).

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:

The iter namespace exposes:

ReferenceTypeNotes
iter.pathstringRelative path of the iterated entry.
iter.basenamestringBasename.
iter.parent_namestringParent dir name.
iter.stemstringBasename minus the final extension (mainly useful for files).
iter.extstringFinal extension without the dot.
iter.is_dirboolTrue for for_each_dir, false for for_each_file; always available.
iter.has_file(pattern)boolGlob 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.

OptionTypeRequiredDefaultDescription
requirelist of nested ruleyesNested rules evaluated against each matched directory.
selectstring or list of stringyesGlob(s) selecting the directories to iterate - a single glob, or a list with !-prefixed excludes (e.g. [“src/*”, “!src/internal”]).
when_iterstringPer-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.

The rule fires on this repository:

src/
src/alpha/
src/alpha/mod.rs
src/beta/
src/beta/lib.rs
src/gamma/
src/gamma/mod.rs
src/alpha/mod.rs
pub fn a() {}
src/beta/lib.rs
pub fn b() {}
src/gamma/mod.rs
pub fn c() {}

With this .alint.yml:

version: 1
rules:
- id: every-module-has-mod
kind: for_each_dir
select: "src/*"
require:
- kind: file_exists
paths: "{path}/mod.rs"
level: error

alint check reports:

Terminal window
--- src/beta -------------------------------------------------------------------
x error every-module-has-mod
expected a file matching [src/beta/mod.rs]
Summary (1 violation):
x 1 error
0 passing * 1 failing

This repository is compliant:

src/
src/alpha/
src/alpha/mod.rs
src/beta/
src/beta/mod.rs
src/alpha/mod.rs
pub fn a() {}
src/beta/mod.rs
pub fn b() {}

With this .alint.yml:

version: 1
rules:
- id: every-module-has-mod
kind: for_each_dir
select: "src/*"
require:
- kind: file_exists
paths: "{path}/mod.rs"
level: error

alint check reports:

Terminal window
v All 1 rule(s) passed.