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

Add Rule.parser property for custom rules to specify which Markdown parser output they use, honor it strictly, and add full type support.

Browse source
This commit is contained in:
David Anson 2024-03-09 16:17:50 -08:00
parent d2acc168d2
commit d5994ae4de
68 changed files with 635 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

3
test/rules/any-blockquote.js
View file

@ -2,7 +2,7 @@
"use strict";
const { filterTokens } = require("markdownlint-rule-helpers");
const { filterTokens } = require("../../helpers");
/** @typedef {import("../../lib/markdownlint").MarkdownItToken} MarkdownItToken */
/** @typedef {(MarkdownItToken) => void} FilterTokensCallback */
@ -16,6 +16,7 @@ module.exports = {
"/blob/main/test/rules/any-blockquote.js"
),
"tags": [ "test" ],
"parser": "markdownit",
"function": (params, onError) => {
filterTokens(
params,

3
test/rules/every-n-lines.js
View file

@ -2,13 +2,14 @@
"use strict";
const { forEachLine, getLineMetadata } = require("markdownlint-rule-helpers");
const { forEachLine, getLineMetadata } = require("../../helpers");
/** @type import("../../lib/markdownlint").Rule */
module.exports = {
"names": [ "every-n-lines" ],
"description": "Rule that reports an error every N lines",
"tags": [ "test" ],
"parser": "markdownit",
"function": (params, onError) => {
const n = params.config.n || 2;
forEachLine(getLineMetadata(params), (line, lineIndex) => {

1
test/rules/first-line.js
View file

@ -7,6 +7,7 @@ module.exports = {
"names": [ "first-line" ],
"description": "Rule that reports an error for the first line",
"tags": [ "test" ],
"parser": "none",
"function": function rule(params, onError) {
// Unconditionally report an error for line 1
onError({

1
test/rules/letters-E-X.js
View file

@ -11,6 +11,7 @@ module.exports = {
"/blob/main/test/rules/letters-E-X.js"
),
"tags": [ "test" ],
"parser": "markdownit",
"function": (params, onError) => {
for (const inline of params.parsers.markdownit.tokens.filter(
(token) => token.type === "inline"

3
test/rules/lint-javascript.js
View file

@ -2,7 +2,7 @@
"use strict";
const { filterTokens } = require("markdownlint-rule-helpers");
const { filterTokens } = require("../../helpers");
const eslint = require("eslint");
const eslintInstance = new eslint.ESLint();
const linter = new eslint.Linter();
@ -29,6 +29,7 @@ module.exports = {
"names": [ "lint-javascript" ],
"description": "Rule that lints JavaScript code",
"tags": [ "test", "lint", "javascript" ],
"parser": "markdownit",
"asynchronous": true,
"function": (params, onError) => {
filterTokens(params, "fence", (fence) => {

1
test/rules/npm/sample-rule.js
View file

@ -7,6 +7,7 @@ module.exports = {
"names": [ "sample-rule" ],
"description": "Sample rule",
"tags": [ "sample" ],
"parser": "markdownit",
"function": function rule(params, onError) {
for (const token of params.parsers.markdownit.tokens) {
if (token.type === "hr") {

3
test/rules/validate-json.js
View file

@ -2,7 +2,7 @@
"use strict";
const { filterTokens } = require("markdownlint-rule-helpers");
const { filterTokens } = require("../../helpers");
const { parse, printParseErrorCode } = require("jsonc-parser");
/** @type import("../../lib/markdownlint").Rule */
@ -10,6 +10,7 @@ module.exports = {
"names": [ "validate-json" ],
"description": "Rule that validates JSON code",
"tags": [ "test", "validate", "json" ],
"parser": "markdownit",
"asynchronous": true,
"function": (params, onError) => {
filterTokens(params, "fence", (fence) => {