Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Reimplement MD040/fenced-code-language using micromark tokens.

Browse source
This commit is contained in:
David Anson 2024-02-18 17:22:32 -08:00
parent f5b5773b50
commit f26df4743c
5 changed files with 42 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

37
demo/markdownlint-browser.js
View file

@ -5483,7 +5483,9 @@ module.exports = {
const { addError, addErrorContext, filterTokens } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js"); const { addError, addErrorContext } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
const { filterByTypes, getTokenTextByType, tokenIfType } =
__webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
module.exports = { module.exports = {
"names": [ "MD040", "fenced-code-language" ], "names": [ "MD040", "fenced-code-language" ],
@ -5493,27 +5495,22 @@ module.exports = {
let allowed = params.config.allowed_languages; let allowed = params.config.allowed_languages;
allowed = Array.isArray(allowed) ? allowed : []; allowed = Array.isArray(allowed) ? allowed : [];
const languageOnly = !!params.config.language_only; const languageOnly = !!params.config.language_only;
const fencedCodes = filterByTypes(params.parsers.micromark.tokens, [ "codeFenced" ]);
filterTokens(params, "fence", function forToken(token) { for (const fencedCode of fencedCodes) {
const lang = token.info.trim().split(/\s+/u).shift(); const openingFence = tokenIfType(fencedCode.children[0], "codeFencedFence");
if (lang === "") { if (openingFence) {
addErrorContext(onError, token.lineNumber, token.line); const { children, startLine, text } = openingFence;
} else if ((allowed.length > 0) && !allowed.includes(lang)) { const info = getTokenTextByType(children, "codeFencedFenceInfo")
addError( if (!info) {
onError, addErrorContext(onError, startLine, text);
token.lineNumber, } else if ((allowed.length > 0) && !allowed.includes(info)) {
`"${lang}" is not allowed` addError(onError, startLine, `"${info}" is not allowed`);
); }
if (languageOnly && getTokenTextByType(children, "codeFencedFenceMeta")) {
addError(onError, startLine, `Info string contains more than language: "${text}"`);
}
} }
if (languageOnly && (token.info !== lang)) {
addError(
onError,
token.lineNumber,
`Info string contains more than language: "${token.info}"`
);
} }
});
} }
}; };

37
lib/md040.js
View file

@ -2,7 +2,9 @@
"use strict"; "use strict";
const { addError, addErrorContext, filterTokens } = require("../helpers"); const { addError, addErrorContext } = require("../helpers");
const { filterByTypes, getTokenTextByType, tokenIfType } =
require("../helpers/micromark.cjs");
module.exports = { module.exports = {
"names": [ "MD040", "fenced-code-language" ], "names": [ "MD040", "fenced-code-language" ],
@ -12,26 +14,21 @@ module.exports = {
let allowed = params.config.allowed_languages; let allowed = params.config.allowed_languages;
allowed = Array.isArray(allowed) ? allowed : []; allowed = Array.isArray(allowed) ? allowed : [];
const languageOnly = !!params.config.language_only; const languageOnly = !!params.config.language_only;
const fencedCodes = filterByTypes(params.parsers.micromark.tokens, [ "codeFenced" ]);
filterTokens(params, "fence", function forToken(token) { for (const fencedCode of fencedCodes) {
const lang = token.info.trim().split(/\s+/u).shift(); const openingFence = tokenIfType(fencedCode.children[0], "codeFencedFence");
if (lang === "") { if (openingFence) {
addErrorContext(onError, token.lineNumber, token.line); const { children, startLine, text } = openingFence;
} else if ((allowed.length > 0) && !allowed.includes(lang)) { const info = getTokenTextByType(children, "codeFencedFenceInfo")
addError( if (!info) {
onError, addErrorContext(onError, startLine, text);
token.lineNumber, } else if ((allowed.length > 0) && !allowed.includes(info)) {
`"${lang}" is not allowed` addError(onError, startLine, `"${info}" is not allowed`);
); }
if (languageOnly && getTokenTextByType(children, "codeFencedFenceMeta")) {
addError(onError, startLine, `Info string contains more than language: "${text}"`);
}
} }
if (languageOnly && (token.info !== lang)) {
addError(
onError,
token.lineNumber,
`Info string contains more than language: "${token.info}"`
);
} }
});
} }
}; };

4
test/md040-language_only.md
View file

@ -3,13 +3,13 @@
Fence code block information with leading whitespace: Fence code block information with leading whitespace:
``` html ``` html
<h1>markdownlint</h1> {MD040:5} <h1>markdownlint</h1>
``` ```
Fence code block information with trailing whitespace: Fence code block information with trailing whitespace:
```css ```css
body {} {MD040:11} {MD009:11} body {} {MD009:11}
``` ```
Fence code block information with extra data: Fence code block information with extra data:

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

@ -38128,33 +38128,7 @@ Generated by [AVA](https://avajs.dev).
}, },
{ {
errorContext: null, errorContext: null,
errorDetail: 'Info string contains more than language: " html"', errorDetail: 'Info string contains more than language: "```html version=5"',
errorRange: null,
fixInfo: null,
lineNumber: 5,
ruleDescription: 'Fenced code blocks should have a language specified',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md040.md',
ruleNames: [
'MD040',
'fenced-code-language',
],
},
{
errorContext: null,
errorDetail: 'Info string contains more than language: "css "',
errorRange: null,
fixInfo: null,
lineNumber: 11,
ruleDescription: 'Fenced code blocks should have a language specified',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md040.md',
ruleNames: [
'MD040',
'fenced-code-language',
],
},
{
errorContext: null,
errorDetail: 'Info string contains more than language: "html version=5"',
errorRange: null, errorRange: null,
fixInfo: null, fixInfo: null,
lineNumber: 17, lineNumber: 17,
@ -38171,13 +38145,13 @@ Generated by [AVA](https://avajs.dev).
Fence code block information with leading whitespace:␊ Fence code block information with leading whitespace:␊
␊ ␊
\`\`\` html␊ \`\`\` html␊
<h1>markdownlint</h1> {MD040:5}␊ <h1>markdownlint</h1>␊
\`\`\`␊ \`\`\`␊
␊ ␊
Fence code block information with trailing whitespace:␊ Fence code block information with trailing whitespace:␊
␊ ␊
\`\`\`css␊ \`\`\`css␊
body {} {MD040:11} {MD009:11}␊ body {} {MD009:11}␊
\`\`\`␊ \`\`\`␊
␊ ␊
Fence code block information with extra data:␊ Fence code block information with extra data:␊

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

Binary file not shown.