mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02:00
Reimplement MD042/no-empty-links using micromark tokens.
This commit is contained in:
David Anson
parent
7377b75383
commit
964e4c80ab
6 changed files with 219 additions and 97 deletions
|
|
@ -1523,6 +1523,21 @@ function filterByTypes(tokens, types, htmlFlow) {
|
|||
return filterByPredicate(tokens, predicate);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a list of nested Micromark token descendants by type path.
|
||||
*
|
||||
* @param {Token|Token[]} parent Micromark token parent or parents.
|
||||
* @param {TokenType[]} typePath Micromark token type path.
|
||||
* @returns {Token[]} Micromark token descendants.
|
||||
*/
|
||||
function getDescendantsByType(parent, typePath) {
|
||||
let tokens = Array.isArray(parent) ? parent : [ parent ];
|
||||
for (const type of typePath) {
|
||||
tokens = tokens.flatMap((t) => t.children).filter((t) => t.type === type);
|
||||
}
|
||||
return tokens;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the heading level of a Micromark heading tokan.
|
||||
*
|
||||
|
|
@ -1691,6 +1706,7 @@ module.exports = {
|
|||
"parse": micromarkParse,
|
||||
filterByPredicate,
|
||||
filterByTypes,
|
||||
getDescendantsByType,
|
||||
getHeadingLevel,
|
||||
getHeadingStyle,
|
||||
getHeadingText,
|
||||
|
|
@ -5813,8 +5829,9 @@ module.exports = {
|
|||
|
||||
|
||||
|
||||
const { addErrorContext, escapeForRegExp, filterTokens } =
|
||||
__webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
|
||||
const { addErrorContext } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
|
||||
const { getDescendantsByType, filterByTypes } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
|
||||
const { referenceLinkImageData } = __webpack_require__(/*! ./cache */ "../lib/cache.js");
|
||||
|
||||
// eslint-disable-next-line jsdoc/valid-types
|
||||
/** @type import("./markdownlint").Rule */
|
||||
|
|
@ -5822,44 +5839,56 @@ module.exports = {
|
|||
"names": [ "MD042", "no-empty-links" ],
|
||||
"description": "No empty links",
|
||||
"tags": [ "links" ],
|
||||
"parser": "markdownit",
|
||||
"parser": "micromark",
|
||||
"function": function MD042(params, onError) {
|
||||
filterTokens(params, "inline", function forToken(token) {
|
||||
let inLink = false;
|
||||
let linkText = "";
|
||||
let emptyLink = false;
|
||||
for (const child of token.children) {
|
||||
if (child.type === "link_open") {
|
||||
inLink = true;
|
||||
linkText = "";
|
||||
for (const attr of child.attrs) {
|
||||
if (attr[0] === "href" && (!attr[1] || (attr[1] === "#"))) {
|
||||
emptyLink = true;
|
||||
}
|
||||
}
|
||||
} else if (child.type === "link_close") {
|
||||
inLink = false;
|
||||
if (emptyLink) {
|
||||
let context = `[${linkText}]`;
|
||||
let range = null;
|
||||
const match = child.line.match(
|
||||
new RegExp(`${escapeForRegExp(context)}\\((?:|#|<>)\\)`)
|
||||
);
|
||||
if (match) {
|
||||
context = match[0];
|
||||
// @ts-ignore
|
||||
range = [ match.index + 1, match[0].length ];
|
||||
}
|
||||
addErrorContext(
|
||||
onError, child.lineNumber, context, null, null, range
|
||||
);
|
||||
emptyLink = false;
|
||||
}
|
||||
} else if (inLink) {
|
||||
linkText += child.content;
|
||||
}
|
||||
const { definitions } = referenceLinkImageData();
|
||||
const isReferenceDefinitionHash = (token) => {
|
||||
const definition = definitions.get(token.text.trim());
|
||||
return (definition && (definition[1] === "#"));
|
||||
};
|
||||
const links = filterByTypes(
|
||||
params.parsers.micromark.tokens,
|
||||
[ "link" ]
|
||||
);
|
||||
for (const link of links) {
|
||||
const labelText = getDescendantsByType(link, [ "label", "labelText" ]);
|
||||
const reference = getDescendantsByType(link, [ "reference" ]);
|
||||
const resource = getDescendantsByType(link, [ "resource" ]);
|
||||
const referenceString = getDescendantsByType(reference, [ "referenceString" ]);
|
||||
const resourceDestination = getDescendantsByType(resource, [ "resourceDestination" ]);
|
||||
const resourceDestinationString = [
|
||||
...getDescendantsByType(resourceDestination, [ "resourceDestinationRaw", "resourceDestinationString" ]),
|
||||
...getDescendantsByType(resourceDestination, [ "resourceDestinationLiteral", "resourceDestinationString" ])
|
||||
];
|
||||
const hasLabelText = labelText.length > 0;
|
||||
const hasReference = reference.length > 0;
|
||||
const hasResource = resource.length > 0;
|
||||
const hasReferenceString = referenceString.length > 0;
|
||||
const hasResourceDestinationString = resourceDestinationString.length > 0;
|
||||
let error = false;
|
||||
if (
|
||||
hasLabelText &&
|
||||
((!hasReference && !hasResource) || (hasReference && !hasReferenceString))
|
||||
) {
|
||||
error = isReferenceDefinitionHash(labelText[0]);
|
||||
} else if (hasReferenceString && !hasResourceDestinationString) {
|
||||
error = isReferenceDefinitionHash(referenceString[0]);
|
||||
} else if (!hasReferenceString && hasResourceDestinationString) {
|
||||
error = (resourceDestinationString[0].text.trim() === "#");
|
||||
} else if (!hasReferenceString && !hasResourceDestinationString) {
|
||||
error = true;
|
||||
}
|
||||
});
|
||||
if (error) {
|
||||
addErrorContext(
|
||||
onError,
|
||||
link.startLine,
|
||||
link.text,
|
||||
undefined,
|
||||
undefined,
|
||||
[ link.startColumn, link.endColumn - link.startColumn ]
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -304,6 +304,21 @@ function filterByTypes(tokens, types, htmlFlow) {
|
|||
return filterByPredicate(tokens, predicate);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a list of nested Micromark token descendants by type path.
|
||||
*
|
||||
* @param {Token|Token[]} parent Micromark token parent or parents.
|
||||
* @param {TokenType[]} typePath Micromark token type path.
|
||||
* @returns {Token[]} Micromark token descendants.
|
||||
*/
|
||||
function getDescendantsByType(parent, typePath) {
|
||||
let tokens = Array.isArray(parent) ? parent : [ parent ];
|
||||
for (const type of typePath) {
|
||||
tokens = tokens.flatMap((t) => t.children).filter((t) => t.type === type);
|
||||
}
|
||||
return tokens;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the heading level of a Micromark heading tokan.
|
||||
*
|
||||
|
|
@ -472,6 +487,7 @@ module.exports = {
|
|||
"parse": micromarkParse,
|
||||
filterByPredicate,
|
||||
filterByTypes,
|
||||
getDescendantsByType,
|
||||
getHeadingLevel,
|
||||
getHeadingStyle,
|
||||
getHeadingText,
|
||||
|
|
|
|||
89
lib/md042.js
89
lib/md042.js
|
|
@ -2,8 +2,9 @@
|
|||
|
||||
"use strict";
|
||||
|
||||
const { addErrorContext, escapeForRegExp, filterTokens } =
|
||||
require("../helpers");
|
||||
const { addErrorContext } = require("../helpers");
|
||||
const { getDescendantsByType, filterByTypes } = require("../helpers/micromark.cjs");
|
||||
const { referenceLinkImageData } = require("./cache");
|
||||
|
||||
// eslint-disable-next-line jsdoc/valid-types
|
||||
/** @type import("./markdownlint").Rule */
|
||||
|
|
@ -11,43 +12,55 @@ module.exports = {
|
|||
"names": [ "MD042", "no-empty-links" ],
|
||||
"description": "No empty links",
|
||||
"tags": [ "links" ],
|
||||
"parser": "markdownit",
|
||||
"parser": "micromark",
|
||||
"function": function MD042(params, onError) {
|
||||
filterTokens(params, "inline", function forToken(token) {
|
||||
let inLink = false;
|
||||
let linkText = "";
|
||||
let emptyLink = false;
|
||||
for (const child of token.children) {
|
||||
if (child.type === "link_open") {
|
||||
inLink = true;
|
||||
linkText = "";
|
||||
for (const attr of child.attrs) {
|
||||
if (attr[0] === "href" && (!attr[1] || (attr[1] === "#"))) {
|
||||
emptyLink = true;
|
||||
}
|
||||
}
|
||||
} else if (child.type === "link_close") {
|
||||
inLink = false;
|
||||
if (emptyLink) {
|
||||
let context = `[${linkText}]`;
|
||||
let range = null;
|
||||
const match = child.line.match(
|
||||
new RegExp(`${escapeForRegExp(context)}\\((?:|#|<>)\\)`)
|
||||
);
|
||||
if (match) {
|
||||
context = match[0];
|
||||
// @ts-ignore
|
||||
range = [ match.index + 1, match[0].length ];
|
||||
}
|
||||
addErrorContext(
|
||||
onError, child.lineNumber, context, null, null, range
|
||||
);
|
||||
emptyLink = false;
|
||||
}
|
||||
} else if (inLink) {
|
||||
linkText += child.content;
|
||||
}
|
||||
const { definitions } = referenceLinkImageData();
|
||||
const isReferenceDefinitionHash = (token) => {
|
||||
const definition = definitions.get(token.text.trim());
|
||||
return (definition && (definition[1] === "#"));
|
||||
};
|
||||
const links = filterByTypes(
|
||||
params.parsers.micromark.tokens,
|
||||
[ "link" ]
|
||||
);
|
||||
for (const link of links) {
|
||||
const labelText = getDescendantsByType(link, [ "label", "labelText" ]);
|
||||
const reference = getDescendantsByType(link, [ "reference" ]);
|
||||
const resource = getDescendantsByType(link, [ "resource" ]);
|
||||
const referenceString = getDescendantsByType(reference, [ "referenceString" ]);
|
||||
const resourceDestination = getDescendantsByType(resource, [ "resourceDestination" ]);
|
||||
const resourceDestinationString = [
|
||||
...getDescendantsByType(resourceDestination, [ "resourceDestinationRaw", "resourceDestinationString" ]),
|
||||
...getDescendantsByType(resourceDestination, [ "resourceDestinationLiteral", "resourceDestinationString" ])
|
||||
];
|
||||
const hasLabelText = labelText.length > 0;
|
||||
const hasReference = reference.length > 0;
|
||||
const hasResource = resource.length > 0;
|
||||
const hasReferenceString = referenceString.length > 0;
|
||||
const hasResourceDestinationString = resourceDestinationString.length > 0;
|
||||
let error = false;
|
||||
if (
|
||||
hasLabelText &&
|
||||
((!hasReference && !hasResource) || (hasReference && !hasReferenceString))
|
||||
) {
|
||||
error = isReferenceDefinitionHash(labelText[0]);
|
||||
} else if (hasReferenceString && !hasResourceDestinationString) {
|
||||
error = isReferenceDefinitionHash(referenceString[0]);
|
||||
} else if (!hasReferenceString && hasResourceDestinationString) {
|
||||
error = (resourceDestinationString[0].text.trim() === "#");
|
||||
} else if (!hasReferenceString && !hasResourceDestinationString) {
|
||||
error = true;
|
||||
}
|
||||
});
|
||||
if (error) {
|
||||
addErrorContext(
|
||||
onError,
|
||||
link.startLine,
|
||||
link.text,
|
||||
undefined,
|
||||
undefined,
|
||||
[ link.startColumn, link.endColumn - link.startColumn ]
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -24,6 +24,10 @@
|
|||
|
||||
[text][ frag ] {MD042}
|
||||
|
||||
[frag][] {MD042}
|
||||
|
||||
[frag] {MD042}
|
||||
|
||||
[frag]: #
|
||||
|
||||
## Non-empty links
|
||||
|
|
|
|||
|
|
@ -11837,9 +11837,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text]( <> )',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
12,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 9,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11850,9 +11853,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text](<> "title")',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
18,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 11,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11863,9 +11869,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text]( <> "title" )',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
20,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 13,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11892,9 +11901,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text]( # )',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
11,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 17,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11905,9 +11917,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text](# "title")',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
17,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 19,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11918,9 +11933,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text]( # "title" )',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
19,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 21,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11931,9 +11949,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text][frag]',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
12,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 23,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11944,9 +11965,12 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]',
|
||||
errorContext: '[text][ frag ]',
|
||||
errorDetail: null,
|
||||
errorRange: null,
|
||||
errorRange: [
|
||||
1,
|
||||
14,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 25,
|
||||
ruleDescription: 'No empty links',
|
||||
|
|
@ -11957,14 +11981,30 @@ Generated by [AVA](https://avajs.dev).
|
|||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]()',
|
||||
errorContext: '[frag][]',
|
||||
errorDetail: null,
|
||||
errorRange: [
|
||||
1,
|
||||
8,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 70,
|
||||
lineNumber: 27,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
'MD042',
|
||||
'no-empty-links',
|
||||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[frag]',
|
||||
errorDetail: null,
|
||||
errorRange: [
|
||||
1,
|
||||
6,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 29,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
|
|
@ -11996,7 +12036,7 @@ Generated by [AVA](https://avajs.dev).
|
|||
8,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 76,
|
||||
lineNumber: 78,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
|
|
@ -12012,7 +12052,7 @@ Generated by [AVA](https://avajs.dev).
|
|||
8,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 79,
|
||||
lineNumber: 80,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
|
|
@ -12028,7 +12068,23 @@ Generated by [AVA](https://avajs.dev).
|
|||
8,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 81,
|
||||
lineNumber: 83,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
'MD042',
|
||||
'no-empty-links',
|
||||
],
|
||||
},
|
||||
{
|
||||
errorContext: '[text]()',
|
||||
errorDetail: null,
|
||||
errorRange: [
|
||||
1,
|
||||
8,
|
||||
],
|
||||
fixInfo: null,
|
||||
lineNumber: 85,
|
||||
ruleDescription: 'No empty links',
|
||||
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md042.md',
|
||||
ruleNames: [
|
||||
|
|
@ -12063,6 +12119,10 @@ Generated by [AVA](https://avajs.dev).
|
|||
␊
|
||||
[text][ frag ] {MD042}␊
|
||||
␊
|
||||
[frag][] {MD042}␊
|
||||
␊
|
||||
[frag] {MD042}␊
|
||||
␊
|
||||
[frag]: #␊
|
||||
␊
|
||||
## Non-empty links␊
|
||||
|
|
|
|||
Binary file not shown.
Loading…
Add table
Add a link
Reference in a new issue