Struct MD041FirstLineHeading 

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

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>

allow_preamble: bool

fix_enabled: bool

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>, fix_enabled: bool, ) -> Self

pub fn with_allow_preamble(self, allow_preamble: bool) -> Self

Allow content before the document’s first heading.

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 fix_capability(&self) -> FixCapability

Fixing is opt-in: adding a document title is a content decision, so the rule reports no fix capability until fix = true turns it on. Once on it is only ever conditional, because a document with no heading to promote or move has nothing the fixer can safely do.

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 config_schema(&self) -> Option<(String, Value)>

Returns the rule name and every config key the rule accepts, for validation.

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

fn skippable_by_category(&self) -> bool

Whether the content-category prefilter may skip this rule.

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 polymorphic_config_keys(&self) -> &'static [&'static str]

Returns the list of config keys whose deserializer accepts more than one TOML type (e.g. either a scalar or a list). The schema is built from a serialized default that can only encode one variant, so the validator would reject the alternative form. The registry replaces the schema entry for each listed key with a polymorphic sentinel so type checking is skipped while the key name is still validated. The registry rewrites Rule::config_schema, so default_config_section() keeps returning the clean user-facing default.

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

fn observes_suppressions(&self) -> bool

Whether this rule reports on the inline comments that suppressed warnings

fn check_suppressions( &self, _ctx: &LintContext<'_>, _report: &SuppressionReport, ) -> LintResult

Report on a document’s inline disable comments