rumdl_lib/rules/

md052_reference_links_images.rs

use crate::rule::{FixCapability, LintError, LintResult, LintWarning, Rule, RuleCategory, Severity};
use crate::utils::mkdocs_patterns::is_mkdocs_auto_reference;
use crate::utils::range_utils::calculate_match_range;
use crate::utils::regex_cache::SHORTCUT_REF_REGEX;
use crate::utils::skip_context::is_in_math_context;
use pulldown_cmark::LinkType;
use regex::Regex;
use std::collections::{HashMap, HashSet};
use std::sync::LazyLock;

mod md052_config;
use md052_config::MD052Config;

// Pattern to match reference definitions [ref]: url
// Note: \S* instead of \S+ to allow empty definitions like [ref]:
// The capturing group handles nested brackets to support cases like [`union[t, none]`]:
static REF_REGEX: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"^\s*\[((?:[^\[\]\\]|\\.|\[[^\]]*\])*)\]:\s*.*").unwrap());

// Pattern for list items to exclude from reference checks (standard regex is fine)
static LIST_ITEM_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^\s*[-*+]\s+(?:\[[xX\s]\]\s+)?").unwrap());

// Pattern for output example sections (standard regex is fine)
static OUTPUT_EXAMPLE_START: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"^#+\s*(?:Output|Example|Output Style|Output Format)\s*$").unwrap());

// Pattern for GitHub alerts/callouts in blockquotes (e.g., > [!NOTE], > [!TIP], etc.)
// Extended to include additional common alert types
static GITHUB_ALERT_REGEX: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^\s*>\s*\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION|INFO|SUCCESS|FAILURE|DANGER|BUG|EXAMPLE|QUOTE)\]")
        .unwrap()
});

// Pattern to detect URLs that may contain brackets (IPv6, API endpoints, etc.)
// This pattern specifically looks for:
// - IPv6 addresses: https://[::1] or https://[2001:db8::1]
// - IPv6 with zone IDs: https://[fe80::1%eth0]
// - IPv6 mixed notation: https://[::ffff:192.0.2.1]
// - API paths with array notation: https://api.example.com/users[0]
// But NOT markdown reference links that happen to follow URLs
static URL_WITH_BRACKETS: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"https?://(?:\[[0-9a-fA-F:.%]+\]|[^\s\[\]]+/[^\s]*\[\d+\])").unwrap());

/// Rule MD052: Reference links and images should use reference style
///
/// See [docs/md052.md](../../docs/md052.md) for full documentation, configuration, and examples.
///
/// This rule is triggered when a reference link or image uses a reference that isn't defined.
///
/// ## Configuration
///
/// - `shortcut-syntax`: Whether to check shortcut reference syntax `[text]` (default: false)
///
/// By default, only full (`[text][ref]`) and collapsed (`[text][]`) reference syntax is checked.
/// Shortcut syntax is ambiguous because `[text]` could be a reference link OR just text in brackets.
#[derive(Clone, Default)]
pub struct MD052ReferenceLinkImages {
    config: MD052Config,
}

impl MD052ReferenceLinkImages {
    pub fn new() -> Self {
        Self {
            config: MD052Config::default(),
        }
    }

    pub fn from_config_struct(config: MD052Config) -> Self {
        Self { config }
    }

    /// Strip surrounding backticks from a string
    /// Used for MkDocs auto-reference detection where `module.Class` should be treated as module.Class
    fn strip_backticks(s: &str) -> &str {
        s.trim_start_matches('`').trim_end_matches('`')
    }

    /// Check if a string is a valid Python identifier
    /// Used for MkDocs auto-reference detection where single-word backtick-wrapped identifiers
    /// like `str`, `int`, etc. should be accepted as valid auto-references
    fn is_valid_python_identifier(s: &str) -> bool {
        if s.is_empty() {
            return false;
        }
        let first_char = s.chars().next().unwrap();
        if !first_char.is_ascii_alphabetic() && first_char != '_' {
            return false;
        }
        s.chars().all(|c| c.is_ascii_alphanumeric() || c == '_')
    }

