markdownlint 0.27.0 → 0.28.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/CHANGELOG.md +382 -0
  2. package/CONTRIBUTING.md +4 -3
  3. package/LICENSE +1 -1
  4. package/README.md +1 -123
  5. package/demo/markdownlint-browser.js +4978 -3583
  6. package/doc/CustomRules.md +1 -4
  7. package/doc/Rules.md +22 -16
  8. package/doc/md034.md +21 -15
  9. package/doc/md051.md +1 -1
  10. package/helpers/LICENSE +1 -1
  11. package/helpers/helpers.js +106 -248
  12. package/helpers/micromark.cjs +209 -0
  13. package/helpers/package.json +4 -1
  14. package/lib/constants.js +1 -1
  15. package/lib/markdownlint.d.ts +16 -5
  16. package/lib/markdownlint.js +99 -46
  17. package/lib/md002.js +1 -1
  18. package/lib/md027.js +1 -1
  19. package/lib/md028.js +1 -1
  20. package/lib/md033.js +47 -40
  21. package/lib/md034.js +54 -72
  22. package/lib/md035.js +9 -11
  23. package/lib/md036.js +1 -1
  24. package/lib/md038.js +80 -55
  25. package/lib/md041.js +1 -1
  26. package/lib/md044.js +58 -44
  27. package/lib/md046.js +1 -1
  28. package/lib/md048.js +3 -1
  29. package/package.json +29 -24
  30. package/schema/.markdownlint.jsonc +1 -1
  31. package/schema/.markdownlint.yaml +3 -4
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "markdownlint",
3
- "version": "0.27.0",
3
+ "version": "0.28.1",
4
4
  "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/markdownlint.js",
@@ -25,70 +25,75 @@
25
25
  "build-config": "npm run build-config-schema && npm run build-config-example",
26
26
  "build-config-example": "node schema/build-config-example.js",
27
27
  "build-config-schema": "node schema/build-config-schema.js",
28
- "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --module commonjs --resolveJsonModule --target es2015 lib/markdownlint.js && node scripts delete 'lib/{c,md,r}*.d.ts' 'helpers/*.d.ts'",
29
- "build-demo": "node scripts copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && cd demo && webpack --no-stats",
28
+ "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --module commonjs --resolveJsonModule --target es2015 lib/markdownlint.js && node scripts delete 'lib/{c,md,r}*.d.ts' 'micromark/*.d.cts' 'helpers/*.d.{cts,ts}'",
29
+ "build-demo": "node scripts copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && node scripts copy node_modules/markdownlint-micromark/micromark-browser.js demo/micromark-browser.js && cd demo && webpack --no-stats",
30
30
  "build-docs": "node doc-build/build-rules.mjs",
31
31
  "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
32
+ "build-micromark": "cd micromark && npm run build",
32
33
  "ci": "npm-run-all --continue-on-error --parallel lint serial-config-docs serial-declaration-demo test-cover && git diff --exit-code",
33
34
  "clone-test-repos-apache-airflow": "cd test-repos && git clone https://github.com/apache/airflow apache-airflow --depth 1 --no-tags --quiet",
34
35
  "clone-test-repos-dotnet-docs": "cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
35
36
  "clone-test-repos-electron-electron": "cd test-repos && git clone https://github.com/electron/electron electron-electron --depth 1 --no-tags --quiet",
36
37
  "clone-test-repos-eslint-eslint": "cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet",
37
38
  "clone-test-repos-mdn-content": "cd test-repos && git clone https://github.com/mdn/content mdn-content --depth 1 --no-tags --quiet",
39
+ "clone-test-repos-mdn-translated-content": "cd test-repos && git clone https://github.com/mdn/translated-content mdn-translated-content --depth 1 --no-tags --quiet",
38
40
  "clone-test-repos-mkdocs-mkdocs": "cd test-repos && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet",
39
41
  "clone-test-repos-mochajs-mocha": "cd test-repos && git clone https://github.com/mochajs/mocha mochajs-mocha --depth 1 --no-tags --quiet",
40
42
  "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",
41
43
  "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",
42
44
  "clone-test-repos-webhintio-hint": "cd test-repos && git clone https://github.com/webhintio/hint webhintio-hint --depth 1 --no-tags --quiet",
43
45
  "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",
44
- "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-apache-airflow && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-electron-electron && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mdn-content && 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-v8-v8-dev && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
46
+ "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-apache-airflow && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-electron-electron && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mdn-content && npm run clone-test-repos-mdn-translated-content && 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-v8-v8-dev && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
45
47
  "declaration": "npm run build-declaration && npm run test-declaration",
46
48
  "example": "cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint",
47
49
  "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm install",
48
50
  "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",
