Skip to main content

rumdl_lib/rules/
md055_table_pipe_style.rs

1use crate::rule::{LintError, LintResult, LintWarning, Rule, RuleCategory, Severity};
2use crate::utils::range_utils::calculate_line_range;
3use crate::utils::table_utils::{TableBlock, TableUtils};
4
5mod md055_config;
6use md055_config::MD055Config;
7
8/// Rule MD055: Table pipe style
9///
10/// See [docs/md055.md](../../docs/md055.md) for full documentation, configuration, and examples.
11///
12/// This rule enforces consistent use of leading and trailing pipe characters in Markdown tables,
13/// which improves readability and ensures uniform document styling.
14///
15/// ## Purpose
16///
17/// - **Consistency**: Ensures uniform table formatting throughout documents
18/// - **Readability**: Well-formatted tables are easier to read and understand
19/// - **Maintainability**: Consistent table syntax makes documents easier to maintain
20/// - **Compatibility**: Some Markdown processors handle different table styles differently
21///
22/// ## Configuration Options
23///
24/// The rule supports the following configuration options:
25///
26/// ```yaml
27/// MD055:
28///   style: "consistent"  # Can be "consistent", "leading_and_trailing", or "no_leading_or_trailing"
29/// ```
30///
31/// ### Style Options
32///
33/// - **consistent**: All tables must use the same style (default)
34/// - **leading_and_trailing**: All tables must have both leading and trailing pipes
35/// - **no_leading_or_trailing**: Tables must not have leading or trailing pipes
36///
37/// ## Examples
38///
39/// ### Leading and Trailing Pipes
40///
41/// ```markdown
42/// | Header 1 | Header 2 | Header 3 |
43/// |----------|----------|----------|
44/// | Cell 1   | Cell 2   | Cell 3   |
45/// | Cell 4   | Cell 5   | Cell 6   |
46/// ```
47///
48/// ### No Leading or Trailing Pipes
49///
50/// ```markdown
51/// Header 1 | Header 2 | Header 3
52/// ---------|----------|---------
53/// Cell 1   | Cell 2   | Cell 3
54/// Cell 4   | Cell 5   | Cell 6
55/// ```
56///
57/// ## Behavior Details
58///
59/// - The rule analyzes each table in the document to determine its pipe style
60/// - With "consistent" style, the first table's style is used as the standard for all others
61/// - The rule handles both the header row, separator row, and content rows
62/// - Tables inside code blocks are ignored
63///
64/// ## Fix Behavior
65///
66/// When applying automatic fixes, this rule:
67/// - Adds or removes leading and trailing pipes as needed
68/// - Preserves the content and alignment of table cells
69/// - Maintains proper spacing around pipe characters
70/// - Updates both header and content rows to match the required style
71///
72/// ## Performance Considerations
73///
74/// The rule includes performance optimizations:
75/// - Efficient table detection with quick checks before detailed analysis
76/// - Smart line-by-line processing to avoid redundant operations
77/// - Optimized string manipulation for pipe character handling
78///
79/// Enforces consistent use of leading and trailing pipe characters in tables
80#[derive(Debug, Default, Clone)]
81pub struct MD055TablePipeStyle {
82    config: MD055Config,
83}
84
85impl MD055TablePipeStyle {
86    pub fn new(style: String) -> Self {
87        Self {
88            config: MD055Config { style },
89        }
90    }
91
92    pub fn from_config_struct(config: MD055Config) -> Self {
93        Self { config }
94    }
95
96    /// Determine the most prevalent table style in a table block
97    fn determine_table_style(&self, table_block: &TableBlock, lines: &[&str]) -> Option<&'static str> {
98        let mut leading_and_trailing_count = 0;
99        let mut no_leading_or_trailing_count = 0;
100        let mut leading_only_count = 0;
101        let mut trailing_only_count = 0;
102
103        // Count style of header row (table line index 0)
104        let header_content = TableUtils::extract_table_row_content(lines[table_block.header_line], table_block, 0);
105        if let Some(style) = TableUtils::determine_pipe_style(header_content) {
106            match style {
107                "leading_and_trailing" => leading_and_trailing_count += 1,
108                "no_leading_or_trailing" => no_leading_or_trailing_count += 1,
109                "leading_only" => leading_only_count += 1,
110                "trailing_only" => trailing_only_count += 1,
111                _ => {}
112            }
113        }
114
115        // Count style of content rows (table line indices 2, 3, 4, ...)
116        for (i, &line_idx) in table_block.content_lines.iter().enumerate() {
117            let content = TableUtils::extract_table_row_content(lines[line_idx], table_block, 2 + i);
118            if let Some(style) = TableUtils::determine_pipe_style(content) {
119                match style {
120                    "leading_and_trailing" => leading_and_trailing_count += 1,
121                    "no_leading_or_trailing" => no_leading_or_trailing_count += 1,
122                    "leading_only" => leading_only_count += 1,
123                    "trailing_only" => trailing_only_count += 1,
124                    _ => {}
125                }
126            }
127        }
128
129        // Determine most prevalent style
130        // In case of tie, prefer leading_and_trailing (most common, widely supported)
131        let max_count = leading_and_trailing_count
132            .max(no_leading_or_trailing_count)
133            .max(leading_only_count)
134            .max(trailing_only_count);
135
136        if max_count > 0 {
137            if leading_and_trailing_count == max_count {
138                Some("leading_and_trailing")
139            } else if no_leading_or_trailing_count == max_count {
140                Some("no_leading_or_trailing")
141            } else if leading_only_count == max_count {
142                Some("leading_only")
143            } else if trailing_only_count == max_count {
144                Some("trailing_only")
145            } else {
146                None
147            }
148        } else {
149            None
150        }
151    }
152
153    /// Simple table row fix for tests - creates a dummy TableBlock without list context
154    #[cfg(test)]
155    fn fix_table_row(&self, line: &str, target_style: &str) -> String {
156        let dummy_block = TableBlock {
157            start_line: 0,
158            end_line: 0,
159            header_line: 0,
160            delimiter_line: 0,
161            content_lines: vec![],
162            list_context: None,
163        };
164        self.fix_table_row_with_context(line, target_style, &dummy_block, 0)
165    }
166
167    /// Fix a table row to match the target style, with full context for list tables
168    ///
169    /// This handles tables inside list items by stripping the list prefix,
170    /// fixing the table content, then restoring the appropriate prefix.
171    fn fix_table_row_with_context(
172        &self,
173        line: &str,
174        target_style: &str,
175        table_block: &TableBlock,
176        table_line_index: usize,
177    ) -> String {
178        // Extract blockquote prefix first
179        let (bq_prefix, after_bq) = TableUtils::extract_blockquote_prefix(line);
180
181        // Handle list context if present
182        if let Some(ref list_ctx) = table_block.list_context {
183            if table_line_index == 0 {
184                // Header line: strip list prefix (handles both markers and indentation)
185                let stripped = after_bq
186                    .strip_prefix(&list_ctx.list_prefix)
187                    .unwrap_or_else(|| TableUtils::extract_list_prefix(after_bq).1);
188                let fixed_content = self.fix_table_content(stripped.trim(), target_style);
189
190                // Restore prefixes: blockquote + list prefix + fixed content
191                let lp = &list_ctx.list_prefix;
192                if bq_prefix.is_empty() && lp.is_empty() {
193                    fixed_content
194                } else {
195                    format!("{bq_prefix}{lp}{fixed_content}")
196                }
197            } else {
198                // Continuation lines: strip indentation, then restore it
199                let content_indent = list_ctx.content_indent;
200                let stripped = TableUtils::extract_table_row_content(line, table_block, table_line_index);
201                let fixed_content = self.fix_table_content(stripped.trim(), target_style);
202
203                // Restore prefixes: blockquote + indentation + fixed content
204                let indent = " ".repeat(content_indent);
205                format!("{bq_prefix}{indent}{fixed_content}")
206            }
207        } else {
208            // No list context, just handle blockquote prefix
209            let fixed_content = self.fix_table_content(after_bq.trim(), target_style);
210            if bq_prefix.is_empty() {
211                fixed_content
212            } else {
213                format!("{bq_prefix}{fixed_content}")
214            }
215        }
216    }
217
218    /// Fix the table content (without any prefix handling)
219    fn fix_table_content(&self, trimmed: &str, target_style: &str) -> String {
220        if !trimmed.contains('|') {
221            return trimmed.to_string();
222        }
223
224        let has_leading = trimmed.starts_with('|');
225        let has_trailing = trimmed.ends_with('|');
226
227        match target_style {
228            "leading_and_trailing" => {
229                let mut result = trimmed.to_string();
230
231                // Add leading pipe if missing
232                if !has_leading {
233                    result = format!("| {result}");
234                }
235
236                // Add trailing pipe if missing
237                if !has_trailing {
238                    result = format!("{result} |");
239                }
240
241                result
242            }
243            "no_leading_or_trailing" => {
244                let mut result = trimmed;
245
246                // Remove leading pipe if present
247                if has_leading {
248                    result = result.strip_prefix('|').unwrap_or(result);
249                    result = result.trim_start();
250                }
251
252                // Remove trailing pipe if present
253                if has_trailing {
254                    result = result.strip_suffix('|').unwrap_or(result);
255                    result = result.trim_end();
256                }
257
258                result.to_string()
259            }
260            "leading_only" => {
261                let mut result = trimmed.to_string();
262
263                // Add leading pipe if missing
264                if !has_leading {
265                    result = format!("| {result}");
266                }
267
268                // Remove trailing pipe if present
269                if has_trailing {
270                    result = result.strip_suffix('|').unwrap_or(&result).trim_end().to_string();
271                }
272
273                result
274            }
275            "trailing_only" => {
276                let mut result = trimmed;
277
278                // Remove leading pipe if present
279                if has_leading {
280                    result = result.strip_prefix('|').unwrap_or(result).trim_start();
281                }
282
283                let mut result = result.to_string();
284
285                // Add trailing pipe if missing
286                if !has_trailing {
287                    result = format!("{result} |");
288                }
289
290                result
291            }
292            _ => trimmed.to_string(),
293        }
294    }
295}
296
297impl Rule for MD055TablePipeStyle {
298    fn name(&self) -> &'static str {
299        "MD055"
300    }
301
302    fn description(&self) -> &'static str {
303        "Table pipe style should be consistent"
304    }
305
306    fn category(&self) -> RuleCategory {
307        RuleCategory::Table
308    }
309
310    fn should_skip(&self, ctx: &crate::lint_context::LintContext) -> bool {
311        // Skip if no tables present (uses cached pipe count)
312        !ctx.likely_has_tables()
313    }
314
315    fn check(&self, ctx: &crate::lint_context::LintContext) -> LintResult {
316        let line_index = &ctx.line_index;
317        let mut warnings = Vec::new();
318
319        // Early return handled by should_skip()
320
321        let lines = ctx.raw_lines();
322
323        // Get the configured style explicitly and validate it
324        let configured_style = match self.config.style.as_str() {
325            "leading_and_trailing" | "no_leading_or_trailing" | "leading_only" | "trailing_only" | "consistent" => {
326                self.config.style.as_str()
327            }
328            _ => {
329                // Invalid style provided, default to "leading_and_trailing"
330                "leading_and_trailing"
331            }
332        };
333
334        // Use pre-computed table blocks from context
335        let table_blocks = &ctx.table_blocks;
336
337        // Process each table block
338        for table_block in table_blocks {
339            // First pass: determine the table's style for "consistent" mode
340            // Count all rows to determine most prevalent style (prevalence-based approach)
341            let table_style = if configured_style == "consistent" {
342                self.determine_table_style(table_block, lines)
343            } else {
344                None
345            };
346
347            // Determine target style for this table
348            let target_style = if configured_style == "consistent" {
349                table_style.unwrap_or("leading_and_trailing")
350            } else {
351                configured_style
352            };
353
354            // Collect all table lines for processing
355            let all_line_indices: Vec<usize> = std::iter::once(table_block.header_line)
356                .chain(std::iter::once(table_block.delimiter_line))
357                .chain(table_block.content_lines.iter().copied())
358                .collect();
359
360            // Check each row and emit a per-row fix. Per-row fixes ensure that
361            // inline-disabling one row does not cause the fix on another row to
362            // overwrite the disabled row's content.
363            for (table_line_idx, &line_idx) in all_line_indices.iter().enumerate() {
364                let line = lines[line_idx];
365                // Extract content to properly check pipe style (handles list/blockquote prefixes)
366                let content = TableUtils::extract_table_row_content(line, table_block, table_line_idx);
367                if let Some(current_style) = TableUtils::determine_pipe_style(content) {
368                    // Only flag lines with actual style mismatches
369                    let needs_fixing = current_style != target_style;
370
371                    if needs_fixing {
372                        let (start_line, start_col, end_line, end_col) = calculate_line_range(line_idx + 1, line);
373
374                        let message = format!(
375                            "Table pipe style should be {}",
376                            match target_style {
377                                "leading_and_trailing" => "leading and trailing",
378                                "no_leading_or_trailing" => "no leading or trailing",
379                                "leading_only" => "leading only",
380                                "trailing_only" => "trailing only",
381                                _ => target_style,
382                            }
383                        );
384
385                        // Build a per-row fix so inline-disabled rows are not
386                        // overwritten by fixes on other rows in the same table.
387                        let fixed_line =
388                            self.fix_table_row_with_context(line, target_style, table_block, table_line_idx);
389                        let row_range =
390                            line_index.line_col_to_byte_range_with_length(line_idx + 1, 1, line.chars().count());
391
392                        warnings.push(LintWarning {
393                            rule_name: Some(self.name().to_string()),
394                            severity: Severity::Warning,
395                            message,
396                            line: start_line,
397                            column: start_col,
398                            end_line,
399                            end_column: end_col,
400                            fix: Some(crate::rule::Fix::new(row_range, fixed_line)),
401                        });
402                    }
403                }
404            }
405        }
406
407        Ok(warnings)
408    }
409
410    fn fix(&self, ctx: &crate::lint_context::LintContext) -> Result<String, LintError> {
411        if self.should_skip(ctx) {
412            return Ok(ctx.content.to_string());
413        }
414        let warnings = self.check(ctx)?;
415        if warnings.is_empty() {
416            return Ok(ctx.content.to_string());
417        }
418        let warnings =
419            crate::utils::fix_utils::filter_warnings_by_inline_config(warnings, ctx.inline_config(), self.name());
420        crate::utils::fix_utils::apply_warning_fixes(ctx.content, &warnings).map_err(LintError::InvalidInput)
421    }
422
423    fn as_any(&self) -> &dyn std::any::Any {
424        self
425    }
426
427    fn default_config_section(&self) -> Option<(String, toml::Value)> {
428        let json_value = serde_json::to_value(&self.config).ok()?;
429        Some((
430            self.name().to_string(),
431            crate::rule_config_serde::json_to_toml_value(&json_value)?,
432        ))
433    }
434
435    fn from_config(config: &crate::config::Config) -> Box<dyn Rule>
436    where
437        Self: Sized,
438    {
439        let rule_config = crate::rule_config_serde::load_rule_config::<MD055Config>(config);
440        Box::new(Self::from_config_struct(rule_config))
441    }
442}
443
444#[cfg(test)]
445mod tests {
446    use super::*;
447
448    // === Issue #611: kebab-case config values ignored, fallback to leading-and-trailing ===
449    //
450    // All style names must work identically whether the user writes kebab-case
451    // (no-leading-or-trailing) or snake_case (no_leading_or_trailing) in config.
452
453    fn rule_from_toml_style(style: &str) -> MD055TablePipeStyle {
454        let config: md055_config::MD055Config =
455            toml::from_str(&format!("style = \"{style}\"")).expect("valid style value");
456        MD055TablePipeStyle::from_config_struct(config)
457    }
458
459    #[test]
460    fn test_no_leading_or_trailing_kebab_accepts_conforming_table() {
461        let rule = rule_from_toml_style("no-leading-or-trailing");
462        let content = "A | B\n--- | ---\n1 | 2";
463        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
464        let warnings = rule.check(&ctx).unwrap();
465        assert!(
466            warnings.is_empty(),
467            "no-leading-or-trailing should accept a table with no pipes: {warnings:?}"
468        );
469    }
470
471    #[test]
472    fn test_no_leading_or_trailing_kebab_rejects_nonconforming_table() {
473        let rule = rule_from_toml_style("no-leading-or-trailing");
474        let content = "| A | B |\n|---|---|\n| 1 | 2 |";
475        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
476        let warnings = rule.check(&ctx).unwrap();
477        assert_eq!(
478            warnings.len(),
479            3,
480            "no-leading-or-trailing should flag all 3 rows with pipes"
481        );
482        assert!(warnings.iter().all(|w| w.message.contains("no leading or trailing")));
483    }
484
485    #[test]
486    fn test_leading_only_kebab_accepts_conforming_table() {
487        let rule = rule_from_toml_style("leading-only");
488        let content = "| A | B\n|---|---\n| 1 | 2";
489        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
490        let warnings = rule.check(&ctx).unwrap();
491        assert!(
492            warnings.is_empty(),
493            "leading-only should accept a leading-only table: {warnings:?}"
494        );
495    }
496
497    #[test]
498    fn test_trailing_only_kebab_accepts_conforming_table() {
499        let rule = rule_from_toml_style("trailing-only");
500        let content = "A | B |\n---|---|\n1 | 2 |";
501        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
502        let warnings = rule.check(&ctx).unwrap();
503        assert!(
504            warnings.is_empty(),
505            "trailing-only should accept a trailing-only table: {warnings:?}"
506        );
507    }
508
509    #[test]
510    fn test_trailing_only_kebab_rejects_nonconforming_table() {
511        let rule = rule_from_toml_style("trailing-only");
512        // leading-and-trailing table must be flagged — proves the table is actually detected
513        let content = "| A | B |\n|---|---|\n| 1 | 2 |";
514        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
515        let warnings = rule.check(&ctx).unwrap();
516        assert_eq!(
517            warnings.len(),
518            3,
519            "trailing-only should flag all 3 rows that have leading pipes"
520        );
521        assert!(warnings.iter().all(|w| w.message.contains("trailing only")));
522    }
523
524    #[test]
525    fn test_leading_only_kebab_rejects_nonconforming_table() {
526        let rule = rule_from_toml_style("leading-only");
527        // trailing-only table must be flagged — proves the table is actually detected
528        let content = "A | B |\n---|---|\n1 | 2 |";
529        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
530        let warnings = rule.check(&ctx).unwrap();
531        assert_eq!(
532            warnings.len(),
533            3,
534            "leading-only should flag all 3 rows that have trailing pipes"
535        );
536        assert!(warnings.iter().all(|w| w.message.contains("leading only")));
537    }
538
539    #[test]
540    fn test_leading_and_trailing_kebab_accepts_conforming_table() {
541        let rule = rule_from_toml_style("leading-and-trailing");
542        let content = "| A | B |\n|---|---|\n| 1 | 2 |";
543        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
544        let warnings = rule.check(&ctx).unwrap();
545        assert!(
546            warnings.is_empty(),
547            "leading-and-trailing should accept a fully-piped table: {warnings:?}"
548        );
549    }
550
551    #[test]
552    fn test_kebab_and_snake_case_styles_are_equivalent() {
553        // For every style, kebab and snake_case forms must produce identical warnings —
554        // same count, same messages, same line numbers.
555        let pairs = [
556            ("no-leading-or-trailing", "no_leading_or_trailing"),
557            ("leading-only", "leading_only"),
558            ("trailing-only", "trailing_only"),
559            ("leading-and-trailing", "leading_and_trailing"),
560        ];
561        // Mixed table so every style produces at least one warning, exercising the message path.
562        let content = "| A | B |\n|---|---|\n| 1 | 2 |";
563        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
564
565        for (kebab, snake) in pairs {
566            let kebab_rule = rule_from_toml_style(kebab);
567            let snake_rule = rule_from_toml_style(snake);
568            let kebab_warnings = kebab_rule.check(&ctx).unwrap();
569            let snake_warnings = snake_rule.check(&ctx).unwrap();
570
571            assert_eq!(
572                kebab_warnings.len(),
573                snake_warnings.len(),
574                "'{kebab}' and '{snake}' must produce the same number of warnings"
575            );
576            for (i, (kw, sw)) in kebab_warnings.iter().zip(snake_warnings.iter()).enumerate() {
577                assert_eq!(
578                    kw.message, sw.message,
579                    "warning[{i}] message differs between '{kebab}' and '{snake}'"
580                );
581                assert_eq!(
582                    kw.line, sw.line,
583                    "warning[{i}] line differs between '{kebab}' and '{snake}'"
584                );
585            }
586        }
587    }
588
589    fn assert_fix_roundtrip_from_toml(style: &str, content: &str) {
590        let rule = rule_from_toml_style(style);
591        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
592        let fixed = rule.fix(&ctx).unwrap();
593        let ctx2 = crate::lint_context::LintContext::new(&fixed, crate::config::MarkdownFlavor::Standard, None);
594        let remaining = rule.check(&ctx2).unwrap();
595        assert!(
596            remaining.is_empty(),
597            "style '{style}': after fix(), check() should find 0 violations.\n\
598             Original: {content:?}\n\
599             Fixed:    {fixed:?}\n\
600             Remaining: {remaining:?}"
601        );
602    }
603
604    #[test]
605    fn test_roundtrip_kebab_no_leading_or_trailing() {
606        assert_fix_roundtrip_from_toml("no-leading-or-trailing", "| H1 | H2 |\n|---|---|\n| a | b |");
607    }
608
609    #[test]
610    fn test_roundtrip_kebab_leading_and_trailing() {
611        assert_fix_roundtrip_from_toml("leading-and-trailing", "H1 | H2\n---|---\na | b");
612    }
613
614    #[test]
615    fn test_roundtrip_kebab_leading_only() {
616        assert_fix_roundtrip_from_toml("leading-only", "| H1 | H2 |\n|---|---|\n| a | b |");
617    }
618
619    #[test]
620    fn test_roundtrip_kebab_trailing_only() {
621        assert_fix_roundtrip_from_toml("trailing-only", "| H1 | H2 |\n|---|---|\n| a | b |");
622    }
623
624    #[test]
625    fn test_md055_delimiter_row_handling() {
626        // Test with no_leading_or_trailing style
627        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
628
629        let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1   | Data 2   | Data 3   |";
630        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
631        let result = rule.fix(&ctx).unwrap();
632
633        // With the fixed implementation, the delimiter row should have pipes removed
634        // Spacing is preserved from original input
635        let expected = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1   | Data 2   | Data 3";
636
637        assert_eq!(result, expected);
638
639        // Test that the check method actually reports the delimiter row as an issue
640        let warnings = rule.check(&ctx).unwrap();
641        let delimiter_warning = &warnings[1]; // Second warning should be for delimiter row
642        assert_eq!(delimiter_warning.line, 2);
643        assert_eq!(
644            delimiter_warning.message,
645            "Table pipe style should be no leading or trailing"
646        );
647
648        // Test with leading_and_trailing style
649        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
650
651        let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1   | Data 2   | Data 3";
652        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
653        let result = rule.fix(&ctx).unwrap();
654
655        // The delimiter row should have pipes added
656        // Spacing is preserved from original input
657        let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1   | Data 2   | Data 3 |";
658
659        assert_eq!(result, expected);
660    }
661
662    #[test]
663    fn test_md055_check_finds_delimiter_row_issues() {
664        // Test that check() correctly identifies delimiter rows that don't match style
665        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
666
667        let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1   | Data 2   | Data 3   |";
668        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
669        let warnings = rule.check(&ctx).unwrap();
670
671        // Should have 3 warnings - header row, delimiter row, and data row
672        assert_eq!(warnings.len(), 3);
673
674        // Specifically verify the delimiter row warning (line 2)
675        let delimiter_warning = &warnings[1];
676        assert_eq!(delimiter_warning.line, 2);
677        assert_eq!(
678            delimiter_warning.message,
679            "Table pipe style should be no leading or trailing"
680        );
681    }
682
683    #[test]
684    fn test_md055_real_world_example() {
685        // Test with a real-world example having content before and after the table
686        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
687
688        let content = "# Table Example\n\nHere's a table with leading and trailing pipes:\n\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1   | Data 2   | Data 3   |\n| Data 4   | Data 5   | Data 6   |\n\nMore content after the table.";
689        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
690        let result = rule.fix(&ctx).unwrap();
691
692        // The table should be fixed, with pipes removed
693        // Spacing is preserved from original input
694        let expected = "# Table Example\n\nHere's a table with leading and trailing pipes:\n\nHeader 1 | Header 2 | Header 3\n----------|----------|----------\nData 1   | Data 2   | Data 3\nData 4   | Data 5   | Data 6\n\nMore content after the table.";
695
696        assert_eq!(result, expected);
697
698        // Ensure we get warnings for all table rows
699        let warnings = rule.check(&ctx).unwrap();
700        assert_eq!(warnings.len(), 4); // All four table rows should have warnings
701
702        // The line numbers should match the correct positions in the original content
703        assert_eq!(warnings[0].line, 5); // Header row
704        assert_eq!(warnings[1].line, 6); // Delimiter row
705        assert_eq!(warnings[2].line, 7); // Data row 1
706        assert_eq!(warnings[3].line, 8); // Data row 2
707    }
708
709    #[test]
710    fn test_md055_invalid_style() {
711        // Test with an invalid style setting
712        let rule = MD055TablePipeStyle::new("leading_or_trailing".to_string()); // Invalid style
713
714        let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1   | Data 2   | Data 3   |";
715        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
716        let result = rule.fix(&ctx).unwrap();
717
718        // Should default to "leading_and_trailing"
719        // Already has leading and trailing pipes, so no changes needed - spacing is preserved
720        let expected = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1   | Data 2   | Data 3   |";
721
722        assert_eq!(result, expected);
723
724        // Now check a content that needs actual modification
725        let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1   | Data 2   | Data 3";
726        let ctx2 = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
727        let result = rule.fix(&ctx2).unwrap();
728
729        // Should add pipes to match the default "leading_and_trailing" style
730        // Spacing is preserved from original input
731        let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1   | Data 2   | Data 3 |";
732        assert_eq!(result, expected);
733
734        // Check that warning messages also work with the fallback style
735        let warnings = rule.check(&ctx2).unwrap();
736
737        // Since content doesn't have leading/trailing pipes but defaults to "leading_and_trailing",
738        // there should be warnings for all rows
739        assert_eq!(warnings.len(), 3);
740    }
741
742    #[test]
743    fn test_underflow_protection() {
744        // Test case to ensure no underflow when parts is empty
745        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
746
747        // Test with empty string (edge case)
748        let result = rule.fix_table_row("", "leading_and_trailing");
749        assert_eq!(result, "");
750
751        // Test with string that doesn't contain pipes
752        let result = rule.fix_table_row("no pipes here", "leading_and_trailing");
753        assert_eq!(result, "no pipes here");
754
755        // Test with minimal pipe content
756        let result = rule.fix_table_row("|", "leading_and_trailing");
757        // Should not panic and should handle gracefully
758        assert!(!result.is_empty());
759    }
760
761    // === Issue #305: Blockquote table tests ===
762
763    #[test]
764    fn test_fix_table_row_in_blockquote() {
765        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
766
767        // Blockquote table without leading pipe
768        let result = rule.fix_table_row("> H1 | H2", "leading_and_trailing");
769        assert_eq!(result, "> | H1 | H2 |");
770
771        // Blockquote table that already has pipes
772        let result = rule.fix_table_row("> | H1 | H2 |", "leading_and_trailing");
773        assert_eq!(result, "> | H1 | H2 |");
774
775        // Removing pipes from blockquote table
776        let result = rule.fix_table_row("> | H1 | H2 |", "no_leading_or_trailing");
777        assert_eq!(result, "> H1 | H2");
778    }
779
780    #[test]
781    fn test_fix_table_row_in_nested_blockquote() {
782        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
783
784        // Double-nested blockquote
785        let result = rule.fix_table_row(">> H1 | H2", "leading_and_trailing");
786        assert_eq!(result, ">> | H1 | H2 |");
787
788        // Triple-nested blockquote
789        let result = rule.fix_table_row(">>> H1 | H2", "leading_and_trailing");
790        assert_eq!(result, ">>> | H1 | H2 |");
791    }
792
793    #[test]
794    fn test_blockquote_table_full_document() {
795        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
796
797        // Full table in blockquote (2 columns, matching delimiter)
798        let content = "> H1 | H2\n> ----|----\n> a  | b";
799        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
800        let result = rule.fix(&ctx).unwrap();
801
802        // Each line should have the blockquote prefix preserved and pipes added
803        // The leading_and_trailing style adds "| " after blockquote prefix
804        assert!(
805            result.starts_with("> |"),
806            "Header should start with blockquote + pipe. Got:\n{result}"
807        );
808        // Delimiter row gets leading pipe added, so check for "> | ---" pattern
809        assert!(
810            result.contains("> | ----"),
811            "Delimiter should have blockquote prefix + leading pipe. Got:\n{result}"
812        );
813    }
814
815    #[test]
816    fn test_blockquote_table_no_leading_trailing() {
817        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
818
819        // Table with pipes that should be removed
820        let content = "> | H1 | H2 |\n> |----|----|---|\n> | a  | b |";
821        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
822        let result = rule.fix(&ctx).unwrap();
823
824        // Pipes should be removed but blockquote prefix preserved
825        let lines: Vec<&str> = result.lines().collect();
826        assert!(lines[0].starts_with("> "), "Line should start with blockquote prefix");
827        assert!(
828            !lines[0].starts_with("> |"),
829            "Leading pipe should be removed. Got: {}",
830            lines[0]
831        );
832    }
833
834    #[test]
835    fn test_mixed_regular_and_blockquote_tables() {
836        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
837
838        // Document with both regular and blockquote tables
839        let content = "H1 | H2\n---|---\na | b\n\n> H3 | H4\n> ---|---\n> c | d";
840        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
841        let result = rule.fix(&ctx).unwrap();
842
843        // Both tables should be fixed
844        assert!(result.contains("| H1 | H2 |"), "Regular table should have pipes added");
845        assert!(
846            result.contains("> | H3 | H4 |"),
847            "Blockquote table should have pipes added with prefix preserved"
848        );
849    }
850
851    // === Roundtrip safety tests ===
852
853    fn assert_fix_roundtrip(rule: &MD055TablePipeStyle, content: &str) {
854        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
855        let fixed = rule.fix(&ctx).unwrap();
856        let ctx2 = crate::lint_context::LintContext::new(&fixed, crate::config::MarkdownFlavor::Standard, None);
857        let remaining = rule.check(&ctx2).unwrap();
858        assert!(
859            remaining.is_empty(),
860            "After fix(), check() should find 0 violations.\nOriginal: {content:?}\nFixed: {fixed:?}\nRemaining: {remaining:?}"
861        );
862    }
863
864    #[test]
865    fn test_roundtrip_leading_and_trailing() {
866        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
867        assert_fix_roundtrip(&rule, "H1 | H2\n---|---\na | b");
868    }
869
870    #[test]
871    fn test_roundtrip_no_leading_or_trailing() {
872        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
873        assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\n| a | b |");
874    }
875
876    #[test]
877    fn test_roundtrip_consistent_mode() {
878        let rule = MD055TablePipeStyle::default();
879        assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\nCell 1 | Cell 2");
880    }
881
882    #[test]
883    fn test_roundtrip_blockquote_table() {
884        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
885        assert_fix_roundtrip(&rule, "> H1 | H2\n> ---|---\n> a | b");
886    }
887
888    #[test]
889    fn test_roundtrip_mixed_tables() {
890        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
891        assert_fix_roundtrip(&rule, "H1 | H2\n---|---\na | b\n\n> H3 | H4\n> ---|---\n> c | d");
892    }
893
894    #[test]
895    fn test_roundtrip_with_surrounding_content() {
896        let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
897        assert_fix_roundtrip(&rule, "# Title\n\n| H1 | H2 |\n|---|---|\n| a | b |\n\nMore text.");
898    }
899
900    #[test]
901    fn test_roundtrip_clean_content() {
902        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
903        assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\n| a | b |");
904    }
905
906    // === Pandoc construct reachability tests ===
907    //
908    // These tests document that MD055 does not flag Pandoc-specific constructs
909    // (grid tables, multi-line tables, line blocks, pipe-table captions) because
910    // `ctx.table_blocks` excludes them at the source:
911    //
912    // - Grid table delimiters use `+---+---+` (no `|`), so `is_delimiter_row`
913    //   returns false and no `TableBlock` is created.
914    // - Multi-line table separators (`----------`) have no `|`, same exclusion.
915    // - Line blocks (`| First line`) end without `|`, so `is_potential_table_row`
916    //   requires `valid_parts >= 2` but finds only 1 — excluded.
917    // - Pipe-table captions (`: caption`) have no `|` — excluded.
918    //
919    // No production guard is needed. These tests ensure that if `find_table_blocks`
920    // ever changes to include these constructs, the failure is visible.
921
922    #[test]
923    fn md055_pandoc_grid_tables_not_flagged() {
924        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
925        let content = "\
926+---+---+
927| a | b |
928+===+===+
929| 1 | 2 |
930+---+---+
931";
932        // Under Pandoc: grid tables are excluded from table_blocks (delimiter rows
933        // use `+` not `|`), so no warnings are emitted.
934        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
935        let result = rule.check(&ctx).unwrap();
936        assert!(
937            result.is_empty(),
938            "MD055 should not flag Pandoc grid tables (excluded by table_blocks): {result:?}"
939        );
940
941        // Under Standard: same content also produces no warnings because the
942        // `+---+---+` lines are not recognized as pipe-table delimiters.
943        let ctx_std = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
944        let result_std = rule.check(&ctx_std).unwrap();
945        assert!(
946            result_std.is_empty(),
947            "MD055 should not flag grid-table-like content under Standard either: {result_std:?}"
948        );
949    }
950
951    #[test]
952    fn md055_pandoc_multi_line_tables_not_flagged() {
953        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
954        // Multi-line table (Pandoc extension): separator line has no `|`.
955        let content = "\
956--------- ----------- ------
957Header 1   Header 2   Header 3
958--------- ----------- ------
959Cell 1     Cell 2     Cell 3
960--------- ----------- ------
961";
962        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
963        let result = rule.check(&ctx).unwrap();
964        assert!(
965            result.is_empty(),
966            "MD055 should not flag Pandoc multi-line tables: {result:?}"
967        );
968
969        let ctx_std = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
970        let result_std = rule.check(&ctx_std).unwrap();
971        assert!(
972            result_std.is_empty(),
973            "MD055 should not flag multi-line table content under Standard: {result_std:?}"
974        );
975    }
976
977    #[test]
978    fn md055_pandoc_line_blocks_not_flagged() {
979        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
980        // Pandoc line blocks: `| text` that starts with `|` but does not end with `|`.
981        // is_potential_table_row requires valid_parts >= 2 for non-outer-piped lines.
982        let content = "| First line\n| Second line\n";
983        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
984        let result = rule.check(&ctx).unwrap();
985        assert!(
986            result.is_empty(),
987            "MD055 should not treat Pandoc line blocks as tables: {result:?}"
988        );
989
990        let ctx_std = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
991        let result_std = rule.check(&ctx_std).unwrap();
992        assert!(
993            result_std.is_empty(),
994            "MD055 should not treat line-block-like content as tables under Standard: {result_std:?}"
995        );
996    }
997
998    #[test]
999    fn md055_pandoc_pipe_table_captions_not_flagged() {
1000        let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
1001        // Pipe-table captions (`: caption`) have no `|`, so they are never included
1002        // in table_blocks.
1003        let content = "\
1004| H1 | H2 |
1005|----|-----|
1006| a  | b  |
1007
1008: My table caption
1009";
1010        let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Pandoc, None);
1011        let result = rule.check(&ctx).unwrap();
1012        assert!(
1013            result.is_empty(),
1014            "MD055 should not flag the pipe-table caption line: {result:?}"
1015        );
1016
1017        // Under Standard: same table rows are correctly checked; caption line is ignored.
1018        let ctx_std = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
1019        let result_std = rule.check(&ctx_std).unwrap();
1020        assert!(
1021            result_std.is_empty(),
1022            "MD055 already-valid table with caption should have no warnings under Standard: {result_std:?}"
1023        );
1024    }
1025}