Skip to main content

rumdl_lib/rules/
md038_no_space_in_code.rs

1use crate::rule::{Fix, LintError, LintResult, LintWarning, Rule, RuleCategory, Severity};
2use crate::utils::mkdocs_extensions::is_inline_hilite_content;
3
4/// Rule MD038: No space inside code span markers
5///
6/// See [docs/md038.md](../../docs/md038.md) for full documentation, configuration, and examples.
7///
8/// MD038: Spaces inside code span elements
9///
10/// This rule is triggered when there are spaces inside code span elements.
11///
12/// For example:
13///
14/// ``` markdown
15/// ` some text`
16/// `some text `
17/// ` some text `
18/// ```
19///
20/// To fix this issue, remove the leading and trailing spaces within the code span markers:
21///
22/// ``` markdown
23/// `some text`
24/// ```
25///
26/// Note: Code spans containing backticks (e.g., `` `backticks` inside ``) are not flagged
27/// to avoid breaking nested backtick structures used to display backticks in documentation.
28#[derive(Debug, Clone, Default)]
29pub struct MD038NoSpaceInCode {
30    pub enabled: bool,
31}
32
33impl MD038NoSpaceInCode {
34    pub fn new() -> Self {
35        Self { enabled: true }
36    }
37
38    /// Check if a code span is part of Hugo template syntax (e.g., {{raw `...`}})
39    ///
40    /// Hugo static site generator uses backticks as part of template delimiters,
41    /// not markdown code spans. This function detects common Hugo shortcode patterns:
42    /// - {{raw `...`}} - Raw HTML shortcode
43    /// - {{< `...` >}} - Partial shortcode
44    /// - {{% `...` %}} - Shortcode with percent delimiters
45    /// - {{ `...` }} - Generic shortcode
46    ///
47    /// The detection is conservative to avoid false positives:
48    /// - Requires opening {{ pattern before the backtick
49    /// - Requires closing }} after the code span
50    /// - Handles multi-line templates correctly
51    ///
52    /// Returns true if the code span is part of Hugo template syntax and should be skipped.
53    fn is_hugo_template_syntax(
54        &self,
55        ctx: &crate::lint_context::LintContext,
56        code_span: &crate::lint_context::CodeSpan,
57    ) -> bool {
58        let start_line_idx = code_span.line.saturating_sub(1);
59        if start_line_idx >= ctx.lines.len() {
60            return false;
61        }
62
63        let start_line_content = ctx.lines[start_line_idx].content(ctx.content);
64
65        // start_col is 0-indexed character position
66        let span_start_col = code_span.start_col;
67
68        // Check if there's Hugo template syntax before the code span on the same line
69        // Pattern: {{raw ` or {{< ` or similar Hugo template patterns
70        // The code span starts at the backtick, so we need to check what's before it
71        // span_start_col is the position of the backtick (0-indexed character position)
72        // Minimum pattern is "{{ `" which has 3 characters before the backtick
73        if span_start_col >= 3 {
74            // Look backwards for Hugo template patterns
75            // Get the content up to (but not including) the backtick
76            let before_span: String = start_line_content.chars().take(span_start_col).collect();
77
78            // Check for Hugo template patterns: {{raw `, {{< `, {{% `, etc.
79            // The backtick is at span_start_col, so we check if the content before it
80            // ends with the Hugo pattern (without the backtick), and verify the next char is a backtick
81            let char_at_span_start = start_line_content.chars().nth(span_start_col).unwrap_or(' ');
82
83            // Match Hugo shortcode patterns:
84            // - {{raw ` - Raw HTML shortcode
85            // - {{< ` - Partial shortcode (may have parameters before backtick)
86            // - {{% ` - Shortcode with percent delimiters
87            // - {{ ` - Generic shortcode
88            // Also handle cases with parameters: {{< highlight go ` or {{< code ` etc.
89            // We check if the pattern starts with {{ and contains the shortcode type before the backtick
90            let is_hugo_start =
91                // Exact match: {{raw `
92                (before_span.ends_with("{{raw ") && char_at_span_start == '`')
93                // Partial shortcode: {{< ` or {{< name ` or {{< name param ` etc.
94                || (before_span.starts_with("{{<") && before_span.ends_with(' ') && char_at_span_start == '`')
95                // Percent shortcode: {{% `
96                || (before_span.ends_with("{{% ") && char_at_span_start == '`')
97                // Generic shortcode: {{ `
98                || (before_span.ends_with("{{ ") && char_at_span_start == '`');
99
100            if is_hugo_start {
101                // Check if there's a closing }} after the code span
102                // First check the end line of the code span
103                let end_line_idx = code_span.end_line.saturating_sub(1);
104                if end_line_idx < ctx.lines.len() {
105                    let end_line_content = ctx.lines[end_line_idx].content(ctx.content);
106                    let end_line_char_count = end_line_content.chars().count();
107                    let span_end_col = code_span.end_col.min(end_line_char_count);
108
109                    // Check for closing }} on the same line as the end of the code span
110                    if span_end_col < end_line_char_count {
111                        let after_span: String = end_line_content.chars().skip(span_end_col).collect();
112                        if after_span.trim_start().starts_with("}}") {
113                            return true;
114                        }
115                    }
116
117                    // Also check the next line for closing }}
118                    let next_line_idx = code_span.end_line;
119                    if next_line_idx < ctx.lines.len() {
120                        let next_line = ctx.lines[next_line_idx].content(ctx.content);
121                        if next_line.trim_start().starts_with("}}") {
122                            return true;
123                        }
124                    }
125                }
126            }
127        }
128
129        false
130    }
131
132    /// Check if content is an Obsidian Dataview inline query
133    ///
134    /// Dataview plugin uses two inline query syntaxes:
135    /// - Inline DQL: `= expression` - Starts with "= "
136    /// - Inline DataviewJS: `$= expression` - Starts with "$= "
137    ///
138    /// Examples:
139    /// - `= this.file.name` - Get current file name
140    /// - `= date(today)` - Get today's date
141    /// - `= [[Page]].field` - Access field from another page
142    /// - `$= dv.current().file.mtime` - DataviewJS expression
143    /// - `$= dv.pages().length` - Count pages
144    ///
145    /// These patterns legitimately start with a space after = or $=,
146    /// so they should not trigger MD038.
147    fn is_dataview_expression(content: &str) -> bool {
148        // Inline DQL: starts with "= " (equals followed by space)
149        // Inline DataviewJS: starts with "$= " (dollar-equals followed by space)
150        content.starts_with("= ") || content.starts_with("$= ")
151    }
152
153    /// Check if a code span is likely part of a nested backtick structure
154    fn is_likely_nested_backticks(&self, ctx: &crate::lint_context::LintContext, span_index: usize) -> bool {
155        // If there are multiple code spans on the same line, and there's text
156        // between them that contains "code" or other indicators, it's likely nested
157        let code_spans = ctx.code_spans();
158        let current_span = &code_spans[span_index];
159        let current_line = current_span.line;
160
161        // Look for other code spans on the same line
162        let same_line_spans: Vec<_> = code_spans
163            .iter()
164            .enumerate()
165            .filter(|(i, s)| s.line == current_line && *i != span_index)
166            .collect();
167
168        if same_line_spans.is_empty() {
169            return false;
170        }
171
172        // Check if there's content between spans that might indicate nesting
173        // Get the line content
174        let line_idx = current_line - 1; // Convert to 0-based
175        if line_idx >= ctx.lines.len() {
176            return false;
177        }
178
179        let line_content = &ctx.lines[line_idx].content(ctx.content);
180
181        // For each pair of adjacent code spans, check what's between them
182        for (_, other_span) in &same_line_spans {
183            let start_char = current_span.end_col.min(other_span.end_col);
184            let end_char = current_span.start_col.max(other_span.start_col);
185
186            if start_char < end_char {
187                // Convert character positions to byte offsets for string slicing
188                let char_indices: Vec<(usize, char)> = line_content.char_indices().collect();
189                let start_byte = char_indices.get(start_char).map(|(i, _)| *i);
190                let end_byte = char_indices.get(end_char).map_or(line_content.len(), |(i, _)| *i);
191
192                if let Some(start_byte) = start_byte
193                    && start_byte < end_byte
194                    && end_byte <= line_content.len()
195                {
196                    let between = &line_content[start_byte..end_byte];
197                    // If there's text containing "code" or similar patterns between spans,
198                    // it's likely they're showing nested backticks
199                    if between.contains("code") || between.contains("backtick") {
200                        return true;
201                    }
202                }
203            }
204        }
205
206        false
207    }
208
209    /// Check for a CommonMark parse shape produced by nested single backticks.
210    ///
211    /// In text like `` `{ outer `inner` outer }` ``, CommonMark sees two adjacent
212    /// code spans rather than one nested span. Removing the apparent leading or
213    /// trailing space from those parsed spans moves prose across the inner
214    /// backticks and changes the rendered text.
215    fn has_attached_nested_backtick_boundary(
216        &self,
217        ctx: &crate::lint_context::LintContext,
218        code_span: &crate::lint_context::CodeSpan,
219    ) -> bool {
220        let content = code_span.content.as_str();
221
222        let next_char = ctx.content[code_span.byte_end..].chars().next();
223        let prev_char = ctx.content[..code_span.byte_offset].chars().next_back();
224
225        // A Pandoc inline code attribute (`code`{.lang}) attached to the closing
226        // backtick is structural syntax, not a nested-backtick illustration.
227        // It must not silence inner-whitespace violations on the code span.
228        let trailing_neighbor_is_pandoc_attr =
229            ctx.flavor.is_pandoc_compatible() && ctx.is_in_inline_code_attr(code_span.byte_end);
230
231        (content.ends_with(char::is_whitespace)
232            && next_char.is_some_and(|c| !c.is_whitespace())
233            && !trailing_neighbor_is_pandoc_attr)
234            || (content.starts_with(char::is_whitespace) && prev_char.is_some_and(|c| !c.is_whitespace()))
235    }
236}
237
238impl Rule for MD038NoSpaceInCode {
239    fn name(&self) -> &'static str {
240        "MD038"
241    }
242
243    fn description(&self) -> &'static str {
244        "Spaces inside code span elements"
245    }
246
247    fn category(&self) -> RuleCategory {
248        RuleCategory::Other
249    }
250
251    fn check(&self, ctx: &crate::lint_context::LintContext) -> LintResult {
252        if !self.enabled {
253            return Ok(vec![]);
254        }
255
256        let mut warnings = Vec::new();
257
258        // Use centralized code spans from LintContext
259        let code_spans = ctx.code_spans();
260        for (i, code_span) in code_spans.iter().enumerate() {
261            // Skip code spans that are inside fenced/indented code blocks
262            if let Some(line_info) = ctx.lines.get(code_span.line - 1) {
263                if line_info.in_code_block {
264                    continue;
265                }
266                // Skip multi-line code spans inside MkDocs containers where pulldown-cmark
267                // misinterprets indented fenced code block markers as code spans.
268                // Covers admonitions, tabs, HTML markdown blocks, and PyMdown blocks.
269                if (line_info.in_mkdocs_container() || line_info.in_pymdown_block) && code_span.content.contains('\n') {
270                    continue;
271                }
272            }
273
274            let code_content = &code_span.content;
275
276            // Skip empty code spans
277            if code_content.is_empty() {
278                continue;
279            }
280
281            // Early check: if no leading/trailing whitespace, skip
282            let has_leading_space = code_content.chars().next().is_some_and(char::is_whitespace);
283            let has_trailing_space = code_content.chars().last().is_some_and(char::is_whitespace);
284
285            if !has_leading_space && !has_trailing_space {
286                continue;
287            }
288
289            let trimmed = code_content.trim();
290
291            // Check if there are leading or trailing spaces
292            if code_content != trimmed {
293                // CommonMark behavior: if there is exactly ONE space at start AND ONE at end,
294                // and the content after trimming is non-empty, those spaces are stripped.
295                // We should NOT flag this case since the spaces are intentionally stripped.
296                // See: https://spec.commonmark.org/0.31.2/#code-spans
297                //
298                // Examples:
299                // ` text ` → "text" (spaces stripped, NOT flagged)
300                // `  text ` → " text" (extra leading space remains, FLAGGED)
301                // ` text  ` → "text " (extra trailing space remains, FLAGGED)
302                // ` text` → " text" (no trailing space to balance, FLAGGED)
303                // `text ` → "text " (no leading space to balance, FLAGGED)
304                if has_leading_space && has_trailing_space && !trimmed.is_empty() {
305                    let leading_spaces = code_content.len() - code_content.trim_start().len();
306                    let trailing_spaces = code_content.len() - code_content.trim_end().len();
307
308                    // Exactly one space on each side - CommonMark strips them
309                    if leading_spaces == 1 && trailing_spaces == 1 {
310                        continue;
311                    }
312                }
313                // Check if the content itself contains backticks - if so, skip to avoid
314                // breaking nested backtick structures
315                if trimmed.contains('`') {
316                    continue;
317                }
318
319                // Skip inline R code in Quarto/RMarkdown: `r expression`
320                // This is RMarkdown/Quarto-specific syntax for inline R evaluation.
321                // Pandoc itself has no concept of executing inline R expressions,
322                // so the exemption is intentionally Quarto-only.
323                if ctx.flavor == crate::config::MarkdownFlavor::Quarto
324                    && trimmed.starts_with('r')
325                    && trimmed.len() > 1
326                    && trimmed.chars().nth(1).is_some_and(char::is_whitespace)
327                {
328                    continue;
329                }
330
331                // Skip InlineHilite syntax in MkDocs: `#!python code`
332                // The space after the language specifier is legitimate
333                if ctx.flavor == crate::config::MarkdownFlavor::MkDocs && is_inline_hilite_content(trimmed) {
334                    continue;
335                }
336
337                // Skip Dataview inline queries in Obsidian: `= expression` or `$= expression`
338                // Dataview plugin uses these patterns for inline DQL and DataviewJS queries.
339                // The space after = or $= is part of the syntax, not a spacing error.
340                if ctx.flavor == crate::config::MarkdownFlavor::Obsidian && Self::is_dataview_expression(code_content) {
341                    continue;
342                }
343
344                // Check if this is part of Hugo template syntax (e.g., {{raw `...`}})
345                // Hugo uses backticks as part of template delimiters, not markdown code spans
346                if self.is_hugo_template_syntax(ctx, code_span) {
347                    continue;
348                }
349
350                // Check if this might be part of a nested backtick structure
351                // by looking for other code spans nearby that might indicate nesting
352                if self.is_likely_nested_backticks(ctx, i) {
353                    continue;
354                }
355
356                if self.has_attached_nested_backtick_boundary(ctx, code_span) {
357                    continue;
358                }
359
360                warnings.push(LintWarning {
361                    rule_name: Some(self.name().to_string()),
362                    line: code_span.line,
363                    column: code_span.start_col + 1, // Convert to 1-indexed
364                    end_line: code_span.line,
365                    end_column: code_span.end_col, // Don't add 1 to match test expectation
366                    message: "Spaces inside code span elements".to_string(),
367                    severity: Severity::Warning,
368                    fix: Some(Fix::new(
369                        code_span.byte_offset..code_span.byte_end,
370                        format!(
371                            "{}{}{}",
372                            "`".repeat(code_span.backtick_count),
373                            trimmed,
374                            "`".repeat(code_span.backtick_count)
375                        ),
376                    )),
377                });
378            }
379        }
380
381        Ok(warnings)
382    }
383
384    fn fix(&self, ctx: &crate::lint_context::LintContext) -> Result<String, LintError> {
385        let content = ctx.content;
386        if !self.enabled {
387            return Ok(content.to_string());
388        }
389
390        // Early return if no backticks in content
391        if !content.contains('`') {
392            return Ok(content.to_string());
393        }
394
395        // Get warnings to identify what needs to be fixed
396        let warnings = self.check(ctx)?;
397        let warnings =
398            crate::utils::fix_utils::filter_warnings_by_inline_config(warnings, ctx.inline_config(), self.name());
399        if warnings.is_empty() {
400            return Ok(content.to_string());
401        }
402
403        // Collect all fixes and sort by position (reverse order to avoid position shifts)
404        let mut fixes: Vec<(std::ops::Range<usize>, String)> = warnings
405            .into_iter()
406            .filter_map(|w| w.fix.map(|f| (f.range, f.replacement)))
407            .collect();
408
409        fixes.sort_by_key(|(range, _)| std::cmp::Reverse(range.start));
410
411        // Apply fixes - only allocate string when we have fixes to apply
412        let mut result = content.to_string();
413        for (range, replacement) in fixes {
414            result.replace_range(range, &replacement);
415        }
416
417        Ok(result)
418    }
419
420    /// Check if content is likely to have code spans
421    fn should_skip(&self, ctx: &crate::lint_context::LintContext) -> bool {
422        !ctx.likely_has_code()
423    }
424
425    fn as_any(&self) -> &dyn std::any::Any {
426        self
427    }
428
429    fn from_config(_config: &crate::config::Config) -> Box<dyn Rule>
430    where
431        Self: Sized,
432    {
433        Box::new(MD038NoSpaceInCode { enabled: true })
434    }
435}
436
437#[cfg(test)]
438mod tests {
439    use super::*;
440
441    #[test]
442    fn test_md038_readme_false_positives() {
443        // These are the exact cases from README.md that are incorrectly flagged
444        let rule = MD038NoSpaceInCode::new();
445        let valid_cases = vec![
446            "3. `pyproject.toml` (must contain `[tool.rumdl]` section)",
447            "#### Effective Configuration (`rumdl config`)",
448            "- Blue: `.rumdl.toml`",
449            "### Defaults Only (`rumdl config --defaults`)",
450        ];
451
452        for case in valid_cases {
453            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
454            let result = rule.check(&ctx).unwrap();
455            assert!(
456                result.is_empty(),
457                "Should not flag code spans without leading/trailing spaces: '{}'. Got {} warnings",
458                case,
459                result.len()
460            );
461        }
462    }
463
464    #[test]
465    fn test_md038_valid() {
466        let rule = MD038NoSpaceInCode::new();
467        let valid_cases = vec![
468            "This is `code` in a sentence.",
469            "This is a `longer code span` in a sentence.",
470            "This is `code with internal spaces` which is fine.",
471            "Code span at `end of line`",
472            "`Start of line` code span",
473            "Multiple `code spans` in `one line` are fine",
474            "Code span with `symbols: !@#$%^&*()`",
475            "Empty code span `` is technically valid",
476        ];
477        for case in valid_cases {
478            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
479            let result = rule.check(&ctx).unwrap();
480            assert!(result.is_empty(), "Valid case should not have warnings: {case}");
481        }
482    }
483
484    #[test]
485    fn test_md038_invalid() {
486        let rule = MD038NoSpaceInCode::new();
487        // Flag cases that violate CommonMark:
488        // - Space only at start (no matching end space)
489        // - Space only at end (no matching start space)
490        // - Multiple spaces at start or end (extra space will remain after CommonMark stripping)
491        let invalid_cases = vec![
492            // Unbalanced: only leading space
493            "This is ` code` with leading space.",
494            // Unbalanced: only trailing space
495            "This is `code ` with trailing space.",
496            // Multiple leading spaces (one will remain after CommonMark strips one)
497            "This is `  code ` with double leading space.",
498            // Multiple trailing spaces (one will remain after CommonMark strips one)
499            "This is ` code  ` with double trailing space.",
500            // Multiple spaces both sides
501            "This is `  code  ` with double spaces both sides.",
502        ];
503        for case in invalid_cases {
504            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
505            let result = rule.check(&ctx).unwrap();
506            assert!(!result.is_empty(), "Invalid case should have warnings: {case}");
507        }
508    }
509
510    #[test]
511    fn test_md038_valid_commonmark_stripping() {
512        let rule = MD038NoSpaceInCode::new();
513        // These cases have exactly ONE space at start AND ONE at end.
514        // CommonMark strips both, so these should NOT be flagged.
515        // See: https://spec.commonmark.org/0.31.2/#code-spans
516        let valid_cases = vec![
517            "Type ` y ` to confirm.",
518            "Use ` git commit -m \"message\" ` to commit.",
519            "The variable ` $HOME ` contains home path.",
520            "The pattern ` *.txt ` matches text files.",
521            "This is ` random word ` with unnecessary spaces.",
522            "Text with ` plain text ` is valid.",
523            "Code with ` just code ` here.",
524            "Multiple ` word ` spans with ` text ` in one line.",
525            "This is ` code ` with both leading and trailing single space.",
526            "Use ` - ` as separator.",
527        ];
528        for case in valid_cases {
529            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
530            let result = rule.check(&ctx).unwrap();
531            assert!(
532                result.is_empty(),
533                "Single space on each side should not be flagged (CommonMark strips them): {case}"
534            );
535        }
536    }
537
538    #[test]
539    fn test_md038_fix() {
540        let rule = MD038NoSpaceInCode::new();
541        // Only cases that violate CommonMark should be fixed
542        let test_cases = vec![
543            // Unbalanced: only leading space - should be fixed
544            (
545                "This is ` code` with leading space.",
546                "This is `code` with leading space.",
547            ),
548            // Unbalanced: only trailing space - should be fixed
549            (
550                "This is `code ` with trailing space.",
551                "This is `code` with trailing space.",
552            ),
553            // Single space on both sides - NOT fixed (valid per CommonMark)
554            (
555                "This is ` code ` with both spaces.",
556                "This is ` code ` with both spaces.", // unchanged
557            ),
558            // Double leading space - should be fixed
559            (
560                "This is `  code ` with double leading space.",
561                "This is `code` with double leading space.",
562            ),
563            // Mixed: one valid (single space both), one invalid (trailing only)
564            (
565                "Multiple ` code ` and `spans ` to fix.",
566                "Multiple ` code ` and `spans` to fix.", // only spans is fixed
567            ),
568        ];
569        for (input, expected) in test_cases {
570            let ctx = crate::lint_context::LintContext::new(input, crate::config::MarkdownFlavor::Standard, None);
571            let result = rule.fix(&ctx).unwrap();
572            assert_eq!(result, expected, "Fix did not produce expected output for: {input}");
573        }
574    }
575
576    #[test]
577    fn test_check_invalid_leading_space() {
578        let rule = MD038NoSpaceInCode::new();
579        let input = "This has a ` leading space` in code";
580        let ctx = crate::lint_context::LintContext::new(input, crate::config::MarkdownFlavor::Standard, None);
581        let result = rule.check(&ctx).unwrap();
582        assert_eq!(result.len(), 1);
583        assert_eq!(result[0].line, 1);
584        assert!(result[0].fix.is_some());
585    }
586
587    #[test]
588    fn test_code_span_parsing_nested_backticks() {
589        let content = "Code with ` nested `code` example ` should preserve backticks";
590        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
591
592        println!("Content: {content}");
593        println!("Code spans found:");
594        let code_spans = ctx.code_spans();
595        for (i, span) in code_spans.iter().enumerate() {
596            println!(
597                "  Span {}: line={}, col={}-{}, backticks={}, content='{}'",
598                i, span.line, span.start_col, span.end_col, span.backtick_count, span.content
599            );
600        }
601
602        // This test reveals the issue - we're getting multiple separate code spans instead of one
603        assert_eq!(code_spans.len(), 2, "Should parse as 2 code spans");
604    }
605
606    #[test]
607    fn test_nested_backtick_detection() {
608        let rule = MD038NoSpaceInCode::new();
609
610        // Test that code spans with backticks are skipped
611        let content = "Code with `` `backticks` inside `` should not be flagged";
612        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
613        let result = rule.check(&ctx).unwrap();
614        assert!(result.is_empty(), "Code spans with backticks should be skipped");
615    }
616
617    #[test]
618    fn test_quarto_inline_r_code() {
619        // Test that Quarto-specific R code exception works
620        let rule = MD038NoSpaceInCode::new();
621
622        // Test inline R code - should NOT trigger warning in Quarto flavor
623        // The key pattern is "r " followed by code
624        let content = r#"The result is `r nchar("test")` which equals 4."#;
625
626        // Quarto flavor should allow R code
627        let ctx_quarto = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Quarto, None);
628        let result_quarto = rule.check(&ctx_quarto).unwrap();
629        assert!(
630            result_quarto.is_empty(),
631            "Quarto inline R code should not trigger warnings. Got {} warnings",
632            result_quarto.len()
633        );
634
635        // Test that invalid code spans (not matching CommonMark stripping) still get flagged in Quarto
636        // Use only trailing space - this violates CommonMark (no balanced stripping)
637        let content_other = "This has `plain text ` with trailing space.";
638        let ctx_other =
639            crate::lint_context::LintContext::new(content_other, crate::config::MarkdownFlavor::Quarto, None);
640        let result_other = rule.check(&ctx_other).unwrap();
641        assert_eq!(
642            result_other.len(),
643            1,
644            "Quarto should still flag non-R code spans with improper spaces"
645        );
646    }
647
648    /// Comprehensive tests for Hugo template syntax detection
649    ///
650    /// These tests ensure MD038 correctly handles Hugo template syntax patterns
651    /// without false positives, while maintaining correct detection of actual
652    /// code span spacing issues.
653    #[test]
654    fn test_hugo_template_syntax_comprehensive() {
655        let rule = MD038NoSpaceInCode::new();
656
657        // ===== VALID HUGO TEMPLATE SYNTAX (Should NOT trigger warnings) =====
658
659        // Basic Hugo shortcode patterns
660        let valid_hugo_cases = vec![
661            // Raw HTML shortcode
662            (
663                "{{raw `\n\tgo list -f '{{.DefaultGODEBUG}}' my/main/package\n`}}",
664                "Multi-line raw shortcode",
665            ),
666            (
667                "Some text {{raw ` code `}} more text",
668                "Inline raw shortcode with spaces",
669            ),
670            ("{{raw `code`}}", "Raw shortcode without spaces"),
671            // Partial shortcode
672            ("{{< ` code ` >}}", "Partial shortcode with spaces"),
673            ("{{< `code` >}}", "Partial shortcode without spaces"),
674            // Shortcode with percent
675            ("{{% ` code ` %}}", "Percent shortcode with spaces"),
676            ("{{% `code` %}}", "Percent shortcode without spaces"),
677            // Generic shortcode
678            ("{{ ` code ` }}", "Generic shortcode with spaces"),
679            ("{{ `code` }}", "Generic shortcode without spaces"),
680            // Shortcodes with parameters (common Hugo pattern)
681            ("{{< highlight go `code` >}}", "Shortcode with highlight parameter"),
682            ("{{< code `go list` >}}", "Shortcode with code parameter"),
683            // Multi-line Hugo templates
684            ("{{raw `\n\tcommand here\n\tmore code\n`}}", "Multi-line raw template"),
685            ("{{< highlight `\ncode here\n` >}}", "Multi-line highlight template"),
686            // Hugo templates with nested Go template syntax
687            (
688                "{{raw `\n\t{{.Variable}}\n\t{{range .Items}}\n`}}",
689                "Nested Go template syntax",
690            ),
691            // Edge case: Hugo template at start of line
692            ("{{raw `code`}}", "Hugo template at line start"),
693            // Edge case: Hugo template at end of line
694            ("Text {{raw `code`}}", "Hugo template at end of line"),
695            // Edge case: Multiple Hugo templates
696            ("{{raw `code1`}} and {{raw `code2`}}", "Multiple Hugo templates"),
697        ];
698
699        for (case, description) in valid_hugo_cases {
700            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
701            let result = rule.check(&ctx).unwrap();
702            assert!(
703                result.is_empty(),
704                "Hugo template syntax should not trigger MD038 warnings: {description} - {case}"
705            );
706        }
707
708        // ===== FALSE POSITIVE PREVENTION (Non-Hugo asymmetric spaces should be flagged) =====
709
710        // These have asymmetric spaces (leading-only or trailing-only) and should be flagged
711        // Per CommonMark spec: symmetric single-space pairs are stripped and NOT flagged
712        let should_be_flagged = vec![
713            ("This is ` code` with leading space.", "Leading space only"),
714            ("This is `code ` with trailing space.", "Trailing space only"),
715            ("Text `  code ` here", "Extra leading space (asymmetric)"),
716            ("Text ` code  ` here", "Extra trailing space (asymmetric)"),
717            ("Text `  code` here", "Double leading, no trailing"),
718            ("Text `code  ` here", "No leading, double trailing"),
719        ];
720
721        for (case, description) in should_be_flagged {
722            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
723            let result = rule.check(&ctx).unwrap();
724            assert!(
725                !result.is_empty(),
726                "Should flag asymmetric space code spans: {description} - {case}"
727            );
728        }
729
730        // ===== COMMONMARK SYMMETRIC SPACE BEHAVIOR (Should NOT be flagged) =====
731
732        // Per CommonMark 0.31.2: When a code span has exactly one space at start AND end,
733        // those spaces are stripped from the output. This is intentional, not an error.
734        // These cases should NOT trigger MD038.
735        let symmetric_single_space = vec![
736            ("Text ` code ` here", "Symmetric single space - CommonMark strips"),
737            ("{raw ` code `}", "Looks like Hugo but missing opening {{"),
738            ("raw ` code `}}", "Missing opening {{ - but symmetric spaces"),
739        ];
740
741        for (case, description) in symmetric_single_space {
742            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
743            let result = rule.check(&ctx).unwrap();
744            assert!(
745                result.is_empty(),
746                "CommonMark symmetric spaces should NOT be flagged: {description} - {case}"
747            );
748        }
749
750        // ===== EDGE CASES: Unicode and Special Characters =====
751
752        let unicode_cases = vec![
753            ("{{raw `\n\t你好世界\n`}}", "Unicode in Hugo template"),
754            ("{{raw `\n\t🎉 emoji\n`}}", "Emoji in Hugo template"),
755            ("{{raw `\n\tcode with \"quotes\"\n`}}", "Quotes in Hugo template"),
756            (
757                "{{raw `\n\tcode with 'single quotes'\n`}}",
758                "Single quotes in Hugo template",
759            ),
760        ];
761
762        for (case, description) in unicode_cases {
763            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
764            let result = rule.check(&ctx).unwrap();
765            assert!(
766                result.is_empty(),
767                "Hugo templates with special characters should not trigger warnings: {description} - {case}"
768            );
769        }
770
771        // ===== BOUNDARY CONDITIONS =====
772
773        // Minimum valid Hugo pattern
774        assert!(
775            rule.check(&crate::lint_context::LintContext::new(
776                "{{ ` ` }}",
777                crate::config::MarkdownFlavor::Standard,
778                None
779            ))
780            .unwrap()
781            .is_empty(),
782            "Minimum Hugo pattern should be valid"
783        );
784
785        // Hugo template with only whitespace
786        assert!(
787            rule.check(&crate::lint_context::LintContext::new(
788                "{{raw `\n\t\n`}}",
789                crate::config::MarkdownFlavor::Standard,
790                None
791            ))
792            .unwrap()
793            .is_empty(),
794            "Hugo template with only whitespace should be valid"
795        );
796    }
797
798    /// Test interaction with other markdown elements
799    #[test]
800    fn test_hugo_template_with_other_markdown() {
801        let rule = MD038NoSpaceInCode::new();
802
803        // Hugo template inside a list
804        let content = r#"1. First item
8052. Second item with {{raw `code`}} template
8063. Third item"#;
807        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
808        let result = rule.check(&ctx).unwrap();
809        assert!(result.is_empty(), "Hugo template in list should not trigger warnings");
810
811        // Hugo template in blockquote
812        let content = r#"> Quote with {{raw `code`}} template"#;
813        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
814        let result = rule.check(&ctx).unwrap();
815        assert!(
816            result.is_empty(),
817            "Hugo template in blockquote should not trigger warnings"
818        );
819
820        // Hugo template near regular code span (should flag the regular one)
821        let content = r#"{{raw `code`}} and ` bad code` here"#;
822        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
823        let result = rule.check(&ctx).unwrap();
824        assert_eq!(result.len(), 1, "Should flag regular code span but not Hugo template");
825    }
826
827    /// Performance test: Many Hugo templates
828    #[test]
829    fn test_hugo_template_performance() {
830        let rule = MD038NoSpaceInCode::new();
831
832        // Create content with many Hugo templates
833        let mut content = String::new();
834        for i in 0..100 {
835            content.push_str(&format!("{{{{raw `code{i}\n`}}}}\n"));
836        }
837
838        let ctx = crate::lint_context::LintContext::new(&content, crate::config::MarkdownFlavor::Standard, None);
839        let start = std::time::Instant::now();
840        let result = rule.check(&ctx).unwrap();
841        let duration = start.elapsed();
842
843        assert!(result.is_empty(), "Many Hugo templates should not trigger warnings");
844        assert!(
845            duration.as_millis() < 1000,
846            "Performance test: Should process 100 Hugo templates in <1s, took {duration:?}"
847        );
848    }
849
850    #[test]
851    fn test_mkdocs_inline_hilite_not_flagged() {
852        // InlineHilite syntax: `#!language code` should NOT be flagged
853        // The space after the language specifier is legitimate
854        let rule = MD038NoSpaceInCode::new();
855
856        let valid_cases = vec![
857            "`#!python print('hello')`",
858            "`#!js alert('hi')`",
859            "`#!c++ cout << x;`",
860            "Use `#!python import os` to import modules",
861            "`#!bash echo $HOME`",
862        ];
863
864        for case in valid_cases {
865            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::MkDocs, None);
866            let result = rule.check(&ctx).unwrap();
867            assert!(
868                result.is_empty(),
869                "InlineHilite syntax should not be flagged in MkDocs: {case}"
870            );
871        }
872
873        // Test that InlineHilite IS flagged in Standard flavor (not MkDocs-aware)
874        let content = "`#!python print('hello')`";
875        let ctx_standard =
876            crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
877        let result_standard = rule.check(&ctx_standard).unwrap();
878        // In standard flavor, the content " print('hello')" has no special meaning
879        // But since "#!python print('hello')" doesn't have leading/trailing spaces, it's valid!
880        assert!(
881            result_standard.is_empty(),
882            "InlineHilite with no extra spaces should not be flagged even in Standard flavor"
883        );
884    }
885
886    #[test]
887    fn test_multibyte_utf8_no_panic() {
888        // Regression test: ensure multi-byte UTF-8 characters don't cause panics
889        // when checking for nested backticks between code spans.
890        // These are real examples from the-art-of-command-line translations.
891        let rule = MD038NoSpaceInCode::new();
892
893        // Greek text with code spans
894        let greek = "- Χρήσιμα εργαλεία της γραμμής εντολών είναι τα `ping`,` ipconfig`, `traceroute` και `netstat`.";
895        let ctx = crate::lint_context::LintContext::new(greek, crate::config::MarkdownFlavor::Standard, None);
896        let result = rule.check(&ctx);
897        assert!(result.is_ok(), "Greek text should not panic");
898
899        // Chinese text with code spans
900        let chinese = "- 當你需要對文字檔案做集合交、並、差運算時,`sort`/`uniq` 很有幫助。";
901        let ctx = crate::lint_context::LintContext::new(chinese, crate::config::MarkdownFlavor::Standard, None);
902        let result = rule.check(&ctx);
903        assert!(result.is_ok(), "Chinese text should not panic");
904
905        // Cyrillic/Ukrainian text with code spans
906        let cyrillic = "- Основи роботи з файлами: `ls` і `ls -l`, `less`, `head`,` tail` і `tail -f`.";
907        let ctx = crate::lint_context::LintContext::new(cyrillic, crate::config::MarkdownFlavor::Standard, None);
908        let result = rule.check(&ctx);
909        assert!(result.is_ok(), "Cyrillic text should not panic");
910
911        // Mixed multi-byte with multiple code spans on same line
912        let mixed = "使用 `git` 命令和 `npm` 工具来管理项目,可以用 `docker` 容器化。";
913        let ctx = crate::lint_context::LintContext::new(mixed, crate::config::MarkdownFlavor::Standard, None);
914        let result = rule.check(&ctx);
915        assert!(
916            result.is_ok(),
917            "Mixed Chinese text with multiple code spans should not panic"
918        );
919    }
920
921    // ==================== Obsidian Dataview Plugin Tests ====================
922
923    /// Test that Dataview inline DQL expressions are not flagged in Obsidian flavor
924    #[test]
925    fn test_obsidian_dataview_inline_dql_not_flagged() {
926        let rule = MD038NoSpaceInCode::new();
927
928        // Basic inline DQL expressions - should NOT be flagged in Obsidian
929        let valid_dql_cases = vec![
930            "`= this.file.name`",
931            "`= date(today)`",
932            "`= [[Page]].field`",
933            "`= choice(condition, \"yes\", \"no\")`",
934            "`= this.file.mtime`",
935            "`= this.file.ctime`",
936            "`= this.file.path`",
937            "`= this.file.folder`",
938            "`= this.file.size`",
939            "`= this.file.ext`",
940            "`= this.file.link`",
941            "`= this.file.outlinks`",
942            "`= this.file.inlinks`",
943            "`= this.file.tags`",
944        ];
945
946        for case in valid_dql_cases {
947            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
948            let result = rule.check(&ctx).unwrap();
949            assert!(
950                result.is_empty(),
951                "Dataview DQL expression should not be flagged in Obsidian: {case}"
952            );
953        }
954    }
955
956    /// Test that Dataview inline DataviewJS expressions are not flagged in Obsidian flavor
957    #[test]
958    fn test_obsidian_dataview_inline_dvjs_not_flagged() {
959        let rule = MD038NoSpaceInCode::new();
960
961        // Inline DataviewJS expressions - should NOT be flagged in Obsidian
962        let valid_dvjs_cases = vec![
963            "`$= dv.current().file.mtime`",
964            "`$= dv.pages().length`",
965            "`$= dv.current()`",
966            "`$= dv.pages('#tag').length`",
967            "`$= dv.pages('\"folder\"').length`",
968            "`$= dv.current().file.name`",
969            "`$= dv.current().file.path`",
970            "`$= dv.current().file.folder`",
971            "`$= dv.current().file.link`",
972        ];
973
974        for case in valid_dvjs_cases {
975            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
976            let result = rule.check(&ctx).unwrap();
977            assert!(
978                result.is_empty(),
979                "Dataview JS expression should not be flagged in Obsidian: {case}"
980            );
981        }
982    }
983
984    /// Test complex Dataview expressions with nested parentheses
985    #[test]
986    fn test_obsidian_dataview_complex_expressions() {
987        let rule = MD038NoSpaceInCode::new();
988
989        let complex_cases = vec![
990            // Nested function calls
991            "`= sum(filter(pages, (p) => p.done))`",
992            "`= length(filter(file.tags, (t) => startswith(t, \"project\")))`",
993            // choice() function
994            "`= choice(x > 5, \"big\", \"small\")`",
995            "`= choice(this.status = \"done\", \"✅\", \"⏳\")`",
996            // date functions
997            "`= date(today) - dur(7 days)`",
998            "`= dateformat(this.file.mtime, \"yyyy-MM-dd\")`",
999            // Math expressions
1000            "`= sum(rows.amount)`",
1001            "`= round(average(rows.score), 2)`",
1002            "`= min(rows.priority)`",
1003            "`= max(rows.priority)`",
1004            // String operations
1005            "`= join(this.file.tags, \", \")`",
1006            "`= replace(this.title, \"-\", \" \")`",
1007            "`= lower(this.file.name)`",
1008            "`= upper(this.file.name)`",
1009            // List operations
1010            "`= length(this.file.outlinks)`",
1011            "`= contains(this.file.tags, \"important\")`",
1012            // Link references
1013            "`= [[Page Name]].field`",
1014            "`= [[Folder/Subfolder/Page]].nested.field`",
1015            // Conditional expressions
1016            "`= default(this.status, \"unknown\")`",
1017            "`= coalesce(this.priority, this.importance, 0)`",
1018        ];
1019
1020        for case in complex_cases {
1021            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1022            let result = rule.check(&ctx).unwrap();
1023            assert!(
1024                result.is_empty(),
1025                "Complex Dataview expression should not be flagged in Obsidian: {case}"
1026            );
1027        }
1028    }
1029
1030    /// Test that complex DataviewJS expressions with method chains are not flagged
1031    #[test]
1032    fn test_obsidian_dataviewjs_method_chains() {
1033        let rule = MD038NoSpaceInCode::new();
1034
1035        let method_chain_cases = vec![
1036            "`$= dv.pages().where(p => p.status).length`",
1037            "`$= dv.pages('#project').where(p => !p.done).length`",
1038            "`$= dv.pages().filter(p => p.file.day).sort(p => p.file.mtime, 'desc').limit(5)`",
1039            "`$= dv.pages('\"folder\"').map(p => p.file.link).join(', ')`",
1040            "`$= dv.current().file.tasks.where(t => !t.completed).length`",
1041            "`$= dv.pages().flatMap(p => p.file.tags).distinct().sort()`",
1042            "`$= dv.page('Index').children.map(p => p.title)`",
1043            "`$= dv.pages().groupBy(p => p.status).map(g => [g.key, g.rows.length])`",
1044        ];
1045
1046        for case in method_chain_cases {
1047            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1048            let result = rule.check(&ctx).unwrap();
1049            assert!(
1050                result.is_empty(),
1051                "DataviewJS method chain should not be flagged in Obsidian: {case}"
1052            );
1053        }
1054    }
1055
1056    /// Test Dataview-like patterns in Standard flavor
1057    ///
1058    /// Note: The actual content `= this.file.name` starts with `=`, not whitespace,
1059    /// so it doesn't have a leading space issue. Dataview expressions only become
1060    /// relevant when their content would otherwise be flagged.
1061    ///
1062    /// To properly test the difference, we need patterns that have leading whitespace
1063    /// issues that would be skipped in Obsidian but flagged in Standard.
1064    #[test]
1065    fn test_standard_flavor_vs_obsidian_dataview() {
1066        let rule = MD038NoSpaceInCode::new();
1067
1068        // These Dataview expressions don't have leading whitespace (they start with "=")
1069        // so they wouldn't be flagged in ANY flavor
1070        let no_issue_cases = vec!["`= this.file.name`", "`$= dv.current()`"];
1071
1072        for case in no_issue_cases {
1073            // Standard flavor - no issue because content doesn't start with whitespace
1074            let ctx_std = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
1075            let result_std = rule.check(&ctx_std).unwrap();
1076            assert!(
1077                result_std.is_empty(),
1078                "Dataview expression without leading space shouldn't be flagged in Standard: {case}"
1079            );
1080
1081            // Obsidian flavor - also no issue
1082            let ctx_obs = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1083            let result_obs = rule.check(&ctx_obs).unwrap();
1084            assert!(
1085                result_obs.is_empty(),
1086                "Dataview expression shouldn't be flagged in Obsidian: {case}"
1087            );
1088        }
1089
1090        // Test that regular code with leading/trailing spaces is still flagged in both flavors
1091        // (when not matching Dataview pattern)
1092        let space_issues = vec![
1093            "` code`", // Leading space, no trailing
1094            "`code `", // Trailing space, no leading
1095        ];
1096
1097        for case in space_issues {
1098            // Standard flavor - should be flagged
1099            let ctx_std = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Standard, None);
1100            let result_std = rule.check(&ctx_std).unwrap();
1101            assert!(
1102                !result_std.is_empty(),
1103                "Code with spacing issue should be flagged in Standard: {case}"
1104            );
1105
1106            // Obsidian flavor - should also be flagged (not a Dataview pattern)
1107            let ctx_obs = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1108            let result_obs = rule.check(&ctx_obs).unwrap();
1109            assert!(
1110                !result_obs.is_empty(),
1111                "Code with spacing issue should be flagged in Obsidian (not Dataview): {case}"
1112            );
1113        }
1114    }
1115
1116    /// Test that regular code spans with leading space are still flagged in Obsidian
1117    #[test]
1118    fn test_obsidian_still_flags_regular_code_spans_with_space() {
1119        let rule = MD038NoSpaceInCode::new();
1120
1121        // These are NOT Dataview expressions, just regular code spans with leading space
1122        // They should still be flagged even in Obsidian flavor
1123        let invalid_cases = [
1124            "` regular code`", // Space at start, not Dataview
1125            "`code `",         // Space at end
1126            "` code `",        // This is valid per CommonMark (symmetric single space)
1127            "`  code`",        // Double space at start (not Dataview pattern)
1128        ];
1129
1130        // Only the asymmetric cases should be flagged
1131        let expected_flags = [
1132            true,  // ` regular code` - leading space, no trailing
1133            true,  // `code ` - trailing space, no leading
1134            false, // ` code ` - symmetric single space (CommonMark valid)
1135            true,  // `  code` - double leading space
1136        ];
1137
1138        for (case, should_flag) in invalid_cases.iter().zip(expected_flags.iter()) {
1139            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1140            let result = rule.check(&ctx).unwrap();
1141            if *should_flag {
1142                assert!(
1143                    !result.is_empty(),
1144                    "Non-Dataview code span with spacing issue should be flagged in Obsidian: {case}"
1145                );
1146            } else {
1147                assert!(
1148                    result.is_empty(),
1149                    "CommonMark-valid symmetric spacing should not be flagged: {case}"
1150                );
1151            }
1152        }
1153    }
1154
1155    /// Test edge cases for Dataview pattern detection
1156    #[test]
1157    fn test_obsidian_dataview_edge_cases() {
1158        let rule = MD038NoSpaceInCode::new();
1159
1160        // Valid Dataview patterns
1161        let valid_cases = vec![
1162            ("`= x`", true),                         // Minimal DQL
1163            ("`$= x`", true),                        // Minimal DVJS
1164            ("`= `", true),                          // Just equals-space (empty expression)
1165            ("`$= `", true),                         // Just dollar-equals-space (empty expression)
1166            ("`=x`", false),                         // No space after = (not Dataview, and no leading whitespace issue)
1167            ("`$=x`", false),       // No space after $= (not Dataview, and no leading whitespace issue)
1168            ("`= [[Link]]`", true), // Link in expression
1169            ("`= this`", true),     // Simple this reference
1170            ("`$= dv`", true),      // Just dv object reference
1171            ("`= 1 + 2`", true),    // Math expression
1172            ("`$= 1 + 2`", true),   // Math in DVJS
1173            ("`= \"string\"`", true), // String literal
1174            ("`$= 'string'`", true), // Single-quoted string
1175            ("`= this.field ?? \"default\"`", true), // Null coalescing
1176            ("`$= dv?.pages()`", true), // Optional chaining
1177        ];
1178
1179        for (case, should_be_valid) in valid_cases {
1180            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1181            let result = rule.check(&ctx).unwrap();
1182            if should_be_valid {
1183                assert!(
1184                    result.is_empty(),
1185                    "Valid Dataview expression should not be flagged: {case}"
1186                );
1187            } else {
1188                // These might or might not be flagged depending on other MD038 rules
1189                // We just verify they don't crash
1190                let _ = result;
1191            }
1192        }
1193    }
1194
1195    /// Test Dataview expressions in context (mixed with regular markdown)
1196    #[test]
1197    fn test_obsidian_dataview_in_context() {
1198        let rule = MD038NoSpaceInCode::new();
1199
1200        // Document with mixed Dataview and regular code spans
1201        let content = r#"# My Note
1202
1203The file name is `= this.file.name` and it was created on `= this.file.ctime`.
1204
1205Regular code: `println!("hello")` and `let x = 5;`
1206
1207DataviewJS count: `$= dv.pages('#project').length` projects found.
1208
1209More regular code with issue: ` bad code` should be flagged.
1210"#;
1211
1212        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Obsidian, None);
1213        let result = rule.check(&ctx).unwrap();
1214
1215        // Should only flag ` bad code` (line 9)
1216        assert_eq!(
1217            result.len(),
1218            1,
1219            "Should only flag the regular code span with leading space, not Dataview expressions"
1220        );
1221        assert_eq!(result[0].line, 9, "Warning should be on line 9");
1222    }
1223
1224    /// Test that Dataview expressions in code blocks are properly handled
1225    #[test]
1226    fn test_obsidian_dataview_in_code_blocks() {
1227        let rule = MD038NoSpaceInCode::new();
1228
1229        // Dataview expressions inside fenced code blocks should be ignored
1230        // (because they're inside code blocks, not because of Dataview logic)
1231        let content = r#"# Example
1232
1233```
1234`= this.file.name`
1235`$= dv.current()`
1236```
1237
1238Regular paragraph with `= this.file.name` Dataview.
1239"#;
1240
1241        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Obsidian, None);
1242        let result = rule.check(&ctx).unwrap();
1243
1244        // Should not flag anything - code blocks are skipped, and inline Dataview is valid
1245        assert!(
1246            result.is_empty(),
1247            "Dataview in code blocks should be ignored, inline Dataview should be valid"
1248        );
1249    }
1250
1251    /// Test Dataview with Unicode content
1252    #[test]
1253    fn test_obsidian_dataview_unicode() {
1254        let rule = MD038NoSpaceInCode::new();
1255
1256        let unicode_cases = vec![
1257            "`= this.日本語`",                  // Japanese field name
1258            "`= this.中文字段`",                // Chinese field name
1259            "`= \"Привет мир\"`",               // Russian string
1260            "`$= dv.pages('#日本語タグ')`",     // Japanese tag
1261            "`= choice(true, \"✅\", \"❌\")`", // Emoji in strings
1262            "`= this.file.name + \" 📝\"`",     // Emoji concatenation
1263        ];
1264
1265        for case in unicode_cases {
1266            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1267            let result = rule.check(&ctx).unwrap();
1268            assert!(
1269                result.is_empty(),
1270                "Unicode Dataview expression should not be flagged: {case}"
1271            );
1272        }
1273    }
1274
1275    /// Test that Dataview detection doesn't break regular equals patterns
1276    #[test]
1277    fn test_obsidian_regular_equals_still_works() {
1278        let rule = MD038NoSpaceInCode::new();
1279
1280        // Regular code with equals signs should still work normally
1281        let valid_regular_cases = vec![
1282            "`x = 5`",       // Assignment (no leading space)
1283            "`a == b`",      // Equality check
1284            "`x >= 10`",     // Comparison
1285            "`let x = 10`",  // Variable declaration
1286            "`const y = 5`", // Const declaration
1287        ];
1288
1289        for case in valid_regular_cases {
1290            let ctx = crate::lint_context::LintContext::new(case, crate::config::MarkdownFlavor::Obsidian, None);
1291            let result = rule.check(&ctx).unwrap();
1292            assert!(
1293                result.is_empty(),
1294                "Regular code with equals should not be flagged: {case}"
1295            );
1296        }
1297    }
1298
1299    /// Test fix behavior doesn't break Dataview expressions
1300    #[test]
1301    fn test_obsidian_dataview_fix_preserves_expressions() {
1302        let rule = MD038NoSpaceInCode::new();
1303
1304        // Content with Dataview expressions and one fixable issue
1305        let content = "Dataview: `= this.file.name` and bad: ` fixme`";
1306        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Obsidian, None);
1307        let fixed = rule.fix(&ctx).unwrap();
1308
1309        // Should fix ` fixme` but preserve `= this.file.name`
1310        assert!(
1311            fixed.contains("`= this.file.name`"),
1312            "Dataview expression should be preserved after fix"
1313        );
1314        assert!(
1315            fixed.contains("`fixme`"),
1316            "Regular code span should be fixed (space removed)"
1317        );
1318        assert!(!fixed.contains("` fixme`"), "Bad code span should have been fixed");
1319    }
1320
1321    /// Test multiple Dataview expressions on same line
1322    #[test]
1323    fn test_obsidian_multiple_dataview_same_line() {
1324        let rule = MD038NoSpaceInCode::new();
1325
1326        let content = "Created: `= this.file.ctime` | Modified: `= this.file.mtime` | Count: `$= dv.pages().length`";
1327        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Obsidian, None);
1328        let result = rule.check(&ctx).unwrap();
1329
1330        assert!(
1331            result.is_empty(),
1332            "Multiple Dataview expressions on same line should all be valid"
1333        );
1334    }
1335
1336    /// Performance test: Many Dataview expressions
1337    #[test]
1338    fn test_obsidian_dataview_performance() {
1339        let rule = MD038NoSpaceInCode::new();
1340
1341        // Create content with many Dataview expressions
1342        let mut content = String::new();
1343        for i in 0..100 {
1344            content.push_str(&format!("Field {i}: `= this.field{i}` | JS: `$= dv.current().f{i}`\n"));
1345        }
1346
1347        let ctx = crate::lint_context::LintContext::new(&content, crate::config::MarkdownFlavor::Obsidian, None);
1348        let start = std::time::Instant::now();
1349        let result = rule.check(&ctx).unwrap();
1350        let duration = start.elapsed();
1351
1352        assert!(result.is_empty(), "All Dataview expressions should be valid");
1353        assert!(
1354            duration.as_millis() < 1000,
1355            "Performance test: Should process 200 Dataview expressions in <1s, took {duration:?}"
1356        );
1357    }
1358
1359    /// Test is_dataview_expression helper function directly
1360    #[test]
1361    fn test_is_dataview_expression_helper() {
1362        // Valid Dataview patterns
1363        assert!(MD038NoSpaceInCode::is_dataview_expression("= this.file.name"));
1364        assert!(MD038NoSpaceInCode::is_dataview_expression("= "));
1365        assert!(MD038NoSpaceInCode::is_dataview_expression("$= dv.current()"));
1366        assert!(MD038NoSpaceInCode::is_dataview_expression("$= "));
1367        assert!(MD038NoSpaceInCode::is_dataview_expression("= x"));
1368        assert!(MD038NoSpaceInCode::is_dataview_expression("$= x"));
1369
1370        // Invalid Dataview patterns
1371        assert!(!MD038NoSpaceInCode::is_dataview_expression("=")); // No space after =
1372        assert!(!MD038NoSpaceInCode::is_dataview_expression("$=")); // No space after $=
1373        assert!(!MD038NoSpaceInCode::is_dataview_expression("=x")); // No space
1374        assert!(!MD038NoSpaceInCode::is_dataview_expression("$=x")); // No space
1375        assert!(!MD038NoSpaceInCode::is_dataview_expression(" = x")); // Leading space before =
1376        assert!(!MD038NoSpaceInCode::is_dataview_expression("x = 5")); // Assignment, not Dataview
1377        assert!(!MD038NoSpaceInCode::is_dataview_expression("== x")); // Double equals
1378        assert!(!MD038NoSpaceInCode::is_dataview_expression("")); // Empty
1379        assert!(!MD038NoSpaceInCode::is_dataview_expression("regular")); // Regular text
1380    }
1381
1382    /// Test Dataview expressions work alongside other Obsidian features (tags)
1383    #[test]
1384    fn test_obsidian_dataview_with_tags() {
1385        let rule = MD038NoSpaceInCode::new();
1386
1387        // Document using both Dataview and Obsidian tags
1388        let content = r#"# Project Status
1389
1390Tags: #project #active
1391
1392Status: `= this.status`
1393Count: `$= dv.pages('#project').length`
1394
1395Regular code: `function test() {}`
1396"#;
1397
1398        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Obsidian, None);
1399        let result = rule.check(&ctx).unwrap();
1400
1401        // Nothing should be flagged
1402        assert!(
1403            result.is_empty(),
1404            "Dataview expressions and regular code should work together"
1405        );
1406    }
1407
1408    #[test]
1409    fn test_unicode_between_code_spans_no_panic() {
1410        // Verify that multi-byte characters between code spans do not cause panics
1411        // or incorrect slicing in the nested-backtick detection logic.
1412        let rule = MD038NoSpaceInCode::new();
1413
1414        // Multi-byte character (U-umlaut = 2 bytes) between two code spans
1415        let content = "Use `one` \u{00DC}nited `two` for backtick examples.";
1416        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
1417        let result = rule.check(&ctx);
1418        // Should not panic; any warnings or lack thereof are acceptable
1419        assert!(result.is_ok(), "Should not panic with Unicode between code spans");
1420
1421        // CJK characters (3 bytes each) between code spans
1422        let content_cjk = "Use `one` \u{4E16}\u{754C} `two` for examples.";
1423        let ctx_cjk = crate::lint_context::LintContext::new(content_cjk, crate::config::MarkdownFlavor::Standard, None);
1424        let result_cjk = rule.check(&ctx_cjk);
1425        assert!(result_cjk.is_ok(), "Should not panic with CJK between code spans");
1426    }
1427
1428    #[test]
1429    fn test_pandoc_inline_r_code_not_exempt() {
1430        // The `r expression` pattern is RMarkdown/Quarto-specific inline R evaluation syntax.
1431        // A code span like `r foo ` (trailing space, starts with `r `) triggers the Quarto
1432        // guard when in Quarto flavor — the trailing space violation is suppressed because the
1433        // content looks like inline R code.  Under Pandoc flavor the guard must NOT fire:
1434        // `r ` is not special Pandoc syntax, so the trailing space is a genuine MD038 violation.
1435        let rule = MD038NoSpaceInCode::new();
1436        // Trailing space only (no leading space) — CommonMark does not strip this, so it's a
1437        // real MD038 violation.  The `r ` prefix makes it match the Quarto `r expression` guard.
1438        let content = "See `r foo ` for details.\n";
1439
1440        // Under Quarto flavor, the `r expression` guard fires and suppresses the warning.
1441        let ctx_quarto = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Quarto, None);
1442        let result_quarto = rule.check(&ctx_quarto).unwrap();
1443        assert!(
1444            result_quarto.is_empty(),
1445            "MD038 should suppress trailing-space warning for `r expression` under Quarto: {result_quarto:?}"
1446        );
1447
1448        // Under Pandoc flavor, the guard does NOT fire — trailing space is flagged.
1449        let ctx_pandoc = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
1450        let result_pandoc = rule.check(&ctx_pandoc).unwrap();
1451        assert!(
1452            !result_pandoc.is_empty(),
1453            "MD038 should flag trailing space in `r expression` under Pandoc flavor (not Quarto/RMarkdown syntax): {result_pandoc:?}"
1454        );
1455    }
1456
1457    /// Pandoc inline code attribute syntax (`` `code`{.lang} ``) does not exempt
1458    /// the code span from MD038's inner-whitespace check: the attribute block lives
1459    /// outside the closing backtick, so a leading space inside the backticks is a
1460    /// real spacing violation regardless of any attached attribute.
1461    #[test]
1462    fn test_pandoc_inline_code_attr_does_not_suppress_leading_space() {
1463        let rule = MD038NoSpaceInCode::new();
1464        let content = "Use ` print()`{.python} for output.\n";
1465        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
1466        let result = rule.check(&ctx).unwrap();
1467        assert!(
1468            !result.is_empty(),
1469            "MD038 must flag leading space inside `code`{{.lang}} under Pandoc — the attribute is outside the span: {result:?}"
1470        );
1471    }
1472
1473    /// Trailing space inside an attributed code span is also a real violation
1474    /// under Pandoc — the `{.lang}` attribute does not absorb whitespace from
1475    /// inside the backticks.
1476    #[test]
1477    fn test_pandoc_inline_code_attr_does_not_suppress_trailing_space() {
1478        let rule = MD038NoSpaceInCode::new();
1479        let content = "Use `print() `{.python} for output.\n";
1480        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
1481        let result = rule.check(&ctx).unwrap();
1482        assert!(
1483            !result.is_empty(),
1484            "MD038 must flag trailing space inside `code`{{.lang}} under Pandoc — the attribute is outside the span: {result:?}"
1485        );
1486    }
1487
1488    /// Cross-flavor parity: Standard flavor still flags the same content.
1489    #[test]
1490    fn test_standard_still_flags_leading_space_with_attr_syntax() {
1491        let rule = MD038NoSpaceInCode::new();
1492        let content = "Use ` print()`{.python} for output.\n";
1493        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
1494        let result = rule.check(&ctx).unwrap();
1495        assert!(
1496            !result.is_empty(),
1497            "MD038 should flag leading space in code span under Standard flavor: {result:?}"
1498        );
1499    }
1500
1501    /// Clean attributed code spans (no inner whitespace) must still pass under
1502    /// Pandoc — the no-whitespace fast path handles them, no special guard needed.
1503    #[test]
1504    fn test_pandoc_inline_code_attr_clean_span_not_flagged() {
1505        let rule = MD038NoSpaceInCode::new();
1506        let content = "Use `print()`{.python} for output.\n";
1507        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
1508        let result = rule.check(&ctx).unwrap();
1509        assert!(
1510            result.is_empty(),
1511            "MD038 must not flag a clean attributed code span under Pandoc: {result:?}"
1512        );
1513    }
1514}