-
Notifications
You must be signed in to change notification settings - Fork 71
feat: added new rule table-column-count #392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
SwetaTanwar
wants to merge
9
commits into
eslint:main
Choose a base branch
from
SwetaTanwar:feat/table-column-count
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
1f4ee49
feat: added new rule table-column-count
SwetaTanwar cc2d8ee
fix: review comments
SwetaTanwar 9cdf7a2
fix: review comments
SwetaTanwar 11ad2a4
fix: error positioning
SwetaTanwar df804d8
test: added more test cases
SwetaTanwar a3d617c
fix: review comments
SwetaTanwar 09d52d4
Merge branch 'main' of github.com:SwetaTanwar/markdown into feat/tabl…
SwetaTanwar 19fc588
docs: added explanation for data rows less than header rows
SwetaTanwar 041d770
fix: review comments
SwetaTanwar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# table-column-count | ||
|
||
Disallow data rows in a GitHub Flavored Markdown table from having more cells than the header row. | ||
|
||
## Background | ||
|
||
In GitHub Flavored Markdown [tables](https://github.github.com/gfm/#tables-extension-), rows should maintain a consistent number of cells. While variations are sometimes tolerated, data rows having *more* cells than the header can lead to lost data or rendering issues. This rule prevents data rows from exceeding the header's column count. | ||
|
||
## Rule Details | ||
|
||
> [!IMPORTANT] <!-- eslint-disable-line -- This should be fixed in https://github.com/eslint/markdown/issues/294 --> | ||
> | ||
> This rule relies on the `table` AST node, typically available when using a GFM-compatible parser (e.g., `language: "markdown/gfm"`). | ||
|
||
This rule is triggered if a data row in a GFM table contains more cells than the header row. It does not flag rows with fewer cells than the header. | ||
|
||
Examples of **incorrect** code for this rule: | ||
|
||
```markdown | ||
<!-- eslint markdown/table-column-count: "error" --> | ||
|
||
| Head1 | Head2 | | ||
| ----- | ----- | | ||
| R1C1 | R1C2 | R2C3 | <!-- This data row has 3 cells, header has 2 --> | ||
|
||
| A | | ||
| - | | ||
| 1 | 2 | <!-- This data row has 2 cells, header has 1 --> | ||
``` | ||
|
||
Examples of **correct** code for this rule: | ||
|
||
```markdown | ||
<!-- eslint markdown/table-column-count: "error" --> | ||
|
||
<!-- Standard correct table --> | ||
| Header | Header | | ||
| ------ | ------ | | ||
| Cell | Cell | | ||
| Cell | Cell | | ||
|
||
<!-- Data row with fewer cells than header (VALID for this rule) --> | ||
| Header | Header | Header | | ||
| ------ | ------ | ------ | | ||
| Cell | Cell | | | ||
|
||
<!-- Table with some empty cells (VALID for this rule) --> | ||
| Col A | Col B | Col C | | ||
| ----- | ----- | ----- | | ||
| 1 | | 3 | | ||
| 4 | 5 | | ||
|
||
<!-- Single column table --> | ||
| Single Header | | ||
| ------------- | | ||
| Single Cell | | ||
``` | ||
|
||
## When Not To Use It | ||
|
||
If you intentionally create Markdown tables where data rows are expected to contain more cells than the header, and you have a specific (perhaps non-standard) processing or rendering pipeline that handles this scenario correctly, you might choose to disable this rule. However, adhering to this rule is recommended for typical GFM rendering and data consistency. | ||
|
||
## Prior Art | ||
|
||
* [MD056 - table-column-count](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md056---table-column-count) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/** | ||
* @fileoverview Rule to disallow data rows in a GitHub Flavored Markdown table from having more cells than the header row | ||
* @author Sweta Tanwar (@SwetaTanwar) | ||
*/ | ||
|
||
//----------------------------------------------------------------------------- | ||
// Type Definitions | ||
//----------------------------------------------------------------------------- | ||
|
||
/** | ||
* @typedef {import("../types.ts").MarkdownRuleDefinition<{ RuleOptions: []; }>} TableColumnCountRuleDefinition | ||
*/ | ||
|
||
//----------------------------------------------------------------------------- | ||
// Rule Definition | ||
//----------------------------------------------------------------------------- | ||
|
||
/** @type {TableColumnCountRuleDefinition} */ | ||
export default { | ||
meta: { | ||
type: "problem", | ||
|
||
docs: { | ||
recommended: true, | ||
description: | ||
"Disallow data rows in a GitHub Flavored Markdown table from having more cells than the header row", | ||
url: "https://github.com/eslint/markdown/blob/main/docs/rules/table-column-count.md", | ||
}, | ||
|
||
messages: { | ||
inconsistentColumnCount: | ||
"Table column count mismatch (Expected: {{expectedCells}}, Actual: {{actualCells}}), extra data starting here will be ignored.", | ||
}, | ||
}, | ||
|
||
create(context) { | ||
return { | ||
table(node) { | ||
if (!node.children || node.children.length < 1) { | ||
return; | ||
} | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
const headerRow = node.children[0]; | ||
const expectedCells = headerRow.children.length; | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
for (let i = 1; i < node.children.length; i++) { | ||
const currentRow = node.children[i]; | ||
const actualCells = currentRow.children.length; | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if (actualCells > expectedCells) { | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const firstExtraCellNode = | ||
currentRow.children[expectedCells]; | ||
|
||
context.report({ | ||
node: currentRow, | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
loc: { | ||
start: { | ||
line: firstExtraCellNode.position.start | ||
.line, | ||
column: firstExtraCellNode.position.start | ||
.column, | ||
}, | ||
end: { | ||
line: currentRow.position.end.line, | ||
column: currentRow.position.end.column, | ||
}, | ||
}, | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
messageId: "inconsistentColumnCount", | ||
data: { | ||
actualCells: String(actualCells), | ||
expectedCells: String(expectedCells), | ||
}, | ||
}); | ||
} | ||
} | ||
}, | ||
}; | ||
}, | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
/** | ||
* @fileoverview Tests for table-column-count rule. | ||
* @author Sweta Tanwar (@SwetaTanwar) | ||
*/ | ||
|
||
//------------------------------------------------------------------------------ | ||
// Imports | ||
//------------------------------------------------------------------------------ | ||
|
||
import rule from "../../src/rules/table-column-count.js"; | ||
import markdown from "../../src/index.js"; | ||
import { RuleTester } from "eslint"; | ||
import dedent from "dedent"; | ||
|
||
//------------------------------------------------------------------------------ | ||
// Tests | ||
//------------------------------------------------------------------------------ | ||
|
||
const ruleTester = new RuleTester({ | ||
plugins: { | ||
markdown, | ||
}, | ||
language: "markdown/gfm", | ||
}); | ||
|
||
ruleTester.run("table-column-count", rule, { | ||
valid: [ | ||
dedent` | ||
| Header | Header | | ||
| ------ | ------ | | ||
| Cell | Cell | | ||
| Cell | Cell | | ||
`, | ||
dedent` | ||
| Header | Header | Header | | ||
| ------ | ------ | ------ | | ||
| Cell | Cell | | ||
| Cell | | | ||
`, | ||
dedent` | ||
| A | B | | ||
|---|---| | ||
| | | | ||
| C | | | ||
`, | ||
`Just some text. | not a table |`, | ||
dedent` | ||
| Header | Header | | ||
| ------ | ------ | ----- | | ||
| Cell | Cell | | ||
`, | ||
dedent` | ||
| Header | Header | | ||
| ------ | ------ | | ||
`, | ||
dedent` | ||
Some text before. | ||
|
||
| H1 | H2 | | ||
|----|----| | ||
| D1 | D2 | | ||
|
||
Some text after. | ||
`, | ||
dedent` | ||
| Valid | Table | | ||
| ----- | ----- | | ||
| Row | Here | | ||
`, | ||
], | ||
|
||
invalid: [ | ||
{ | ||
code: dedent` | ||
| Head1 | Head2 | | ||
| ----- | ----- | | ||
| R1C1 | R1C2 | R2C3 | | ||
`, | ||
errors: [ | ||
{ | ||
messageId: "inconsistentColumnCount", | ||
data: { actualCells: "3", expectedCells: "2" }, | ||
line: 3, | ||
column: 17, | ||
endLine: 3, | ||
endColumn: 26, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: dedent` | ||
| A | | ||
| - | | ||
| 1 | 2 | | ||
`, | ||
errors: [ | ||
{ | ||
messageId: "inconsistentColumnCount", | ||
data: { actualCells: "2", expectedCells: "1" }, | ||
line: 3, | ||
column: 5, | ||
endLine: 3, | ||
endColumn: 10, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: dedent` | ||
Some introductory text. | ||
|
||
| Header1 | Header2 | | ||
| ------- | ------- | | ||
| Data1 | Data2 | Data3 | | ||
| D4 | D5 | | ||
|
||
Some concluding text. | ||
`, | ||
errors: [ | ||
{ | ||
messageId: "inconsistentColumnCount", | ||
data: { actualCells: "3", expectedCells: "2" }, | ||
line: 5, | ||
column: 21, | ||
endLine: 5, | ||
endColumn: 30, | ||
}, | ||
], | ||
}, | ||
SwetaTanwar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
], | ||
}); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.