Docs: Fix reference links and remove markdownlint-cli dependency (#1566)

Create a custom rule for `markdownlint` that validates that a link
reference is valid and replace the calls to `markdownlint-cli` to the
new script in all packages.

`markdownlint-cli` does not have a way to add custom rules, you need to
use the API to do so and thus `markdownlint-cli` is no longer needed as
a dependency.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: #1436

Author: molant

.markdownlintrc

@@ -5,5 +5,8 @@
     "MD026": {
         "punctuation": ".,;:!"
     },
-    "MD029": false
+    "MD029": false,
+    "MD033": {
+        "allowed_elements": ["br", "details", "summary"]
+    }
 }

package.json

@@ -16,7 +16,7 @@
     "listr": "^0.14.2",
     "listr-input": "^0.1.2",
     "loop": "^3.0.6",
-    "markdownlint-cli": "^0.13.0",
+    "markdownlint": "^0.11.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^2.6.2",
     "shelljs": "^0.8.3",
@@ -56,7 +56,7 @@
     "clean:packages": "rimraf \"packages/!(connector-edge|extension-vscode)/{dist,node_modules,npm-shrinkwrap.json,package-lock.json,yarn.lock}\"",
     "clean:root": "rimraf dist",
     "lint": "npm-run-all lint:*",
-    "lint:md": "markdownlint *.md",
+    "lint:md": "node scripts/lint-markdown",
     "lint:packages": "loop \"yarn lint\" --cwd packages --exclude configuration-development,configuration-progressive-web-apps,configuration-web-recommended",
     "lint:scripts": "eslint scripts .travis --cache --ext js --ext ts --report-unused-disable-directives",
     "pre-release": "npm run clean:packages && npm run build:scripts && npm run release -- --prerelease",

packages/connector-chrome/package.json

@@ -26,7 +26,6 @@
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
     "lodash": "^4.17.11",
-    "markdownlint-cli": "^0.13.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
     "rimraf": "^2.6.2",
@@ -74,7 +73,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/connector-edge/package.json

@@ -11,7 +11,6 @@
     "eslint-plugin-markdown": "^1.0.0-beta.6",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^2.6.2",
     "typescript": "^3.1.6",
@@ -52,7 +51,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "preinstall": "node scripts/preinstall.js",
     "test": "npm run test-only",
     "test-only": "npm run build",

packages/connector-jsdom/package.json

@@ -26,7 +26,6 @@
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
     "lodash": "^4.17.11",
-    "markdownlint-cli": "^0.13.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
     "rimraf": "^2.6.2",
@@ -74,7 +73,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/connector-local/package.json

@@ -23,7 +23,6 @@
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
     "lodash": "^4.17.11",
-    "markdownlint-cli": "^0.13.0",
     "mock-require": "^3.0.2",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -61,7 +60,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/create-hint/package.json

@@ -23,7 +23,6 @@
     "handlebars": "^4.0.11",
     "hint": "^4.1.0",
     "inquirer": "^6.2.0",
-    "markdownlint-cli": "^0.13.0",
     "mkdirp": "^0.5.1",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
@@ -62,7 +61,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/create-hint/src/shared-templates/package.hbs

@@ -15,8 +15,8 @@
     {{{dependencyVersion "cpx" "^1.5.0"}}},
     {{{dependencyVersion "eslint" "^5.0.1"}}},
     {{{dependencyVersion "eslint-plugin-markdown" "^1.0.0-beta.7"}}},
