panache 2.57.0

An LSP, formatter, and linter for Markdown, Quarto, and R Markdown
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

pub mod code_block_collector;
pub mod diagnostics;
#[cfg(not(target_arch = "wasm32"))]
pub mod external_linters;
#[cfg(not(target_arch = "wasm32"))]
pub mod external_linters_sync;
pub mod index;
pub mod metadata_diagnostics;
pub(crate) mod offsets;
pub mod rules;
pub mod runner;

pub use diagnostics::{
    Diagnostic, DiagnosticNote, DiagnosticNoteKind, DiagnosticOrigin, Fix, Location, Severity,
};
pub use rules::{DiagnosticCode, Requirement, Rule, RuleMeta, RuleRegistry};
pub use runner::LintRunner;

use crate::config::Config;
use crate::syntax::SyntaxNode;

/// Lint a document and return diagnostics (built-in rules only).
pub fn lint(tree: &SyntaxNode, input: &str, config: &Config) -> Vec<Diagnostic> {
    let registry = default_registry(config);
    let runner = LintRunner::new(registry);
    runner.run(tree, input, config)
}

/// Lint a document with external linters (sync version for CLI).
#[cfg(not(target_arch = "wasm32"))]
pub fn lint_with_external_sync(tree: &SyntaxNode, input: &str, config: &Config) -> Vec<Diagnostic> {
    let registry = default_registry(config);
    let runner = LintRunner::new(registry);
    runner.run_with_external_linters_sync(tree, input, config, None)
}

pub fn lint_with_metadata(
    tree: &SyntaxNode,
    input: &str,
    config: &Config,
    metadata: Option<&crate::metadata::DocumentMetadata>,
) -> Vec<Diagnostic> {
    let registry = default_registry(config);
    let runner = LintRunner::new(registry);
    runner.run_with_metadata(tree, input, config, metadata)
}

#[cfg(not(target_arch = "wasm32"))]
pub fn lint_with_external_sync_and_metadata(
    tree: &SyntaxNode,
    input: &str,
    config: &Config,
    metadata: Option<&crate::metadata::DocumentMetadata>,
) -> Vec<Diagnostic> {
    let registry = default_registry(config);
    let runner = LintRunner::new(registry);
    runner.run_with_external_linters_sync(tree, input, config, metadata)
}

/// Every built-in rule, in registration order, regardless of config.
///
/// `default_registry` filters this list by config; `builtin_rule_metadata`
/// reads each rule's [`RuleMeta`] off it. Adding a rule means adding one entry
/// here (plus its `impl Rule`), nothing else.
fn all_rules() -> Vec<Box<dyn Rule>> {
    vec![
        Box::new(rules::heading_hierarchy::HeadingHierarchyRule),
        Box::new(rules::empty_list_item::EmptyListItemRule),
        Box::new(rules::math_content::MathContentRule),
        Box::new(rules::heading_eaten_attrs::HeadingEatenAttrsRule),
        Box::new(rules::heading_strip_comments_residue::HeadingStripCommentsResidueRule),
        Box::new(rules::adjacent_footnote_refs::AdjacentFootnoteRefsRule),
        Box::new(rules::footnote_ref_in_footnote_def::FootnoteRefInFootnoteDefRule),
        Box::new(rules::duplicate_references::DuplicateReferencesRule),
        Box::new(rules::undefined_references::UndefinedReferencesRule),
        Box::new(rules::undefined_anchor::UndefinedAnchorRule),
        Box::new(rules::unused_definitions::UnusedDefinitionsRule),
        Box::new(rules::citation_keys::CitationKeysRule),
        Box::new(rules::crossref_as_link_target::CrossrefAsLinkTargetRule),
        Box::new(rules::chunk_label_spaces::ChunkLabelSpacesRule),
        Box::new(rules::missing_chunk_labels::MissingChunkLabelsRule),
        Box::new(rules::figure_crossref_captions::FigureCrossrefCaptionsRule),
        Box::new(rules::emoji_aliases::EmojiAliasesRule),
        Box::new(rules::html_entities::HtmlEntitiesRule),
        Box::new(rules::link_text_is_url::LinkTextIsUrlRule),
        Box::new(rules::stray_fenced_div_markers::StrayFencedDivMarkersRule),
    ]
}

/// Metadata for every built-in rule, independent of config. The reference docs
/// (`docs/reference/linter-rules.qmd`) are validated against this in
/// `tests/linter_rules_docs.rs`.
pub fn builtin_rule_metadata() -> Vec<RuleMeta> {
    all_rules().iter().map(|rule| rule.metadata()).collect()
}

/// Create the default rule registry with all built-in rules.
///
/// Each rule declares its config preconditions via [`RuleMeta::requires`] and
/// whether it is on by default via [`RuleMeta::default_on`]; this function is
/// the single consumer of those facts. Rules whose preconditions are not met
/// are not registered: besides matching the documented "Requirements", skipping
/// registration avoids the per-rule dispatch + tree-walk entry cost on each
/// lint invocation (this pays off on large flat-Markdown corpora where most
/// rules would otherwise run for nothing).
fn default_registry(config: &Config) -> RuleRegistry {
    let mut registry = RuleRegistry::new();
    for rule in all_rules() {
        let meta = rule.metadata();
        let enabled = if meta.default_on {
            config.lint.is_rule_enabled(meta.name)
        } else {
            config.lint.is_rule_explicitly_enabled(meta.name)
        };
        if enabled && meta.requires.is_satisfied(config) {
            registry.register(rule);
        }
    }
    registry
}