Struct MD041FirstLineHeading 

pub struct MD041FirstLineHeading {
    pub level: usize,
    pub front_matter_title: bool,
    pub front_matter_title_pattern: Option<Regex>,
}

Rule MD041: First line in file should be a top-level heading

See docs/md041.md for full documentation, configuration, and examples.

Fields

level: usize

front_matter_title: bool

front_matter_title_pattern: Option<Regex>

Implementations

impl MD041FirstLineHeading

pub fn new(level: usize, front_matter_title: bool) -> Self

pub fn with_pattern( level: usize, front_matter_title: bool, pattern: Option<String>, ) -> Self

Trait Implementations

impl Clone for MD041FirstLineHeading

fn clone(&self) -> MD041FirstLineHeading

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for MD041FirstLineHeading

fn default() -> Self

Returns the “default value” for a type.

impl Rule for MD041FirstLineHeading

fn should_skip(&self, ctx: &LintContext<'_>) -> bool

Check if this rule should be skipped

fn name(&self) -> &'static str

fn description(&self) -> &'static str

fn check(&self, ctx: &LintContext<'_>) -> LintResult

fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>

fn as_any(&self) -> &dyn Any

fn from_config(config: &Config) -> Box<dyn Rule>

where Self: Sized,

Factory: create a rule from config (if present), or use defaults.

fn default_config_section(&self) -> Option<(String, Value)>

Returns the rule name and default config table if the rule has config. If a rule implements this, it MUST be defined on the impl Rule for ... block, not just the inherent impl.

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

fn config_aliases(&self) -> Option<HashMap<String, String>>

Returns config key aliases for this rule This allows rules to accept alternative config key names for backwards compatibility

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule

fn cross_file_scope(&self) -> CrossFileScope

Declares cross-file analysis requirements for this rule

fn contribute_to_index( &self, _ctx: &LintContext<'_>, _file_index: &mut FileIndex, )

Contribute data to the workspace index during linting

fn cross_file_check( &self, _file_path: &Path, _file_index: &FileIndex, _workspace_index: &WorkspaceIndex, ) -> LintResult

Perform cross-file validation after all files have been linted