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

Reimplement MD038/no-space-in-code using micromark tokens.

Browse source
This commit is contained in:
David Anson 2023-02-23 22:20:27 -08:00
parent b787758a48
commit 962547ecc8
6 changed files with 219 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

106
demo/markdownlint-browser.js
View file

@ -5408,56 +5408,86 @@ module.exports = {
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; } } }; }
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); }
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; }
var _require = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js"), var _require = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js"),
addErrorContext = _require.addErrorContext, addErrorContext = _require.addErrorContext;
filterTokens = _require.filterTokens, var _require2 = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs"),
forEachInlineCodeSpan = _require.forEachInlineCodeSpan, filterByTypes = _require2.filterByTypes;
newLineRe = _require.newLineRe;
var leftSpaceRe = /^\s(?:[^`]|$)/; var leftSpaceRe = /^\s(?:[^`]|$)/;
var rightSpaceRe = /[^`]\s$/; var rightSpaceRe = /[^`]\s$/;
var spaceInsideCodeInline = function spaceInsideCodeInline(token) { var trimCodeText = function trimCodeText(text, start, end) {
return token.type === "code_inline" && (leftSpaceRe.test(token.content) || rightSpaceRe.test(token.content)); text = text.replace(/^\s+$/, "");
if (start) {
text = text.replace(/^\s+?(\s`|\S)/, "$1");
}
if (end) {
text = text.replace(/(`\s|\S)\s+$/, "$1");
}
return text;
};
var tokenIfType = function tokenIfType(token, type) {
return token && token.type === type && token;
}; };
module.exports = { module.exports = {
"names": ["MD038", "no-space-in-code"], "names": ["MD038", "no-space-in-code"],
"description": "Spaces inside code span elements", "description": "Spaces inside code span elements",
"tags": ["whitespace", "code"], "tags": ["whitespace", "code"],
"function": function MD038(params, onError) { "function": function MD038(params, onError) {
filterTokens(params, "inline", function (token) { var codeTextTokens = filterByTypes(params.parsers.micromark.tokens, ["codeText"]);
if (token.children.some(spaceInsideCodeInline)) { var _iterator = _createForOfIteratorHelper(codeTextTokens),
var tokenLines = params.lines.slice(token.map[0], token.map[1]); _step;
forEachInlineCodeSpan(tokenLines.join("\n"), function (code, lineIndex, columnIndex, tickCount) { try {
var rangeIndex = columnIndex - tickCount; for (_iterator.s(); !(_step = _iterator.n()).done;) {
var rangeLength = code.length + 2 * tickCount; var token = _step.value;
var rangeLineOffset = 0; var tokens = token.tokens;
var fixIndex = columnIndex; var first = 0;
var fixLength = code.length; var last = tokens.length - 1;
var codeLines = code.split(newLineRe); var startSequence = tokenIfType(tokens[first], "codeTextSequence");
var left = leftSpaceRe.test(code); var endSequence = tokenIfType(tokens[last], "codeTextSequence");
var right = !left && rightSpaceRe.test(code); var startData = tokenIfType(tokens[first + 1], "codeTextData") || tokenIfType(tokens[first + 2], "codeTextData");
if (right && codeLines.length > 1) { var endData = tokenIfType(tokens[last - 1], "codeTextData") || tokenIfType(tokens[last - 2], "codeTextData");
rangeIndex = 0; if (startSequence && endSequence && startData && endData) {
rangeLineOffset = codeLines.length - 1; var spaceLeft = leftSpaceRe.test(startData.text);
fixIndex = 0; var spaceRight = !spaceLeft && rightSpaceRe.test(endData.text);
} if (spaceLeft || spaceRight) {
if (left || right) { var lineNumber = startSequence.startLine;
var codeLinesRange = codeLines[rangeLineOffset]; var range = null;
if (codeLines.length > 1) { var fixInfo = null;
rangeLength = codeLinesRange.length + tickCount; if (startSequence.startLine === endSequence.endLine) {
fixLength = codeLinesRange.length; range = [startSequence.startColumn, endSequence.endColumn - startSequence.startColumn];
fixInfo = {
"editColumn": startSequence.endColumn,
"deleteCount": endSequence.startColumn - startSequence.endColumn,
"insertText": trimCodeText(startData.text, true, true)
};
} else if (spaceLeft) {
range = [startSequence.startColumn, startData.endColumn - startSequence.startColumn];
fixInfo = {
"editColumn": startSequence.endColumn,
"deleteCount": startData.endColumn - startData.startColumn,
"insertText": trimCodeText(startData.text, true, false)
};
} else {
lineNumber = endSequence.endLine;
range = [endData.startColumn, endSequence.endColumn - endData.startColumn];
fixInfo = {
"editColumn": endData.startColumn,
"deleteCount": endData.endColumn - endData.startColumn,
"insertText": trimCodeText(endData.text, false, true)
};
} }
var context = tokenLines[lineIndex + rangeLineOffset].substring(rangeIndex, rangeIndex + rangeLength); var context = params.lines[lineNumber - 1].substring(range[0] - 1, range[0] - 1 + range[1]);
var codeLinesRangeTrim = codeLinesRange.trim(); addErrorContext(onError, lineNumber, context, spaceLeft, spaceRight, range, fixInfo);
var fixText = (codeLinesRangeTrim.startsWith("`") ? " " : "") + codeLinesRangeTrim + (codeLinesRangeTrim.endsWith("`") ? " " : "");
addErrorContext(onError, token.lineNumber + lineIndex + rangeLineOffset, context, left, right, [rangeIndex + 1, rangeLength], {
"editColumn": fixIndex + 1,
"deleteCount": fixLength,
"insertText": fixText
});
} }
}); }
} }
}); } catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
} }
}; };

