Struct LintContext 

pub struct LintContext<'a> {

    pub content: &'a str,
    pub line_offsets: Vec<usize>,
    pub code_blocks: Vec<(usize, usize)>,
    pub lines: Vec<LineInfo>,
    pub links: Vec<ParsedLink<'a>>,
    pub images: Vec<ParsedImage<'a>>,
    pub broken_links: Vec<BrokenLinkInfo>,
    pub footnote_refs: Vec<FootnoteRef>,
    pub reference_defs: Vec<ReferenceDef>,
    pub list_blocks: Vec<ListBlock>,
    pub char_frequency: CharFrequency,
    pub table_blocks: Vec<TableBlock>,
    pub line_index: LineIndex<'a>,
    pub flavor: MarkdownFlavor,
    pub source_file: Option<PathBuf>,
    /* private fields */
}

Fields

content: &'a str

line_offsets: Vec<usize>

code_blocks: Vec<(usize, usize)>

lines: Vec<LineInfo>

links: Vec<ParsedLink<'a>>

images: Vec<ParsedImage<'a>>

broken_links: Vec<BrokenLinkInfo>

footnote_refs: Vec<FootnoteRef>

reference_defs: Vec<ReferenceDef>

list_blocks: Vec<ListBlock>

char_frequency: CharFrequency

table_blocks: Vec<TableBlock>

line_index: LineIndex<'a>

flavor: MarkdownFlavor

source_file: Option<PathBuf>

Implementations

impl<'a> LintContext<'a>

