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#[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 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 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 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 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 #[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 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 let (bq_prefix, after_bq) = TableUtils::extract_blockquote_prefix(line);
180
181 if let Some(ref list_ctx) = table_block.list_context {
183 if table_line_index == 0 {
184 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 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 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 let indent = " ".repeat(content_indent);
205 format!("{bq_prefix}{indent}{fixed_content}")
206 }
207 } else {
208 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 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 if !has_leading {
233 result = format!("| {result}");
234 }
235
236 if !has_trailing {
238 result = format!("{result} |");
239 }
240
241 result
242 }
243 "no_leading_or_trailing" => {
244 let mut result = trimmed;
245
246 if has_leading {
248 result = result.strip_prefix('|').unwrap_or(result);
249 result = result.trim_start();
250 }
251
252 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 if !has_leading {
265 result = format!("| {result}");
266 }
267
268 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 if has_leading {
280 result = result.strip_prefix('|').unwrap_or(result).trim_start();
281 }
282
283 let mut result = result.to_string();
284
285 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 !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 let lines = ctx.raw_lines();
322
323 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 "leading_and_trailing"
331 }
332 };
333
334 let table_blocks = &ctx.table_blocks;
336
337 for table_block in table_blocks {
339 let table_style = if configured_style == "consistent" {
342 self.determine_table_style(table_block, lines)
343 } else {
344 None
345 };
346
347 let target_style = if configured_style == "consistent" {
349 table_style.unwrap_or("leading_and_trailing")
350 } else {
351 configured_style
352 };
353
354 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 for (table_line_idx, &line_idx) in all_line_indices.iter().enumerate() {
364 let line = lines[line_idx];
365 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 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 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 {
401 range: row_range,
402 replacement: fixed_line,
403 }),
404 });
405 }
406 }
407 }
408 }
409
410 Ok(warnings)
411 }
412
413 fn fix(&self, ctx: &crate::lint_context::LintContext) -> Result<String, LintError> {
414 if self.should_skip(ctx) {
415 return Ok(ctx.content.to_string());
416 }
417 let warnings = self.check(ctx)?;
418 if warnings.is_empty() {
419 return Ok(ctx.content.to_string());
420 }
421 let warnings =
422 crate::utils::fix_utils::filter_warnings_by_inline_config(warnings, ctx.inline_config(), self.name());
423 crate::utils::fix_utils::apply_warning_fixes(ctx.content, &warnings).map_err(LintError::InvalidInput)
424 }
425
426 fn as_any(&self) -> &dyn std::any::Any {
427 self
428 }
429
430 fn default_config_section(&self) -> Option<(String, toml::Value)> {
431 let json_value = serde_json::to_value(&self.config).ok()?;
432 Some((
433 self.name().to_string(),
434 crate::rule_config_serde::json_to_toml_value(&json_value)?,
435 ))
436 }
437
438 fn from_config(config: &crate::config::Config) -> Box<dyn Rule>
439 where
440 Self: Sized,
441 {
442 let rule_config = crate::rule_config_serde::load_rule_config::<MD055Config>(config);
443 Box::new(Self::from_config_struct(rule_config))
444 }
445}
446
447#[cfg(test)]
448mod tests {
449 use super::*;
450
451 #[test]
452 fn test_md055_delimiter_row_handling() {
453 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
455
456 let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
457 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
458 let result = rule.fix(&ctx).unwrap();
459
460 let expected = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
463
464 assert_eq!(result, expected);
465
466 let warnings = rule.check(&ctx).unwrap();
468 let delimiter_warning = &warnings[1]; assert_eq!(delimiter_warning.line, 2);
470 assert_eq!(
471 delimiter_warning.message,
472 "Table pipe style should be no leading or trailing"
473 );
474
475 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
477
478 let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
479 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
480 let result = rule.fix(&ctx).unwrap();
481
482 let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1 | Data 2 | Data 3 |";
485
486 assert_eq!(result, expected);
487 }
488
489 #[test]
490 fn test_md055_check_finds_delimiter_row_issues() {
491 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
493
494 let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
495 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
496 let warnings = rule.check(&ctx).unwrap();
497
498 assert_eq!(warnings.len(), 3);
500
501 let delimiter_warning = &warnings[1];
503 assert_eq!(delimiter_warning.line, 2);
504 assert_eq!(
505 delimiter_warning.message,
506 "Table pipe style should be no leading or trailing"
507 );
508 }
509
510 #[test]
511 fn test_md055_real_world_example() {
512 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
514
515 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.";
516 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
517 let result = rule.fix(&ctx).unwrap();
518
519 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.";
522
523 assert_eq!(result, expected);
524
525 let warnings = rule.check(&ctx).unwrap();
527 assert_eq!(warnings.len(), 4); assert_eq!(warnings[0].line, 5); assert_eq!(warnings[1].line, 6); assert_eq!(warnings[2].line, 7); assert_eq!(warnings[3].line, 8); }
535
536 #[test]
537 fn test_md055_invalid_style() {
538 let rule = MD055TablePipeStyle::new("leading_or_trailing".to_string()); let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
542 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
543 let result = rule.fix(&ctx).unwrap();
544
545 let expected = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
548
549 assert_eq!(result, expected);
550
551 let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
553 let ctx2 = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
554 let result = rule.fix(&ctx2).unwrap();
555
556 let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1 | Data 2 | Data 3 |";
559 assert_eq!(result, expected);
560
561 let warnings = rule.check(&ctx2).unwrap();
563
564 assert_eq!(warnings.len(), 3);
567 }
568
569 #[test]
570 fn test_underflow_protection() {
571 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
573
574 let result = rule.fix_table_row("", "leading_and_trailing");
576 assert_eq!(result, "");
577
578 let result = rule.fix_table_row("no pipes here", "leading_and_trailing");
580 assert_eq!(result, "no pipes here");
581
582 let result = rule.fix_table_row("|", "leading_and_trailing");
584 assert!(!result.is_empty());
586 }
587
588 #[test]
591 fn test_fix_table_row_in_blockquote() {
592 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
593
594 let result = rule.fix_table_row("> H1 | H2", "leading_and_trailing");
596 assert_eq!(result, "> | H1 | H2 |");
597
598 let result = rule.fix_table_row("> | H1 | H2 |", "leading_and_trailing");
600 assert_eq!(result, "> | H1 | H2 |");
601
602 let result = rule.fix_table_row("> | H1 | H2 |", "no_leading_or_trailing");
604 assert_eq!(result, "> H1 | H2");
605 }
606
607 #[test]
608 fn test_fix_table_row_in_nested_blockquote() {
609 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
610
611 let result = rule.fix_table_row(">> H1 | H2", "leading_and_trailing");
613 assert_eq!(result, ">> | H1 | H2 |");
614
615 let result = rule.fix_table_row(">>> H1 | H2", "leading_and_trailing");
617 assert_eq!(result, ">>> | H1 | H2 |");
618 }
619
620 #[test]
621 fn test_blockquote_table_full_document() {
622 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
623
624 let content = "> H1 | H2\n> ----|----\n> a | b";
626 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
627 let result = rule.fix(&ctx).unwrap();
628
629 assert!(
632 result.starts_with("> |"),
633 "Header should start with blockquote + pipe. Got:\n{result}"
634 );
635 assert!(
637 result.contains("> | ----"),
638 "Delimiter should have blockquote prefix + leading pipe. Got:\n{result}"
639 );
640 }
641
642 #[test]
643 fn test_blockquote_table_no_leading_trailing() {
644 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
645
646 let content = "> | H1 | H2 |\n> |----|----|---|\n> | a | b |";
648 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
649 let result = rule.fix(&ctx).unwrap();
650
651 let lines: Vec<&str> = result.lines().collect();
653 assert!(lines[0].starts_with("> "), "Line should start with blockquote prefix");
654 assert!(
655 !lines[0].starts_with("> |"),
656 "Leading pipe should be removed. Got: {}",
657 lines[0]
658 );
659 }
660
661 #[test]
662 fn test_mixed_regular_and_blockquote_tables() {
663 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
664
665 let content = "H1 | H2\n---|---\na | b\n\n> H3 | H4\n> ---|---\n> c | d";
667 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
668 let result = rule.fix(&ctx).unwrap();
669
670 assert!(result.contains("| H1 | H2 |"), "Regular table should have pipes added");
672 assert!(
673 result.contains("> | H3 | H4 |"),
674 "Blockquote table should have pipes added with prefix preserved"
675 );
676 }
677
678 fn assert_fix_roundtrip(rule: &MD055TablePipeStyle, content: &str) {
681 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
682 let fixed = rule.fix(&ctx).unwrap();
683 let ctx2 = crate::lint_context::LintContext::new(&fixed, crate::config::MarkdownFlavor::Standard, None);
684 let remaining = rule.check(&ctx2).unwrap();
685 assert!(
686 remaining.is_empty(),
687 "After fix(), check() should find 0 violations.\nOriginal: {content:?}\nFixed: {fixed:?}\nRemaining: {remaining:?}"
688 );
689 }
690
691 #[test]
692 fn test_roundtrip_leading_and_trailing() {
693 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
694 assert_fix_roundtrip(&rule, "H1 | H2\n---|---\na | b");
695 }
696
697 #[test]
698 fn test_roundtrip_no_leading_or_trailing() {
699 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
700 assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\n| a | b |");
701 }
702
703 #[test]
704 fn test_roundtrip_consistent_mode() {
705 let rule = MD055TablePipeStyle::default();
706 assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\nCell 1 | Cell 2");
707 }
708
709 #[test]
710 fn test_roundtrip_blockquote_table() {
711 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
712 assert_fix_roundtrip(&rule, "> H1 | H2\n> ---|---\n> a | b");
713 }
714
715 #[test]
716 fn test_roundtrip_mixed_tables() {
717 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
718 assert_fix_roundtrip(&rule, "H1 | H2\n---|---\na | b\n\n> H3 | H4\n> ---|---\n> c | d");
719 }
720
721 #[test]
722 fn test_roundtrip_with_surrounding_content() {
723 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
724 assert_fix_roundtrip(&rule, "# Title\n\n| H1 | H2 |\n|---|---|\n| a | b |\n\nMore text.");
725 }
726
727 #[test]
728 fn test_roundtrip_clean_content() {
729 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
730 assert_fix_roundtrip(&rule, "| H1 | H2 |\n|---|---|\n| a | b |");
731 }
732}