markdownlint 0.21.1 → 0.24.0

package/schema/markdownlint-config-schema.json

@@ -9,7 +9,10 @@
     },
     "extends": {
       "description": "Path to configuration file to extend",
-      "type": "string",
+      "type": [
+        "string",
+        "null"
+      ],
       "default": null
     },
     "$schema": {
@@ -33,7 +36,7 @@
       "default": true
     },
     "MD002": {
-      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
+      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -49,7 +52,7 @@
       "additionalProperties": false
     },
     "first-heading-h1": {
-      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
+      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -65,7 +68,7 @@
       "additionalProperties": false
     },
     "first-header-h1": {
-      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
+      "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -324,6 +327,11 @@
           "description": "Include code blocks",
           "type": "boolean",
           "default": true
+        },
+        "spaces_per_tab": {
+          "description": "Number of spaces for each hard tab",
+          "type": "number",
+          "default": 1
         }
       },
       "additionalProperties": false
@@ -340,6 +348,11 @@
           "description": "Include code blocks",
           "type": "boolean",
           "default": true
+        },
+        "spaces_per_tab": {
+          "description": "Number of spaces for each hard tab",
+          "type": "number",
+          "default": 1
         }
       },
       "additionalProperties": false
@@ -690,7 +703,7 @@
       "additionalProperties": false
     },
     "MD025": {
-      "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
+      "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
       "type": [
         "boolean",
         "object"
@@ -711,7 +724,7 @@
       "additionalProperties": false
     },
     "single-title": {
-      "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
+      "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
       "type": [
         "boolean",
         "object"
@@ -732,7 +745,7 @@
       "additionalProperties": false
     },
     "single-h1": {
-      "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
+      "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
       "type": [
         "boolean",
         "object"
@@ -763,7 +776,7 @@
         "punctuation": {
           "description": "Punctuation characters",
           "type": "string",
-          "default": ".,;:!?。，；：！？"
+          "default": ".,;:!。，；：！"
         }
       },
       "additionalProperties": false
@@ -779,7 +792,7 @@
         "punctuation": {
           "description": "Punctuation characters",
           "type": "string",
-          "default": ".,;:!?。，；：！？"
+          "default": ".,;:!。，；：！"
         }
       },
       "additionalProperties": false
@@ -1121,7 +1134,7 @@
       "default": true
     },
     "MD041": {
-      "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
+      "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -1142,7 +1155,7 @@
       "additionalProperties": false
     },
     "first-line-heading": {
-      "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
+      "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -1163,7 +1176,7 @@
       "additionalProperties": false
     },
     "first-line-h1": {
-      "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
+      "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
       "type": [
         "boolean",
         "object"
@@ -1207,7 +1220,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         },
         "headers": {
           "description": "List of headings",
@@ -1215,7 +1228,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         }
       },
       "additionalProperties": false
@@ -1234,7 +1247,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         },
         "headers": {
           "description": "List of headings",
@@ -1242,7 +1255,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         }
       },
       "additionalProperties": false
@@ -1261,7 +1274,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         },
         "headers": {
           "description": "List of headings",
@@ -1269,7 +1282,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         }
       },
       "additionalProperties": false