    /// Check if text matches a known non-reference pattern that should be skipped.
    ///
    /// These are deterministic patterns from markdown extensions or code examples,
    /// not heuristics. Returns true for:
    /// - User-configured names via `ignore` config option
    /// - Markdown extensions: [^footnote], [@citation], [!alert], [TOC]
    /// - Programming syntax: [T], [null], [i32], ["string"]
    /// - Descriptive text: [default: value], [0-9]
    fn is_known_non_reference_pattern(&self, text: &str) -> bool {
        // Check user-configured ignore list first (case-insensitive match)
        // Reference IDs are normalized to lowercase during parsing,
        // so we use case-insensitive comparison for user convenience
        if self.config.ignore.iter().any(|p| p.eq_ignore_ascii_case(text)) {
            return true;
        }
        // Skip numeric patterns (array indices, ranges)
        if text.chars().all(|c| c.is_ascii_digit()) {
            return true;
        }

        // Skip numeric ranges like [1:3], [0:10], etc.
        if text.contains(':') && text.chars().all(|c| c.is_ascii_digit() || c == ':') {
            return true;
        }

        // Skip patterns that look like config sections [tool.something], [section.subsection]
        // But not if they contain other non-alphanumeric chars like hyphens, underscores, or backticks
        // Backticks indicate intentional code formatting in a reference name (e.g., [`module.Class`])
        if text.contains('.')
            && !text.contains(' ')
            && !text.contains('-')
            && !text.contains('_')
            && !text.contains('`')
        {
            // Config sections typically have dots, no spaces, and only alphanumeric + dots
            return true;
        }

        // Skip glob/wildcard patterns like [*], [...], [**]
        if text == "*" || text == "..." || text == "**" {
            return true;
        }

        // Skip patterns that look like file paths [dir/file], [src/utils]
        if text.contains('/') && !text.contains(' ') && !text.starts_with("http") {
            return true;
        }

        // Skip programming type annotations like [int, str], [Dict[str, Any]]
        // These typically have commas and/or nested brackets
        if text.contains(',') || text.contains('[') || text.contains(']') {
            // Check if it looks like a type annotation pattern
            return true;
        }

        // Note: We don't filter out patterns with backticks because backticks in reference names
        // are valid markdown syntax, e.g., [`dataclasses.InitVar`] is a valid reference name

        // Skip patterns that look like module/class paths ONLY if they don't have backticks
        // Backticks indicate intentional code formatting in a reference name
        // e.g., skip [dataclasses.initvar] but allow [`typing.ClassVar`]
        if !text.contains('`')
            && text.contains('.')
            && !text.contains(' ')
            && !text.contains('-')
            && !text.contains('_')
        {
            return true;
        }

        // Note: We don't filter based on word count anymore because legitimate references
        // can have many words, like "python language reference for import statements"
        // Word count filtering was causing false positives where valid references were
        // being incorrectly flagged as unused

        // Skip patterns that are just punctuation or operators
        if text.chars().all(|c| !c.is_alphanumeric() && c != ' ') {
            return true;
        }

        // Skip very short non-word patterns (likely operators or syntax)
        if text.len() <= 2 && !text.chars().all(char::is_alphabetic) {
            return true;
        }

        // Skip quoted patterns like ["E501"], ["ALL"], ["E", "F"]
        if (text.starts_with('"') && text.ends_with('"'))
            || (text.starts_with('\'') && text.ends_with('\''))
            || text.contains('"')
            || text.contains('\'')
        {
            return true;
        }

        // Skip descriptive patterns with colon like [default: the project root]
        // But allow simple numeric ranges which are handled above
        if text.contains(':') && text.contains(' ') {
            return true;
        }

        // Skip alert/admonition patterns like [!WARN], [!NOTE], etc.
        if text.starts_with('!') {
            return true;
        }

        // Skip footnote syntax like [^1], [^note], etc.
        // Footnotes start with ^ and are a common markdown extension
        if text.starts_with('^') {
            return true;
        }

        // Skip Pandoc/RMarkdown/Quarto citation syntax like [@citation-key]
        // Citations in these formats start with @ inside brackets
        if text.starts_with('@') {
            return true;
        }

        // Skip table of contents markers like [TOC]
        // Used by Python-Markdown and other processors
        if text == "TOC" {
            return true;
        }

        // Skip single uppercase letters (likely type parameters) like [T], [U], [K], [V]
        if text.len() == 1 && text.chars().all(|c| c.is_ascii_uppercase()) {
            return true;
        }

        // Skip common programming type names, literals, and short identifiers
        // that are likely not markdown references
        let common_non_refs = [
            // Programming types
            "object",
            "Object",
            "any",
            "Any",
            "inv",
            "void",
            "bool",
            "int",
            "float",
            "str",
            "char",
            "i8",
            "i16",
            "i32",
            "i64",
            "i128",
            "isize",
            "u8",
            "u16",
            "u32",
            "u64",
            "u128",
            "usize",
            "f32",
            "f64",
            // JavaScript/JSON literals (excluding "undefined" which is too ambiguous)
            "null",
            "true",
            "false",
            "NaN",
            "Infinity",
            // Common JavaScript output patterns
            "object Object",
        ];

        if common_non_refs.contains(&text) {
            return true;
        }

        false
    }

    /// Check if a byte position is inside any code span. O(log n) via binary search.
    fn is_in_code_span(byte_pos: usize, code_spans: &[crate::lint_context::CodeSpan]) -> bool {
        let idx = code_spans.partition_point(|span| span.byte_offset <= byte_pos);
        idx > 0 && byte_pos < code_spans[idx - 1].byte_end
    }

    /// Check if a byte position is within an HTML tag. O(log n) via binary search.
    fn is_in_html_tag(html_tags: &[crate::lint_context::HtmlTag], byte_pos: usize) -> bool {
        let idx = html_tags.partition_point(|tag| tag.byte_offset <= byte_pos);
        idx > 0 && byte_pos < html_tags[idx - 1].byte_end
    }

    fn extract_references(&self, ctx: &crate::lint_context::LintContext) -> HashSet<String> {
        use crate::utils::skip_context::is_mkdocs_snippet_line;

        let mut references = HashSet::new();

        for (line_num, line) in ctx.content.lines().enumerate() {
            // Use LintContext's pre-computed code block info (1-indexed)
            if let Some(line_info) = ctx.line_info(line_num + 1)
                && line_info.in_code_block
            {
                continue;
            }

            // Skip lines that look like MkDocs snippet markers (only in MkDocs mode)
            if is_mkdocs_snippet_line(line, ctx.flavor) {
                continue;
            }

            // Check for abbreviation syntax (*[ABBR]: Definition) and skip it
            // Abbreviations are not reference links and should not be tracked
            if line.trim_start().starts_with("*[") {
                continue;
            }

            if let Some(cap) = REF_REGEX.captures(line) {
                // Store references in lowercase for case-insensitive comparison
                if let Some(reference) = cap.get(1) {
                    references.insert(reference.as_str().to_lowercase());
                }
            }
        }

        // Include definitions found by rumdl's shared parser, which recognizes
        // blockquote-prefixed definitions (`> [id]: url`) that the line scan above
        // does not. IDs are already lowercased.
        for def in ctx.reference_definitions() {
            references.insert(def.id.clone());
        }

        references
    }

    fn compute_example_sections(ctx: &crate::lint_context::LintContext) -> HashSet<usize> {
        let mut sections = HashSet::new();
        let mut in_section = false;
        for (line_num, line) in ctx.raw_lines().iter().enumerate() {
            if OUTPUT_EXAMPLE_START.is_match(line) {
                in_section = true;
            } else if line.starts_with('#') {
                in_section = false;
            }
            if in_section {
                sections.insert(line_num + 1);
            }
        }
        sections
    }

