Struct LintOptions 

pub struct LintOptions {
    pub files: Vec<String>,
    pub strings: HashMap<String, String>,
    pub config: Option<Config>,
    pub config_file: Option<String>,
    pub custom_rules: Vec<BoxedRule>,
    pub front_matter: Option<String>,
    pub no_inline_config: bool,
    pub result_version: u32,
    pub handle_rule_failures: bool,
}

Options for linting markdown content

Fields

files: Vec<String>

Files to lint (paths)

strings: HashMap<String, String>

Strings to lint (keyed by identifier)

config: Option<Config>

Configuration object

config_file: Option<String>

Path to configuration file

custom_rules: Vec<BoxedRule>

Custom rules to use

front_matter: Option<String>

Front matter pattern (regex)

no_inline_config: bool

Whether to ignore inline configuration

result_version: u32

Result version for backward compatibility

handle_rule_failures: bool

Handle errors during rule execution

Implementations

impl LintOptions

pub fn new() -> Self

Create a new LintOptions with default values

pub fn with_file(self, file: impl Into<String>) -> Self

Add a file to lint

pub fn with_files( self, files: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add multiple files to lint

pub fn with_string( self, name: impl Into<String>, content: impl Into<String>, ) -> Self

Add a string to lint

pub fn with_config(self, config: Config) -> Self

Set the configuration

pub fn with_config_file(self, path: impl Into<String>) -> Self

Set the configuration file path

pub fn with_custom_rule(self, rule: BoxedRule) -> Self

Add a custom rule

pub fn with_front_matter(self, pattern: impl Into<String>) -> Self

Set the front matter pattern

pub fn no_inline_config(self) -> Self

Disable inline configuration

Trait Implementations

impl Default for LintOptions

fn default() -> LintOptions

Returns the “default value” for a type.