49
- "lint": "eslint --ext .js,.mjs --max-warnings 0 .",
50
- "lint-test-repos": "ava --timeout=5m test/markdownlint-test-repos.js",
51
+ "lint": "eslint --ext .js,.cjs,.mjs --max-warnings 0 .",
52
+ "lint-test-repos": "ava --timeout=10m test/markdownlint-test-repos.js",
51
53
  "serial-config-docs": "npm run build-config && npm run build-docs",
52
54
  "serial-declaration-demo": "npm run build-declaration && npm-run-all --continue-on-error --parallel build-demo test-declaration",
53
- "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",
54
- "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
55
+ "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-micromark.mjs test/markdownlint-test-result-object.js test/markdownlint-test-scenarios.js",
56
+ "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --exclude 'test/**' --exclude 'micromark/**' npm test",
55
57
  "test-declaration": "cd example/typescript && tsc && node type-check.js",
56
58
  "test-extra": "ava --timeout=5m test/markdownlint-test-extra-parse.js test/markdownlint-test-extra-type.js",
57
- "update-snapshots": "ava --update-snapshots test/markdownlint-test-scenarios.js",
59
+ "update-snapshots": "ava --update-snapshots test/markdownlint-test-micromark.mjs test/markdownlint-test-scenarios.js",
58
60
  "upgrade": "npx --yes npm-check-updates --upgrade"
59
61
  },
60
62
  "engines": {
61
63
  "node": ">=14.18.0"
62
64
  },
63
65
  "dependencies": {
64
- "markdown-it": "13.0.1"
66
+ "markdown-it": "13.0.1",
67
+ "markdownlint-micromark": "0.1.2"
65
68
  },
66
69
  "devDependencies": {
67
- "ava": "5.1.0",
68
- "c8": "7.12.0",
69
- "eslint": "8.30.0",
70
+ "ava": "5.2.0",
71
+ "babel-loader": "9.1.2",
72
+ "@babel/core": "7.21.4",
73
+ "@babel/preset-env": "7.21.4",
74
+ "c8": "7.13.0",
75
+ "eslint": "8.37.0",
70
76
  "eslint-plugin-es": "4.1.0",
71
- "eslint-plugin-jsdoc": "39.6.4",
72
- "eslint-plugin-n": "15.6.0",
73
- "eslint-plugin-regexp": "1.11.0",
74
- "eslint-plugin-unicorn": "45.0.2",
77
+ "eslint-plugin-jsdoc": "40.1.1",
78
+ "eslint-plugin-n": "15.7.0",
79
+ "eslint-plugin-regexp": "1.14.0",
80
+ "eslint-plugin-unicorn": "46.0.0",
75
81
  "globby": "13.1.3",
76
82
  "js-yaml": "4.1.0",
77
- "markdown-it-footnote": "3.0.3",
78
83
  "markdown-it-for-inline": "0.1.1",
79
84
  "markdown-it-sub": "1.0.0",
80
85
  "markdown-it-sup": "1.0.0",
81
86
  "markdown-it-texmath": "1.0.0",
82
- "markdownlint-rule-helpers": "0.17.2",
87
+ "markdownlint-rule-helpers": "0.19.0",
83
88
  "npm-run-all": "4.1.5",
84
89
  "strip-json-comments": "5.0.0",
85
- "terser-webpack-plugin": "5.3.6",
90
+ "terser-webpack-plugin": "5.3.7",
86
91
  "toml": "3.0.0",
87
- "ts-loader": "9.4.2",
88
92
  "tv4": "1.3.0",
89
- "typescript": "4.9.4",
90
- "webpack": "5.75.0",
91
- "webpack-cli": "5.0.1"
93
+ "typescript": "5.0.3",
94
+ "webpack": "5.77.0",
95
+ "webpack-cli": "5.0.1",
96
+ "yaml": "2.2.1"
92
97
  },
93
98
  "keywords": [
94
99
  "markdown",
package/schema/.markdownlint.jsonc CHANGED
@@ -1,5 +1,5 @@
1
+ // Example markdownlint configuration with all properties set to their default value
1
2
  {
2
- // Example markdownlint JSON(C) configuration with all properties set to their default value
3
3
 
4
4
  // Default state for all rules
5
5
  "default": true,
package/schema/.markdownlint.yaml CHANGED
@@ -1,4 +1,4 @@
1
- # Example markdownlint YAML configuration with all properties set to their default value
1
+ # Example markdownlint configuration with all properties set to their default value
2
2
 
3
3
  # Default state for all rules
4
4
  default: true
@@ -257,6 +257,5 @@ MD052: true
257
257
  # MD053/link-image-reference-definitions - Link and image reference definitions should be needed
258
258
  MD053:
259
259
  # Ignored definitions
260
- ignored_definitions: [
261
- "//"
262
- ]
260
+ ignored_definitions:
261
+ - "//"