1use crate::rule::{LintError, LintResult, LintWarning, Rule, 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 should_skip(&self, ctx: &crate::lint_context::LintContext) -> bool {
307 !ctx.likely_has_tables()
309 }
310
311 fn check(&self, ctx: &crate::lint_context::LintContext) -> LintResult {
312 let line_index = &ctx.line_index;
313 let mut warnings = Vec::new();
314
315 let lines = ctx.raw_lines();
318
319 let configured_style = match self.config.style.as_str() {
321 "leading_and_trailing" | "no_leading_or_trailing" | "leading_only" | "trailing_only" | "consistent" => {
322 self.config.style.as_str()
323 }
324 _ => {
325 "leading_and_trailing"
327 }
328 };
329
330 let table_blocks = &ctx.table_blocks;
332
333 for table_block in table_blocks {
335 let table_style = if configured_style == "consistent" {
338 self.determine_table_style(table_block, lines)
339 } else {
340 None
341 };
342
343 let target_style = if configured_style == "consistent" {
345 table_style.unwrap_or("leading_and_trailing")
346 } else {
347 configured_style
348 };
349
350 let all_line_indices: Vec<usize> = std::iter::once(table_block.header_line)
352 .chain(std::iter::once(table_block.delimiter_line))
353 .chain(table_block.content_lines.iter().copied())
354 .collect();
355
356 let table_start_line = table_block.start_line + 1; let table_end_line = table_block.end_line + 1; let mut fixed_table_lines: Vec<String> = Vec::with_capacity(all_line_indices.len());
363 for (table_line_idx, &line_idx) in all_line_indices.iter().enumerate() {
364 let line = lines[line_idx];
365 let fixed_line = self.fix_table_row_with_context(line, target_style, table_block, table_line_idx);
366 if line_idx < lines.len() - 1 {
367 fixed_table_lines.push(format!("{fixed_line}\n"));
368 } else {
369 fixed_table_lines.push(fixed_line);
370 }
371 }
372 let table_replacement = fixed_table_lines.concat();
373 let table_range = line_index.multi_line_range(table_start_line, table_end_line);
374
375 for (table_line_idx, &line_idx) in all_line_indices.iter().enumerate() {
377 let line = lines[line_idx];
378 let content = TableUtils::extract_table_row_content(line, table_block, table_line_idx);
380 if let Some(current_style) = TableUtils::determine_pipe_style(content) {
381 let needs_fixing = current_style != target_style;
383
384 if needs_fixing {
385 let (start_line, start_col, end_line, end_col) = calculate_line_range(line_idx + 1, line);
386
387 let message = format!(
388 "Table pipe style should be {}",
389 match target_style {
390 "leading_and_trailing" => "leading and trailing",
391 "no_leading_or_trailing" => "no leading or trailing",
392 "leading_only" => "leading only",
393 "trailing_only" => "trailing only",
394 _ => target_style,
395 }
396 );
397
398 warnings.push(LintWarning {
401 rule_name: Some(self.name().to_string()),
402 severity: Severity::Warning,
403 message,
404 line: start_line,
405 column: start_col,
406 end_line,
407 end_column: end_col,
408 fix: Some(crate::rule::Fix {
409 range: table_range.clone(),
410 replacement: table_replacement.clone(),
411 }),
412 });
413 }
414 }
415 }
416 }
417
418 Ok(warnings)
419 }
420
421 fn fix(&self, ctx: &crate::lint_context::LintContext) -> Result<String, LintError> {
422 let lines = ctx.raw_lines();
423
424 let configured_style = match self.config.style.as_str() {
426 "leading_and_trailing" | "no_leading_or_trailing" | "leading_only" | "trailing_only" | "consistent" => {
427 self.config.style.as_str()
428 }
429 _ => {
430 "leading_and_trailing"
432 }
433 };
434
435 let table_blocks = &ctx.table_blocks;
437
438 let mut result_lines = lines.iter().map(|&s| s.to_string()).collect::<Vec<String>>();
440
441 for table_block in table_blocks {
443 let table_style = if configured_style == "consistent" {
446 self.determine_table_style(table_block, lines)
447 } else {
448 None
449 };
450
451 let target_style = if configured_style == "consistent" {
453 table_style.unwrap_or("leading_and_trailing")
454 } else {
455 configured_style
456 };
457
458 let all_line_indices: Vec<usize> = std::iter::once(table_block.header_line)
460 .chain(std::iter::once(table_block.delimiter_line))
461 .chain(table_block.content_lines.iter().copied())
462 .collect();
463
464 for (table_line_idx, &line_idx) in all_line_indices.iter().enumerate() {
465 let line = lines[line_idx];
466 let fixed_line = self.fix_table_row_with_context(line, target_style, table_block, table_line_idx);
467 result_lines[line_idx] = fixed_line;
468 }
469 }
470
471 let mut fixed = result_lines.join("\n");
472 if ctx.content.ends_with('\n') && !fixed.ends_with('\n') {
474 fixed.push('\n');
475 }
476 Ok(fixed)
477 }
478
479 fn as_any(&self) -> &dyn std::any::Any {
480 self
481 }
482
483 fn default_config_section(&self) -> Option<(String, toml::Value)> {
484 let json_value = serde_json::to_value(&self.config).ok()?;
485 Some((
486 self.name().to_string(),
487 crate::rule_config_serde::json_to_toml_value(&json_value)?,
488 ))
489 }
490
491 fn from_config(config: &crate::config::Config) -> Box<dyn Rule>
492 where
493 Self: Sized,
494 {
495 let rule_config = crate::rule_config_serde::load_rule_config::<MD055Config>(config);
496 Box::new(Self::from_config_struct(rule_config))
497 }
498}
499
500#[cfg(test)]
501mod tests {
502 use super::*;
503
504 #[test]
505 fn test_md055_delimiter_row_handling() {
506 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
508
509 let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
510 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
511 let result = rule.fix(&ctx).unwrap();
512
513 let expected = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
516
517 assert_eq!(result, expected);
518
519 let warnings = rule.check(&ctx).unwrap();
521 let delimiter_warning = &warnings[1]; assert_eq!(delimiter_warning.line, 2);
523 assert_eq!(
524 delimiter_warning.message,
525 "Table pipe style should be no leading or trailing"
526 );
527
528 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
530
531 let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
532 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
533 let result = rule.fix(&ctx).unwrap();
534
535 let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1 | Data 2 | Data 3 |";
538
539 assert_eq!(result, expected);
540 }
541
542 #[test]
543 fn test_md055_check_finds_delimiter_row_issues() {
544 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
546
547 let content = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
548 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
549 let warnings = rule.check(&ctx).unwrap();
550
551 assert_eq!(warnings.len(), 3);
553
554 let delimiter_warning = &warnings[1];
556 assert_eq!(delimiter_warning.line, 2);
557 assert_eq!(
558 delimiter_warning.message,
559 "Table pipe style should be no leading or trailing"
560 );
561 }
562
563 #[test]
564 fn test_md055_real_world_example() {
565 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
567
568 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.";
569 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
570 let result = rule.fix(&ctx).unwrap();
571
572 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.";
575
576 assert_eq!(result, expected);
577
578 let warnings = rule.check(&ctx).unwrap();
580 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); }
588
589 #[test]
590 fn test_md055_invalid_style() {
591 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 |";
595 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
596 let result = rule.fix(&ctx).unwrap();
597
598 let expected = "| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Data 1 | Data 2 | Data 3 |";
601
602 assert_eq!(result, expected);
603
604 let content = "Header 1 | Header 2 | Header 3\n----------|----------|----------\nData 1 | Data 2 | Data 3";
606 let ctx2 = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
607 let result = rule.fix(&ctx2).unwrap();
608
609 let expected = "| Header 1 | Header 2 | Header 3 |\n| ----------|----------|---------- |\n| Data 1 | Data 2 | Data 3 |";
612 assert_eq!(result, expected);
613
614 let warnings = rule.check(&ctx2).unwrap();
616
617 assert_eq!(warnings.len(), 3);
620 }
621
622 #[test]
623 fn test_underflow_protection() {
624 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
626
627 let result = rule.fix_table_row("", "leading_and_trailing");
629 assert_eq!(result, "");
630
631 let result = rule.fix_table_row("no pipes here", "leading_and_trailing");
633 assert_eq!(result, "no pipes here");
634
635 let result = rule.fix_table_row("|", "leading_and_trailing");
637 assert!(!result.is_empty());
639 }
640
641 #[test]
644 fn test_fix_table_row_in_blockquote() {
645 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
646
647 let result = rule.fix_table_row("> H1 | H2", "leading_and_trailing");
649 assert_eq!(result, "> | H1 | H2 |");
650
651 let result = rule.fix_table_row("> | H1 | H2 |", "leading_and_trailing");
653 assert_eq!(result, "> | H1 | H2 |");
654
655 let result = rule.fix_table_row("> | H1 | H2 |", "no_leading_or_trailing");
657 assert_eq!(result, "> H1 | H2");
658 }
659
660 #[test]
661 fn test_fix_table_row_in_nested_blockquote() {
662 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
663
664 let result = rule.fix_table_row(">> H1 | H2", "leading_and_trailing");
666 assert_eq!(result, ">> | H1 | H2 |");
667
668 let result = rule.fix_table_row(">>> H1 | H2", "leading_and_trailing");
670 assert_eq!(result, ">>> | H1 | H2 |");
671 }
672
673 #[test]
674 fn test_blockquote_table_full_document() {
675 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
676
677 let content = "> H1 | H2\n> ----|----\n> a | b";
679 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
680 let result = rule.fix(&ctx).unwrap();
681
682 assert!(
685 result.starts_with("> |"),
686 "Header should start with blockquote + pipe. Got:\n{result}"
687 );
688 assert!(
690 result.contains("> | ----"),
691 "Delimiter should have blockquote prefix + leading pipe. Got:\n{result}"
692 );
693 }
694
695 #[test]
696 fn test_blockquote_table_no_leading_trailing() {
697 let rule = MD055TablePipeStyle::new("no_leading_or_trailing".to_string());
698
699 let content = "> | H1 | H2 |\n> |----|----|---|\n> | a | b |";
701 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
702 let result = rule.fix(&ctx).unwrap();
703
704 let lines: Vec<&str> = result.lines().collect();
706 assert!(lines[0].starts_with("> "), "Line should start with blockquote prefix");
707 assert!(
708 !lines[0].starts_with("> |"),
709 "Leading pipe should be removed. Got: {}",
710 lines[0]
711 );
712 }
713
714 #[test]
715 fn test_mixed_regular_and_blockquote_tables() {
716 let rule = MD055TablePipeStyle::new("leading_and_trailing".to_string());
717
718 let content = "H1 | H2\n---|---\na | b\n\n> H3 | H4\n> ---|---\n> c | d";
720 let ctx = crate::lint_context::LintContext::new(content, crate::config::MarkdownFlavor::Standard, None);
721 let result = rule.fix(&ctx).unwrap();
722
723 assert!(result.contains("| H1 | H2 |"), "Regular table should have pipes added");
725 assert!(
726 result.contains("> | H3 | H4 |"),
727 "Blockquote table should have pipes added with prefix preserved"
728 );
729 }
730}