Struct FilePresenceRule 

pub struct FilePresenceRule { /* private fields */ }

Ensures that specific files exist (or do not exist) in the project.

Unlike other rules, this doesn’t scan file content — it checks whether required files are present and forbidden files are absent. Useful for enforcing project conventions like “every project must have a .env.example” or “.env files should not be committed.”

The required_files config field lists relative paths that must exist. The forbidden_files config field lists relative paths that must NOT exist. The rule emits one violation per missing required file or present forbidden file.

Implementations

impl FilePresenceRule

pub fn new(config: &RuleConfig) -> Result<Self, RuleBuildError>

pub fn check_paths(&self, root_paths: &[PathBuf]) -> Vec<Violation>

Check which required files are missing and which forbidden files exist. Returns violations for each missing required file or present forbidden file.

Trait Implementations

impl Debug for FilePresenceRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Rule for FilePresenceRule

fn id(&self) -> &str

Unique identifier for this rule (e.g. "tailwind-dark-mode").

fn severity(&self) -> Severity

Severity level reported when the rule fires.

fn file_glob(&self) -> Option<&str>

Optional glob pattern restricting which files are scanned.

fn check_file(&self, _ctx: &ScanContext<'_>) -> Vec<Violation>

Scan a single file and return any violations found.