Skip to content

Commit 30d62f1

Browse files
DavidAnsonDavidAnson
committed
Add rule MD056/table-column-count (fixes #92).
1 parent f694a56 commit 30d62f1

26 files changed

Lines changed: 1748 additions & 298 deletions

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ playground for learning and exploring.
135135
- **[MD053](doc/md053.md)** *link-image-reference-definitions* - Link and image reference definitions should be needed
136136
- **[MD054](doc/md054.md)** *link-image-style* - Link and image style
137137
- **[MD055](doc/md055.md)** *table-pipe-style* - Table pipe style
138+
- **[MD056](doc/md056.md)** *table-column-count* - Table column count
138139

139140
<!-- markdownlint-restore -->
140141

@@ -176,7 +177,7 @@ rules at once.
176177
- **`ol`** - `MD029`, `MD030`, `MD032`
177178
- **`spaces`** - `MD018`, `MD019`, `MD020`, `MD021`, `MD023`
178179
- **`spelling`** - `MD044`
179-
- **`table`** - `MD055`
180+
- **`table`** - `MD055`, `MD056`
180181
- **`ul`** - `MD004`, `MD005`, `MD007`, `MD030`, `MD032`
181182
- **`url`** - `MD034`
182183
- **`whitespace`** - `MD009`, `MD010`, `MD012`, `MD027`, `MD028`, `MD030`,

‎demo/markdownlint-browser.js‎

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6822,6 +6822,75 @@ module.exports = {
68226822

68236823
/***/ }),
68246824