    fn find_undefined_references(
        &self,
        references: &HashSet<String>,
        ctx: &crate::lint_context::LintContext,
        mkdocs_mode: bool,
    ) -> Vec<(usize, usize, usize, String)> {
        let mut undefined = Vec::new();
        let mut reported_refs = HashMap::new();

        let example_sections = Self::compute_example_sections(ctx);

        // Get code spans and HTML tags once for the entire function
        let code_spans = ctx.code_spans();
        let html_tags = ctx.html_tags();

        // Use cached data for reference links and images
        for link in ctx.links() {
            if !link.is_reference {
                continue; // Skip inline links
            }

            // Skip shortcut links if shortcut_syntax is disabled
            if !self.config.shortcut_syntax && matches!(link.link_type, LinkType::Shortcut | LinkType::ShortcutUnknown)
            {
                continue;
            }

            // Skip Pandoc/RMarkdown inline footnotes: ^[text]
            if link.byte_offset > 0 && ctx.content.as_bytes().get(link.byte_offset - 1) == Some(&b'^') {
                continue;
            }

            // Skip links inside Jinja templates
            if ctx.is_in_jinja_range(link.byte_offset) {
                continue;
            }

            // Skip links inside code spans
            if Self::is_in_code_span(link.byte_offset, &code_spans) {
                continue;
            }

            // Skip links inside HTML comments (uses pre-computed ranges)
            if ctx.is_in_html_comment(link.byte_offset) || ctx.is_in_mdx_comment(link.byte_offset) {
                continue;
            }

            // Skip links inside HTML tags
            if Self::is_in_html_tag(&html_tags, link.byte_offset) {
                continue;
            }

            // Skip links inside math contexts
            if is_in_math_context(ctx, link.byte_offset) {
                continue;
            }

            // Skip links inside frontmatter
            if ctx.line_info(link.line).is_some_and(|info| info.in_front_matter) {
                continue;
            }

            // Skip Pandoc/Quarto citations ([@citation], @citation)
            // Citations look like reference links but are bibliography references
            if ctx.flavor.is_pandoc_compatible() && ctx.is_in_citation(link.byte_offset) {
                continue;
            }

            // Skip links inside shortcodes ({{< ... >}} or {{% ... %}})
            // Shortcodes may contain template syntax that looks like reference links
            if ctx.is_in_shortcode(link.byte_offset) {
                continue;
            }

            if let Some(ref_id) = &link.reference_id {
                let reference_lower = ref_id.to_lowercase();

                // Skip Pandoc implicit header references
                if ctx.flavor.is_pandoc_compatible() && ctx.matches_implicit_header_reference(ref_id) {
                    continue;
                }

                // Skip known non-reference patterns (markdown extensions, code examples)
                if self.is_known_non_reference_pattern(ref_id) {
                    continue;
                }

                // Skip MkDocs auto-references if in MkDocs mode
                // Check both the reference_id and the link text for shorthand references
                // Strip backticks since MkDocs resolves `module.Class` as module.Class
                let stripped_ref = Self::strip_backticks(ref_id);
                let stripped_text = Self::strip_backticks(&link.text);
                if mkdocs_mode
                    && (is_mkdocs_auto_reference(stripped_ref)
                        || is_mkdocs_auto_reference(stripped_text)
                        || (ref_id != stripped_ref && Self::is_valid_python_identifier(stripped_ref))
                        || (link.text.as_ref() != stripped_text && Self::is_valid_python_identifier(stripped_text)))
                {
                    continue;
                }

                // Check if reference is defined
                if !references.contains(&reference_lower) && !reported_refs.contains_key(&reference_lower) {
                    if example_sections.contains(&link.line) {
                        continue;
                    }

                    if let Some(line_info) = ctx.line_info(link.line) {
                        // Skip list items
                        if LIST_ITEM_REGEX.is_match(line_info.content(ctx.content)) {
                            continue;
                        }

                        // Skip lines that are HTML content
                        let trimmed = line_info.content(ctx.content).trim_start();
                        if trimmed.starts_with('<') {
                            continue;
                        }
                    }

                    let match_len = link.byte_end - link.byte_offset;
                    // calculate_match_range expects a byte offset within the line;
                    // start_col is a character column, so derive the byte offset.
                    let line_start = ctx.line_start_byte(link.line).unwrap_or(0);
                    undefined.push((
                        link.line - 1,
                        link.byte_offset - line_start,
                        match_len,
                        original_case_label(&link.text, &reference_lower),
                    ));
                    reported_refs.insert(reference_lower, true);
                }
            }
        }

        // Use cached data for reference images
        for image in ctx.images() {
            if !image.is_reference {
                continue; // Skip inline images
            }

            // Skip images inside Jinja templates
            if ctx.is_in_jinja_range(image.byte_offset) {
                continue;
            }

            // Skip images inside code spans
            if Self::is_in_code_span(image.byte_offset, &code_spans) {
                continue;
            }

            // Skip images inside HTML comments (uses pre-computed ranges)
            if ctx.is_in_html_comment(image.byte_offset) || ctx.is_in_mdx_comment(image.byte_offset) {
                continue;
            }

            // Skip images inside HTML tags
            if Self::is_in_html_tag(&html_tags, image.byte_offset) {
                continue;
            }

            // Skip images inside math contexts
            if is_in_math_context(ctx, image.byte_offset) {
                continue;
            }

            // Skip images inside frontmatter
            if ctx.line_info(image.line).is_some_and(|info| info.in_front_matter) {
                continue;
            }

            if let Some(ref_id) = &image.reference_id {
                let reference_lower = ref_id.to_lowercase();

                // Skip known non-reference patterns (markdown extensions, code examples)
                if self.is_known_non_reference_pattern(ref_id) {
                    continue;
                }

                // Skip MkDocs auto-references if in MkDocs mode
                // Check both the reference_id and the alt text for shorthand references
                // Strip backticks since MkDocs resolves `module.Class` as module.Class
                let stripped_ref = Self::strip_backticks(ref_id);
                let stripped_alt = Self::strip_backticks(&image.alt_text);
                if mkdocs_mode
                    && (is_mkdocs_auto_reference(stripped_ref)
                        || is_mkdocs_auto_reference(stripped_alt)
                        || (ref_id != stripped_ref && Self::is_valid_python_identifier(stripped_ref))
                        || (image.alt_text.as_ref() != stripped_alt && Self::is_valid_python_identifier(stripped_alt)))
                {
                    continue;
                }

                // Check if reference is defined
                if !references.contains(&reference_lower) && !reported_refs.contains_key(&reference_lower) {
                    if example_sections.contains(&image.line) {
                        continue;
                    }

                    if let Some(line_info) = ctx.line_info(image.line) {
                        // Skip list items
                        if LIST_ITEM_REGEX.is_match(line_info.content(ctx.content)) {
                            continue;
                        }

                        // Skip lines that are HTML content
                        let trimmed = line_info.content(ctx.content).trim_start();
                        if trimmed.starts_with('<') {
                            continue;
                        }
                    }

                    let match_len = image.byte_end - image.byte_offset;
                    // calculate_match_range expects a byte offset within the line;
                    // start_col is a character column, so derive the byte offset.
                    let line_start = ctx.line_start_byte(image.line).unwrap_or(0);
                    undefined.push((
                        image.line - 1,
                        image.byte_offset - line_start,
                        match_len,
                        original_case_label(&image.alt_text, &reference_lower),
                    ));
                    reported_refs.insert(reference_lower, true);
                }
            }
        }

        // Build a set of byte ranges that are already covered by parsed links/images
        let mut covered_ranges: Vec<(usize, usize)> = Vec::new();

        // Add ranges from parsed links
        for link in ctx.links() {
            covered_ranges.push((link.byte_offset, link.byte_end));
        }

        // Add ranges from parsed images
        for image in ctx.images() {
            covered_ranges.push((image.byte_offset, image.byte_end));
        }

        // Sort ranges by start position
        covered_ranges.sort_by_key(|&(start, _)| start);

        // Handle shortcut references [text] which aren't captured in ctx.links()
        // Only check these if shortcut_syntax is enabled (default: false)
        // Shortcut syntax is ambiguous because [text] could be a reference link
        // OR just text in brackets (like spec notation in quotes)
        if !self.config.shortcut_syntax {
            return undefined;
        }

        // Need to use regex for shortcut references
        let lines = ctx.raw_lines();
        for (line_num, line) in lines.iter().enumerate() {
            // Skip lines in frontmatter or code blocks using LintContext's pre-computed info
            if let Some(line_info) = ctx.line_info(line_num + 1)
                && (line_info.in_front_matter || line_info.in_code_block)
            {
                continue;
            }

            if example_sections.contains(&(line_num + 1)) {
                continue;
            }

            // Skip list items
            if LIST_ITEM_REGEX.is_match(line) {
                continue;
            }

            // Skip lines that are HTML content
            let trimmed_line = line.trim_start();
            if trimmed_line.starts_with('<') {
                continue;
            }

            // Skip GitHub alerts/callouts (e.g., > [!TIP])
            if GITHUB_ALERT_REGEX.is_match(line) {
                continue;
            }

            // Skip abbreviation definitions (*[ABBR]: Definition)
            // These are not reference links and should not be checked
            if trimmed_line.starts_with("*[") {
                continue;
            }

            // Collect positions of brackets that are part of URLs (IPv6, etc.)
            // so we can exclude them from reference checking
            let mut url_bracket_ranges: Vec<(usize, usize)> = Vec::new();
            for mat in URL_WITH_BRACKETS.find_iter(line) {
                // Find all bracket pairs within this URL match
                let url_str = mat.as_str();
                let url_start = mat.start();

                // Find brackets within the URL (e.g., in https://[::1]:8080)
                let mut idx = 0;
                while idx < url_str.len() {
                    if let Some(bracket_start) = url_str[idx..].find('[') {
                        let bracket_start_abs = url_start + idx + bracket_start;
                        if let Some(bracket_end) = url_str[idx + bracket_start + 1..].find(']') {
                            let bracket_end_abs = url_start + idx + bracket_start + 1 + bracket_end + 1;
                            url_bracket_ranges.push((bracket_start_abs, bracket_end_abs));
                            idx += bracket_start + bracket_end + 2;
                        } else {
                            break;
                        }
                    } else {
                        break;
                    }
                }
            }

            // Check shortcut references: [reference]
            if let Ok(captures) = SHORTCUT_REF_REGEX.captures_iter(line).collect::<Result<Vec<_>, _>>() {
                for cap in captures {
                    if let Some(ref_match) = cap.get(1) {
                        // Check if this bracket is part of a URL (IPv6, etc.)
                        let bracket_start = cap.get(0).unwrap().start();
                        let bracket_end = cap.get(0).unwrap().end();

                        // Skip if this bracket pair is within any URL bracket range
                        let is_in_url = url_bracket_ranges
                            .iter()
                            .any(|&(url_start, url_end)| bracket_start >= url_start && bracket_end <= url_end);

                        if is_in_url {
                            continue;
                        }

                        // Skip Pandoc/RMarkdown inline footnotes: ^[text]
                        // Check if there's a ^ immediately before the opening bracket
                        if bracket_start > 0 {
                            // bracket_start is a byte offset, so we need to check the byte before
                            if let Some(byte) = line.as_bytes().get(bracket_start.saturating_sub(1))
                                && *byte == b'^'
                            {
                                continue; // This is an inline footnote, skip it
                            }
                        }

                        let reference = ref_match.as_str();
                        let reference_lower = reference.to_lowercase();

                        // Skip known non-reference patterns (markdown extensions, code examples)
                        if self.is_known_non_reference_pattern(reference) {
                            continue;
                        }

                        // Skip GitHub alerts (including extended types)
                        if let Some(alert_type) = reference.strip_prefix('!')
                            && matches!(
                                alert_type,
                                "NOTE"
                                    | "TIP"
                                    | "WARNING"
                                    | "IMPORTANT"
                                    | "CAUTION"
                                    | "INFO"
                                    | "SUCCESS"
                                    | "FAILURE"
                                    | "DANGER"
                                    | "BUG"
                                    | "EXAMPLE"
                                    | "QUOTE"
                            )
                        {
                            continue;
                        }

                        // Skip MkDocs snippet section markers like [start:section] or [end:section]
                        // when they appear as part of snippet syntax (e.g., # -8<- [start:section])
                        if mkdocs_mode
                            && (reference.starts_with("start:") || reference.starts_with("end:"))
                            && (crate::utils::mkdocs_snippets::is_snippet_section_start(line)
                                || crate::utils::mkdocs_snippets::is_snippet_section_end(line))
                        {
                            continue;
                        }

                        // Skip MkDocs auto-references if in MkDocs mode
                        // Strip backticks since MkDocs resolves `module.Class` as module.Class
                        let stripped_ref = Self::strip_backticks(reference);
                        if mkdocs_mode
                            && (is_mkdocs_auto_reference(stripped_ref)
                                || (reference != stripped_ref && Self::is_valid_python_identifier(stripped_ref)))
                        {
                            continue;
                        }

                        // Pandoc-flavor implicit header references: `[Section name]` resolves
                        // to a heading whose Pandoc slug matches the bracketed text. These are
                        // not undefined references — Pandoc renders them as anchor links.
                        if ctx.flavor.is_pandoc_compatible() && ctx.matches_implicit_header_reference(reference) {
                            continue;
                        }

                        if !references.contains(&reference_lower) && !reported_refs.contains_key(&reference_lower) {
                            let full_match = cap.get(0).unwrap();
                            let col = full_match.start();
                            let line_start_byte = ctx.line_offsets[line_num];
                            let byte_pos = line_start_byte + col;

                            // Skip if inside code span
                            let code_spans = ctx.code_spans();
                            if Self::is_in_code_span(byte_pos, &code_spans) {
                                continue;
                            }

                            // Skip if inside Jinja template
                            if ctx.is_in_jinja_range(byte_pos) {
                                continue;
                            }

                            // Skip if inside code block
                            if crate::utils::code_block_utils::CodeBlockUtils::is_in_code_block(
                                &ctx.code_blocks,
                                byte_pos,
                            ) {
                                continue;
                            }

                            // Skip if inside HTML comment (uses pre-computed ranges)
                            if ctx.is_in_html_comment(byte_pos) || ctx.is_in_mdx_comment(byte_pos) {
                                continue;
                            }

                            // Skip if inside HTML tag
                            if Self::is_in_html_tag(&html_tags, byte_pos) {
                                continue;
                            }

                            // Skip if inside math context
                            if is_in_math_context(ctx, byte_pos) {
                                continue;
                            }

                            let byte_end = byte_pos + (full_match.end() - full_match.start());

                            // Check if this shortcut ref overlaps with any parsed link/image
                            let mut is_covered = false;
                            for &(range_start, range_end) in &covered_ranges {
                                if range_start <= byte_pos && byte_end <= range_end {
                                    // This shortcut ref is completely within a parsed link/image
                                    is_covered = true;
                                    break;
                                }
                                if range_start > byte_end {
                                    // No need to check further (ranges are sorted)
                                    break;
                                }
                            }

                            if is_covered {
                                continue;
                            }

                            // More sophisticated checks to avoid false positives

                            // Check 1: If preceded by ], this might be part of [text][ref]
                            // Look for the pattern ...][ref] and check if there's a matching [ before
                            let line_chars: Vec<char> = line.chars().collect();
                            if col > 0 && col <= line_chars.len() && line_chars.get(col - 1) == Some(&']') {
                                // Look backwards for a [ that would make this [text][ref]
                                let mut bracket_count = 1; // We already saw one ]
                                let mut check_pos = col.saturating_sub(2);
                                let mut found_opening = false;

                                while check_pos > 0 && check_pos < line_chars.len() {
                                    match line_chars.get(check_pos) {
                                        Some(&']') => bracket_count += 1,
                                        Some(&'[') => {
                                            bracket_count -= 1;
                                            if bracket_count == 0 {
                                                // Check if this [ is escaped
                                                if check_pos == 0 || line_chars.get(check_pos - 1) != Some(&'\\') {
                                                    found_opening = true;
                                                }
                                                break;
                                            }
                                        }
                                        _ => {}
                                    }
                                    if check_pos == 0 {
                                        break;
                                    }
                                    check_pos = check_pos.saturating_sub(1);
                                }

                                if found_opening {
                                    // This is part of [text][ref], skip it
                                    continue;
                                }
                            }

                            // Check 2: If there's an escaped bracket pattern before this
                            // e.g., \[text\][ref], the [ref] shouldn't be treated as a shortcut
                            let before_text = &line[..col];
                            if before_text.contains("\\]") {
                                // Check if there's a \[ before the \]
                                if let Some(escaped_close_pos) = before_text.rfind("\\]") {
                                    let search_text = &before_text[..escaped_close_pos];
                                    if search_text.contains("\\[") {
                                        // This looks like \[...\][ref], skip it
                                        continue;
                                    }
                                }
                            }

                            let match_len = full_match.end() - full_match.start();
                            undefined.push((line_num, col, match_len, reference.to_string()));
                            reported_refs.insert(reference_lower, true);
                        }
                    }
                }
            }
        }

        undefined
    }
}

