Add rule MD056/table-column-count (fixes #92).

This commit is contained in:
David Anson 2024-01-04 23:07:55 -08:00
parent f694a56254
commit 30d62f19ac
26 changed files with 1748 additions and 298 deletions

View file

@ -10,8 +10,8 @@ Parameters:
`consistent` / `leading_and_trailing` / `leading_only` /
`no_leading_or_trailing` / `trailing_only`)
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table] is
inconsistent about its use of leading and trailing pipe characters (`|`).
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-055]
is inconsistent about its use of leading and trailing pipe characters (`|`).
By default (`consistent` style), the header row of the first table in a document
is used to determine the style that is enforced for all tables in that document.
@ -22,18 +22,18 @@ missing the trailing pipe and its first row of cells is missing the leading
pipe:
```markdown
| Heading | Heading |
| ------- | -------
Cell | Cell |
| Header | Header |
| ------ | ------
Cell | Cell |
```
To fix these issues, make sure there is a pipe character at the beginning and
end of every row:
```markdown
| Heading | Heading |
| ------- | ------- |
| Cell | Cell |
| Header | Header |
| ------ | ------ |
| Cell | Cell |
```
Note that text immediately following a table (i.e., not separated by an empty
@ -41,9 +41,9 @@ line) is treated as part of the table (per the specification) and may also
trigger this rule:
```markdown
| Heading | Heading |
| ------- | ------- |
| Cell | Cell |
| Header | Header |
| ------ | ------ |
| Cell | Cell |
This text is part of the table
```
@ -51,4 +51,4 @@ Rationale: Some parsers have difficulty with tables that are missing their
leading or trailing pipe characters. The use of leading/trailing pipes can also
help provide visual clarity.
[gfm-table]: https://github.github.com/gfm/#tables-extension-
[gfm-table-055]: https://github.github.com/gfm/#tables-extension-