mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02:00
05509da984
Some checks are pending
Checkers / linkcheck (push) Waiting to run
Checkers / spellcheck (push) Waiting to run
CI / build (20, macos-latest) (push) Waiting to run
CI / build (20, ubuntu-latest) (push) Waiting to run
CI / build (20, windows-latest) (push) Waiting to run
CI / build (22, macos-latest) (push) Waiting to run
CI / build (22, ubuntu-latest) (push) Waiting to run
CI / build (22, windows-latest) (push) Waiting to run
CI / build (24, macos-latest) (push) Waiting to run
CI / build (24, ubuntu-latest) (push) Waiting to run
CI / build (24, windows-latest) (push) Waiting to run
CI / pnpm (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
TestRepos / build (latest, ubuntu-latest) (push) Waiting to run
UpdateTestRepos / update (push) Waiting to run
687 lines
18 KiB
JavaScript
687 lines
18 KiB
JavaScript
// @ts-check
|
|
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
/** @type {import("markdownlint").Rule[]} */
|
|
import rules from "../lib/rules.mjs";
|
|
import jsonSchemaToTypeScript from "json-schema-to-typescript";
|
|
import { version } from "../lib/constants.mjs";
|
|
import { __dirname } from "../test/esm-helpers.mjs";
|
|
|
|
const schemaName = "markdownlint-config-schema.json";
|
|
const schemaUri = `https://raw.githubusercontent.com/DavidAnson/markdownlint/v${version}/schema/${schemaName}`;
|
|
const schemaStrictName = "markdownlint-config-schema-strict.json";
|
|
const schemaStrictUri = `https://raw.githubusercontent.com/DavidAnson/markdownlint/v${version}/schema/${schemaStrictName}`;
|
|
|
|
// Schema scaffolding
|
|
const schema = {
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"$id": schemaUri,
|
|
"title": "markdownlint configuration schema",
|
|
"type": "object",
|
|
/** @type {Object.<string, object>} */
|
|
"properties": {
|
|
"$schema": {
|
|
"description": "JSON Schema URI (expected by some editors)",
|
|
"type": "string",
|
|
"default": schemaUri
|
|
},
|
|
"default": {
|
|
"description": "Default state for all rules",
|
|
"oneOf": [
|
|
{ "type": "boolean" },
|
|
{ "enum": [ "error" ] }
|
|
],
|
|
"default": true
|
|
},
|
|
"extends": {
|
|
"description": "Path to configuration file to extend",
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"default": null
|
|
}
|
|
},
|
|
"additionalProperties": {
|
|
"type": [
|
|
"boolean",
|
|
"object"
|
|
]
|
|
}
|
|
};
|
|
/** @type {Object.<string, string[]>} */
|
|
const tags = {};
|
|
|
|
// Add rules
|
|
for (const rule of rules) {
|
|
const ruleName = rule.names[0];
|
|
for (const tag of rule.tags) {
|
|
const tagRules = tags[tag] || [];
|
|
tagRules.push(ruleName);
|
|
tags[tag] = tagRules;
|
|
}
|
|
const scheme = {
|
|
"description":
|
|
`${rule.names.join("/")} : ${rule.description} : ${rule.information}`,
|
|
"oneOf": [
|
|
{ "type": "boolean" },
|
|
{ "enum": [ "error" ] }
|
|
],
|
|
"default": true
|
|
};
|
|
const subscheme = {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"severity": {
|
|
"description": "Rule severity",
|
|
"type": "string",
|
|
"enum": [
|
|
"error"
|
|
],
|
|
"default": "error"
|
|
}
|
|
}
|
|
};
|
|
scheme.oneOf.push(subscheme);
|
|
/* eslint-disable camelcase */
|
|
switch (ruleName) {
|
|
case "MD001":
|
|
// @ts-ignore
|
|
subscheme.properties.front_matter_title = {
|
|
"description": "RegExp for matching title in front matter",
|
|
"type": "string",
|
|
"default": "^\\s*title\\s*[:=]"
|
|
};
|
|
break;
|
|
case "MD003":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Heading style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"atx",
|
|
"atx_closed",
|
|
"setext",
|
|
"setext_with_atx",
|
|
"setext_with_atx_closed"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD004":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "List style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"asterisk",
|
|
"plus",
|
|
"dash",
|
|
"sublist"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD007":
|
|
// @ts-ignore
|
|
subscheme.properties.indent = {
|
|
"description": "Spaces for indent",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 2
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.start_indented = {
|
|
"description": "Whether to indent the first level of the list",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.start_indent = {
|
|
"description":
|
|
"Spaces for first level indent (when start_indented is set)",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 2
|
|
};
|
|
break;
|
|
case "MD009":
|
|
// @ts-ignore
|
|
subscheme.properties.br_spaces = {
|
|
"description": "Spaces for line break",
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"default": 2
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.list_item_empty_lines = {
|
|
"description": "Allow spaces for empty lines in list items",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.strict = {
|
|
"description": "Include unnecessary breaks",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD010":
|
|
// @ts-ignore
|
|
subscheme.properties.code_blocks = {
|
|
"description": "Include code blocks",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.ignore_code_languages = {
|
|
"description": "Fenced code languages to ignore",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": []
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.spaces_per_tab = {
|
|
"description": "Number of spaces for each hard tab",
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"default": 1
|
|
};
|
|
break;
|
|
case "MD012":
|
|
// @ts-ignore
|
|
subscheme.properties.maximum = {
|
|
"description": "Consecutive blank lines",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
};
|
|
break;
|
|
case "MD013":
|
|
// @ts-ignore
|
|
subscheme.properties.line_length = {
|
|
"description": "Number of characters",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 80
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.heading_line_length = {
|
|
"description": "Number of characters for headings",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 80
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.code_block_line_length = {
|
|
"description": "Number of characters for code blocks",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 80
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.code_blocks = {
|
|
"description": "Include code blocks",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.tables = {
|
|
"description": "Include tables",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.headings = {
|
|
"description": "Include headings",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.strict = {
|
|
"description": "Strict length checking",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.stern = {
|
|
"description": "Stern length checking",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD022":
|
|
// @ts-ignore
|
|
subscheme.properties.lines_above = {
|
|
"description": "Blank lines above heading",
|
|
"type": [
|
|
"integer",
|
|
"array"
|
|
],
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"minimum": -1,
|
|
"default": 1
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.lines_below = {
|
|
"description": "Blank lines below heading",
|
|
"type": [
|
|
"integer",
|
|
"array"
|
|
],
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"minimum": -1,
|
|
"default": 1
|
|
};
|
|
break;
|
|
case "MD024":
|
|
// @ts-ignore
|
|
subscheme.properties.siblings_only = {
|
|
"description": "Only check sibling headings",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD026":
|
|
case "MD036":
|
|
// @ts-ignore
|
|
subscheme.properties.punctuation = {
|
|
"description": "Punctuation characters",
|
|
"type": "string",
|
|
"default": (ruleName === "MD026") ? ".,;:!。，；：！" : ".,;:!?。，；：！？"
|
|
};
|
|
break;
|
|
case "MD027":
|
|
// @ts-ignore
|
|
subscheme.properties.list_items = {
|
|
"description": "Include list items",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
break;
|
|
case "MD029":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "List style",
|
|
"type": "string",
|
|
"enum": [
|
|
"one",
|
|
"ordered",
|
|
"one_or_ordered",
|
|
"zero"
|
|
],
|
|
"default": "one_or_ordered"
|
|
};
|
|
break;
|
|
case "MD030":
|
|
// @ts-ignore
|
|
subscheme.properties.ul_single = {
|
|
"description": "Spaces for single-line unordered list items",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.ol_single = {
|
|
"description": "Spaces for single-line ordered list items",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.ul_multi = {
|
|
"description": "Spaces for multi-line unordered list items",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.ol_multi = {
|
|
"description": "Spaces for multi-line ordered list items",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
};
|
|
break;
|
|
case "MD031":
|
|
// @ts-ignore
|
|
subscheme.properties.list_items = {
|
|
"description": "Include list items",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
break;
|
|
case "MD033":
|
|
// @ts-ignore
|
|
subscheme.properties.allowed_elements = {
|
|
"description": "Allowed elements",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": []
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.table_allowed_elements = {
|
|
"description": "Allowed elements in tables",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": []
|
|
};
|
|
break;
|
|
case "MD035":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Horizontal rule style",
|
|
"type": "string",
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD040":
|
|
// @ts-ignore
|
|
subscheme.properties.allowed_languages = {
|
|
"description": "List of languages",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": []
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.language_only = {
|
|
"description": "Require language only",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD025":
|
|
case "MD041":
|
|
if (ruleName === "MD041") {
|
|
// @ts-ignore
|
|
subscheme.properties.allow_preamble = {
|
|
"description": "Allow content before first heading",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
}
|
|
// @ts-ignore
|
|
subscheme.properties.front_matter_title = {
|
|
"description": "RegExp for matching title in front matter",
|
|
"type": "string",
|
|
"default": "^\\s*title\\s*[:=]"
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.level = {
|
|
"description": "Heading level",
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 6,
|
|
"default": 1
|
|
};
|
|
break;
|
|
case "MD043":
|
|
// @ts-ignore
|
|
subscheme.properties.headings = {
|
|
"description": "List of headings",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"pattern": "^(\\*|\\+|\\?|#{1,6}\\s+\\S.*)$"
|
|
},
|
|
"default": []
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.match_case = {
|
|
"description": "Match case of headings",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD044":
|
|
// @ts-ignore
|
|
subscheme.properties.names = {
|
|
"description": "List of proper names",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": []
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.code_blocks = {
|
|
"description": "Include code blocks",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.html_elements = {
|
|
"description": "Include HTML elements",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
break;
|
|
case "MD046":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Block style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"fenced",
|
|
"indented"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD048":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Code fence style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"backtick",
|
|
"tilde"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD049":
|
|
case "MD050":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": (ruleName === "MD049") ? "Emphasis style" : "Strong style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"asterisk",
|
|
"underscore"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD051":
|
|
// @ts-ignore
|
|
subscheme.properties.ignore_case = {
|
|
"description": "Ignore case of fragments",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.ignored_pattern = {
|
|
"description": "Pattern for ignoring additional fragments",
|
|
"type": "string",
|
|
"default": ""
|
|
};
|
|
break;
|
|
case "MD052":
|
|
// @ts-ignore
|
|
subscheme.properties.ignored_labels = {
|
|
"description": "Ignored link labels",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": [ "x" ]
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.shortcut_syntax = {
|
|
"description": "Include shortcut syntax",
|
|
"type": "boolean",
|
|
"default": false
|
|
};
|
|
break;
|
|
case "MD053":
|
|
// @ts-ignore
|
|
subscheme.properties.ignored_definitions = {
|
|
"description": "Ignored definitions",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": [ "//" ]
|
|
};
|
|
break;
|
|
case "MD054":
|
|
// @ts-ignore
|
|
subscheme.properties.autolink = {
|
|
"description": "Allow autolinks",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.inline = {
|
|
"description": "Allow inline links and images",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.full = {
|
|
"description": "Allow full reference links and images",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.collapsed = {
|
|
"description": "Allow collapsed reference links and images",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.shortcut = {
|
|
"description": "Allow shortcut reference links and images",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
// @ts-ignore
|
|
subscheme.properties.url_inline = {
|
|
"description": "Allow URLs as inline links",
|
|
"type": "boolean",
|
|
"default": true
|
|
};
|
|
break;
|
|
case "MD055":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Table pipe style",
|
|
"type": "string",
|
|
"enum": [
|
|
"consistent",
|
|
"leading_only",
|
|
"trailing_only",
|
|
"leading_and_trailing",
|
|
"no_leading_or_trailing"
|
|
],
|
|
"default": "consistent"
|
|
};
|
|
break;
|
|
case "MD059":
|
|
// @ts-ignore
|
|
subscheme.properties.prohibited_texts = {
|
|
"description": "Prohibited link texts",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"default": [
|
|
"click here",
|
|
"here",
|
|
"link",
|
|
"more"
|
|
]
|
|
};
|
|
break;
|
|
case "MD060":
|
|
// @ts-ignore
|
|
subscheme.properties.style = {
|
|
"description": "Table column style",
|
|
"type": "string",
|
|
"enum": [
|
|
"any",
|
|
"aligned",
|
|
"compact",
|
|
"tight"
|
|
],
|
|
"default": "any"
|
|
};
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
/* eslint-enable camelcase */
|
|
for (const name of rule.names) {
|
|
schema.properties[name] = scheme;
|
|
// Using $ref causes rule aliases not to get JSDoc comments
|
|
// schema.properties[name] = (index === 0) ? scheme : {
|
|
// "$ref": `#/properties/${firstName}`
|
|
// };
|
|
}
|
|
}
|
|
|
|
// Add tags
|
|
for (const [ tag, tagTags ] of Object.entries(tags)) {
|
|
const scheme = {
|
|
"description": `${tag} : ${tagTags.join(", ")}`,
|
|
"oneOf": [
|
|
{ "type": "boolean" },
|
|
{ "enum": [ "error" ] }
|
|
],
|
|
"default": true
|
|
};
|
|
schema.properties[tag] = scheme;
|
|
}
|
|
|
|
// Write schema
|
|
const schemaFile = path.join(__dirname(import.meta), schemaName);
|
|
await fs.writeFile(schemaFile, JSON.stringify(schema, null, " "));
|
|
|
|
// Create and write strict schema
|
|
const schemaStrict = {
|
|
...schema,
|
|
"$id": schemaStrictUri,
|
|
"additionalProperties": false
|
|
};
|
|
const schemaFileStrict = path.join(__dirname(import.meta), schemaStrictName);
|
|
await fs.writeFile(schemaFileStrict, JSON.stringify(schemaStrict, null, " "));
|
|
|
|
// Write TypeScript declaration file
|
|
const declarationStrictName = path.join(__dirname(import.meta), "..", "lib", "configuration-strict.d.ts");
|
|
schemaStrict.title = "ConfigurationStrict";
|
|
const declaration = await jsonSchemaToTypeScript.compile(
|
|
// @ts-ignore
|
|
schemaStrict,
|
|
"UNUSED"
|
|
);
|
|
await fs.writeFile(declarationStrictName, declaration);
|