/// Choose the casing to display for an undefined reference. The matching key
/// (`reference_id`) is lowercased, but for shortcut and collapsed references the
/// link text (or image alt text) is itself the label, so its original casing is
/// what the author wrote. Prefer that; fall back to the normalized key for full
/// reference links (where the text is not the label) or when the text is empty.
fn original_case_label(text: &str, reference_lower: &str) -> String {
    if !text.is_empty() && text.to_lowercase() == reference_lower {
        text.to_string()
    } else {
        reference_lower.to_string()
    }
}

impl Rule for MD052ReferenceLinkImages {
    fn name(&self) -> &'static str {
        "MD052"
    }

    fn description(&self) -> &'static str {
        "Reference links and images should use a reference that exists"
    }

    fn category(&self) -> RuleCategory {
        RuleCategory::Link
    }

    fn fix_capability(&self) -> FixCapability {
        FixCapability::Unfixable
    }

    fn check(&self, ctx: &crate::lint_context::LintContext) -> LintResult {
        let content = ctx.content;
        let mut warnings = Vec::new();

        // OPTIMIZATION: Early exit if no brackets at all
        if !content.contains('[') {
            return Ok(warnings);
        }

        // Check if we're in MkDocs mode from the context
        let mkdocs_mode = ctx.flavor == crate::config::MarkdownFlavor::MkDocs;

        let references = self.extract_references(ctx);

        // Use optimized detection method with cached link/image data
        let lines = ctx.raw_lines();
        for (line_num, col, match_len, reference) in self.find_undefined_references(&references, ctx, mkdocs_mode) {
            let line_content = lines.get(line_num).unwrap_or(&"");

            // Calculate precise character range for the entire undefined reference
            let (start_line, start_col, end_line, end_col) =
                calculate_match_range(line_num + 1, line_content, col, match_len);

            warnings.push(LintWarning {
                rule_name: Some(self.name().to_string()),
                line: start_line,
                column: start_col,
                end_line,
                end_column: end_col,
                message: format!("Reference '{reference}' not found"),
                severity: Severity::Warning,
                fix: None,
            });
        }

        Ok(warnings)
    }

    /// Check if this rule should be skipped for performance
    fn should_skip(&self, ctx: &crate::lint_context::LintContext) -> bool {
        // Skip if content is empty or has no links/images
        ctx.content.is_empty() || !ctx.likely_has_links_or_images()
    }

    fn fix(&self, ctx: &crate::lint_context::LintContext) -> Result<String, LintError> {
        let content = ctx.content;
        // No automatic fix available for undefined references
        Ok(content.to_string())
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }

    crate::impl_rule_config_methods!(MD052Config);
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::lint_context::LintContext;

    #[test]
    fn test_valid_reference_link() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[text][ref]\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_undefined_reference_link() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[text][undefined]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("Reference 'undefined' not found"));
    }

    #[test]
    fn test_undefined_reference_column_non_ascii_prefix() {
        // Issue #670: columns are character offsets. A multi-byte prefix must not
        // shift the reported column (the reference span is located via a char-based
        // start_col fed into a byte-expecting range helper).
        let rule = MD052ReferenceLinkImages::new();
        // Character columns: 1:你 2:好 3:[ ...  The reference link starts at column 3.
        let content = "你好[text][undefined]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1);
        assert_eq!(
            result[0].column, 3,
            "Column must be a character offset, not a byte offset"
        );
    }

    #[test]
    fn test_valid_reference_image() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "![alt][img]\n\n[img]: image.jpg";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_undefined_reference_image() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "![alt][missing]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("Reference 'missing' not found"));
    }

    #[test]
    fn test_case_insensitive_references() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[Text][REF]\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_shortcut_reference_valid() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[ref]\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_shortcut_reference_undefined_with_shortcut_syntax_enabled() {
        // Shortcut syntax checking is disabled by default
        // Enable it to test undefined shortcut references
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });
        let content = "[undefined]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("Reference 'undefined' not found"));
    }

    #[test]
    fn test_shortcut_reference_in_table_cell_with_shortcut_syntax_enabled() {
        // A table cell is an ordinary inline context, so a shortcut reference in
        // one is checked like any other once shortcut_syntax is on.
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });
        let content = "| A | B |\n| --- | --- |\n| [undefined] | [defined] |\n\n[defined]: https://example.com\n";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1, "{result:?}");
        assert_eq!(result[0].line, 3);
        assert!(result[0].message.contains("Reference 'undefined' not found"));
    }

    #[test]
    fn test_shortcut_reference_not_checked_by_default() {
        // By default, shortcut references are NOT checked (matches markdownlint behavior)
        let rule = MD052ReferenceLinkImages::new();
        let content = "[undefined]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should be 0 because shortcut_syntax is false by default
        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_inline_links_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[text](https://example.com)";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_inline_images_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "![alt](image.jpg)";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_references_in_code_blocks_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "```\n[undefined]\n```\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_references_in_inline_code_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "`[undefined]`";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // References inside inline code spans should be ignored
        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_comprehensive_inline_code_detection() {
        // Enable shortcut_syntax to test comprehensive detection
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });
        let content = r#"# Test

This `[inside]` should be ignored.
This [outside] should be flagged.
Reference links `[text][ref]` in code are ignored.
Regular reference [text][missing] should be flagged.
Images `![alt][img]` in code are ignored.
Regular image ![alt][badimg] should be flagged.

Multiple `[one]` and `[two]` in code ignored, but [three] is not.

```
[code block content] should be ignored
```

`Multiple [refs] in [same] code span` ignored."#;

        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag: outside, missing, badimg, three (4 total)
        assert_eq!(result.len(), 4);

        let messages: Vec<&str> = result.iter().map(|w| &*w.message).collect();
        assert!(messages.iter().any(|m| m.contains("outside")));
        assert!(messages.iter().any(|m| m.contains("missing")));
        assert!(messages.iter().any(|m| m.contains("badimg")));
        assert!(messages.iter().any(|m| m.contains("three")));

        // Should NOT flag any references inside code spans
        assert!(!messages.iter().any(|m| m.contains("inside")));
        assert!(!messages.iter().any(|m| m.contains("one")));
        assert!(!messages.iter().any(|m| m.contains("two")));
        assert!(!messages.iter().any(|m| m.contains("refs")));
        assert!(!messages.iter().any(|m| m.contains("same")));
    }

    #[test]
    fn test_multiple_undefined_references() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[link1][ref1] [link2][ref2] [link3][ref3]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 3);
        assert!(result[0].message.contains("ref1"));
        assert!(result[1].message.contains("ref2"));
        assert!(result[2].message.contains("ref3"));
    }

    #[test]
    fn test_mixed_valid_and_undefined() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[valid][ref] [invalid][missing]\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("missing"));
    }

    #[test]
    fn test_empty_reference() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[text][]\n\n[ref]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Empty reference should use the link text as reference
        assert_eq!(result.len(), 1);
    }

    #[test]
    fn test_escaped_brackets_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "\\[not a link\\]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_list_items_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "- [undefined]\n* [another]\n+ [third]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // List items that look like shortcut references should be ignored
        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_output_example_section_ignored() {
        // Enable shortcut_syntax to test example section handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });
        let content = "## Output\n\n[undefined]\n\n## Normal Section\n\n[missing]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Only the reference outside the Output section should be flagged
        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("missing"));
    }

    #[test]
    fn test_reference_definitions_in_code_blocks_ignored() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[link][ref]\n\n```\n[ref]: https://example.com\n```";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Reference defined in code block should not count
        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("ref"));
    }

    #[test]
    fn test_multiple_references_to_same_undefined() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[first][missing] [second][missing] [third][missing]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only report once per unique reference
        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("missing"));
    }

    #[test]
    fn test_reference_with_special_characters() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[text][ref-with-hyphens]\n\n[ref-with-hyphens]: https://example.com";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_issue_51_html_attribute_not_reference() {
        // Test for issue #51 - HTML attributes with square brackets shouldn't be treated as references
        let rule = MD052ReferenceLinkImages::new();
        let content = r#"# Example

