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

Refactor RegExps to avoid the possibility of polynomial backtracking (fixes #657).

Browse source
This commit is contained in:
David Anson 2024-10-05 18:07:45 -07:00
parent 9b1840a5a4
commit e0219411c6
8 changed files with 14 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -525,7 +525,7 @@ specify a custom `RegExp` or use the value `null` to disable the feature.
The default value: The default value:
```javascript ```javascript
/((^---\s*$[\s\S]+?^---\s*)|(^\+\+\+\s*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{\s*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m /((^---[^\S\r\n\u2028\u2029]*$[\s\S]+?^---\s*)|(^\+\+\+[^\S\r\n\u2028\u2029]*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{[^\S\r\n\u2028\u2029]*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m
``` ```
Ignores [YAML](https://en.wikipedia.org/wiki/YAML), Ignores [YAML](https://en.wikipedia.org/wiki/YAML),

10
demo/markdownlint-browser.js
View file

@ -36,7 +36,7 @@ module.exports.nextLinesRe = nextLinesRe;
// Regular expression for matching common front matter (YAML and TOML) // Regular expression for matching common front matter (YAML and TOML)
module.exports.frontMatterRe = module.exports.frontMatterRe =
/((^---\s*$[\s\S]+?^---\s*)|(^\+\+\+\s*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{\s*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m; /((^---[^\S\r\n\u2028\u2029]*$[\s\S]+?^---\s*)|(^\+\+\+[^\S\r\n\u2028\u2029]*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{[^\S\r\n\u2028\u2029]*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m;
// Regular expression for matching the start of inline disable/enable comments // Regular expression for matching the start of inline disable/enable comments
const inlineCommentStartRe = const inlineCommentStartRe =
@ -1554,7 +1554,7 @@ function freezeToken(token) {
/** /**
* Annotate tokens with line/lineNumber and freeze them. * Annotate tokens with line/lineNumber and freeze them.
* *
* @param {import("markdown-it").Token[]} tokens Array of markdown-it tokens. * @param {Object[]} tokens Array of markdown-it tokens.
* @param {string[]} lines Lines of Markdown content. * @param {string[]} lines Lines of Markdown content.
* @returns {void} * @returns {void}
*/ */
@ -1613,18 +1613,18 @@ function annotateAndFreezeTokens(tokens, lines) {
* @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins. * @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins.
* @param {string} content Markdown content. * @param {string} content Markdown content.
* @param {string[]} lines Lines of Markdown content. * @param {string[]} lines Lines of Markdown content.
* @returns {import("markdown-it").Token[]} Array of markdown-it tokens. * @returns {import("../lib/markdownlint").MarkdownItToken} Array of markdown-it tokens.
*/ */
function getMarkdownItTokens(markdownItPlugins, content, lines) { function getMarkdownItTokens(markdownItPlugins, content, lines) {
const markdownit = __webpack_require__(/*! markdown-it */ "markdown-it"); const markdownit = __webpack_require__(/*! markdown-it */ "markdown-it");
const md = markdownit({ "html": true }); const md = markdownit({ "html": true });
// const markdownItPlugins = options.markdownItPlugins || [];
for (const plugin of markdownItPlugins) { for (const plugin of markdownItPlugins) {
// @ts-ignore // @ts-ignore
md.use(...plugin); md.use(...plugin);
} }
const tokens = md.parse(content, {}); const tokens = md.parse(content, {});
annotateAndFreezeTokens(tokens, lines); annotateAndFreezeTokens(tokens, lines);
// @ts-ignore
return tokens; return tokens;
}; };
@ -4192,7 +4192,7 @@ module.exports = {
for (const [ lineIndex, line ] of lines.entries()) { for (const [ lineIndex, line ] of lines.entries()) {
if (!ignoreBlockLineNumbers.has(lineIndex + 1)) { if (!ignoreBlockLineNumbers.has(lineIndex + 1)) {
const match = const match =
/^(#+)([ \t]*)([^#]*?[^#\\])([ \t]*)((?:\\#)?)(#+)(\s*)$/.exec(line); /^(#+)([ \t]*)([^# \t\\]|[^# \t][^#]*?[^# \t\\])([ \t]*)((?:\\#)?)(#+)(\s*)$/.exec(line);
if (match) { if (match) {
const [ const [
, ,

1
eslint.config.mjs
View file

@ -75,7 +75,6 @@ export default [
"prefer-destructuring": "off", "prefer-destructuring": "off",
"prefer-named-capture-group": "off", "prefer-named-capture-group": "off",
"prefer-template": "off", "prefer-template": "off",
"regexp/no-super-linear-backtracking": "off",
"require-unicode-regexp": "off", "require-unicode-regexp": "off",
"sort-imports": "off", "sort-imports": "off",
"sort-keys": "off", "sort-keys": "off",

2
helpers/helpers.js
View file

@ -24,7 +24,7 @@ module.exports.nextLinesRe = nextLinesRe;
// Regular expression for matching common front matter (YAML and TOML) // Regular expression for matching common front matter (YAML and TOML)
module.exports.frontMatterRe = module.exports.frontMatterRe =
/((^---\s*$[\s\S]+?^---\s*)|(^\+\+\+\s*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{\s*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m; /((^---[^\S\r\n\u2028\u2029]*$[\s\S]+?^---\s*)|(^\+\+\+[^\S\r\n\u2028\u2029]*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{[^\S\r\n\u2028\u2029]*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m;
// Regular expression for matching the start of inline disable/enable comments // Regular expression for matching the start of inline disable/enable comments
const inlineCommentStartRe = const inlineCommentStartRe =

6
lib/markdownit.cjs
View file

@ -92,7 +92,7 @@ function freezeToken(token) {
/** /**
* Annotate tokens with line/lineNumber and freeze them. * Annotate tokens with line/lineNumber and freeze them.
* *
* @param {import("markdown-it").Token[]} tokens Array of markdown-it tokens. * @param {Object[]} tokens Array of markdown-it tokens.
* @param {string[]} lines Lines of Markdown content. * @param {string[]} lines Lines of Markdown content.
* @returns {void} * @returns {void}
*/ */
@ -151,18 +151,18 @@ function annotateAndFreezeTokens(tokens, lines) {
* @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins. * @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins.
* @param {string} content Markdown content. * @param {string} content Markdown content.
* @param {string[]} lines Lines of Markdown content. * @param {string[]} lines Lines of Markdown content.
* @returns {import("markdown-it").Token[]} Array of markdown-it tokens. * @returns {import("../lib/markdownlint").MarkdownItToken} Array of markdown-it tokens.
*/ */
function getMarkdownItTokens(markdownItPlugins, content, lines) { function getMarkdownItTokens(markdownItPlugins, content, lines) {
const markdownit = require("markdown-it"); const markdownit = require("markdown-it");
const md = markdownit({ "html": true }); const md = markdownit({ "html": true });
// const markdownItPlugins = options.markdownItPlugins || [];
for (const plugin of markdownItPlugins) { for (const plugin of markdownItPlugins) {
// @ts-ignore // @ts-ignore
md.use(...plugin); md.use(...plugin);
} }
const tokens = md.parse(content, {}); const tokens = md.parse(content, {});
annotateAndFreezeTokens(tokens, lines); annotateAndFreezeTokens(tokens, lines);
// @ts-ignore
return tokens; return tokens;
}; };

2
lib/md020.js
View file

@ -22,7 +22,7 @@ module.exports = {
for (const [ lineIndex, line ] of lines.entries()) { for (const [ lineIndex, line ] of lines.entries()) {
if (!ignoreBlockLineNumbers.has(lineIndex + 1)) { if (!ignoreBlockLineNumbers.has(lineIndex + 1)) {
const match = const match =
/^(#+)([ \t]*)([^#]*?[^#\\])([ \t]*)((?:\\#)?)(#+)(\s*)$/.exec(line); /^(#+)([ \t]*)([^# \t\\]|[^# \t][^#]*?[^# \t\\])([ \t]*)((?:\\#)?)(#+)(\s*)$/.exec(line);
if (match) { if (match) {
const [ const [
, ,

5
test/markdownlint-test.js
View file

@ -1034,8 +1034,7 @@ test("validateConfigExampleJson", (t) => {
const ajv = new Ajv(ajvOptions); const ajv = new Ajv(ajvOptions);
const validateSchema = ajv.compile(configSchema); const validateSchema = ajv.compile(configSchema);
t.is( t.is(
// eslint-disable-next-line regexp/optimal-quantifier-concatenation configSchema.$id.replace(/^.*\/v(?<ver>\d+\.\d+\.\d+)\/.*$/u, "$<ver>"),
configSchema.$id.replace(/^.*v(?<ver>\d+\.\d+\.\d+).*$/u, "$<ver>"),
version version
); );
t.is(configSchema.$id, configSchema.properties.$schema.default); t.is(configSchema.$id, configSchema.properties.$schema.default);
@ -1081,7 +1080,7 @@ test("allBuiltInRulesHaveValidUrl", (t) => {
}); });
test("someCustomRulesHaveValidUrl", (t) => { test("someCustomRulesHaveValidUrl", (t) => {
t.plan(8); t.plan(9);
for (const rule of customRules.all) { for (const rule of customRules.all) {
t.true(!rule.information || t.true(!rule.information ||
(Object.getPrototypeOf(rule.information) === URL.prototype)); (Object.getPrototypeOf(rule.information) === URL.prototype));

2
test/rules/rules.js
View file

@ -3,7 +3,7 @@
"use strict"; "use strict";
const anyBlockquote = require("./any-blockquote"); const anyBlockquote = require("./any-blockquote");
module.exports.anyBlockquote = anyBlockquote; module.exports.anyBlockquote = anyBlockquote[1];
const everyNLines = require("./every-n-lines"); const everyNLines = require("./every-n-lines");
module.exports.everyNLines = everyNLines; module.exports.everyNLines = everyNLines;