135
lib/md038.js
View file

@ -2,70 +2,95 @@
"use strict"; "use strict";
const { addErrorContext, filterTokens, forEachInlineCodeSpan, newLineRe } = const { addErrorContext } = require("../helpers");
require("../helpers"); const { filterByTypes } = require("../helpers/micromark.cjs");
const leftSpaceRe = /^\s(?:[^`]|$)/; const leftSpaceRe = /^\s(?:[^`]|$)/;
const rightSpaceRe = /[^`]\s$/; const rightSpaceRe = /[^`]\s$/;
const trimCodeText = (text, start, end) => {
const spaceInsideCodeInline = (token) => ( text = text.replace(/^\s+$/, "");
(token.type === "code_inline") && if (start) {
(leftSpaceRe.test(token.content) || rightSpaceRe.test(token.content)) text = text.replace(/^\s+?(\s`|\S)/, "$1");
); }
if (end) {
text = text.replace(/(`\s|\S)\s+$/, "$1");
}
return text;
};
const tokenIfType = (token, type) => token && (token.type === type) && token;
module.exports = { module.exports = {
"names": [ "MD038", "no-space-in-code" ], "names": [ "MD038", "no-space-in-code" ],
"description": "Spaces inside code span elements", "description": "Spaces inside code span elements",
"tags": [ "whitespace", "code" ], "tags": [ "whitespace", "code" ],
"function": function MD038(params, onError) { "function": function MD038(params, onError) {
filterTokens(params, "inline", (token) => { const codeTextTokens =
if (token.children.some(spaceInsideCodeInline)) { filterByTypes(params.parsers.micromark.tokens, [ "codeText" ]);
const tokenLines = params.lines.slice(token.map[0], token.map[1]); for (const token of codeTextTokens) {
forEachInlineCodeSpan( const { tokens } = token;
tokenLines.join("\n"), const first = 0;
(code, lineIndex, columnIndex, tickCount) => { const last = tokens.length - 1;
let rangeIndex = columnIndex - tickCount; const startSequence = tokenIfType(tokens[first], "codeTextSequence");
let rangeLength = code.length + (2 * tickCount); const endSequence = tokenIfType(tokens[last], "codeTextSequence");
let rangeLineOffset = 0; const startData =
let fixIndex = columnIndex; tokenIfType(tokens[first + 1], "codeTextData") ||
let fixLength = code.length; tokenIfType(tokens[first + 2], "codeTextData");
const codeLines = code.split(newLineRe); const endData =
const left = leftSpaceRe.test(code); tokenIfType(tokens[last - 1], "codeTextData") ||
const right = !left && rightSpaceRe.test(code); tokenIfType(tokens[last - 2], "codeTextData");
if (right && (codeLines.length > 1)) { if (startSequence && endSequence && startData && endData) {
rangeIndex = 0; const spaceLeft = leftSpaceRe.test(startData.text);
rangeLineOffset = codeLines.length - 1; const spaceRight = !spaceLeft && rightSpaceRe.test(endData.text);
fixIndex = 0; if (spaceLeft || spaceRight) {
} let lineNumber = startSequence.startLine;
if (left || right) { let range = null;
const codeLinesRange = codeLines[rangeLineOffset]; let fixInfo = null;
if (codeLines.length > 1) { if (startSequence.startLine === endSequence.endLine) {
rangeLength = codeLinesRange.length + tickCount; range = [
fixLength = codeLinesRange.length; startSequence.startColumn,
} endSequence.endColumn - startSequence.startColumn
const context = tokenLines[lineIndex + rangeLineOffset] ];
.substring(rangeIndex, rangeIndex + rangeLength); fixInfo = {
const codeLinesRangeTrim = codeLinesRange.trim(); "editColumn": startSequence.endColumn,
const fixText = "deleteCount": endSequence.startColumn - startSequence.endColumn,
(codeLinesRangeTrim.startsWith("`") ? " " : "") + "insertText": trimCodeText(startData.text, true, true)
codeLinesRangeTrim + };
(codeLinesRangeTrim.endsWith("`") ? " " : ""); } else if (spaceLeft) {
addErrorContext( range = [
onError, startSequence.startColumn,
token.lineNumber + lineIndex + rangeLineOffset, startData.endColumn - startSequence.startColumn
context, ];
left, fixInfo = {
right, "editColumn": startSequence.endColumn,
[ rangeIndex + 1, rangeLength ], "deleteCount": startData.endColumn - startData.startColumn,
{ "insertText": trimCodeText(startData.text, true, false)
"editColumn": fixIndex + 1, };
"deleteCount": fixLength, } else {
"insertText": fixText lineNumber = endSequence.endLine;
} range = [
); endData.startColumn,
} endSequence.endColumn - endData.startColumn
}); ];
fixInfo = {
"editColumn": endData.startColumn,
"deleteCount": endData.endColumn - endData.startColumn,
"insertText": trimCodeText(endData.text, false, true)
};
}
const context = params
.lines[lineNumber - 1]
.substring(range[0] - 1, range[0] - 1 + range[1]);
addErrorContext(
onError,
lineNumber,
context,
spaceLeft,
spaceRight,
range,
fixInfo
);
}
} }
}); }
} }
}; };

1
test/markdownlint-test-repos.js
View file

@ -160,6 +160,7 @@ test("https://github.com/dotnet/docs", (t) => {
/^test-repos\/dotnet-docs\/docs\/framework\/whats-new\/index\.md: \d+: MD034\/.*$\r?\n?/gm, /^test-repos\/dotnet-docs\/docs\/framework\/whats-new\/index\.md: \d+: MD034\/.*$\r?\n?/gm,
/^test-repos\/dotnet-docs\/docs\/orleans\/tutorials-and-samples\/index\.md: \d+: MD034\/.*$\r?\n?/gm, /^test-repos\/dotnet-docs\/docs\/orleans\/tutorials-and-samples\/index\.md: \d+: MD034\/.*$\r?\n?/gm,
/^test-repos\/dotnet-docs\/docs\/standard\/base-types\/regular-expression-source-generators\.md: \d+: MD034\/.*$\r?\n?/gm, /^test-repos\/dotnet-docs\/docs\/standard\/base-types\/regular-expression-source-generators\.md: \d+: MD034\/.*$\r?\n?/gm,
/^test-repos\/dotnet-docs\/docs\/standard\/generics\/math\.md: \d+: MD038\/.*$\r?\n?/gm,
/^test-repos\/dotnet-docs\/docs\/standard\/serialization\/xml-schema-def-tool-gen\.md: \d+: MD034\/.*$\r?\n?/gm /^test-repos\/dotnet-docs\/docs\/standard\/serialization\/xml-schema-def-tool-gen\.md: \d+: MD034\/.*$\r?\n?/gm
]; ];
return lintTestRepo(t, globPatterns, configPath, ignoreRes); return lintTestRepo(t, globPatterns, configPath, ignoreRes);

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

@ -38877,6 +38877,46 @@ Generated by [AVA](https://avajs.dev).
'no-space-in-code', 'no-space-in-code',
], ],
}, },
{
errorContext: '``` ` multiple leading {MD038...',
errorDetail: null,
errorRange: [
6,
31,
],
fixInfo: {
deleteCount: 28,
editColumn: 9,
insertText: ' ` multiple leading {MD038}',
},
lineNumber: 129,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
},
{
errorContext: 'not allowed ` ``',
errorDetail: null,
errorRange: [
1,
17,
],
fixInfo: {
deleteCount: 15,
editColumn: 1,
insertText: 'not allowed ` ',
},
lineNumber: 136,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
},
{ {
errorContext: '#link%60link', errorContext: '#link%60link',
errorDetail: null, errorDetail: null,
@ -39080,6 +39120,21 @@ Generated by [AVA](https://avajs.dev).
Again, 2 characters: \` ab \`␊ Again, 2 characters: \` ab \`␊
Again, 1 character: \` a \`␊ Again, 1 character: \` a \`␊
Many internal spaces: \` code code code code code code \`␊ Many internal spaces: \` code code code code code code \`␊
␊
text \`\`\` \` leading space␊
allowed for backtick\`\`\` text␊
␊
text \`\`\` \` multiple leading {MD038}␊
spaces not allowed\`\`\` text␊
␊
text \`\`trailing space␊
allowed for backtick \` \`\` text␊
␊
text \`\`multiple trailing spaces␊
not allowed \` \`\` text {MD038}␊
␊
text \`\` \` leading and trailing␊
space allowed for backtick \` \`\` text␊
`, `,
} }

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

Binary file not shown.

15
test/spaces_inside_codespan_elements.md
View file

@ -122,3 +122,18 @@ Again, 3 characters: ` abc `
Again, 2 characters: ` ab ` Again, 2 characters: ` ab `
Again, 1 character: ` a ` Again, 1 character: ` a `
Many internal spaces: ` code code code code code code ` Many internal spaces: ` code code code code code code `
text ``` ` leading space
allowed for backtick``` text
text ``` ` multiple leading {MD038}
spaces not allowed``` text
text ``trailing space
allowed for backtick ` `` text
text ``multiple trailing spaces
not allowed ` `` text {MD038}
text `` ` leading and trailing
space allowed for backtick ` `` text