## Test

Want to fill out this form?

<form method="post">
    <input type="email" name="fields[email]" id="drip-email" placeholder="email@domain.com">
</form>"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(
            result.len(),
            0,
            "HTML attributes with square brackets should not be flagged as undefined references"
        );
    }

    #[test]
    fn test_extract_references() {
        let rule = MD052ReferenceLinkImages::new();
        let content = "[ref1]: url1\n[Ref2]: url2\n[REF3]: url3";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let refs = rule.extract_references(&ctx);

        assert_eq!(refs.len(), 3);
        assert!(refs.contains("ref1"));
        assert!(refs.contains("ref2"));
        assert!(refs.contains("ref3"));
    }

    #[test]
    fn test_inline_code_not_flagged() {
        // Enable shortcut_syntax to test inline code detection
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        // Test that arrays in inline code are not flagged as references
        let content = r#"# Test

Configure with `["JavaScript", "GitHub", "Node.js"]` in your settings.

Also, `[todo]` is not a reference link.

But this [reference] should be flagged.

And this `[inline code]` should not be flagged.
"#;

        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let warnings = rule.check(&ctx).unwrap();

        // Should only flag [reference], not the ones in backticks
        assert_eq!(warnings.len(), 1, "Should only flag one undefined reference");
        assert!(warnings[0].message.contains("'reference'"));
    }

    #[test]
    fn test_code_block_references_ignored() {
        // Enable shortcut_syntax to test code block handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        let content = r#"# Test

```markdown
[undefined] reference in code block
![undefined] image in code block
```

[real-undefined] reference outside
"#;

        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let warnings = rule.check(&ctx).unwrap();

        // Should only flag [real-undefined], not the ones in code block
        assert_eq!(warnings.len(), 1);
        assert!(warnings[0].message.contains("'real-undefined'"));
    }

    #[test]
    fn test_html_comments_ignored() {
        // Test for issue #20 - MD052 should not flag content inside HTML comments
        let rule = MD052ReferenceLinkImages::new();

        // Test the exact case from issue #20
        let content = r#"<!--- write fake_editor.py 'import sys\nopen(*sys.argv[1:], mode="wt").write("2 3 4 4 2 3 2")' -->
<!--- set_env EDITOR 'python3 fake_editor.py' -->

```bash
$ python3 vote.py
3 votes for: 2
2 votes for: 3, 4
```"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(result.len(), 0, "Should not flag [1:] inside HTML comments");

        // Test various reference patterns inside HTML comments
        let content = r#"<!-- This is [ref1] and [ref2][ref3] -->
Normal [text][undefined]
<!-- Another [comment][with] references -->"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(
            result.len(),
            1,
            "Should only flag the undefined reference outside comments"
        );
        assert!(result[0].message.contains("undefined"));

        // Test multi-line HTML comments
        let content = r#"<!--