@@ -1288,7 +1301,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         },
         "code_blocks": {
           "description": "Include code blocks",
@@ -1312,7 +1325,7 @@
           "items": {
             "type": "string"
           },
-          "default": null
+          "default": []
         },
         "code_blocks": {
           "description": "Include code blocks",
@@ -1393,7 +1406,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1414,7 +1427,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1548,7 +1561,7 @@
     }
   },
   "additionalProperties": {
-    "type:": [
+    "type": [
       "boolean",
       "object"
     ]

package/schema/build-config-schema.js

@@ -1,409 +0,0 @@
-// @ts-check
-
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const rules = require("../lib/rules");
-
-// Schema scaffolding
-const schema = {
-  "title": "Markdownlint configuration schema",
-  "type": "object",
-  "properties": {
-    "default": {
-      "description": "Default state for all rules",
-      "type": "boolean",
-      "default": true
-    },
-    "extends": {
-      "description": "Path to configuration file to extend",
-      "type": "string",
-      "default": null
-    },
-    "$schema": {
-      "description": "JSON Schema URI (used by some editors)",
-      "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint" +
-        "/main/schema/markdownlint-config-schema.json"
-    }
-  },
-  "additionalProperties": {
-    "type:": [
-      "boolean",
-      "object"
-    ]
-  }
-};
-const tags = {};
-
-// Add rules
-rules.forEach(function forRule(rule) {
-  rule.tags.forEach(function forTag(tag) {
-    const tagRules = tags[tag] || [];
-    tagRules.push(rule.names[0]);
-    tags[tag] = tagRules;
-  });
-  const scheme = {
-    "description": rule.names.join("/") + " - " + rule.description,
-    "type": "boolean",
-    "default": true
-  };
-  let custom = true;
-  switch (rule.names[0]) {
-    case "MD002":
-      scheme.properties = {
-        "level": {
-          "description": "Heading level",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD003":
-      scheme.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":
-      scheme.properties = {
-        "style": {
-          "description": "List style",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "asterisk",
-            "plus",
-            "dash",
-            "sublist"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD007":
-      scheme.properties = {
-        "indent": {
-          "description": "Spaces for indent",
-          "type": "integer",
-          "default": 2
-        },
-        "start_indented": {
-          "description": "Whether to indent the first level of the list",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD009":
-      scheme.properties = {
-        "br_spaces": {
-          "description": "Spaces for line break",
-          "type": "integer",
-          "default": 2
-        },
-        "list_item_empty_lines": {
-          "description": "Allow spaces for empty lines in list items",
-          "type": "boolean",
-          "default": false
-        },
-        "strict": {
-          "description": "Include unnecessary breaks",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD010":
-      scheme.properties = {
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD012":
-      scheme.properties = {
-        "maximum": {
-          "description": "Consecutive blank lines",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD013":
-      scheme.properties = {
-        "line_length": {
-          "description": "Number of characters",
-          "type": "integer",
-          "default": 80
-        },
-        "heading_line_length": {
-          "description": "Number of characters for headings",
-          "type": "integer",
-          "default": 80
-        },
-        "code_block_line_length": {
-          "description": "Number of characters for code blocks",
-          "type": "integer",
-          "default": 80
-        },
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        },
-        "tables": {
-          "description": "Include tables",
-          "type": "boolean",
-          "default": true
-        },
-        "headings": {
-          "description": "Include headings",
-          "type": "boolean",
-          "default": true
-        },
-        "headers": {
-          "description": "Include headings",
-          "type": "boolean",
-          "default": true
-        },
-        "strict": {
-          "description": "Strict length checking",
-          "type": "boolean",
-          "default": false
-        },
-        "stern": {
-          "description": "Stern length checking",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD022":
-      scheme.properties = {
-        "lines_above": {
-          "description": "Blank lines above heading",
-          "type": "integer",
-          "default": 1
-        },
-        "lines_below": {
-          "description": "Blank lines below heading",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD024":
-      scheme.properties = {
-        "allow_different_nesting": {
-          "description": "Only check sibling headings",
-          "type": "boolean",
-          "default": false
-        },
-        "siblings_only": {
-          "description": "Only check sibling headings",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD026":
-    case "MD036":
-      scheme.properties = {
-        "punctuation": {
-          "description": "Punctuation characters",
-          "type": "string",
-          "default": ".,;:!?。，；：！？"
-        }
-      };
-      break;
-    case "MD029":
-      scheme.properties = {
-        "style": {
-          "description": "List style",
-          "type": "string",
-          "enum": [
-            "one",
-            "ordered",
-            "one_or_ordered",
-            "zero"
-          ],
-          "default": "one_or_ordered"
-        }
-      };
-      break;
-    case "MD030":
-      scheme.properties = {
-        "ul_single": {
-          "description": "Spaces for single-line unordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ol_single": {
-          "description": "Spaces for single-line ordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ul_multi": {
-          "description": "Spaces for multi-line unordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ol_multi": {
-          "description": "Spaces for multi-line ordered list items",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD031":
-      scheme.properties = {
-        "list_items": {
-          "description": "Include list items",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD033":
-      scheme.properties = {
-        "allowed_elements": {
-          "description": "Allowed elements",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": []
-        }
-      };
-      break;
-    case "MD035":
-      scheme.properties = {
-        "style": {
-          "description": "Horizontal rule style",
-          "type": "string",
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD025":
-    case "MD041":
-      scheme.properties = {
-        "level": {
-          "description": "Heading level",
-          "type": "integer",
-          "default": 1
-        },
-        "front_matter_title": {
-          "description": "RegExp for matching title in front matter",
-          "type": "string",
-          "default": "^\\s*title\\s*[:=]"
-        }
-      };
-      break;
-    case "MD043":
-      scheme.properties = {
-        "headings": {
-          "description": "List of headings",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": null
-        },
-        "headers": {
-          "description": "List of headings",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": null
-        }
-      };
-      break;
-    case "MD044":
-      scheme.properties = {
-        "names": {
-          "description": "List of proper names",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": null
-        },
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD046":
-      scheme.properties = {
-        "style": {
-          "description": "Block style",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "fenced",
-            "indented"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD048":
-      scheme.properties = {
-        "style": {
-          "description": "Code fence syle",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "backtick",
-            "tilde"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    default:
-      custom = false;
-      break;
-  }
-  if (custom) {
-    // @ts-ignore
-    scheme.type = [ "boolean", "object" ];
-    scheme.additionalProperties = false;
-  }
-  rule.names.forEach(function forName(name) {
-    schema.properties[name] = scheme;
-  });
-});
-
-// Add tags
-Object.keys(tags).forEach(function forTag(tag) {
-  const scheme = {
-    "description": tag + " - " + tags[tag].join(", "),
-    "type": "boolean",
-    "default": true
-  };
-  schema.properties[tag] = scheme;
-});
-
-// Write schema
-const schemaFile = path.join(__dirname, "markdownlint-config-schema.json");
-fs.writeFileSync(schemaFile, JSON.stringify(schema, null, "  "));