Struct MD032BlanksAroundLists 

pub struct MD032BlanksAroundLists { /* private fields */ }

Rule MD032: Lists should be surrounded by blank lines

This rule enforces that lists are surrounded by blank lines, which improves document readability and ensures consistent rendering across different Markdown processors.

Purpose

• Readability: Blank lines create visual separation between lists and surrounding content
• Parsing: Many Markdown parsers require blank lines around lists for proper rendering
• Consistency: Ensures uniform document structure and appearance
• Compatibility: Improves compatibility across different Markdown implementations

Examples

Correct

This is a paragraph of text.

- Item 1
- Item 2
- Item 3

This is another paragraph.

Incorrect

This is a paragraph of text.
- Item 1
- Item 2
- Item 3
This is another paragraph.

Behavior Details

This rule checks for the following:

• List Start: There should be a blank line before the first item in a list (unless the list is at the beginning of the document or after front matter)
• List End: There should be a blank line after the last item in a list (unless the list is at the end of the document)
• Nested Lists: Properly handles nested lists and list continuations
• List Types: Works with ordered lists, unordered lists, and all valid list markers (-, *, +)

Special Cases

This rule handles several special cases:

• Front Matter: YAML front matter is detected and skipped
• Code Blocks: Lists inside code blocks are ignored
• List Content: Indented content belonging to list items is properly recognized as part of the list
• Document Boundaries: Lists at the beginning or end of the document have adjusted requirements

Fix Behavior

When applying automatic fixes, this rule:

• Adds a blank line before the first list item when needed
• Adds a blank line after the last list item when needed
• Preserves document structure and existing content

Performance Optimizations

The rule includes several optimizations:

• Fast path checks before applying more expensive regex operations
• Efficient list item detection
• Pre-computation of code block lines to avoid redundant processing

Implementations

impl MD032BlanksAroundLists

pub fn from_config_struct(config: MD032Config) -> Self

Trait Implementations

impl Clone for MD032BlanksAroundLists

fn clone(&self) -> MD032BlanksAroundLists

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MD032BlanksAroundLists

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

Formats the value using the given formatter.

impl Default for MD032BlanksAroundLists

fn default() -> MD032BlanksAroundLists

Returns the “default value” for a type.

impl Rule for MD032BlanksAroundLists

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 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 as_any(&self) -> &dyn Any

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 from_config(config: &Config) -> Box<dyn Rule>

where Self: Sized,

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

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

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