[ref1]
[ref2][ref3]
-->
[actual][undefined]"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(
            result.len(),
            1,
            "Should not flag references in multi-line HTML comments"
        );
        assert!(result[0].message.contains("undefined"));

        // Test mixed scenarios
        let content = r#"<!-- Comment with [1:] pattern -->
Valid [link][ref]
<!-- More [refs][in][comments] -->
![image][missing]

[ref]: https://example.com"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(result.len(), 1, "Should only flag missing image reference");
        assert!(result[0].message.contains("missing"));
    }

    #[test]
    fn test_frontmatter_ignored() {
        // Test for issue #24 - MD052 should not flag content inside frontmatter
        // Enable shortcut_syntax to test frontmatter handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        // Test YAML frontmatter with arrays and references
        let content = r#"---
layout: post
title: "My Jekyll Post"
date: 2023-01-01
categories: blog
tags: ["test", "example"]
author: John Doe
---

# My Blog Post

This is the actual markdown content that should be linted.

[undefined] reference should be flagged.

## Section 1

Some content here."#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag [undefined] in the content, not the ["test", "example"] array in frontmatter
        assert_eq!(
            result.len(),
            1,
            "Should only flag the undefined reference outside frontmatter"
        );
        assert!(result[0].message.contains("undefined"));

        // Test TOML frontmatter
        let content = r#"+++
title = "My Post"
tags = ["example", "test"]
+++

# Content

[missing] reference should be flagged."#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(
            result.len(),
            1,
            "Should only flag the undefined reference outside TOML frontmatter"
        );
        assert!(result[0].message.contains("missing"));
    }

    #[test]
    fn test_mkdocs_snippet_markers_not_flagged() {
        // Test for issue #68 - MkDocs snippet selection markers should not be flagged as undefined references
        // Enable shortcut_syntax to test snippet marker handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        // Test snippet section markers
        let content = r#"# Document with MkDocs Snippets

Some content here.

# -8<- [start:remote-content]

This is the remote content section.

# -8<- [end:remote-content]

More content here.

<!-- --8<-- [start:another-section] -->
Content in another section
<!-- --8<-- [end:another-section] -->"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::MkDocs, None);
        let result = rule.check(&ctx).unwrap();

        // Should not flag any snippet markers as undefined references
        assert_eq!(
            result.len(),
            0,
            "Should not flag MkDocs snippet markers as undefined references"
        );

        // Test that the snippet marker lines are properly skipped
        // but regular undefined references on other lines are still caught
        let content = r#"# Document

# -8<- [start:section]
Content with [reference] inside snippet section
# -8<- [end:section]

Regular [undefined] reference outside snippet markers."#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::MkDocs, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(
            result.len(),
            2,
            "Should flag undefined references but skip snippet marker lines"
        );
        // The references inside the content should be flagged, but not start: and end:
        assert!(result[0].message.contains("reference"));
        assert!(result[1].message.contains("undefined"));

        // Test in standard mode - should flag the markers as undefined
        let content = r#"# Document

