Struct MD066FootnoteValidation 

pub struct MD066FootnoteValidation;

Rule MD066: Footnote validation - ensure all footnote references have definitions and vice versa

This rule validates footnote usage in markdown documents:

• Detects orphaned footnote references ([^1]) without corresponding definitions
• Detects orphaned footnote definitions ([^1]: text) that are never referenced

Footnote syntax (common markdown extension, not part of CommonMark):

• Reference: [^identifier] in text
• Definition: [^identifier]: definition text (can span multiple lines with indentation)

Examples

Valid:

This has a footnote[^1] that is properly defined.

[^1]: This is the footnote content.

Invalid - orphaned reference:

This references[^missing] a footnote that doesn't exist.

Invalid - orphaned definition:

[^unused]: This footnote is defined but never referenced.

Implementations

impl MD066FootnoteValidation

pub fn new() -> Self

Trait Implementations

impl Clone for MD066FootnoteValidation

fn clone(&self) -> MD066FootnoteValidation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MD066FootnoteValidation

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

Formats the value using the given formatter.

impl Default for MD066FootnoteValidation

fn default() -> MD066FootnoteValidation

Returns the “default value” for a type.

impl Rule for MD066FootnoteValidation

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 should_skip(&self, _ctx: &LintContext<'_>) -> bool

Check if this rule should quickly skip processing based on content

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

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_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