markdownlint 0.32.1 → 0.34.0

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 (76) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/CONTRIBUTING.md +4 -3
  3. package/README.md +6 -0
  4. package/demo/markdownlint-browser.js +3866 -3564
  5. package/doc/CustomRules.md +14 -7
  6. package/doc/Rules.md +139 -12
  7. package/doc/md013.md +8 -7
  8. package/doc/md024.md +2 -5
  9. package/doc/md049.md +3 -0
  10. package/doc/md050.md +3 -0
  11. package/doc/md051.md +26 -0
  12. package/doc/md055.md +54 -0
  13. package/doc/md056.md +37 -0
  14. package/helpers/README.md +5 -3
  15. package/helpers/helpers.js +5 -5
  16. package/helpers/micromark.cjs +46 -27
  17. package/helpers/package.json +2 -2
  18. package/lib/configuration.d.ts +136 -110
  19. package/lib/constants.js +1 -1
  20. package/lib/markdownlint.d.ts +79 -6
  21. package/lib/markdownlint.js +95 -21
  22. package/lib/md001.js +3 -0
  23. package/lib/md003.js +3 -0
  24. package/lib/md004.js +3 -0
  25. package/lib/md005.js +12 -4
  26. package/lib/md007.js +17 -11
  27. package/lib/md009.js +3 -0
  28. package/lib/md010.js +4 -1
  29. package/lib/md011.js +3 -0
  30. package/lib/md012.js +3 -0
  31. package/lib/md013.js +3 -0
  32. package/lib/md014.js +4 -0
  33. package/lib/md018.js +4 -0
  34. package/lib/md019.js +3 -0
  35. package/lib/md020.js +3 -0
  36. package/lib/md021.js +3 -0
  37. package/lib/md022.js +10 -2
  38. package/lib/md023.js +3 -0
  39. package/lib/md024.js +11 -4
  40. package/lib/md025.js +3 -0
  41. package/lib/md026.js +11 -7
  42. package/lib/md027.js +29 -43
  43. package/lib/md028.js +31 -14
  44. package/lib/md029.js +3 -0
  45. package/lib/md030.js +9 -4
  46. package/lib/md031.js +3 -0
  47. package/lib/md032.js +12 -14
  48. package/lib/md033.js +9 -2
  49. package/lib/md034.js +31 -5
  50. package/lib/md035.js +9 -2
  51. package/lib/md036.js +33 -39
  52. package/lib/md037.js +10 -2
  53. package/lib/md038.js +27 -18
  54. package/lib/md039.js +4 -0
  55. package/lib/md040.js +26 -21
  56. package/lib/md041.js +21 -26
  57. package/lib/md042.js +4 -0
  58. package/lib/md043.js +3 -0
  59. package/lib/md044.js +9 -1
  60. package/lib/md045.js +10 -3
  61. package/lib/md046.js +14 -7
  62. package/lib/md047.js +5 -2
  63. package/lib/md048.js +26 -13
  64. package/lib/md049-md050.js +26 -7
  65. package/lib/md051.js +20 -16
  66. package/lib/md052.js +3 -0
  67. package/lib/md053.js +3 -0
  68. package/lib/md054.js +10 -5
  69. package/lib/md055.js +80 -0
  70. package/lib/md056.js +52 -0
  71. package/lib/rules.js +5 -3
  72. package/package.json +26 -32
  73. package/schema/.markdownlint.jsonc +58 -51
  74. package/schema/.markdownlint.yaml +56 -50
  75. package/schema/ValidatingConfiguration.md +28 -0
  76. package/schema/markdownlint-config-schema.json +165 -113
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.34.0
4
+
5
+ - Use `micromark` in MD027/MD028/MD036/MD040/MD041/MD046/MD048
6
+ - Improve MD013/MD034/MD049/MD050/MD051
7
+ - Update custom rule requirements and documentation
8
+ - Improve various TypeScript declarations
9
+ - Update dependencies
10
+
11
+ ## 0.33.0
12
+
13
+ - Add MD055/table-pipe-style, MD056/table-column-count
14
+ - Improve MD005/MD007/MD024/MD026/MD038
15
+ - Incorporate `micromark-extension-directive`
16
+ - Improve JSON schema, document validation
17
+ - Reduce size of browser script
18
+ - Update dependencies
19
+
3
20
  ## 0.32.1
