Struct Engine 

pub struct Engine { /* private fields */ }

The linting engine.

Bundles a profile and a set of rules, and exposes methods to lint strings, files, and stdin-sourced text.

Implementations

impl Engine

pub fn with_profile(profile: Profile) -> Self

Build an engine with the default rule set for the given profile.

pub fn with_profile_and_conditions( profile: Profile, conditions: &[ConditionTag], ) -> Self

Build an engine for the given profile, restricting the rule set to rules tagged general plus those whose condition tags intersect with conditions (F71 + F72).

pub fn with_profile_conditions_and_experimental( profile: Profile, conditions: &[ConditionTag], experimental: &ExperimentalOptIn, ) -> Self

Build an engine with the F71/F72 condition filter and the F139 experimental opt-in applied together.

Filtering order: experimental first (drops crate::rules::Status::Experimental rules the user did not opt in to), then conditions. Order is observably equivalent — both filters are pure subset operations — but experimental-first keeps the cardinality cheaper.

pub fn with_rules(profile: Profile, rules: Vec<Box<dyn Rule>>) -> Self

Build an engine with a custom rule set.

pub fn with_scoring_config(self, scoring_config: ScoringConfig) -> Self

Attach a custom ScoringConfig, overriding the defaults.

pub fn with_readability_formula(self, formula: FormulaChoice) -> Self

Override the ReadabilityScore rule’s formula choice (F11).

When FormulaChoice::Auto is passed the engine keeps the default per-language selection; other variants pin a concrete formula regardless of the document’s detected language.

If the rule set does not currently include a readability-score rule (e.g., it was filtered out), this is a no-op — the rule will not be re-added.

pub fn with_unexplained_whitelist(self, extra: Vec<String>) -> Self

Extend the UnexplainedAbbreviation rule’s user whitelist with project-specific entries (F31). The extras are additive over the profile baseline — callers typically use this to restore the narrower acronyms that F31 moved out of the shipped dev-doc baseline (WCAG, ARIA, ADHD, LLM, …).

If the rule set does not currently include an unexplained-abbreviation rule, this is a no-op.

pub fn with_excessive_commas_max_commas(self, max_commas: NonZeroU32) -> Self

Override the ExcessiveCommas rule’s max_commas threshold.

If the rule set does not currently include an excessive-commas rule (e.g., it was filtered out), this is a no-op.

pub const fn profile(&self) -> Profile

The profile this engine was configured with.

pub fn lint_str(&self, input: &str) -> Report

Lint a string input. Markdown syntax is assumed.

pub fn lint_stdin(&self, input: &str) -> Report

Lint stdin-like input.

pub fn lint_file(&self, path: &Path) -> Result<Report, EngineError>

Lint a file from disk.

Markdown is assumed for .md and .markdown extensions; other files are treated as plain text.

Errors

Returns EngineError::Io if the file cannot be read.