Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Reimplement MD019/no-multiple-space-atx using micromark tokens.

Browse source
This commit is contained in:
David Anson 2024-06-11 21:37:09 -07:00
parent 3003d244f9
commit 4ff3a27fa2
6 changed files with 174 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

56
demo/markdownlint-browser.js
View file

@ -4236,8 +4236,8 @@ module.exports = {
const { addErrorContext, filterTokens, headingStyleFor } = const { addErrorContext } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
__webpack_require__(/*! ../helpers */ "../helpers/helpers.js"); const { filterByTypes, getHeadingStyle } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
// eslint-disable-next-line jsdoc/valid-types // eslint-disable-next-line jsdoc/valid-types
/** @type import("./markdownlint").Rule */ /** @type import("./markdownlint").Rule */
@ -4245,33 +4245,35 @@ module.exports = {
"names": [ "MD019", "no-multiple-space-atx" ], "names": [ "MD019", "no-multiple-space-atx" ],
"description": "Multiple spaces after hash on atx style heading", "description": "Multiple spaces after hash on atx style heading",
"tags": [ "headings", "atx", "spaces" ], "tags": [ "headings", "atx", "spaces" ],
"parser": "markdownit", "parser": "micromark",
"function": function MD019(params, onError) { "function": function MD019(params, onError) {
filterTokens(params, "heading_open", (token) => { const atxHeadings = filterByTypes(
if (headingStyleFor(token) === "atx") { params.parsers.micromark.tokens,
const { line, lineNumber } = token; [ "atxHeading" ]
const match = /^(#+)([ \t]{2,})\S/.exec(line); ).filter((heading) => getHeadingStyle(heading) === "atx");
if (match) { for (const atxHeading of atxHeadings) {
const [ const [ atxHeadingSequence, whitespace ] = atxHeading.children;
, if (
{ "length": hashLength }, (atxHeadingSequence?.type === "atxHeadingSequence") &&
{ "length": spacesLength } (whitespace?.type === "whitespace") &&
] = match; (whitespace.text.length > 1)
addErrorContext( ) {
onError, const column = whitespace.startColumn + 1;
lineNumber, const length = whitespace.endColumn - column;
line.trim(), addErrorContext(
undefined, onError,
undefined, atxHeading.startLine,
[ 1, hashLength + spacesLength + 1 ], atxHeading.text.trim(),
{ undefined,
"editColumn": hashLength + 1, undefined,
"deleteCount": spacesLength - 1 [ column, length ],
} {
); "editColumn": column,
} "deleteCount": length
}
);
} }
}); }
} }
}; };

56
lib/md019.js
View file

@ -2,8 +2,8 @@
"use strict"; "use strict";
const { addErrorContext, filterTokens, headingStyleFor } = const { addErrorContext } = require("../helpers");
require("../helpers"); const { filterByTypes, getHeadingStyle } = require("../helpers/micromark.cjs");
// eslint-disable-next-line jsdoc/valid-types // eslint-disable-next-line jsdoc/valid-types
/** @type import("./markdownlint").Rule */ /** @type import("./markdownlint").Rule */
@ -11,32 +11,34 @@ module.exports = {
"names": [ "MD019", "no-multiple-space-atx" ], "names": [ "MD019", "no-multiple-space-atx" ],
"description": "Multiple spaces after hash on atx style heading", "description": "Multiple spaces after hash on atx style heading",
"tags": [ "headings", "atx", "spaces" ], "tags": [ "headings", "atx", "spaces" ],
"parser": "markdownit", "parser": "micromark",
"function": function MD019(params, onError) { "function": function MD019(params, onError) {
filterTokens(params, "heading_open", (token) => { const atxHeadings = filterByTypes(
if (headingStyleFor(token) === "atx") { params.parsers.micromark.tokens,
const { line, lineNumber } = token; [ "atxHeading" ]
const match = /^(#+)([ \t]{2,})\S/.exec(line); ).filter((heading) => getHeadingStyle(heading) === "atx");
if (match) { for (const atxHeading of atxHeadings) {
const [ const [ atxHeadingSequence, whitespace ] = atxHeading.children;
, if (
{ "length": hashLength }, (atxHeadingSequence?.type === "atxHeadingSequence") &&
{ "length": spacesLength } (whitespace?.type === "whitespace") &&
] = match; (whitespace.text.length > 1)
addErrorContext( ) {
onError, const column = whitespace.startColumn + 1;
lineNumber, const length = whitespace.endColumn - column;
line.trim(), addErrorContext(
undefined, onError,
undefined, atxHeading.startLine,
[ 1, hashLength + spacesLength + 1 ], atxHeading.text.trim(),
{ undefined,
"editColumn": hashLength + 1, undefined,
"deleteCount": spacesLength - 1 [ column, length ],
} {
); "editColumn": column,
} "deleteCount": length
}
);
} }
}); }
} }
}; };

2
test/headings-without-content.md
View file

@ -18,3 +18,5 @@
## ##
## ##
{MD019:10} {MD019:12} {MD019:18} {MD019:20}

8
test/markdownlint-test-result-object.js
View file

@ -186,7 +186,7 @@ test("resultFormattingV1", (t) => new Promise((resolve) => {
"ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`, "ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`,
"errorDetail": null, "errorDetail": null,
"errorContext": "## Heading 2 {MD019}", "errorContext": "## Heading 2 {MD019}",
"errorRange": [ 1, 5 ] }, "errorRange": [ 4, 1 ] },
{ "lineNumber": 5, { "lineNumber": 5,
"ruleName": "MD019", "ruleName": "MD019",
"ruleAlias": "no-multiple-space-atx", "ruleAlias": "no-multiple-space-atx",
@ -194,7 +194,7 @@ test("resultFormattingV1", (t) => new Promise((resolve) => {
"ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`, "ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`,
"errorDetail": null, "errorDetail": null,
"errorContext": "## Heading 3 {MD019}", "errorContext": "## Heading 3 {MD019}",
"errorRange": [ 1, 6 ] }, "errorRange": [ 4, 2 ] },
{ "lineNumber": 1, { "lineNumber": 1,
"ruleName": "MD041", "ruleName": "MD041",
"ruleAlias": "first-line-heading", "ruleAlias": "first-line-heading",
@ -287,14 +287,14 @@ test("resultFormattingV2", (t) => new Promise((resolve) => {
"ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`, "ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`,
"errorDetail": null, "errorDetail": null,
"errorContext": "## Heading 2 {MD019}", "errorContext": "## Heading 2 {MD019}",
"errorRange": [ 1, 5 ] }, "errorRange": [ 4, 1 ] },
{ "lineNumber": 5, { "lineNumber": 5,
"ruleNames": [ "MD019", "no-multiple-space-atx" ], "ruleNames": [ "MD019", "no-multiple-space-atx" ],
"ruleDescription": "Multiple spaces after hash on atx style heading", "ruleDescription": "Multiple spaces after hash on atx style heading",
"ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`, "ruleInformation": `${homepage}/blob/v${version}/doc/md019.md`,
"errorDetail": null, "errorDetail": null,
"errorContext": "## Heading 3 {MD019}", "errorContext": "## Heading 3 {MD019}",
"errorRange": [ 1, 6 ] }, "errorRange": [ 4, 2 ] },
{ "lineNumber": 1, { "lineNumber": 1,
"ruleNames": [ "MD041", "first-line-heading", "first-line-h1" ], "ruleNames": [ "MD041", "first-line-heading", "first-line-h1" ],
"ruleDescription": "First line in a file should be a top-level heading", "ruleDescription": "First line in a file should be a top-level heading",

141
test/snapshots/markdownlint-test-scenarios.js.md
View file

@ -465,12 +465,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Multiple spaces B {MD019}', errorContext: '## Multiple spaces B {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 16, lineNumber: 16,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -2622,12 +2622,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Heading 2 {MD019}', errorContext: '## Heading 2 {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
1, 4,
7, 3,
], ],
fixInfo: { fixInfo: {
deleteCount: 3, deleteCount: 3,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 7, lineNumber: 7,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -2983,12 +2983,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Heading 2 {MD019}', errorContext: '## Heading 2 {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 3, lineNumber: 3,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -3002,12 +3002,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Heading 3 {MD019}', errorContext: '## Heading 3 {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
1, 4,
6, 2,
], ],
fixInfo: { fixInfo: {
deleteCount: 2, deleteCount: 2,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 5, lineNumber: 5,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -6999,12 +6999,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '# Heading 5 {MD019}', errorContext: '# Heading 5 {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
3,
1, 1,
4,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 2, editColumn: 3,
}, },
lineNumber: 27, lineNumber: 27,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -15812,12 +15812,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Extra normal space {MD019}', errorContext: '## Extra normal space {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 23, lineNumber: 23,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -15831,12 +15831,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Extra Tab {MD019}', errorContext: '## Extra Tab {MD019}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 27, lineNumber: 27,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -16037,7 +16037,84 @@ Generated by [AVA](https://avajs.dev).
> Snapshot 1 > Snapshot 1
{ {
errors: [], errors: [
{
errorContext: '#',
errorDetail: null,
errorRange: [
3,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 3,
},
lineNumber: 10,
ruleDescription: 'Multiple spaces after hash on atx style heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md019.md',
ruleNames: [
'MD019',
'no-multiple-space-atx',
],
},
{
errorContext: '#',
errorDetail: null,
errorRange: [
3,
2,
],
fixInfo: {
deleteCount: 2,
editColumn: 3,
},
lineNumber: 12,
ruleDescription: 'Multiple spaces after hash on atx style heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md019.md',
ruleNames: [
'MD019',
'no-multiple-space-atx',
],
},
{
errorContext: '##',
errorDetail: null,
errorRange: [
4,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 4,
},
lineNumber: 18,
ruleDescription: 'Multiple spaces after hash on atx style heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md019.md',
ruleNames: [
'MD019',
'no-multiple-space-atx',
],
},
{
errorContext: '##',
errorDetail: null,
errorRange: [
4,
2,
],
fixInfo: {
deleteCount: 2,
editColumn: 4,
},
lineNumber: 20,
ruleDescription: 'Multiple spaces after hash on atx style heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md019.md',
ruleNames: [
'MD019',
'no-multiple-space-atx',
],
},
],
fixed: `# Headings Without Content␊ fixed: `# Headings Without Content␊
␊ ␊
<!-- markdownlint-disable single-title heading-style -->␊ <!-- markdownlint-disable single-title heading-style -->␊
@ -16047,17 +16124,19 @@ Generated by [AVA](https://avajs.dev).
␊ ␊
# ␊ # ␊
␊ ␊
# ␊ # ␊
␊ ␊
# ␊ # ␊
␊ ␊
##␊ ##␊
␊ ␊
## ␊ ## ␊
␊ ␊
## ␊ ## ␊
␊ ␊
## ␊ ## ␊
␊
{MD019:10} {MD019:12} {MD019:18} {MD019:20}␊
`, `,
} }
@ -37916,12 +37995,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## Heading 2b {MD019} {MD022}', errorContext: '## Heading 2b {MD019} {MD022}',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 24, lineNumber: 24,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -46613,12 +46692,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '# C', errorContext: '# C',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
3,
1, 1,
4,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 2, editColumn: 3,
}, },
lineNumber: 11, lineNumber: 11,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -46632,12 +46711,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## I', errorContext: '## I',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 31, lineNumber: 31,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -46651,12 +46730,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '# OO', errorContext: '# OO',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
3,
1, 1,
4,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 2, editColumn: 3,
}, },
lineNumber: 51, lineNumber: 51,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',
@ -46670,12 +46749,12 @@ Generated by [AVA](https://avajs.dev).
errorContext: '## UU', errorContext: '## UU',
errorDetail: null, errorDetail: null,
errorRange: [ errorRange: [
4,
1, 1,
5,
], ],
fixInfo: { fixInfo: {
deleteCount: 1, deleteCount: 1,
editColumn: 3, editColumn: 4,
}, },
lineNumber: 71, lineNumber: 71,
ruleDescription: 'Multiple spaces after hash on atx style heading', ruleDescription: 'Multiple spaces after hash on atx style heading',

BIN
test/snapshots/markdownlint-test-scenarios.js.snap
View file

Binary file not shown.