6825+
/***/ "../lib/md056.js":
6826+
/*!***********************!*\
6827+
!*** ../lib/md056.js ***!
6828+
\***********************/
6829+
/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
6830+
6831+
"use strict";
6832+
// @ts-check
6833+
6834+
6835+
6836+
function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
6837+
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
6838+
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
6839+
var _require = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js"),
6840+
addErrorDetailIf = _require.addErrorDetailIf;
6841+
var _require2 = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs"),
6842+
filterByTypes = _require2.filterByTypes;
6843+
var makeRange = function makeRange(start, end) {
6844+
return [start, end - start + 1];
6845+
};
6846+
module.exports = {
6847+
"names": ["MD056", "table-column-count"],
6848+
"description": "Table column count",
6849+
"tags": ["table"],
6850+
"function": function MD056(params, onError) {
6851+
var tables = filterByTypes(params.parsers.micromark.tokens, ["table"]);
6852+
var _iterator = _createForOfIteratorHelper(tables),
6853+
_step;
6854+
try {
6855+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
6856+
var table = _step.value;
6857+
var rows = filterByTypes(table.children, ["tableDelimiterRow", "tableRow"]);
6858+
var expectedCount = 0;
6859+
var _iterator2 = _createForOfIteratorHelper(rows),
6860+
_step2;
6861+
try {
6862+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
6863+
var row = _step2.value;
6864+
var cells = filterByTypes(row.children, ["tableData", "tableDelimiter", "tableHeader"]);
6865+
var actualCount = cells.length;
6866+
expectedCount || (expectedCount = actualCount);
6867+
var detail = null;
6868+
var range = null;
6869+
if (actualCount < expectedCount) {
6870+
detail = "Too few cells, row will be missing data";
6871+
range = [row.endColumn - 1, 1];
6872+
} else if (expectedCount < actualCount) {
6873+
detail = "Too many cells, extra data will be missing";
6874+
range = makeRange(cells[expectedCount].startColumn, row.endColumn - 1);
6875+
}
6876+
addErrorDetailIf(onError, row.endLine, expectedCount, actualCount, detail, null, range);
6877+
}
6878+
} catch (err) {
6879+
_iterator2.e(err);
6880+
} finally {
6881+
_iterator2.f();
6882+
}
6883+
}
6884+
} catch (err) {
6885+
_iterator.e(err);
6886+
} finally {
6887+
_iterator.f();
6888+
}
6889+
}
6890+
};
6891+
6892+
/***/ }),
6893+
68256894
/***/ "../lib/rules.js":
68266895
/*!***********************!*\
68276896
!*** ../lib/rules.js ***!
@@ -6843,8 +6912,11 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
68436912
var _require = __webpack_require__(/*! ./constants */ "../lib/constants.js"),
68446913
homepage = _require.homepage,
68456914
version = _require.version;
6846-
var rules = [__webpack_require__(/*! ./md001 */ "../lib/md001.js"), __webpack_require__(/*! ./md003 */ "../lib/md003.js"), __webpack_require__(/*! ./md004 */ "../lib/md004.js"), __webpack_require__(/*! ./md005 */ "../lib/md005.js"), __webpack_require__(/*! ./md007 */ "../lib/md007.js"), __webpack_require__(/*! ./md009 */ "../lib/md009.js"), __webpack_require__(/*! ./md010 */ "../lib/md010.js"), __webpack_require__(/*! ./md011 */ "../lib/md011.js"), __webpack_require__(/*! ./md012 */ "../lib/md012.js"), __webpack_require__(/*! ./md013 */ "../lib/md013.js"), __webpack_require__(/*! ./md014 */ "../lib/md014.js"), __webpack_require__(/*! ./md018 */ "../lib/md018.js"), __webpack_require__(/*! ./md019 */ "../lib/md019.js"), __webpack_require__(/*! ./md020 */ "../lib/md020.js"), __webpack_require__(/*! ./md021 */ "../lib/md021.js"), __webpack_require__(/*! ./md022 */ "../lib/md022.js"), __webpack_require__(/*! ./md023 */ "../lib/md023.js"), __webpack_require__(/*! ./md024 */ "../lib/md024.js"), __webpack_require__(/*! ./md025 */ "../lib/md025.js"), __webpack_require__(/*! ./md026 */ "../lib/md026.js"), __webpack_require__(/*! ./md027 */ "../lib/md027.js"), __webpack_require__(/*! ./md028 */ "../lib/md028.js"), __webpack_require__(/*! ./md029 */ "../lib/md029.js"), __webpack_require__(/*! ./md030 */ "../lib/md030.js"), __webpack_require__(/*! ./md031 */ "../lib/md031.js"), __webpack_require__(/*! ./md032 */ "../lib/md032.js"), __webpack_require__(/*! ./md033 */ "../lib/md033.js"), __webpack_require__(/*! ./md034 */ "../lib/md034.js"), __webpack_require__(/*! ./md035 */ "../lib/md035.js"), __webpack_require__(/*! ./md036 */ "../lib/md036.js"), __webpack_require__(/*! ./md037 */ "../lib/md037.js"), __webpack_require__(/*! ./md038 */ "../lib/md038.js"), __webpack_require__(/*! ./md039 */ "../lib/md039.js"), __webpack_require__(/*! ./md040 */ "../lib/md040.js"), __webpack_require__(/*! ./md041 */ "../lib/md041.js"), __webpack_require__(/*! ./md042 */ "../lib/md042.js"), __webpack_require__(/*! ./md043 */ "../lib/md043.js"), __webpack_require__(/*! ./md044 */ "../lib/md044.js"), __webpack_require__(/*! ./md045 */ "../lib/md045.js"), __webpack_require__(/*! ./md046 */ "../lib/md046.js"), __webpack_require__(/*! ./md047 */ "../lib/md047.js"), __webpack_require__(/*! ./md048 */ "../lib/md048.js")].concat(_toConsumableArray(__webpack_require__(/*! ./md049-md050 */ "../lib/md049-md050.js")), [__webpack_require__(/*! ./md051 */ "../lib/md051.js"), __webpack_require__(/*! ./md052 */ "../lib/md052.js"), __webpack_require__(/*! ./md053 */ "../lib/md053.js"), __webpack_require__(/*! ./md054 */ "../lib/md054.js"), __webpack_require__(/*! ./md055 */ "../lib/md055.js")
6847-
// md056: See https://github.com/markdownlint/markdownlint
6915+
var rules = [__webpack_require__(/*! ./md001 */ "../lib/md001.js"),
6916+
// md002: Deprecated and removed
6917+
__webpack_require__(/*! ./md003 */ "../lib/md003.js"), __webpack_require__(/*! ./md004 */ "../lib/md004.js"), __webpack_require__(/*! ./md005 */ "../lib/md005.js"),
6918+
// md006: Deprecated and removed
6919+
__webpack_require__(/*! ./md007 */ "../lib/md007.js"), __webpack_require__(/*! ./md009 */ "../lib/md009.js"), __webpack_require__(/*! ./md010 */ "../lib/md010.js"), __webpack_require__(/*! ./md011 */ "../lib/md011.js"), __webpack_require__(/*! ./md012 */ "../lib/md012.js"), __webpack_require__(/*! ./md013 */ "../lib/md013.js"), __webpack_require__(/*! ./md014 */ "../lib/md014.js"), __webpack_require__(/*! ./md018 */ "../lib/md018.js"), __webpack_require__(/*! ./md019 */ "../lib/md019.js"), __webpack_require__(/*! ./md020 */ "../lib/md020.js"), __webpack_require__(/*! ./md021 */ "../lib/md021.js"), __webpack_require__(/*! ./md022 */ "../lib/md022.js"), __webpack_require__(/*! ./md023 */ "../lib/md023.js"), __webpack_require__(/*! ./md024 */ "../lib/md024.js"), __webpack_require__(/*! ./md025 */ "../lib/md025.js"), __webpack_require__(/*! ./md026 */ "../lib/md026.js"), __webpack_require__(/*! ./md027 */ "../lib/md027.js"), __webpack_require__(/*! ./md028 */ "../lib/md028.js"), __webpack_require__(/*! ./md029 */ "../lib/md029.js"), __webpack_require__(/*! ./md030 */ "../lib/md030.js"), __webpack_require__(/*! ./md031 */ "../lib/md031.js"), __webpack_require__(/*! ./md032 */ "../lib/md032.js"), __webpack_require__(/*! ./md033 */ "../lib/md033.js"), __webpack_require__(/*! ./md034 */ "../lib/md034.js"), __webpack_require__(/*! ./md035 */ "../lib/md035.js"), __webpack_require__(/*! ./md036 */ "../lib/md036.js"), __webpack_require__(/*! ./md037 */ "../lib/md037.js"), __webpack_require__(/*! ./md038 */ "../lib/md038.js"), __webpack_require__(/*! ./md039 */ "../lib/md039.js"), __webpack_require__(/*! ./md040 */ "../lib/md040.js"), __webpack_require__(/*! ./md041 */ "../lib/md041.js"), __webpack_require__(/*! ./md042 */ "../lib/md042.js"), __webpack_require__(/*! ./md043 */ "../lib/md043.js"), __webpack_require__(/*! ./md044 */ "../lib/md044.js"), __webpack_require__(/*! ./md045 */ "../lib/md045.js"), __webpack_require__(/*! ./md046 */ "../lib/md046.js"), __webpack_require__(/*! ./md047 */ "../lib/md047.js"), __webpack_require__(/*! ./md048 */ "../lib/md048.js")].concat(_toConsumableArray(__webpack_require__(/*! ./md049-md050 */ "../lib/md049-md050.js")), [__webpack_require__(/*! ./md051 */ "../lib/md051.js"), __webpack_require__(/*! ./md052 */ "../lib/md052.js"), __webpack_require__(/*! ./md053 */ "../lib/md053.js"), __webpack_require__(/*! ./md054 */ "../lib/md054.js"), __webpack_require__(/*! ./md055 */ "../lib/md055.js"), __webpack_require__(/*! ./md056 */ "../lib/md056.js")
68486920
// md057: See https://github.com/markdownlint/markdownlint
68496921
]);
68506922
var _iterator = _createForOfIteratorHelper(rules),

‎doc-build/md055.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table] is
2-
inconsistent about its use of leading and trailing pipe characters (`|`).
1+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-055]
2+
is inconsistent about its use of leading and trailing pipe characters (`|`).
33

