Skip to content

file_exists

Every glob match in paths must correspond to a real file. Use an array to accept any of several names.

- id: readme-exists
kind: file_exists
paths: ["README.md", "README", "README.rst"]
root_only: true
level: error

Fix: file_create — write a declared content. With an array of paths, the fix creates the first entry.

Optional git_tracked_only: true further requires that the matching file be in git’s index — useful for rules like “every release must commit a CHANGELOG entry” where local-only files shouldn’t satisfy the requirement. Outside a git repo, the rule fails (no file qualifies). See The walker and .gitignore for the full semantics.

OptionTypeRequiredDefaultDescription
git_tracked_onlybooleanfalseRestrict matches to files tracked in git’s index: entries present in the walked tree but not in git ls-files are skipped. No effect outside a git repo. Default false.
respect_gitignorebooleannullPer-rule override for the workspace respect_gitignore setting. When false, this rule’s literal-path checks also stat the filesystem directly, so it sees files that are tracked AND .gitignore-masked (the bazel-style .bazelversion pattern — pitfall #18 in docs/development/CONFIG-AUTHORING.md). Honoured only by file_exists literal paths; glob patterns fall through to the workspace setting. Default: inherit the workspace respect_gitignore.
root_onlybooleanfalseIf true, only files directly at the repository root satisfy the rule.

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