rumdl_lib/config/
flavor.rs

1use serde::{Deserialize, Serialize};
2use std::fmt;
3use std::str::FromStr;
4
5// ============================================================================
6// Typestate markers for configuration pipeline
7// ============================================================================
8
9/// Marker type for configuration that has been loaded but not yet validated.
10/// This is the initial state after `load_with_discovery()`.
11#[derive(Debug, Clone, Copy, Default)]
12pub struct ConfigLoaded;
13
14/// Marker type for configuration that has been validated.
15/// Only validated configs can be converted to `Config`.
16#[derive(Debug, Clone, Copy, Default)]
17pub struct ConfigValidated;
18
19/// Markdown flavor/dialect enumeration
20#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
21#[serde(rename_all = "lowercase")]
22pub enum MarkdownFlavor {
23    /// Standard Markdown without flavor-specific adjustments
24    #[serde(rename = "standard", alias = "none", alias = "")]
25    #[default]
26    Standard,
27    /// MkDocs flavor with auto-reference support
28    #[serde(rename = "mkdocs")]
29    MkDocs,
30    /// MDX flavor with JSX and ESM support (.mdx files)
31    #[serde(rename = "mdx")]
32    MDX,
33    /// Pandoc Markdown — fenced divs, attribute lists, citations, definition
34    /// lists, math, and other Pandoc-specific syntax.
35    #[serde(rename = "pandoc")]
36    Pandoc,
37    /// Quarto/RMarkdown flavor for scientific publishing (.qmd, .Rmd files)
38    #[serde(rename = "quarto")]
39    Quarto,
40    /// Obsidian flavor with tag syntax support (#tagname as tags, not headings)
41    #[serde(rename = "obsidian")]
42    Obsidian,
43    /// Kramdown flavor for Jekyll sites with IAL, ALD, and extension block support
44    #[serde(rename = "kramdown")]
45    Kramdown,
46    /// Azure DevOps flavor — treats `:::lang` blocks as opaque code fences
47    #[serde(rename = "azure_devops", alias = "azure", alias = "ado")]
48    AzureDevOps,
49    /// MyST (Markedly Structured Text) flavor — directives, roles, dollar math, % comments
50    #[serde(rename = "myst", alias = "mystmd")]
51    MyST,
52    /// Hugo flavor — GFM plus Goldmark block attribute lists (`{class="a" id="b"}`)
53    #[serde(rename = "hugo", alias = "goldmark")]
54    Hugo,
55}
56
57/// Custom JSON schema for MarkdownFlavor that includes all accepted values and aliases
58fn markdown_flavor_schema(_gen: &mut schemars::SchemaGenerator) -> schemars::Schema {
59    schemars::json_schema!({
60        "description": "Markdown flavor/dialect. Accepts: standard, gfm, mkdocs, mdx, pandoc, quarto, obsidian, kramdown, azure_devops, myst, hugo. Aliases: commonmark/github map to standard, qmd/rmd/rmarkdown map to quarto, jekyll maps to kramdown, azure/ado map to azure_devops, mystmd maps to myst, goldmark maps to hugo.",
61        "type": "string",
62        "enum": ["standard", "gfm", "github", "commonmark", "mkdocs", "mdx", "pandoc", "quarto", "qmd", "rmd", "rmarkdown", "obsidian", "kramdown", "jekyll", "azure_devops", "azure", "ado", "myst", "mystmd", "hugo", "goldmark"]
63    })
64}
65
66impl schemars::JsonSchema for MarkdownFlavor {
67    fn schema_name() -> std::borrow::Cow<'static, str> {
68        std::borrow::Cow::Borrowed("MarkdownFlavor")
69    }
70
71    fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
72        markdown_flavor_schema(generator)
73    }
74}
75
76impl fmt::Display for MarkdownFlavor {
77    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
78        match self {
79            MarkdownFlavor::Standard => write!(f, "standard"),
80            MarkdownFlavor::MkDocs => write!(f, "mkdocs"),
81            MarkdownFlavor::MDX => write!(f, "mdx"),
82            MarkdownFlavor::Pandoc => write!(f, "pandoc"),
83            MarkdownFlavor::Quarto => write!(f, "quarto"),
84            MarkdownFlavor::Obsidian => write!(f, "obsidian"),
85            MarkdownFlavor::Kramdown => write!(f, "kramdown"),
86            MarkdownFlavor::AzureDevOps => write!(f, "azure_devops"),
87            MarkdownFlavor::MyST => write!(f, "myst"),
88            MarkdownFlavor::Hugo => write!(f, "hugo"),
89        }
90    }
91}
92
93impl FromStr for MarkdownFlavor {
94    type Err = String;
95
96    fn from_str(s: &str) -> Result<Self, Self::Err> {
97        match s.to_lowercase().as_str() {
98            "standard" | "" | "none" => Ok(MarkdownFlavor::Standard),
99            "mkdocs" => Ok(MarkdownFlavor::MkDocs),
100            "mdx" => Ok(MarkdownFlavor::MDX),
101            "pandoc" => Ok(MarkdownFlavor::Pandoc),
102            "quarto" | "qmd" | "rmd" | "rmarkdown" => Ok(MarkdownFlavor::Quarto),
103            "obsidian" => Ok(MarkdownFlavor::Obsidian),
104            "kramdown" | "jekyll" => Ok(MarkdownFlavor::Kramdown),
105            "azure_devops" | "azure" | "ado" => Ok(MarkdownFlavor::AzureDevOps),
106            "myst" | "mystmd" => Ok(MarkdownFlavor::MyST),
107            "hugo" | "goldmark" => Ok(MarkdownFlavor::Hugo),
108            // GFM and CommonMark are aliases for Standard since the base parser
109            // (pulldown-cmark) already supports GFM extensions (tables, task lists,
110            // strikethrough, autolinks, etc.) which are a superset of CommonMark
111            "gfm" | "github" | "commonmark" => Ok(MarkdownFlavor::Standard),
112            _ => Err(format!("Unknown markdown flavor: {s}")),
113        }
114    }
115}
116
117impl MarkdownFlavor {
118    /// Detect flavor from file extension
119    pub fn from_extension(ext: &str) -> Self {
120        match ext.to_lowercase().as_str() {
121            "mdx" => Self::MDX,
122            "qmd" => Self::Quarto,
123            "rmd" => Self::Quarto,
124            "kramdown" => Self::Kramdown,
125            _ => Self::Standard,
126        }
127    }
128
129    /// Detect flavor from file path
130    pub fn from_path(path: &std::path::Path) -> Self {
131        path.extension()
132            .and_then(|e| e.to_str())
133            .map_or(Self::Standard, Self::from_extension)
134    }
135
136    /// Check if this flavor supports ESM imports/exports (MDX-specific)
137    pub fn supports_esm_blocks(self) -> bool {
138        matches!(self, Self::MDX)
139    }
140
141    /// Check if this flavor supports JSX components (MDX-specific)
142    pub fn supports_jsx(self) -> bool {
143        matches!(self, Self::MDX)
144    }
145
146    /// Check if this flavor supports auto-references (MkDocs-specific)
147    pub fn supports_auto_references(self) -> bool {
148        matches!(self, Self::MkDocs)
149    }
150
151    /// Check if this flavor supports kramdown syntax (IALs, ALDs, extension blocks)
152    pub fn supports_kramdown_syntax(self) -> bool {
153        matches!(self, Self::Kramdown)
154    }
155
156    /// Check if this flavor supports attribute lists ({#id .class key="value"})
157    pub fn supports_attr_lists(self) -> bool {
158        matches!(self, Self::MkDocs | Self::Kramdown | Self::Hugo)
159    }
160
161    /// Check if this flavor requires strict (≥4-space) list continuation indent.
162    ///
163    /// Python-Markdown (used by MkDocs) requires 4-space indentation for ordered
164    /// list continuation content, regardless of marker width.
165    pub fn requires_strict_list_indent(self) -> bool {
166        matches!(self, Self::MkDocs)
167    }
168
169    /// True for any flavor that includes Pandoc-style syntax — fenced divs,
170    /// attribute lists, citations, definition lists, math, raw blocks.
171    /// Use this to gate behavior shared by both Pandoc and Quarto users.
172    pub fn is_pandoc_compatible(self) -> bool {
173        matches!(self, Self::Pandoc | Self::Quarto)
174    }
175
176    /// Get a human-readable name for this flavor
177    pub fn name(self) -> &'static str {
178        match self {
179            Self::Standard => "Standard",
180            Self::MkDocs => "MkDocs",
181            Self::MDX => "MDX",
182            Self::Pandoc => "Pandoc",
183            Self::Quarto => "Quarto",
184            Self::Obsidian => "Obsidian",
185            Self::Kramdown => "Kramdown",
186            Self::AzureDevOps => "AzureDevOps",
187            Self::MyST => "MyST",
188            Self::Hugo => "Hugo",
189        }
190    }
191
192    /// True only for Azure DevOps flavor, which uses `:::lang` as a code fence.
193    pub fn supports_colon_code_fences(self) -> bool {
194        matches!(self, Self::AzureDevOps)
195    }
196
197    /// True for MyST flavor — supports directive syntax (backtick and colon fences with `{name}`)
198    pub fn supports_myst_directives(self) -> bool {
199        matches!(self, Self::MyST)
200    }
201
202    /// True for MyST flavor — supports role syntax (`{role}`content``)
203    pub fn supports_myst_roles(self) -> bool {
204        matches!(self, Self::MyST)
205    }
206
207    /// True for MyST flavor — supports `%` line comments
208    pub fn supports_myst_comments(self) -> bool {
209        matches!(self, Self::MyST)
210    }
211}
212
213/// Normalizes configuration keys (rule names, option names) to lowercase kebab-case.
214pub fn normalize_key(key: &str) -> String {
215    // If the key looks like a rule name (e.g., MD013), uppercase it
216    if key.len() == 5 && key.to_ascii_lowercase().starts_with("md") && key[2..].chars().all(|c| c.is_ascii_digit()) {
217        key.to_ascii_uppercase()
218    } else {
219        key.replace('_', "-").to_ascii_lowercase()
220    }
221}
222
223/// Warns if a per-file-ignores pattern contains a comma but no braces.
224/// This is a common mistake where users expect "A.md,B.md" to match both files,
225/// but glob syntax requires "{A.md,B.md}" for brace expansion.
226///
227/// The pattern is a key out of the config file, so for one reached through
228/// `extends` it is named rather than shown, and the suggestion that would have
229/// rewritten it becomes a description of the rewrite.
230pub(super) fn warn_comma_without_brace_in_pattern(pattern: &str, config_file: super::types::ConfigRef<'_>) {
231    if pattern.contains(',') && !pattern.contains('{') {
232        if config_file.may_quote_contents() {
233            eprintln!("Warning: Pattern \"{pattern}\" in {config_file} contains a comma but no braces.");
234            eprintln!("  To match multiple files, use brace expansion: \"{{{pattern}}}\"");
235        } else {
236            eprintln!("Warning: A pattern in {config_file} contains a comma but no braces.");
237            eprintln!("  To match multiple files, wrap the pattern in braces for brace expansion.");
238        }
239        eprintln!("  Or use separate entries for each file.");
240    }
241}
242
243#[cfg(test)]
244mod tests {
245    use super::*;
246
247    /// Every MarkdownFlavor variant must produce a lowercase, unquoted string via Display.
248    /// This guards against new variants being added without a matching Display arm,
249    /// and against the Display impl regressing to Debug-style output (e.g. "Standard").
250    #[test]
251    fn test_display_all_variants_are_lowercase() {
252        let cases = [
253            (MarkdownFlavor::Standard, "standard"),
254            (MarkdownFlavor::MkDocs, "mkdocs"),
255            (MarkdownFlavor::MDX, "mdx"),
256            (MarkdownFlavor::Pandoc, "pandoc"),
257            (MarkdownFlavor::Quarto, "quarto"),
258            (MarkdownFlavor::Obsidian, "obsidian"),
259            (MarkdownFlavor::Kramdown, "kramdown"),
260            (MarkdownFlavor::AzureDevOps, "azure_devops"),
261            (MarkdownFlavor::MyST, "myst"),
262            (MarkdownFlavor::Hugo, "hugo"),
263        ];
264        for (variant, expected) in cases {
265            let displayed = variant.to_string();
266            assert_eq!(
267                displayed, expected,
268                "MarkdownFlavor::{variant:?} Display should produce \"{expected}\", got \"{displayed}\""
269            );
270            // Must be lowercase — no uppercase letters anywhere
271            assert!(
272                displayed.chars().all(|c| !c.is_ascii_uppercase()),
273                "MarkdownFlavor::{variant:?} Display must be entirely lowercase, got \"{displayed}\""
274            );
275        }
276    }
277
278    /// Display output must round-trip through FromStr — every variant's Display string
279    /// must parse back to the same variant.
280    #[test]
281    fn test_display_round_trips_through_from_str() {
282        let variants = [
283            MarkdownFlavor::Standard,
284            MarkdownFlavor::MkDocs,
285            MarkdownFlavor::MDX,
286            MarkdownFlavor::Pandoc,
287            MarkdownFlavor::Quarto,
288            MarkdownFlavor::Obsidian,
289            MarkdownFlavor::Kramdown,
290            MarkdownFlavor::AzureDevOps,
291            MarkdownFlavor::MyST,
292            MarkdownFlavor::Hugo,
293        ];
294        for variant in variants {
295            let displayed = variant.to_string();
296            let parsed: MarkdownFlavor = displayed
297                .parse()
298                .unwrap_or_else(|e| panic!("Display string \"{displayed}\" for {variant:?} failed to parse back: {e}"));
299            assert_eq!(
300                parsed, variant,
301                "Display(\"{displayed}\") for {variant:?} round-trips to a different variant: {parsed:?}"
302            );
303        }
304    }
305
306    #[test]
307    fn test_pandoc_from_str() {
308        assert_eq!("pandoc".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::Pandoc);
309        assert_eq!("PANDOC".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::Pandoc);
310    }
311
312    #[test]
313    fn test_pandoc_name_and_display() {
314        assert_eq!(MarkdownFlavor::Pandoc.name(), "Pandoc");
315        assert_eq!(MarkdownFlavor::Pandoc.to_string(), "pandoc");
316    }
317
318    #[test]
319    fn test_from_extension_does_not_auto_detect_pandoc() {
320        // Pandoc files use .md — must NOT auto-detect to Pandoc.
321        assert_eq!(MarkdownFlavor::from_extension("md"), MarkdownFlavor::Standard);
322        assert_eq!(MarkdownFlavor::from_extension("markdown"), MarkdownFlavor::Standard);
323    }
324
325    #[test]
326    fn test_is_pandoc_compatible() {
327        assert!(MarkdownFlavor::Pandoc.is_pandoc_compatible());
328        assert!(MarkdownFlavor::Quarto.is_pandoc_compatible());
329
330        assert!(!MarkdownFlavor::Standard.is_pandoc_compatible());
331        assert!(!MarkdownFlavor::MkDocs.is_pandoc_compatible());
332        assert!(!MarkdownFlavor::MDX.is_pandoc_compatible());
333        assert!(!MarkdownFlavor::Obsidian.is_pandoc_compatible());
334        assert!(!MarkdownFlavor::Kramdown.is_pandoc_compatible());
335    }
336
337    #[test]
338    fn test_azure_devops_from_str() {
339        assert_eq!(
340            "azure_devops".parse::<MarkdownFlavor>().unwrap(),
341            MarkdownFlavor::AzureDevOps
342        );
343        assert_eq!("azure".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::AzureDevOps);
344        assert_eq!("ado".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::AzureDevOps);
345        assert_eq!(
346            "AZURE_DEVOPS".parse::<MarkdownFlavor>().unwrap(),
347            MarkdownFlavor::AzureDevOps
348        );
349    }
350
351    #[test]
352    fn test_azure_devops_display_and_round_trip() {
353        assert_eq!(MarkdownFlavor::AzureDevOps.to_string(), "azure_devops");
354        let parsed: MarkdownFlavor = "azure_devops".parse().unwrap();
355        assert_eq!(parsed, MarkdownFlavor::AzureDevOps);
356    }
357
358    #[test]
359    fn test_supports_colon_code_fences() {
360        assert!(MarkdownFlavor::AzureDevOps.supports_colon_code_fences());
361        assert!(!MarkdownFlavor::Standard.supports_colon_code_fences());
362        assert!(!MarkdownFlavor::MkDocs.supports_colon_code_fences());
363        assert!(!MarkdownFlavor::MDX.supports_colon_code_fences());
364        assert!(!MarkdownFlavor::Pandoc.supports_colon_code_fences());
365        assert!(!MarkdownFlavor::Quarto.supports_colon_code_fences());
366        assert!(!MarkdownFlavor::Obsidian.supports_colon_code_fences());
367        assert!(!MarkdownFlavor::Kramdown.supports_colon_code_fences());
368        assert!(!MarkdownFlavor::MyST.supports_colon_code_fences());
369    }
370
371    #[test]
372    fn test_azure_devops_not_pandoc_compatible() {
373        assert!(!MarkdownFlavor::AzureDevOps.is_pandoc_compatible());
374    }
375
376    #[test]
377    fn test_display_all_variants_covers_azure_devops() {
378        let displayed = MarkdownFlavor::AzureDevOps.to_string();
379        assert!(displayed.chars().all(|c| !c.is_ascii_uppercase()));
380    }
381
382    #[test]
383    fn test_myst_from_str() {
384        assert_eq!("myst".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::MyST);
385        assert_eq!("MYST".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::MyST);
386        assert_eq!("mystmd".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::MyST);
387    }
388
389    #[test]
390    fn test_myst_display_and_round_trip() {
391        assert_eq!(MarkdownFlavor::MyST.to_string(), "myst");
392        let parsed: MarkdownFlavor = "myst".parse().unwrap();
393        assert_eq!(parsed, MarkdownFlavor::MyST);
394    }
395
396    #[test]
397    fn test_myst_capabilities() {
398        assert!(MarkdownFlavor::MyST.supports_myst_directives());
399        assert!(MarkdownFlavor::MyST.supports_myst_roles());
400        assert!(MarkdownFlavor::MyST.supports_myst_comments());
401        assert!(!MarkdownFlavor::MyST.is_pandoc_compatible());
402        assert!(!MarkdownFlavor::MyST.supports_colon_code_fences());
403        assert!(!MarkdownFlavor::MyST.supports_jsx());
404
405        assert!(!MarkdownFlavor::Standard.supports_myst_directives());
406        assert!(!MarkdownFlavor::Standard.supports_myst_roles());
407        assert!(!MarkdownFlavor::Standard.supports_myst_comments());
408    }
409
410    #[test]
411    fn test_myst_name() {
412        assert_eq!(MarkdownFlavor::MyST.name(), "MyST");
413    }
414
415    #[test]
416    fn test_hugo_from_str() {
417        assert_eq!("hugo".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::Hugo);
418        assert_eq!("HUGO".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::Hugo);
419        assert_eq!("goldmark".parse::<MarkdownFlavor>().unwrap(), MarkdownFlavor::Hugo);
420    }
421
422    #[test]
423    fn test_hugo_display_name_and_round_trip() {
424        assert_eq!(MarkdownFlavor::Hugo.to_string(), "hugo");
425        assert_eq!(MarkdownFlavor::Hugo.name(), "Hugo");
426        let parsed: MarkdownFlavor = "hugo".parse().unwrap();
427        assert_eq!(parsed, MarkdownFlavor::Hugo);
428    }
429
430    #[test]
431    fn test_hugo_supports_attr_lists() {
432        // Hugo/Goldmark supports block attribute lists like MkDocs and Kramdown.
433        assert!(MarkdownFlavor::Hugo.supports_attr_lists());
434        assert!(MarkdownFlavor::MkDocs.supports_attr_lists());
435        assert!(MarkdownFlavor::Kramdown.supports_attr_lists());
436
437        // Standard Markdown does not: there, `{class="a"}` is literal text.
438        assert!(!MarkdownFlavor::Standard.supports_attr_lists());
439        assert!(!MarkdownFlavor::Pandoc.supports_attr_lists());
440
441        // Hugo is otherwise plain GFM.
442        assert!(!MarkdownFlavor::Hugo.is_pandoc_compatible());
443        assert!(!MarkdownFlavor::Hugo.supports_myst_directives());
444        assert!(!MarkdownFlavor::Hugo.supports_colon_code_fences());
445    }
446}
rumdl_lib/config/flavor.rs

rumdl_lib/config/
flavor.rs