44
By default (`consistent` style), the header row of the first table in a document
55
is used to determine the style that is enforced for all tables in that document.
@@ -10,33 +10,33 @@ missing the trailing pipe and its first row of cells is missing the leading
1010
pipe:
1111

1212
```markdown
13-
| Heading | Heading |
14-
| ------- | -------
15-
Cell | Cell |
13+
| Header | Header |
14+
| ------ | ------
15+
Cell | Cell |
1616
```
1717

1818
To fix these issues, make sure there is a pipe character at the beginning and
1919
end of every row:
2020

2121
```markdown
22-
| Heading | Heading |
23-
| ------- | ------- |
24-
| Cell | Cell |
22+
| Header | Header |
23+
| ------ | ------ |
24+
| Cell | Cell |
2525
```
2626

2727
Note that text immediately following a table (i.e., not separated by an empty
2828
line) is treated as part of the table (per the specification) and may also
2929
trigger this rule:
3030

3131
```markdown
32-
| Heading | Heading |
33-
| ------- | ------- |
34-
| Cell | Cell |
32+
| Header | Header |
33+
| ------ | ------ |
34+
| Cell | Cell |
3535
This text is part of the table
3636
```
3737

3838
Rationale: Some parsers have difficulty with tables that are missing their
3939
leading or trailing pipe characters. The use of leading/trailing pipes can also
4040
help provide visual clarity.
4141

