Skip to main content

rumdl_lib/
lib.rs

1#![warn(unreachable_pub)]
2#![warn(clippy::pedantic)]
3// Style-only pedantic lints we don't enforce. Each one generated >5 occurrences
4// that were either deliberate design choices or too noisy for the value
5// delivered. Categories that flag potential bugs stay on.
6#![allow(clippy::doc_markdown)]
7#![allow(clippy::must_use_candidate)]
8#![allow(clippy::missing_errors_doc)]
9#![allow(clippy::missing_panics_doc)]
10#![allow(clippy::too_many_lines)]
11#![allow(clippy::if_not_else)]
12#![allow(clippy::similar_names)]
13#![allow(clippy::wildcard_imports)]
14#![allow(clippy::case_sensitive_file_extension_comparisons)]
15#![allow(clippy::doc_link_with_quotes)]
16#![allow(clippy::needless_raw_string_hashes)]
17#![allow(clippy::trivially_copy_pass_by_ref)]
18#![allow(clippy::struct_excessive_bools)]
19#![allow(clippy::fn_params_excessive_bools)]
20#![allow(clippy::elidable_lifetime_names)]
21#![allow(clippy::return_self_not_must_use)]
22#![allow(clippy::redundant_else)]
23#![allow(clippy::single_match_else)]
24#![allow(clippy::needless_continue)]
25#![allow(clippy::semicolon_if_nothing_returned)]
26#![allow(clippy::ignored_unit_patterns)]
27#![allow(clippy::unreadable_literal)]
28#![allow(clippy::implicit_hasher)]
29#![allow(clippy::ref_option)]
30#![allow(clippy::struct_field_names)]
31#![allow(clippy::unused_self)]
32#![allow(clippy::unnested_or_patterns)]
33#![allow(clippy::cast_precision_loss)]
34#![allow(clippy::cast_sign_loss)]
35#![allow(clippy::cast_possible_wrap)]
36#![allow(clippy::cast_possible_truncation)]
37#![allow(clippy::cast_lossless)]
38#![allow(clippy::items_after_statements)]
39#![allow(clippy::match_same_arms)]
40#![allow(clippy::format_push_string)]
41// Test smoke-constructors like `let _formatter = Foo;` fire this lint,
42// but are acceptable: they verify the type exists without asserting behavior.
43#![allow(clippy::no_effect_underscore_binding)]
44// Style-only: `Default::default()` vs `T::default()`. Both are readable.
45#![allow(clippy::default_trait_access)]
46// Style-only: `"".to_string()` vs `String::new()`. Tests favor the former
47// for symmetry with non-empty string literals.
48#![allow(clippy::manual_string_new)]
49
50pub mod code_block_tools;
51pub mod config;
52pub mod discovery;
53pub mod doc_comment_lint;
54pub mod document_run;
55pub mod embedded_lint;
56pub mod exit_codes;
57pub mod filtered_lines;
58pub mod fix_coordinator;
59pub mod inline_config;
60pub mod linguist_data;
61pub mod lint_context;
62pub mod markdownlint_config;
63pub mod profiling;
64pub mod rule;
65#[cfg(feature = "colored")]
66pub mod vscode;
67pub mod workspace_index;
68#[macro_use]
69pub mod rule_config;
70#[macro_use]
71pub mod rule_config_serde;
72pub mod rules;
73pub mod types;
74pub mod utils;
75
76// Native-only modules (require tokio, tower-lsp, etc.)
77#[cfg(feature = "native")]
78pub mod lsp;
79#[cfg(feature = "colored")]
80pub mod output;
81
82// WASM module
83#[cfg(feature = "wasm")]
84pub mod wasm;
85
86pub use rules::heading_utils::HeadingStyle;
87pub use rules::*;
88
89pub use crate::lint_context::{LineInfo, LintContext, ListItemInfo};
90use crate::rule::{LintResult, Rule, RuleCategory};
91use crate::utils::calculate_indentation_width_default;
92#[cfg(not(target_arch = "wasm32"))]
93use std::time::Instant;
94
95/// Content characteristics for efficient rule filtering
96#[derive(Debug, Default)]
97struct ContentCharacteristics {
98    has_headings: bool,    // # or setext headings
99    has_lists: bool,       // *, -, +, 1. etc
100    has_links: bool,       // [text](url) or [text][ref]
101    has_code: bool,        // ``` or ~~~ or indented code
102    has_emphasis: bool,    // * or _ for emphasis
103    has_html: bool,        // < > tags
104    has_tables: bool,      // | pipes
105    has_blockquotes: bool, // > markers
106    has_images: bool,      // ![alt](url)
107}
108
109/// Check if a line has enough leading whitespace to be an indented code block.
110/// Indented code blocks require 4+ columns of leading whitespace (with proper tab expansion).
111fn has_potential_indented_code_indent(line: &str) -> bool {
112    calculate_indentation_width_default(line) >= 4
113}
114
115impl ContentCharacteristics {
116    fn analyze(content: &str) -> Self {
117        let mut chars = Self { ..Default::default() };
118
119        // Quick single-pass analysis
120        let mut has_atx_heading = false;
121        let mut has_setext_heading = false;
122
123        for line in content.lines() {
124            let trimmed = line.trim();
125
126            // Headings: ATX (#) or Setext (underlines). A blockquoted ATX
127            // heading (`> ## Title`) still emits a fragment anchor, so rules
128            // like MD051/MD080 must run for blockquote-only documents too.
129            // Stripping `>`/space/tab is a coarse, deliberately
130            // over-inclusive prefilter check (it must never skip a rule that
131            // has work; `parse_blockquote_prefix` also accepts a tab marker).
132            if !has_atx_heading
133                && (trimmed.starts_with('#') || trimmed.trim_start_matches(['>', ' ', '\t']).starts_with('#'))
134            {
135                has_atx_heading = true;
136            }
137            if !has_setext_heading && (trimmed.chars().all(|c| c == '=' || c == '-') && trimmed.len() > 1) {
138                has_setext_heading = true;
139            }
140
141            // Quick character-based detection (more efficient than regex)
142            // Include patterns without spaces to enable user-intention detection (MD030)
143            if !chars.has_lists
144                && (line.contains("* ")
145                    || line.contains("- ")
146                    || line.contains("+ ")
147                    || trimmed.starts_with("* ")
148                    || trimmed.starts_with("- ")
149                    || trimmed.starts_with("+ ")
150                    || trimmed.starts_with('*')
151                    || trimmed.starts_with('-')
152                    || trimmed.starts_with('+'))
153            {
154                chars.has_lists = true;
155            }
156            // Ordered lists: line starts with digit, or blockquote line contains digit followed by period
157            if !chars.has_lists
158                && ((line.chars().next().is_some_and(|c| c.is_ascii_digit())
159                    && (line.contains(". ") || line.contains('.')))
160                    || (trimmed.starts_with('>')
161                        && trimmed.chars().any(|c| c.is_ascii_digit())
162                        && (trimmed.contains(". ") || trimmed.contains('.'))))
163            {
164                chars.has_lists = true;
165            }
166            if !chars.has_links
167                && (line.contains('[')
168                    || line.contains("http://")
169                    || line.contains("https://")
170                    || line.contains("ftp://")
171                    || line.contains("www."))
172            {
173                chars.has_links = true;
174            }
175            if !chars.has_images && line.contains("![") {
176                chars.has_images = true;
177            }
178            if !chars.has_code
179                && (line.contains('`') || line.contains("~~~") || has_potential_indented_code_indent(line))
180            {
181                chars.has_code = true;
182            }
183            if !chars.has_emphasis && (line.contains('*') || line.contains('_')) {
184                chars.has_emphasis = true;
185            }
186            if !chars.has_html && line.contains('<') {
187                chars.has_html = true;
188            }
189            if !chars.has_tables && line.contains('|') {
190                chars.has_tables = true;
191            }
192            if !chars.has_blockquotes && line.starts_with('>') {
193                chars.has_blockquotes = true;
194            }
195        }
196
197        chars.has_headings = has_atx_heading || has_setext_heading;
198        chars
199    }
200
201    /// Check if a rule should be skipped based on content characteristics
202    fn should_skip_rule(&self, rule: &dyn Rule) -> bool {
203        match rule.category() {
204            RuleCategory::Heading => !self.has_headings,
205            RuleCategory::List => !self.has_lists,
206            RuleCategory::Link => !self.has_links && !self.has_images,
207            RuleCategory::Image => !self.has_images,
208            RuleCategory::CodeBlock => !self.has_code,
209            RuleCategory::Html => !self.has_html,
210            RuleCategory::Emphasis => !self.has_emphasis,
211            RuleCategory::Blockquote => !self.has_blockquotes,
212            RuleCategory::Table => !self.has_tables,
213            // Always check these categories as they apply to all content
214            RuleCategory::Whitespace | RuleCategory::FrontMatter | RuleCategory::Other => false,
215        }
216    }
217}
218
219/// Compute content hash for incremental indexing change detection
220///
221/// Uses blake3 for native builds (fast, cryptographic-strength hash)
222/// Falls back to std::hash for WASM builds
223#[cfg(feature = "native")]
224fn compute_content_hash(content: &str) -> String {
225    #[cfg(feature = "profiling")]
226    let start = std::time::Instant::now();
227    let hash = blake3::hash(content.as_bytes()).to_hex().to_string();
228    #[cfg(feature = "profiling")]
229    profiling::record_duration("index: hash content", start.elapsed());
230    hash
231}
232
233/// Compute content hash for WASM builds using std::hash
234#[cfg(not(feature = "native"))]
235fn compute_content_hash(content: &str) -> String {
236    use std::hash::{DefaultHasher, Hash, Hasher};
237    let mut hasher = DefaultHasher::new();
238    content.hash(&mut hasher);
239    format!("{:016x}", hasher.finish())
240}
241
242/// Lint a file against the given rules with intelligent rule filtering
243/// Assumes the provided `rules` vector contains the final,
244/// configured, and filtered set of rules to be executed.
245pub fn lint(
246    content: &str,
247    rules: &[Box<dyn Rule>],
248    verbose: bool,
249    flavor: crate::config::MarkdownFlavor,
250    source_file: Option<std::path::PathBuf>,
251    config: Option<&crate::config::Config>,
252) -> LintResult {
253    let (result, _file_index) = lint_and_index(content, rules, verbose, flavor, source_file, config);
254    result
255}
256
257/// Build FileIndex only (no linting) for cross-file analysis on cache hits
258///
259/// This is a lightweight function that only builds the FileIndex without running
260/// any rules. Used when we have a cache hit but still need the FileIndex for
261/// cross-file validation.
262///
263/// This avoids the overhead of re-running all rules when only the index data is needed.
264pub fn build_file_index_only(
265    content: &str,
266    rules: &[Box<dyn Rule>],
267    flavor: crate::config::MarkdownFlavor,
268    source_file: Option<std::path::PathBuf>,
269) -> crate::workspace_index::FileIndex {
270    // Compute content hash for change detection
271    let content_hash = compute_content_hash(content);
272    let mut file_index = crate::workspace_index::FileIndex::with_hash(content_hash);
273
274    // Early return for empty content
275    if content.is_empty() {
276        return file_index;
277    }
278
279    // Parse LintContext once with the provided flavor
280    let lint_ctx = time_function!(
281        "index: parse lint context",
282        crate::lint_context::LintContext::new(content, flavor, source_file)
283    );
284
285    // Export inline disable data to the FileIndex so cross-file checks honor
286    // `<!-- rumdl-disable -->` blocks on the lint-cache fast path, exactly as
287    // lint_and_index does on the normal path.
288    let (file_disabled, persistent_transitions, line_disabled) = lint_ctx.inline_config().export_for_file_index();
289    file_index.file_disabled_rules = file_disabled;
290    file_index.persistent_transitions = persistent_transitions;
291    file_index.line_disabled_rules = line_disabled;
292
293    // Only call contribute_to_index for cross-file rules (no rule checking!)
294    time_section!("index: contribute cross-file data", {
295        for rule in rules {
296            if rule.cross_file_scope() == crate::rule::CrossFileScope::Workspace {
297                rule.contribute_to_index(&lint_ctx, &mut file_index);
298            }
299        }
300    });
301
302    file_index
303}
304
305/// Drop the warnings a document silences, and apply any configured severity override
306/// to the rest.
307///
308/// A warning is dropped when it sits in a kramdown extension block or when an inline
309/// comment disables its rule somewhere in its range. `suppressed`, when given,
310/// collects what the inline comments removed, for the rules that report on them. A
311/// kramdown extension block is not an inline comment, so what it drops is left out.
312fn retain_reportable_warnings(
313    lint_ctx: &crate::lint_context::LintContext,
314    config: Option<&crate::config::Config>,
315    rule_name: &str,
316    rule_warnings: Vec<crate::rule::LintWarning>,
317    mut suppressed: Option<&mut Vec<crate::rule::SuppressedWarning>>,
318) -> Vec<crate::rule::LintWarning> {
319    let inline_config = lint_ctx.inline_config();
320    let mut kept = Vec::with_capacity(rule_warnings.len());
321
322    for mut warning in rule_warnings {
323        if lint_ctx
324            .line_info(warning.line)
325            .is_some_and(|info| info.in_kramdown_extension_block)
326        {
327            continue;
328        }
329
330        // Use the warning's rule_name if available, otherwise use the rule's name
331        let rule_name_to_check = warning.rule_name.as_deref().unwrap_or(rule_name);
332
333        // Extract the base rule name for sub-rules like "MD029-style" -> "MD029"
334        let base_rule_name = if let Some(dash_pos) = rule_name_to_check.find('-') {
335            &rule_name_to_check[..dash_pos]
336        } else {
337            rule_name_to_check
338        };
339
340        // Check if the rule is disabled at any line in the warning's range.
341        // Multi-line warnings (e.g., reflow) report on the first line,
342        // but inline disable comments may appear later in the range.
343        // Guard: if end_line < line (e.g., end_line=0), fall back to
344        // checking only the warning's line to match original behavior.
345        let end = if warning.end_line >= warning.line {
346            warning.end_line
347        } else {
348            warning.line
349        };
350        let disabled_at = (warning.line..=end).find_map(|line| {
351            inline_config
352                .disabling_layer(base_rule_name, line)
353                .map(|layer| (line, layer))
354        });
355        if let Some((line, layer)) = disabled_at {
356            if let Some(record) = suppressed.as_deref_mut() {
357                record.push(crate::rule::SuppressedWarning {
358                    rule_name: base_rule_name.to_string(),
359                    line,
360                    layer,
361                });
362            }
363            continue;
364        }
365
366        // Apply severity override from config if present
367        if let Some(cfg) = config
368            && let Some(override_severity) = cfg.get_rule_severity(rule_name_to_check)
369        {
370            warning.severity = override_severity;
371        }
372
373        kept.push(warning);
374    }
375
376    kept
377}
378
379/// Lint a file and contribute to workspace index for cross-file analysis
380///
381/// This variant performs linting and optionally populates a `FileIndex` with data
382/// needed for cross-file validation. The FileIndex is populated during linting,
383/// avoiding duplicate parsing.
384///
385/// Returns: (warnings, FileIndex) - the FileIndex contains headings/links for cross-file rules
386#[cfg_attr(test, allow(unused_variables))]
387#[allow(clippy::needless_pass_by_value)] // Public compatibility: callers already pass an owned path.
388pub fn lint_and_index(
389    content: &str,
390    rules: &[Box<dyn Rule>],
391    verbose: bool,
392    flavor: crate::config::MarkdownFlavor,
393    source_file: Option<std::path::PathBuf>,
394    config: Option<&crate::config::Config>,
395) -> (LintResult, crate::workspace_index::FileIndex) {
396    lint_and_index_with_paths(
397        content,
398        rules,
399        verbose,
400        flavor,
401        DocumentPaths::same(source_file.as_deref()),
402        config,
403    )
404}
405
406/// The two path roles involved in document processing.
407#[derive(Debug, Clone, Copy, Default)]
408pub struct DocumentPaths<'a> {
409    /// Logical path used for per-file configuration matching.
410    pub config_path: Option<&'a std::path::Path>,
411    /// Native path exposed to filesystem-aware rules.
412    pub source_file: Option<&'a std::path::Path>,
413}
414
415impl<'a> DocumentPaths<'a> {
416    /// Use one native path for both roles.
417    pub fn same(path: Option<&'a std::path::Path>) -> Self {
418        Self {
419            config_path: path,
420            source_file: path,
421        }
422    }
423}
424
425/// Lint a document while keeping configuration matching separate from filesystem context.
426///
427/// `paths.config_path` selects per-file ignores and other path-scoped configuration.
428/// `paths.source_file` is exposed to rules that need a real filesystem location. Native
429/// adapters normally pass the same path for both; virtual adapters can supply only
430/// `config_path` without accidentally enabling filesystem-dependent rule behavior.
431#[cfg_attr(test, allow(unused_variables))]
432pub fn lint_and_index_with_paths(
433    content: &str,
434    rules: &[Box<dyn Rule>],
435    verbose: bool,
436    flavor: crate::config::MarkdownFlavor,
437    paths: DocumentPaths<'_>,
438    config: Option<&crate::config::Config>,
439) -> (LintResult, crate::workspace_index::FileIndex) {
440    let mut warnings = Vec::new();
441    // Compute content hash for change detection
442    let content_hash = compute_content_hash(content);
443    let mut file_index = crate::workspace_index::FileIndex::with_hash(content_hash);
444
445    // Early return for empty content
446    if content.is_empty() {
447        return (Ok(warnings), file_index);
448    }
449
450    // The rules `per-file-ignores` takes away for this file. It decides what this
451    // file REPORTS, and nothing else: the index contribution at the end of this
452    // function deliberately keeps running every cross-file rule, because a file's
453    // headings and links belong to the workspace rather than to its own report.
454    // Dropping a rule from the index instead would break the links pointing HERE,
455    // in files that never named it.
456    let ignored_for_file = match (config, paths.config_path) {
457        (Some(cfg), Some(path)) => cfg.get_ignored_rules_for_file(path),
458        _ => std::collections::HashSet::new(),
459    };
460
461    // Parse LintContext once (includes inline config parsing)
462    let lint_ctx = time_function!(
463        "lint: parse lint context",
464        crate::lint_context::LintContext::new(content, flavor, paths.source_file.map(std::path::Path::to_path_buf))
465    );
466    let inline_config = lint_ctx.inline_config();
467
468    // Export inline config data to FileIndex for cross-file rule filtering
469    let (file_disabled, persistent_transitions, line_disabled) = inline_config.export_for_file_index();
470    file_index.file_disabled_rules = file_disabled;
471    file_index.persistent_transitions = persistent_transitions;
472    file_index.line_disabled_rules = line_disabled;
473
474    // Analyze content characteristics for rule filtering
475    let characteristics = time_function!(
476        "lint: analyze content characteristics",
477        ContentCharacteristics::analyze(content)
478    );
479
480    // Filter rules based on per-file-ignores and content characteristics
481    let applicable_rules: Vec<_> = rules
482        .iter()
483        .filter(|rule| !ignored_for_file.contains(rule.name()))
484        .filter(|rule| !(rule.skippable_by_category() && characteristics.should_skip_rule(rule.as_ref())))
485        .collect();
486
487    // Calculate skipped rules count before consuming applicable_rules
488    #[cfg(not(test))]
489    let total_rules = rules.len();
490    #[cfg(not(test))]
491    let applicable_count = applicable_rules.len();
492
493    #[cfg(not(target_arch = "wasm32"))]
494    let profile_rules = std::env::var("RUMDL_PROFILE_RULES").is_ok();
495
496    // Automatic inline config support: merge inline overrides into config once,
497    // then recreate only the affected rules. Works for ALL rules without per-rule changes.
498    let inline_overrides = inline_config.get_all_rule_configs();
499    let merged_config = if !inline_overrides.is_empty() {
500        config.map(|c| c.merge_with_inline_config(inline_config))
501    } else {
502        None
503    };
504    let effective_config = merged_config.as_ref().or(config);
505
506    // Cache recreated rules for rules with inline overrides
507    let mut recreated_rules: std::collections::HashMap<String, Box<dyn crate::rule::Rule>> =
508        std::collections::HashMap::new();
509
510    // Pre-create rules that have inline config overrides
511    if let Some(cfg) = effective_config {
512        for rule_name in inline_overrides.keys() {
513            if let Some(recreated) = crate::rules::create_rule_by_name(rule_name, cfg) {
514                recreated_rules.insert(rule_name.clone(), recreated);
515            }
516        }
517    }
518
519    // A rule reporting on the run's inline disable comments needs to know what they
520    // removed, which costs a record per suppressed warning, so it is only kept when
521    // such a rule is going to read it.
522    let suppression_observers: Vec<_> = applicable_rules
523        .iter()
524        .filter(|rule| rule.observes_suppressions() && !rule.should_skip(&lint_ctx))
525        .collect();
526    let mut suppressed = Vec::new();
527
528    {
529        let _timer = profiling::ScopedTimer::new("lint: run single-file rules");
530        for rule in &applicable_rules {
531            #[cfg(not(target_arch = "wasm32"))]
532            let rule_start = Instant::now();
533
534            // Skip rules that indicate they should be skipped (opt-in rules, content-based skipping)
535            if rule.should_skip(&lint_ctx) {
536                continue;
537            }
538
539            // Use recreated rule if inline config overrides exist for this rule
540            let effective_rule: &dyn crate::rule::Rule = recreated_rules
541                .get(rule.name())
542                .map_or(rule.as_ref(), std::convert::AsRef::as_ref);
543
544            // Run single-file check with the effective rule (possibly with inline config applied)
545            let result = effective_rule.check(&lint_ctx);
546
547            match result {
548                Ok(rule_warnings) => {
549                    let record = if suppression_observers.is_empty() {
550                        None
551                    } else {
552                        Some(&mut suppressed)
553                    };
554                    let filtered_warnings =
555                        retain_reportable_warnings(&lint_ctx, config, rule.name(), rule_warnings, record);
556                    warnings.extend(filtered_warnings);
557                }
558                Err(e) => {
559                    log::error!("Error checking rule {}: {}", rule.name(), e);
560                    return (Err(e), file_index);
561                }
562            }
563
564            #[cfg(not(target_arch = "wasm32"))]
565            {
566                let rule_duration = rule_start.elapsed();
567                if profile_rules {
568                    eprintln!("[RULE] {:6} {:?}", rule.name(), rule_duration);
569                }
570
571                #[cfg(not(test))]
572                if verbose && rule_duration.as_millis() > 500 {
573                    log::debug!("Rule {} took {:?}", rule.name(), rule_duration);
574                }
575            }
576        }
577    }
578
579    // Report on the inline disable comments, now that every single-file rule has run
580    // and the suppressions are complete.
581    if !suppression_observers.is_empty() {
582        let _timer = profiling::ScopedTimer::new("lint: run suppression rules");
583
584        // A workspace-scope rule has its warnings filtered after this point, and for a
585        // single-file run not at all, so its findings never reach the report and
586        // nothing can be concluded about a comment naming it. A rule this file
587        // ignores does not report either, for the same reason.
588        let report = crate::rule::SuppressionReport {
589            suppressed,
590            judged_rules: rules
591                .iter()
592                .filter(|rule| rule.cross_file_scope() != crate::rule::CrossFileScope::Workspace)
593                .filter(|rule| !ignored_for_file.contains(rule.name()))
594                .map(|rule| rule.name().to_string())
595                .collect(),
596        };
597
598        for rule in &suppression_observers {
599            match rule.check_suppressions(&lint_ctx, &report) {
600                Ok(rule_warnings) => {
601                    let filtered_warnings =
602                        retain_reportable_warnings(&lint_ctx, config, rule.name(), rule_warnings, None);
603                    warnings.extend(filtered_warnings);
604                }
605                Err(e) => {
606                    log::error!("Error checking rule {}: {}", rule.name(), e);
607                    return (Err(e), file_index);
608                }
609            }
610        }
611    }
612
613    // Contribute to index for cross-file rules (done after all rules checked)
614    // NOTE: We iterate over ALL rules (not just applicable_rules) because cross-file
615    // rules need to extract data from every file in the workspace, regardless of whether
616    // that file has content that would trigger the rule, and regardless of what this
617    // file's own configuration reports. For example, MD051 needs to index headings from
618    // files that have no links (like target.md) so that links FROM other files TO those
619    // headings can be validated - including from a file that ignores MD051 itself.
620    time_section!("lint: contribute cross-file data", {
621        for rule in rules {
622            if rule.cross_file_scope() == crate::rule::CrossFileScope::Workspace {
623                rule.contribute_to_index(&lint_ctx, &mut file_index);
624            }
625        }
626    });
627
628    #[cfg(not(test))]
629    if verbose {
630        let skipped_rules = total_rules - applicable_count;
631        if skipped_rules > 0 {
632            log::debug!("Skipped {skipped_rules} of {total_rules} rules based on content analysis");
633        }
634    }
635
636    (Ok(warnings), file_index)
637}
638
639/// Run cross-file checks for rules that need workspace-wide validation
640///
641/// This should be called after all files have been linted and the WorkspaceIndex
642/// has been built from the accumulated FileIndex data.
643///
644/// Note: This takes the FileIndex instead of content to avoid re-parsing each file.
645/// The FileIndex was already populated during contribute_to_index in the linting phase.
646///
647/// Rules can use workspace_index methods for cross-file validation:
648/// - `get_file(path)` - to look up headings in target files (for MD051)
649///
650/// Returns additional warnings from cross-file validation.
651pub fn run_cross_file_checks(
652    file_path: &std::path::Path,
653    file_index: &crate::workspace_index::FileIndex,
654    rules: &[Box<dyn Rule>],
655    workspace_index: &crate::workspace_index::WorkspaceIndex,
656    config: Option<&crate::config::Config>,
657) -> LintResult {
658    use crate::rule::CrossFileScope;
659
660    let mut warnings = Vec::new();
661
662    // Honor `per-file-ignores` for cross-file rules. Cross-file warnings are
663    // attributed to `file_path` (the file holding the link), so a rule ignored
664    // for that file must not emit them. This applies on every path; single-file
665    // rule filtering does not cover cross-file checks because they run over the
666    // config group's full rule set, and cross-file rules share link data.
667    let ignored_rules_for_file = config.map(|cfg| cfg.get_ignored_rules_for_file(file_path));
668
669    // Only check rules that need cross-file analysis
670    for rule in rules {
671        if rule.cross_file_scope() != CrossFileScope::Workspace {
672            continue;
673        }
674
675        if ignored_rules_for_file
676            .as_ref()
677            .is_some_and(|ignored| ignored.contains(rule.name()))
678        {
679            continue;
680        }
681
682        match time_function!(
683            "workspace: cross-file rule check",
684            rule.cross_file_check(file_path, file_index, workspace_index)
685        ) {
686            Ok(rule_warnings) => {
687                // Filter cross-file warnings based on inline config stored in file_index
688                let filtered: Vec<_> = rule_warnings
689                    .into_iter()
690                    .filter(|w| !file_index.is_rule_disabled_at_line(rule.name(), w.line))
691                    .map(|mut warning| {
692                        // Apply severity override from config if present
693                        if let Some(cfg) = config
694                            && let Some(override_severity) = cfg.get_rule_severity(rule.name())
695                        {
696                            warning.severity = override_severity;
697                        }
698                        warning
699                    })
700                    .collect();
701                warnings.extend(filtered);
702            }
703            Err(e) => {
704                log::error!("Error in cross-file check for rule {}: {}", rule.name(), e);
705                return Err(e);
706            }
707        }
708    }
709
710    Ok(warnings)
711}
712
713/// Get the profiling report
714pub fn get_profiling_report() -> String {
715    profiling::get_report()
716}
717
718/// Reset the profiling data
719pub fn reset_profiling() {
720    profiling::reset()
721}
722
723/// Get regex cache statistics for performance monitoring
724pub fn get_regex_cache_stats() -> std::collections::HashMap<String, u64> {
725    crate::utils::regex_cache::get_cache_stats()
726}
727
728#[cfg(test)]
729mod tests {
730    use super::*;
731    use crate::rule::Rule;
732    use crate::rules::{MD001HeadingIncrement, MD009TrailingSpaces};
733
734    #[test]
735    fn test_content_characteristics_analyze() {
736        // Test empty content
737        let chars = ContentCharacteristics::analyze("");
738        assert!(!chars.has_headings);
739        assert!(!chars.has_lists);
740        assert!(!chars.has_links);
741        assert!(!chars.has_code);
742        assert!(!chars.has_emphasis);
743        assert!(!chars.has_html);
744        assert!(!chars.has_tables);
745        assert!(!chars.has_blockquotes);
746        assert!(!chars.has_images);
747
748        // Test content with headings
749        let chars = ContentCharacteristics::analyze("# Heading");
750        assert!(chars.has_headings);
751
752        // Test setext headings
753        let chars = ContentCharacteristics::analyze("Heading\n=======");
754        assert!(chars.has_headings);
755
756        // Blockquoted ATX headings emit fragment anchors, so Heading-category
757        // rules (MD051/MD080) must run for blockquote-only documents.
758        let chars = ContentCharacteristics::analyze("> ## Alpha\n>\n> ## Alpha");
759        assert!(chars.has_headings, "blockquoted ATX heading must set has_headings");
760        let chars = ContentCharacteristics::analyze(">> # Nested");
761        assert!(
762            chars.has_headings,
763            "nested-blockquote ATX heading must set has_headings"
764        );
765        // A tab after the blockquote marker is also a valid heading
766        // (`parse_blockquote_prefix` accepts it).
767        let chars = ContentCharacteristics::analyze(">\t## Tabbed");
768        assert!(
769            chars.has_headings,
770            "tab-separated blockquote ATX heading must set has_headings"
771        );
772
773        // Test lists
774        let chars = ContentCharacteristics::analyze("* Item\n- Item 2\n+ Item 3");
775        assert!(chars.has_lists);
776
777        // Test ordered lists
778        let chars = ContentCharacteristics::analyze("1. First\n2. Second");
779        assert!(chars.has_lists);
780
781        // Test links
782        let chars = ContentCharacteristics::analyze("[link](url)");
783        assert!(chars.has_links);
784
785        // Test URLs
786        let chars = ContentCharacteristics::analyze("Visit https://example.com");
787        assert!(chars.has_links);
788
789        // Test images
790        let chars = ContentCharacteristics::analyze("![alt text](image.png)");
791        assert!(chars.has_images);
792
793        // Test code
794        let chars = ContentCharacteristics::analyze("`inline code`");
795        assert!(chars.has_code);
796
797        let chars = ContentCharacteristics::analyze("~~~\ncode block\n~~~");
798        assert!(chars.has_code);
799
800        // Test indented code blocks (4 spaces)
801        let chars = ContentCharacteristics::analyze("Text\n\n    indented code\n\nMore text");
802        assert!(chars.has_code);
803
804        // Test tab-indented code blocks
805        let chars = ContentCharacteristics::analyze("Text\n\n\ttab indented code\n\nMore text");
806        assert!(chars.has_code);
807
808        // Test mixed whitespace indented code (2 spaces + tab = 4 columns)
809        let chars = ContentCharacteristics::analyze("Text\n\n  \tmixed indent code\n\nMore text");
810        assert!(chars.has_code);
811
812        // Test 1 space + tab (also 4 columns due to tab expansion)
813        let chars = ContentCharacteristics::analyze("Text\n\n \ttab after space\n\nMore text");
814        assert!(chars.has_code);
815
816        // Test emphasis
817        let chars = ContentCharacteristics::analyze("*emphasis* and _more_");
818        assert!(chars.has_emphasis);
819
820        // Test HTML
821        let chars = ContentCharacteristics::analyze("<div>HTML content</div>");
822        assert!(chars.has_html);
823
824        // Test tables
825        let chars = ContentCharacteristics::analyze("| Header | Header |\n|--------|--------|");
826        assert!(chars.has_tables);
827
828        // Test blockquotes
829        let chars = ContentCharacteristics::analyze("> Quote");
830        assert!(chars.has_blockquotes);
831
832        // Test mixed content
833        let content = "# Heading\n* List item\n[link](url)\n`code`\n*emphasis*\n<p>html</p>\n| table |\n> quote\n![image](img.png)";
834        let chars = ContentCharacteristics::analyze(content);
835        assert!(chars.has_headings);
836        assert!(chars.has_lists);
837        assert!(chars.has_links);
838        assert!(chars.has_code);
839        assert!(chars.has_emphasis);
840        assert!(chars.has_html);
841        assert!(chars.has_tables);
842        assert!(chars.has_blockquotes);
843        assert!(chars.has_images);
844    }
845
846    #[test]
847    fn test_content_characteristics_should_skip_rule() {
848        let chars = ContentCharacteristics {
849            has_headings: true,
850            has_lists: false,
851            has_links: true,
852            has_code: false,
853            has_emphasis: true,
854            has_html: false,
855            has_tables: true,
856            has_blockquotes: false,
857            has_images: false,
858        };
859
860        // Create test rules for different categories
861        let heading_rule = MD001HeadingIncrement::default();
862        assert!(!chars.should_skip_rule(&heading_rule));
863
864        let trailing_spaces_rule = MD009TrailingSpaces::new(2, false);
865        assert!(!chars.should_skip_rule(&trailing_spaces_rule)); // Whitespace rules always run
866
867        // Test skipping based on content
868        let chars_no_headings = ContentCharacteristics {
869            has_headings: false,
870            ..Default::default()
871        };
872        assert!(chars_no_headings.should_skip_rule(&heading_rule));
873    }
874
875    #[test]
876    fn test_lint_empty_content() {
877        let rules: Vec<Box<dyn Rule>> = vec![Box::new(MD001HeadingIncrement::default())];
878
879        let result = lint("", &rules, false, crate::config::MarkdownFlavor::Standard, None, None);
880        assert!(result.is_ok());
881        assert!(result.unwrap().is_empty());
882    }
883
884    #[test]
885    fn test_lint_with_violations() {
886        let content = "## Level 2\n#### Level 4"; // Skips level 3
887        let rules: Vec<Box<dyn Rule>> = vec![Box::new(MD001HeadingIncrement::default())];
888
889        let result = lint(
890            content,
891            &rules,
892            false,
893            crate::config::MarkdownFlavor::Standard,
894            None,
895            None,
896        );
897        assert!(result.is_ok());
898        let warnings = result.unwrap();
899        assert!(!warnings.is_empty());
900        // Check the rule field of LintWarning struct
901        assert_eq!(warnings[0].rule_name.as_deref(), Some("MD001"));
902    }
903
904    #[test]
905    fn test_lint_with_inline_disable() {
906        let content = "<!-- rumdl-disable MD001 -->\n## Level 2\n#### Level 4";
907        let rules: Vec<Box<dyn Rule>> = vec![Box::new(MD001HeadingIncrement::default())];
908
909        let result = lint(
910            content,
911            &rules,
912            false,
913            crate::config::MarkdownFlavor::Standard,
914            None,
915            None,
916        );
917        assert!(result.is_ok());
918        let warnings = result.unwrap();
919        assert!(warnings.is_empty()); // Should be disabled by inline comment
920    }
921
922    #[test]
923    fn test_lint_rule_filtering() {
924        // Content with no lists
925        let content = "# Heading\nJust text";
926        let rules: Vec<Box<dyn Rule>> = vec![
927            Box::new(MD001HeadingIncrement::default()),
928            // A list-related rule would be skipped
929        ];
930
931        let result = lint(
932            content,
933            &rules,
934            false,
935            crate::config::MarkdownFlavor::Standard,
936            None,
937            None,
938        );
939        assert!(result.is_ok());
940    }
941
942    #[test]
943    fn test_get_profiling_report() {
944        // Just test that it returns a string without panicking
945        let report = get_profiling_report();
946        assert!(!report.is_empty());
947        assert!(report.contains("Profiling"));
948    }
949
950    #[test]
951    fn test_reset_profiling() {
952        // Test that reset_profiling doesn't panic
953        reset_profiling();
954
955        // After reset, report should indicate no measurements or profiling disabled
956        let report = get_profiling_report();
957        assert!(report.contains("disabled") || report.contains("no measurements"));
958    }
959
960    #[test]
961    fn test_get_regex_cache_stats() {
962        let stats = get_regex_cache_stats();
963        // Stats should be a valid HashMap (might be empty)
964        assert!(stats.is_empty() || !stats.is_empty());
965
966        // If not empty, all values should be positive
967        for count in stats.values() {
968            assert!(*count > 0);
969        }
970    }
971
972    #[test]
973    fn test_content_characteristics_edge_cases() {
974        // Test setext heading edge case
975        let chars = ContentCharacteristics::analyze("-"); // Single dash, not a heading
976        assert!(!chars.has_headings);
977
978        let chars = ContentCharacteristics::analyze("--"); // Two dashes, valid setext
979        assert!(chars.has_headings);
980
981        // Test list detection - we now include potential list patterns (with or without space)
982        // to support user-intention detection in MD030
983        let chars = ContentCharacteristics::analyze("*emphasis*"); // Could be list or emphasis
984        assert!(chars.has_lists); // Run list rules to be safe
985
986        let chars = ContentCharacteristics::analyze("1.Item"); // Could be list without space
987        assert!(chars.has_lists); // Run list rules for user-intention detection
988
989        // Test blockquote must be at start of line
990        let chars = ContentCharacteristics::analyze("text > not a quote");
991        assert!(!chars.has_blockquotes);
992    }
993}