# -8<- [start:section]
# -8<- [end:section]"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        assert_eq!(
            result.len(),
            2,
            "In standard mode, snippet markers should be flagged as undefined references"
        );
    }

    #[test]
    fn test_pandoc_citations_not_flagged() {
        // Test that Pandoc/RMarkdown/Quarto citation syntax is not flagged
        // Enable shortcut_syntax to test citation handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        let content = r#"# Research Paper

We are using the **bookdown** package [@R-bookdown] in this sample book.
This was built on top of R Markdown and **knitr** [@xie2015].

Multiple citations [@citation1; @citation2; @citation3] are also supported.

Regular [undefined] reference should still be flagged.
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag the undefined reference, not the citations
        assert_eq!(
            result.len(),
            1,
            "Should only flag the undefined reference, not Pandoc citations"
        );
        assert!(result[0].message.contains("undefined"));
    }

    #[test]
    fn test_pandoc_inline_footnotes_not_flagged() {
        // Test that Pandoc inline footnote syntax is not flagged
        // Enable shortcut_syntax to test inline footnote handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        let content = r#"# Math Document

You can use math in footnotes like this^[where we mention $p = \frac{a}{b}$].

Another footnote^[with some text and a [link](https://example.com)].

But this [reference] without ^ should be flagged.
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag the reference without ^
        assert_eq!(
            result.len(),
            1,
            "Should only flag the regular reference, not inline footnotes"
        );
        assert!(result[0].message.contains("reference"));
    }

    #[test]
    fn test_github_alerts_not_flagged() {
        // Test for issue #60 - GitHub alerts should not be flagged as undefined references
        // Enable shortcut_syntax to test GitHub alert handling
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });

        // Test various GitHub alert types
        let content = r#"# Document with GitHub Alerts

> [!NOTE]
> This is a note alert.

> [!TIP]
> This is a tip alert.

> [!IMPORTANT]
> This is an important alert.

> [!WARNING]
> This is a warning alert.

> [!CAUTION]
> This is a caution alert.

Regular content with [undefined] reference."#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag the undefined reference, not the GitHub alerts
        assert_eq!(
            result.len(),
            1,
            "Should only flag the undefined reference, not GitHub alerts"
        );
        assert!(result[0].message.contains("undefined"));
        assert_eq!(result[0].line, 18); // Line with [undefined]

        // Test GitHub alerts with additional content
        let content = r#"> [!TIP]
> Here's a useful tip about [something].
> Multiple lines are allowed.

[something] is mentioned but not defined."#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should flag only the [something] outside blockquotes
        // The test shows we're only catching one, which might be correct behavior
        // matching markdownlint's approach
        assert_eq!(result.len(), 1, "Should flag undefined reference");
        assert!(result[0].message.contains("something"));

        // Test GitHub alerts with proper references
        let content = r#"> [!NOTE]
> See [reference] for more details.

[reference]: https://example.com"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should not flag anything - [!NOTE] is GitHub alert and [reference] is defined
        assert_eq!(result.len(), 0, "Should not flag GitHub alerts or defined references");
    }

    #[test]
    fn test_ignore_config() {
        // Test that user-configured ignore list is respected
        let config = MD052Config {
            shortcut_syntax: true,
            ignore: vec!["Vec".to_string(), "HashMap".to_string(), "Option".to_string()],
        };
        let rule = MD052ReferenceLinkImages::from_config_struct(config);

        let content = r#"# Document with Custom Types

Use [Vec] for dynamic arrays.
Use [HashMap] for key-value storage.
Use [Option] for nullable values.
Use [Result] for error handling.
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag [Result] because it's not in ignore
        assert_eq!(result.len(), 1, "Should only flag names not in ignore");
        // The message preserves the author's original casing for shortcut references.
        assert!(result[0].message.contains("Result"));
    }

    #[test]
    fn test_ignore_case_insensitive() {
        // Test that ignore list is case-insensitive
        let config = MD052Config {
            shortcut_syntax: true,
            ignore: vec!["Vec".to_string()],
        };
        let rule = MD052ReferenceLinkImages::from_config_struct(config);

        let content = r#"# Case Insensitivity Test

[Vec] should be ignored.
[vec] should also be ignored (different case, same match).
[VEC] should also be ignored (different case, same match).
[undefined] should be flagged (not in ignore list).
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should only flag [undefined] because ignore is case-insensitive
        assert_eq!(result.len(), 1, "Should only flag non-ignored reference");
        assert!(result[0].message.contains("undefined"));
    }

    #[test]
    fn test_ignore_empty_by_default() {
        // Test that empty ignore list doesn't affect existing behavior
        let rule = MD052ReferenceLinkImages::new();

        let content = "[text][undefined]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Should still flag undefined references
        assert_eq!(result.len(), 1);
        assert!(result[0].message.contains("undefined"));
    }

    #[test]
    fn test_ignore_with_reference_links() {
        // Test ignore list with full reference link syntax [text][ref]
        let config = MD052Config {
            shortcut_syntax: false,
            ignore: vec!["CustomType".to_string()],
        };
        let rule = MD052ReferenceLinkImages::from_config_struct(config);

        let content = r#"# Test

See [documentation][CustomType] for details.
See [other docs][MissingRef] for more.
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Debug: print warnings if test fails
        for (i, w) in result.iter().enumerate() {
            eprintln!("Warning {}: {}", i, w.message);
        }

        // Should flag [MissingRef] but not [CustomType]
        // Note: reference IDs are lowercased in the message
        assert_eq!(result.len(), 1, "Expected 1 warning, got {}", result.len());
        assert!(
            result[0].message.contains("missingref"),
            "Expected 'missingref' in message: {}",
            result[0].message
        );
    }

    #[test]
    fn test_ignore_multiple() {
        // Test multiple ignored names work correctly
        let config = MD052Config {
            shortcut_syntax: true,
            ignore: vec![
                "i32".to_string(),
                "u64".to_string(),
                "String".to_string(),
                "Arc".to_string(),
                "Mutex".to_string(),
            ],
        };
        let rule = MD052ReferenceLinkImages::from_config_struct(config);

        let content = r#"# Types

[i32] [u64] [String] [Arc] [Mutex] [Box]
"#;
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // Note: i32 and u64 are already in the hardcoded list, so they'd be skipped anyway
        // String is NOT in the hardcoded list, so we test that the user config works
        // [Box] should be flagged (not in ignore)
        assert_eq!(result.len(), 1);
        // The message preserves the author's original casing for shortcut references.
        assert!(result[0].message.contains("Box"));
    }

    #[test]
    fn test_nested_code_fences_reference_extraction() {
        // Verify that extract_references uses LintContext's pre-computed in_code_block
        // so nested fences are handled correctly.
        // A 4-backtick fence wrapping a 3-backtick fence should treat the inner
        // ``` as content, not a code block boundary.
        let rule = MD052ReferenceLinkImages::new();

        let content = "````\n```\n[ref-inside]: https://example.com\n```\n````\n\n[Use this link][ref-inside]";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();

        // The reference definition is inside a code block (the outer ````),
        // so it should NOT be recognized as a definition.
        // Therefore [ref-inside] should be flagged as undefined.
        assert_eq!(
            result.len(),
            1,
            "Reference defined inside nested code fence should not count as a definition"
        );
        assert!(result[0].message.contains("ref-inside"));
    }

    #[test]
    fn test_pandoc_flavor_skips_citations() {
        // Pandoc citations ([@key]) are bibliography references, not undefined reference
        // links. MD052 should skip them under Pandoc flavor, mirroring the Quarto skip.
        let rule = MD052ReferenceLinkImages::new();
        let content = "See [@smith2020] for details.\n";
        let ctx = LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
        let result = rule.check(&ctx).unwrap();
        assert!(
            result.is_empty(),
            "MD052 should skip Pandoc citations under Pandoc flavor: {result:?}"
        );
    }

    #[test]
    fn md052_pandoc_skips_implicit_header_refs_with_shortcut_syntax() {
        // Implicit header references (`[Section name]` resolving to a heading
        // whose Pandoc slug matches the bracketed text) only flow through
        // MD052's shortcut-syntax regex path — pulldown-cmark drops them as
        // broken links before they reach `ctx.links()`. Enabling
        // `shortcut_syntax = true` exercises the SHORTCUT_REF_REGEX scan where
        // the Pandoc implicit-header-ref guard lives.
        use crate::config::MarkdownFlavor;
        let rule = MD052ReferenceLinkImages::from_config_struct(MD052Config {
            shortcut_syntax: true,
            ..Default::default()
        });
        let content = "# My Section\n\nSee [My Section] for details.\n";

        // Under Standard flavor (no implicit-header-ref resolution), shortcut
        // checking flags the bracketed text as undefined.
        let ctx_std = LintContext::new(content, MarkdownFlavor::Standard, None);
        let std_result = rule.check(&ctx_std).unwrap();
        assert_eq!(
            std_result.len(),
            1,
            "Standard flavor with shortcut_syntax should flag [My Section]: {std_result:?}"
        );

        // Under Pandoc flavor, the implicit-header-ref guard resolves it.
        let ctx_pandoc = LintContext::new(content, MarkdownFlavor::Pandoc, None);
        let pandoc_result = rule.check(&ctx_pandoc).unwrap();
        assert!(
            pandoc_result.is_empty(),
            "Pandoc flavor should accept [My Section] as an implicit header ref: {pandoc_result:?}"
        );
    }

    #[test]
    fn test_md052_complex_undefined_reference() {
        let rule = MD052ReferenceLinkImages::from_config(&crate::config::Config::default());
        // Undefined reference with complex text containing brackets in code span
        let content = "Check [link `code [with brackets]` text][undefined_ref] for details.\n";
        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
        let result = rule.check(&ctx).unwrap();
        assert_eq!(
            result.len(),
            1,
            "Undefined reference in complex link must be flagged: {result:?}"
        );
        assert_eq!(result[0].message, "Reference 'undefined_ref' not found");
    }
}