42-
[gfm-table]: https://github.github.com/gfm/#tables-extension-
42+
[gfm-table-055]: https://github.github.com/gfm/#tables-extension-

‎doc-build/md056.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-056]
2+
does not have the same number of cells in every row.
3+
4+
This table's second data row has too few cells and its third data row has too
5+
many cells:
6+
7+
```markdown
8+
| Header | Header |
9+
| ------ | ------ |
10+
| Cell | Cell |
11+
| Cell |
12+
| Cell | Cell | Cell |
13+
```
14+
15+
To fix these issues, ensure every row has the same number of cells:
16+
17+
```markdown
18+
| Header | Header |
19+
| ------ | ------ |
20+
| Cell | Cell |
21+
| Cell | Cell |
22+
| Cell | Cell |
23+
```
24+
25+
Note that a table's header row and its delimiter row must have the same number
26+
of cells or it will not be recognized as a table (per specification).
27+
28+
Rationale: Extra cells in a row are usually not shown, so their data is lost.
29+
Missing cells in a row create holes in the table and suggest an omission.
30+
31+
[gfm-table-056]: https://github.github.com/gfm/#tables-extension-

‎doc/Rules.md‎

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2337,8 +2337,8 @@ Parameters:
23372337
`consistent` / `leading_and_trailing` / `leading_only` /
23382338
`no_leading_or_trailing` / `trailing_only`)
23392339

2340-
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table] is
2341-
inconsistent about its use of leading and trailing pipe characters (`|`).
2340+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-055]
2341+
is inconsistent about its use of leading and trailing pipe characters (`|`).
23422342

23432343
By default (`consistent` style), the header row of the first table in a document
23442344
is used to determine the style that is enforced for all tables in that document.
@@ -2349,36 +2349,76 @@ missing the trailing pipe and its first row of cells is missing the leading
23492349
pipe:
23502350

23512351
```markdown
2352-
| Heading | Heading |
2353-
| ------- | -------
2354-
Cell | Cell |
2352+
| Header | Header |
2353+
| ------ | ------
2354+
Cell | Cell |
23552355
```
23562356

23572357
To fix these issues, make sure there is a pipe character at the beginning and
23582358
end of every row:
23592359

23602360
```markdown
2361-
| Heading | Heading |
2362-
| ------- | ------- |
2363-
| Cell | Cell |
2361+
| Header | Header |
2362+
| ------ | ------ |
2363+
| Cell | Cell |
23642364
```
23652365

23662366
Note that text immediately following a table (i.e., not separated by an empty
23672367
line) is treated as part of the table (per the specification) and may also
23682368
trigger this rule:
23692369

23702370
```markdown
2371-
| Heading | Heading |
2372-
| ------- | ------- |
2373-
| Cell | Cell |
2371+
| Header | Header |
2372+
| ------ | ------ |
2373+
| Cell | Cell |
23742374
This text is part of the table
23752375
```
23762376

23772377
Rationale: Some parsers have difficulty with tables that are missing their
23782378
leading or trailing pipe characters. The use of leading/trailing pipes can also
23792379
help provide visual clarity.
23802380