pub fn new( content: &'a str, flavor: MarkdownFlavor, source_file: Option<PathBuf>, ) -> Self

pub fn is_rule_disabled(&self, rule_name: &str, line_number: usize) -> bool

Check if a rule is disabled at a specific line number (1-indexed)

This method checks both persistent disable comments () and line-specific comments (, ).

pub fn code_spans(&self) -> Arc<Vec<CodeSpan>>

Get code spans - computed lazily on first access

pub fn math_spans(&self) -> Arc<Vec<MathSpan>>

Get math spans - computed lazily on first access

pub fn is_in_math_span(&self, byte_pos: usize) -> bool

Check if a byte position is within a math span (inline $…$ or display $$…$$)

pub fn html_comment_ranges(&self) -> &[ByteRange]

Get HTML comment ranges - pre-computed during LintContext construction

pub fn html_tags(&self) -> Arc<Vec<HtmlTag>>

Get HTML tags - computed lazily on first access

pub fn emphasis_spans(&self) -> Arc<Vec<EmphasisSpan>>

Get emphasis spans - pre-computed during construction

pub fn table_rows(&self) -> Arc<Vec<TableRow>>

Get table rows - computed lazily on first access

pub fn bare_urls(&self) -> Arc<Vec<BareUrl>>

Get bare URLs - computed lazily on first access

pub fn has_mixed_list_nesting(&self) -> bool

Check if document has mixed ordered/unordered list nesting. Result is cached after first computation (document-level invariant). This is used by MD007 for smart style auto-detection.

pub fn offset_to_line_col(&self, offset: usize) -> (usize, usize)

Map a byte offset to (line, column)

pub fn is_in_code_block_or_span(&self, pos: usize) -> bool

Check if a position is within a code block or code span

pub fn line_info(&self, line_num: usize) -> Option<&LineInfo>

Get line information by line number (1-indexed)

pub fn line_to_byte_offset(&self, line_num: usize) -> Option<usize>

Get byte offset for a line number (1-indexed)

pub fn get_reference_url(&self, ref_id: &str) -> Option<&str>

Get URL for a reference link/image by its ID (O(1) lookup via HashMap)

pub fn get_reference_def(&self, ref_id: &str) -> Option<&ReferenceDef>

Get a reference definition by its ID (O(1) lookup via HashMap)

pub fn has_reference_def(&self, ref_id: &str) -> bool

Check if a reference definition exists by ID (O(1) lookup via HashMap)

pub fn is_in_list_block(&self, line_num: usize) -> bool

Check if a line is part of a list block

pub fn list_block_for_line(&self, line_num: usize) -> Option<&ListBlock>

Get the list block containing a specific line

pub fn is_in_code_block(&self, line_num: usize) -> bool

Check if a line is within a code block

pub fn is_in_front_matter(&self, line_num: usize) -> bool

Check if a line is within front matter

pub fn is_in_html_block(&self, line_num: usize) -> bool

Check if a line is within an HTML block

pub fn is_in_code_span(&self, line_num: usize, col: usize) -> bool

Check if a line and column is within a code span

pub fn is_byte_offset_in_code_span(&self, byte_offset: usize) -> bool

Check if a byte offset is within a code span

pub fn is_in_reference_def(&self, byte_pos: usize) -> bool

Check if a byte position is within a reference definition This is much faster than scanning the content with regex for each check (O(1) vs O(n))

pub fn is_in_html_comment(&self, byte_pos: usize) -> bool

Check if a byte position is within an HTML comment This is much faster than scanning the content with regex for each check (O(k) vs O(n)) where k is the number of HTML comments (typically very small)

pub fn is_in_html_tag(&self, byte_pos: usize) -> bool

Check if a byte position is within an HTML tag (including multiline tags) Uses the pre-parsed html_tags which correctly handles tags spanning multiple lines

pub fn is_in_jinja_range(&self, byte_pos: usize) -> bool

Check if a byte position is within a Jinja template ({{ }} or {% %})

pub fn is_in_jsx_expression(&self, byte_pos: usize) -> bool

Check if a byte position is within a JSX expression (MDX: {expression})

pub fn is_in_mdx_comment(&self, byte_pos: usize) -> bool

Check if a byte position is within an MDX comment ({/* … */})

pub fn jsx_expression_ranges(&self) -> &[(usize, usize)]

Get all JSX expression byte ranges

pub fn mdx_comment_ranges(&self) -> &[(usize, usize)]

Get all MDX comment byte ranges

pub fn is_in_citation(&self, byte_pos: usize) -> bool

Check if a byte position is within a Pandoc/Quarto citation (@key or [@key]) Only active in Quarto flavor

pub fn citation_ranges(&self) -> &[ByteRange]

Get all citation byte ranges (Quarto flavor only)

pub fn is_in_shortcode(&self, byte_pos: usize) -> bool

Check if a byte position is within a Hugo/Quarto shortcode ({{< … >}} or {{% … %}})

pub fn shortcode_ranges(&self) -> &[(usize, usize)]

Get all shortcode byte ranges

pub fn is_in_link_title(&self, byte_pos: usize) -> bool

Check if a byte position is within a link reference definition title

pub fn has_char(&self, ch: char) -> bool

Check if content has any instances of a specific character (fast)

pub fn char_count(&self, ch: char) -> usize

Get count of a specific character (fast)

pub fn likely_has_headings(&self) -> bool

Check if content likely contains headings (fast)

pub fn likely_has_lists(&self) -> bool

Check if content likely contains lists (fast)

pub fn likely_has_emphasis(&self) -> bool

Check if content likely contains emphasis (fast)

pub fn likely_has_tables(&self) -> bool

Check if content likely contains tables (fast)

pub fn likely_has_blockquotes(&self) -> bool

Check if content likely contains blockquotes (fast)

pub fn likely_has_code(&self) -> bool

Check if content likely contains code (fast)

pub fn likely_has_links_or_images(&self) -> bool

Check if content likely contains links or images (fast)

pub fn likely_has_html(&self) -> bool

Check if content likely contains HTML (fast)

pub fn blockquote_prefix_for_blank_line(&self, line_idx: usize) -> String

Get the blockquote prefix for inserting a blank line at the given line index. Returns the prefix without trailing content (e.g., “>” or “>>”). This is needed because blank lines inside blockquotes must preserve the blockquote structure. Returns an empty string if the line is not inside a blockquote.

pub fn html_tags_on_line(&self, line_num: usize) -> Vec<HtmlTag>

Get HTML tags on a specific line

pub fn emphasis_spans_on_line(&self, line_num: usize) -> Vec<EmphasisSpan>

Get emphasis spans on a specific line

pub fn table_rows_on_line(&self, line_num: usize) -> Vec<TableRow>

Get table rows on a specific line

pub fn bare_urls_on_line(&self, line_num: usize) -> Vec<BareUrl>

Get bare URLs on a specific line

pub fn valid_headings(&self) -> ValidHeadingsIter<'_>

Get an iterator over valid CommonMark headings

This iterator filters out malformed headings like #NoSpace (hashtag-like patterns) that should be flagged by MD018 but should not be processed by other heading rules.

Examples

use rumdl_lib::lint_context::LintContext;
use rumdl_lib::config::MarkdownFlavor;

let content = "# Valid Heading\n#NoSpace\n## Another Valid";
let ctx = LintContext::new(content, MarkdownFlavor::Standard, None);

for heading in ctx.valid_headings() {
    println!("Line {}: {} (level {})", heading.line_num, heading.heading.text, heading.heading.level);
}
// Only prints valid headings, skips `#NoSpace`

pub fn has_valid_headings(&self) -> bool

Check if the document contains any valid CommonMark headings

Returns true if there is at least one heading with proper space after #.

Trait Implementations

impl<'a> FilteredLinesExt for LintContext<'a>

fn filtered_lines(&self) -> FilteredLinesBuilder<'_>

Start building a filtered lines iterator

fn content_lines(&self) -> FilteredLinesIter<'_>

Get an iterator over content lines only