-    {{{dependencyVersion "eslint-plugin-typescript" "^0.12.0"}}},
-    {{{dependencyVersion "markdownlint-cli" "^0.10.0"}}},
+    {{{dependencyVersion "eslint-plugin-typescript" "^0.12.0"}}},{{#unless official}}
+    {{{dependencyVersion "markdownlint-cli" "^0.13.0"}}},{{/unless}}
     {{{dependencyVersion "npm-link-check" "^2.0.0"}}},
     {{{dependencyVersion "npm-run-all" "^4.1.2"}}},
     {{{dependencyVersion "nyc" "^12.0.2"}}},
@@ -73,9 +73,10 @@
     "build:ts": "tsc -b",
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",{{#if official}}
-    "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",{{else}}
-    "lint:js": "eslint . --cache --ext js --ext md --ext ts --report-unused-disable-directives",{{/if}}
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
+    "lint:md": "node ../../scripts/lint-markdown.js",{{else}}
+    "lint:js": "eslint . --cache --ext js --ext md --ext ts --report-unused-disable-directives",
+    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",{{/if}}
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "init": "npm install && npm run build",

packages/create-hintrc/package.json

@@ -28,7 +28,6 @@
     "handlebars": "^4.0.11",
     "hint": "^4.1.0",
     "inquirer": "^6.2.0",
-    "markdownlint-cli": "^0.13.0",
     "mkdirp": "^0.5.1",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
@@ -69,7 +68,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/create-parser/package.json

@@ -24,7 +24,6 @@
     "handlebars": "^4.0.11",
     "hint": "^4.1.0",
     "inquirer": "^6.2.0",
-    "markdownlint-cli": "^0.13.0",
     "mkdirp": "^0.5.1",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
@@ -65,7 +64,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/create-parser/src/shared-templates/package.hbs

@@ -17,8 +17,8 @@
     {{{dependencyVersion "eslint-plugin-typescript" "^0.12.0"}}},
     {{{dependencyVersion "eventemitter2" "^5.0.1"}}},
     {{{dependencyVersion "proxyquire" "2.0.0"}}},
-    {{{dependencyVersion "sinon" "^6.0.1"}}},
-    {{{dependencyVersion "markdownlint-cli" "^0.10.0"}}},
+    {{{dependencyVersion "sinon" "^6.0.1"}}},{{#unless official}}
+    {{{dependencyVersion "markdownlint-cli" "^0.13.0"}}},{{/unless}}
     {{{dependencyVersion "npm-link-check" "^2.0.0"}}},
     {{{dependencyVersion "npm-run-all" "^4.1.2"}}},
     {{{dependencyVersion "nyc" "^12.0.2"}}},
@@ -74,9 +74,10 @@
     "build:ts": "tsc -b",
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",{{#if official}}
-    "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",{{else}}
-    "lint:js": "eslint . --cache --ext js --ext md --ext ts --report-unused-disable-directives",{{/if}}
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
+    "lint:md": "node ../../scripts/lint-markdown.js",{{else}}
+    "lint:js": "eslint . --cache --ext js --ext md --ext ts --report-unused-disable-directives",
+    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",{{/if}}
     "test": "npm run lint && npm run build && nyc ava",{{#if official}}
     "test-only": "nyc ava",{{/if}}
     "init": "npm install && npm run build",

packages/extension-browser/package.json

@@ -49,7 +49,6 @@
     "html-minifier": "^3.5.21",
     "is-ci": "^1.2.1",
     "lodash": "^4.17.11",
-    "markdownlint-cli": "^0.13.0",
     "mock-require": "^3.0.2",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -95,7 +94,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "watch": "npm run build && npm-run-all --parallel -c watch:*",

packages/extension-vscode/package.json

@@ -30,7 +30,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -65,7 +64,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "postinstall": "node ./node_modules/vscode/bin/install",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",

packages/formatter-codeframe/package.json

@@ -21,7 +21,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -63,7 +62,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/formatter-excel/package.json

@@ -19,7 +19,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -62,7 +61,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/formatter-html/package.json

@@ -25,7 +25,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -67,7 +66,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/formatter-json/package.json

@@ -18,7 +18,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -59,7 +58,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/formatter-stylish/package.json

@@ -23,7 +23,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -64,7 +63,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/formatter-summary/package.json

@@ -22,7 +22,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -63,7 +62,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/hint-amp-validator/package.json

@@ -20,7 +20,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -59,7 +58,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/hint-apple-touch-icons/package.json

@@ -20,7 +20,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -60,7 +59,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",

packages/hint-axe/package.json

@@ -19,7 +19,6 @@
     "eslint-plugin-markdown": "^1.0.0-rc.0",
     "eslint-plugin-typescript": "0.14.0",
     "hint": "^4.1.0",
-    "markdownlint-cli": "^0.13.0",
     "npm-link-check": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^13.1.0",
@@ -59,7 +58,7 @@
     "clean": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:js": "eslint . --cache --ext js --ext md --ext ts --ignore-path ../../.eslintignore --report-unused-disable-directives",
-    "lint:md": "markdownlint --ignore CHANGELOG.md *.md",
+    "lint:md": "node ../../scripts/lint-markdown.js",
     "test": "npm run lint && npm run build && npm run test-only",
     "test-only": "nyc ava",
     "test-release": "npm run lint && npm run clean && npm run build:assets && tsc && npm run test-only",