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.