markdownlint 0.23.0 → 0.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.23.0",
+  "version": "0.25.1",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "types": "lib/markdownlint.d.ts",
@@ -16,52 +16,62 @@
     "build-config": "npm run build-config-schema && npm run build-config-example",
     "build-config-example": "node schema/build-config-example.js",
     "build-config-schema": "node schema/build-config-schema.js",
-    "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --resolveJsonModule lib/markdownlint.js && rimraf 'lib/{c,md,r}*.d.ts' 'helpers/*.d.ts'",
-    "build-demo": "cpy node_modules/markdown-it/dist/markdown-it.min.js demo && cd demo && rimraf markdownlint-browser.* && webpack --no-stats",
+    "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --resolveJsonModule lib/markdownlint.js && node scripts delete 'lib/{c,md,r}*.d.ts' 'helpers/*.d.ts'",
+    "build-demo": "node scripts copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && cd demo && webpack --no-stats",
     "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
-    "ci": "npm-run-all --continue-on-error --parallel test-cover lint declaration build-config build-demo && git diff --exit-code",
-    "clean-test-repos": "rimraf test-repos",
-    "clone-test-repos": "mkdir test-repos && cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet",
-    "clone-test-repos-large": "npm run clone-test-repos && cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
+    "ci": "npm-run-all --continue-on-error --parallel build-config lint serial-declaration-demo test-cover && git diff --exit-code",
+    "clone-test-repos-dotnet-docs": "cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
+    "clone-test-repos-eslint-eslint": "cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet",
+    "clone-test-repos-mkdocs-mkdocs": "cd test-repos && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet",
+    "clone-test-repos-mochajs-mocha": "cd test-repos && git clone https://github.com/mochajs/mocha mochajs-mocha --depth 1 --no-tags --quiet",
+    "clone-test-repos-pi-hole-docs": "cd test-repos && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet",
+    "clone-test-repos-v8-v8-dev": "cd test-repos && git clone https://github.com/v8/v8.dev v8-v8-dev --depth 1 --no-tags --quiet",
+    "clone-test-repos-webhintio-hint": "cd test-repos && git clone https://github.com/webhintio/hint webhintio-hint --depth 1 --no-tags --quiet",
+    "clone-test-repos-webpack-webpack-js-org": "cd test-repos && git clone https://github.com/webpack/webpack.js.org webpack-webpack-js-org --depth 1 --no-tags --quiet",
+    "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mkdocs-mkdocs && npm run clone-test-repos-mochajs-mocha && npm run clone-test-repos-pi-hole-docs && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
+    "clone-test-repos-large": "npm run clone-test-repos && cd test-repos && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-v8-v8-dev",
     "declaration": "npm run build-declaration && npm run test-declaration",
     "example": "cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint",
+    "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm install",
+    "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm run upgrade",
     "lint": "eslint --max-warnings 0 .",
     "lint-test-repos": "ava --timeout=5m test/markdownlint-test-repos.js",
-    "test": "ava test/markdownlint-test.js test/markdownlint-test-custom-rules.js test/markdownlint-test-helpers.js test/markdownlint-test-result-object.js test/markdownlint-test-scenarios.js",
+    "serial-declaration-demo": "npm run build-declaration && npm-run-all --continue-on-error --parallel build-demo test-declaration",
+    "test": "ava test/markdownlint-test.js test/markdownlint-test-config.js test/markdownlint-test-custom-rules.js test/markdownlint-test-helpers.js test/markdownlint-test-result-object.js test/markdownlint-test-scenarios.js",
     "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
     "test-declaration": "cd example/typescript && tsc && node type-check.js",