4
21
 
5
22
  - Fix behavior of MD054
@@ -13,6 +30,7 @@
13
30
  - Improve MD022/MD026/MD034/MD037/MD038/MD045/MD051
14
31
  - Improve JSON schema and related examples
15
32
  - Provide type declaration for Configuration object
33
+ - Remove support for end-of-life Node version 16
16
34
  - Update dependencies
17
35
 
18
36
  ## 0.31.1
package/CONTRIBUTING.md CHANGED
@@ -19,8 +19,9 @@ project's only dependencies.
19
19
 
20
20
  Package versions for `dependencies` and `devDependencies` should be specified
21
21
  exactly (also known as "pinning"). The short explanation is that doing otherwise
22
- eventually leads to inconsistent behavior and broken functionality. (See [Pin
23
- your npm/yarn dependencies][pin-dependencies] for a longer explanation.)
22
+ eventually leads to inconsistent behavior and broken functionality. (See [Why I
23
+ pin dependency versions in Node.js packages][version-pinning] for a longer
24
+ explanation.)
24
25
 
25
26
  If developing a new rule, start by creating a [custom rule][custom-rules] in its
26
27
  own project. Once written, published, and tested in real world scenarios, open
@@ -88,5 +89,5 @@ Thank you!
88
89
  [micromark]: https://www.npmjs.com/package/micromark
89
90
  [new-rule]: https://github.com/DavidAnson/markdownlint/labels/new%20rule
90
91
  [npm-scripts]: https://docs.npmjs.com/misc/scripts
91
- [pin-dependencies]: https://maxleiter.com/blog/pin-dependencies
92
92
  [rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
93
+ [version-pinning]: https://dlaa.me/blog/post/versionpinning
package/README.md CHANGED
@@ -134,6 +134,8 @@ playground for learning and exploring.
134
134
  - **[MD052](doc/md052.md)** *reference-links-images* - Reference links and images should use a label that is defined
135
135
  - **[MD053](doc/md053.md)** *link-image-reference-definitions* - Link and image reference definitions should be needed
136
136
  - **[MD054](doc/md054.md)** *link-image-style* - Link and image style
137
+ - **[MD055](doc/md055.md)** *table-pipe-style* - Table pipe style
138
+ - **[MD056](doc/md056.md)** *table-column-count* - Table column count
137
139
 
138
140
  <!-- markdownlint-restore -->
139
141
 
@@ -175,6 +177,7 @@ rules at once.
175
177
  - **`ol`** - `MD029`, `MD030`, `MD032`
176
178
  - **`spaces`** - `MD018`, `MD019`, `MD020`, `MD021`, `MD023`
177
179
  - **`spelling`** - `MD044`
180
+ - **`table`** - `MD055`, `MD056`
178
181
  - **`ul`** - `MD004`, `MD005`, `MD007`, `MD030`, `MD032`
179
182
  - **`url`** - `MD034`
180
183
  - **`whitespace`** - `MD009`, `MD010`, `MD012`, `MD027`, `MD028`, `MD030`,
@@ -403,6 +406,9 @@ See [markdownlint-config-schema.json](schema/markdownlint-config-schema.json)
403
406
  for the [JSON Schema](https://json-schema.org/) of the `options.config`
404
407
  object.
405
408
 
409
+ See [ValidatingConfiguration.md](schema/ValidatingConfiguration.md) for ways to
410
+ use the JSON Schema to validate configuration.
411
+
406
412
  For more advanced scenarios, styles can reference and extend other styles.
407
413
  The `readConfig` and `readConfigSync` functions can be used to read such
408
414
  styles.