2381-
[gfm-table]: https://github.github.com/gfm/#tables-extension-
2381+
[gfm-table-055]: https://github.github.com/gfm/#tables-extension-
2382+
2383+
<a name="md056"></a>
2384+
2385+
## `MD056` - Table column count
2386+
2387+
Tags: `table`
2388+
2389+
Aliases: `table-column-count`
2390+
2391+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-056]
2392+
does not have the same number of cells in every row.
2393+
2394+
This table's second data row has too few cells and its third data row has too
2395+
many cells:
2396+
2397+
```markdown
2398+
| Header | Header |
2399+
| ------ | ------ |
2400+
| Cell | Cell |
2401+
| Cell |
2402+
| Cell | Cell | Cell |
2403+
```
2404+
2405+
To fix these issues, ensure every row has the same number of cells:
2406+
2407+
```markdown
2408+
| Header | Header |
2409+
| ------ | ------ |
2410+
| Cell | Cell |
2411+
| Cell | Cell |
2412+
| Cell | Cell |
2413+
```
2414+
2415+
Note that a table's header row and its delimiter row must have the same number
2416+
of cells or it will not be recognized as a table (per specification).
2417+
2418+
Rationale: Extra cells in a row are usually not shown, so their data is lost.
2419+
Missing cells in a row create holes in the table and suggest an omission.
2420+
2421+
[gfm-table-056]: https://github.github.com/gfm/#tables-extension-
23822422

23832423
<!-- markdownlint-configure-file {
23842424
"no-inline-html": {

‎doc/md055.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Parameters:
1010
`consistent` / `leading_and_trailing` / `leading_only` /
1111
`no_leading_or_trailing` / `trailing_only`)
1212

13-
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table] is
14-
inconsistent about its use of leading and trailing pipe characters (`|`).
13+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-055]
14+
is inconsistent about its use of leading and trailing pipe characters (`|`).
1515

1616
By default (`consistent` style), the header row of the first table in a document
1717
is used to determine the style that is enforced for all tables in that document.
@@ -22,33 +22,33 @@ missing the trailing pipe and its first row of cells is missing the leading
2222
pipe:
2323

2424
```markdown
25-
| Heading | Heading |
26-
| ------- | -------
27-
Cell | Cell |
25+
| Header | Header |
26+
| ------ | ------
27+
Cell | Cell |
2828
```
2929

3030
To fix these issues, make sure there is a pipe character at the beginning and
3131
end of every row:
3232

3333
```markdown
34-
| Heading | Heading |
35-
| ------- | ------- |
36-
| Cell | Cell |
34+
| Header | Header |
35+
| ------ | ------ |
36+
| Cell | Cell |
3737
```
3838

3939
Note that text immediately following a table (i.e., not separated by an empty
4040
line) is treated as part of the table (per the specification) and may also
4141
trigger this rule:
4242

4343
```markdown
44-
| Heading | Heading |
45-
| ------- | ------- |
46-
| Cell | Cell |
44+
| Header | Header |
45+
| ------ | ------ |
46+
| Cell | Cell |
4747
This text is part of the table
4848
```
4949

5050
Rationale: Some parsers have difficulty with tables that are missing their
5151
leading or trailing pipe characters. The use of leading/trailing pipes can also
5252
help provide visual clarity.
5353

54-
[gfm-table]: https://github.github.com/gfm/#tables-extension-
54+
[gfm-table-055]: https://github.github.com/gfm/#tables-extension-

‎doc/md056.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# `MD056` - Table column count
2+
3+
Tags: `table`
4+
5+
Aliases: `table-column-count`
6+
7+
This rule is triggered when a [GitHub Flavored Markdown table][gfm-table-056]
8+
does not have the same number of cells in every row.
9+
10+
This table's second data row has too few cells and its third data row has too
11+
many cells:
12+
13+
```markdown
14+
| Header | Header |
15+
| ------ | ------ |
16+
| Cell | Cell |
17+
| Cell |
18+
| Cell | Cell | Cell |
19+
```
20+
21+
To fix these issues, ensure every row has the same number of cells:
22+
23+
```markdown
24+
| Header | Header |
25+
| ------ | ------ |
26+
| Cell | Cell |
27+
| Cell | Cell |
28+
| Cell | Cell |
29+
```
30+
31+
Note that a table's header row and its delimiter row must have the same number
32+
of cells or it will not be recognized as a table (per specification).
33+
34+
Rationale: Extra cells in a row are usually not shown, so their data is lost.
35+
Missing cells in a row create holes in the table and suggest an omission.
36+
37+
[gfm-table-056]: https://github.github.com/gfm/#tables-extension-

0 commit comments

Comments
 (0)