-    "test-extra": "ava --timeout=5m test/markdownlint-test-extra.js"
+    "test-extra": "ava --timeout=5m test/markdownlint-test-extra-parse.js test/markdownlint-test-extra-type.js",
+    "upgrade": "npx --yes npm-check-updates --upgrade"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "dependencies": {
-    "markdown-it": "12.0.4"
+    "markdown-it": "12.3.2"
   },
   "devDependencies": {
-    "ava": "~3.15.0",
-    "c8": "~7.5.0",
-    "cpy-cli": "~3.1.1",
-    "eslint": "~7.19.0",
-    "eslint-plugin-jsdoc": "~31.6.0",
-    "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~27.0.0",
-    "globby": "~11.0.2",
-    "js-yaml": "~4.0.0",
-    "markdown-it-for-inline": "~0.1.1",
-    "markdown-it-sub": "~1.0.0",
-    "markdown-it-sup": "~1.0.0",
-    "markdown-it-texmath": "~0.8.0",
-    "markdownlint-rule-helpers": "~0.13.0",
-    "npm-run-all": "~4.1.5",
-    "rimraf": "~3.0.2",
-    "strip-json-comments": "~3.1.1",
-    "toml": "~3.0.0",
-    "ts-loader": "~8.0.15",
-    "tv4": "~1.3.0",
-    "typescript": "~4.1.3",
-    "webpack": "~5.21.1",
-    "webpack-cli": "~4.5.0"
+    "ava": "3.15.0",
+    "c8": "7.10.0",
+    "eslint": "8.5.0",
+    "eslint-plugin-jsdoc": "37.4.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-unicorn": "39.0.0",
+    "globby": "12.0.2",
+    "js-yaml": "4.1.0",
+    "markdown-it-for-inline": "0.1.1",
+    "markdown-it-sub": "1.0.0",
+    "markdown-it-sup": "1.0.0",
+    "markdown-it-texmath": "0.9.7",
+    "markdownlint-rule-github-internal-links": "0.1.0",
+    "markdownlint-rule-helpers": "0.15.0",
+    "npm-run-all": "4.1.5",
+    "strip-json-comments": "4.0.0",
+    "toml": "3.0.0",
+    "ts-loader": "9.2.6",
+    "tv4": "1.3.0",
+    "typescript": "4.5.4",
+    "webpack": "5.65.0",
+    "webpack-cli": "4.9.1"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -39,7 +39,9 @@
     // Spaces for indent
     "indent": 2,
     // Whether to indent the first level of the list
-    "start_indented": false
+    "start_indented": false,
+    // Spaces for first level indent (when start_indented is set)
+    "start_indent": 2
   },
 
   // MD009/no-trailing-spaces - Trailing spaces
@@ -55,7 +57,9 @@
   // MD010/no-hard-tabs - Hard tabs
   "MD010": {
     // Include code blocks
-    "code_blocks": true
+    "code_blocks": true,
+    // Number of spaces for each hard tab
+    "spaces_per_tab": 1
   },
 
   // MD011/no-reversed-links - Reversed link syntax
@@ -244,7 +248,19 @@
 
   // MD048/code-fence-style - Code fence style
   "MD048": {
-    // Code fence syle
+    // Code fence style
+    "style": "consistent"
+  },
+
+  // MD049/emphasis-style - Emphasis style should be consistent
+  "MD049": {
+    // Emphasis style should be consistent
+    "style": "consistent"
+  },
+
+  // MD050/strong-style - Strong style should be consistent
+  "MD050": {
+    // Strong style should be consistent
     "style": "consistent"
   }
 }

package/schema/.markdownlint.yaml

@@ -36,6 +36,8 @@ MD007:
   indent: 2
   # Whether to indent the first level of the list
   start_indented: false
+  # Spaces for first level indent (when start_indented is set)
+  start_indent: 2
 
 # MD009/no-trailing-spaces - Trailing spaces
 MD009:
@@ -50,6 +52,8 @@ MD009:
 MD010:
   # Include code blocks
   code_blocks: true
+  # Number of spaces for each hard tab
+  spaces_per_tab: 1
 
 # MD011/no-reversed-links - Reversed link syntax
 MD011: true
@@ -221,5 +225,15 @@ MD047: true
 
 # MD048/code-fence-style - Code fence style
 MD048:
-  # Code fence syle
+  # Code fence style
+  style: "consistent"
+
+# MD049/emphasis-style - Emphasis style should be consistent
+MD049:
+  # Emphasis style should be consistent
+  style: "consistent"
+
+# MD050/strong-style - Strong style should be consistent
+MD050:
+  # Strong style should be consistent
   style: "consistent"

package/schema/markdownlint-config-schema.json

@@ -238,6 +238,11 @@
           "description": "Whether to indent the first level of the list",
           "type": "boolean",
           "default": false
+        },
+        "start_indent": {
+          "description": "Spaces for first level indent (when start_indented is set)",
+          "type": "integer",
+          "default": 2
         }
       },
       "additionalProperties": false
@@ -259,6 +264,11 @@
           "description": "Whether to indent the first level of the list",
           "type": "boolean",
           "default": false
+        },
+        "start_indent": {
+          "description": "Spaces for first level indent (when start_indented is set)",
+          "type": "integer",
+          "default": 2
         }
       },
       "additionalProperties": false
@@ -327,6 +337,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
@@ -343,6 +358,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
@@ -1396,7 +1416,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1417,7 +1437,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1429,6 +1449,90 @@
       },
       "additionalProperties": false
     },
+    "MD049": {
+      "description": "MD049/emphasis-style - Emphasis style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Emphasis style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "emphasis-style": {
+      "description": "MD049/emphasis-style - Emphasis style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Emphasis style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MD050": {
+      "description": "MD050/strong-style - Strong style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Strong style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "strong-style": {
+      "description": "MD050/strong-style - Strong style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Strong style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
     "headings": {
       "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
       "type": "boolean",
@@ -1525,7 +1629,7 @@
       "default": true
     },
     "emphasis": {
-      "description": "emphasis - MD036, MD037",
+      "description": "emphasis - MD036, MD037, MD049, MD050",
       "type": "boolean",
       "default": true
     },
@@ -1551,7 +1655,7 @@
     }
   },
   "additionalProperties": {
-    "type:": [
+    "type": [
       "boolean",
       "object"
     ]

package/schema/build-config-example.js

@@ -1,53 +0,0 @@
-// @ts-check
-
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const configSchema = require("./markdownlint-config-schema.json");
-
-const configExample = {};
-for (const rule in configSchema.properties) {
-  if (/^(MD\d{3}|default|extends)$/.test(rule)) {
-    const properties = configSchema.properties[rule];
-    configExample[rule + "-description"] = properties.description;
-    configExample[rule] = properties.default;
-    if (properties.properties) {
-      const ruleExample = {};
-      // eslint-disable-next-line guard-for-in
-      for (const property in properties.properties) {
-        const ruleProperties = properties.properties[property];
-        ruleExample[property + "-sub-description"] = ruleProperties.description;
-        ruleExample[property] = ruleProperties.default;
-      }
-      configExample[rule] = ruleExample;
-    }
-  }
-}
-
-const configStringJson = JSON.stringify(configExample, null, 2)
-  // eslint-disable-next-line max-len
-  .replace(/^\{/, "{\n  // Example markdownlint JSON(C) configuration with all properties set to their default value")
-  .replace(/(\s+)"[^-"]+-description": "(.+)",/g, "\n$1// $2")
-  .replace(/"[^-"]+-sub-description": "(.+)",/g, "// $1");
-fs.writeFileSync(
-  path.join(__dirname, ".markdownlint.jsonc"),
-  configStringJson,
-  "utf8"
-);
-
-const configStringYaml = configStringJson
-  .replace(/JSON\(C\)/, "YAML")
-  .replace(/\n {2}/g, "\n")
-  .replace(/\/\/ /g, "# ")
-  .replace(/(\s*)"([^"]+)":/g, "$1$2:")
-  .replace(/: \{/g, ":")
-  .replace(/\n\}/g, "")
-  .replace(/,\n/g, "\n")
-  .replace(/^\{\n/, "")
-  .replace(/\}$/, "");
-fs.writeFileSync(
-  path.join(__dirname, ".markdownlint.yaml"),
-  configStringYaml,
-  "utf8"
-);