markdownlint 0.28.2 → 0.30.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.
- package/CHANGELOG.md +17 -1
- package/CONTRIBUTING.md +6 -0
- package/README.md +8 -1
- package/demo/markdownlint-browser.js +896 -836
- package/doc/CustomRules.md +2 -0
- package/doc/Rules.md +33 -17
- package/doc/md022.md +12 -6
- package/doc/md026.md +1 -2
- package/doc/md049.md +2 -2
- package/doc/md050.md +2 -2
- package/doc/md051.md +17 -6
- package/helpers/helpers.js +83 -290
- package/helpers/micromark.cjs +163 -21
- package/helpers/package.json +2 -2
- package/helpers/shared.js +7 -0
- package/lib/cache.js +0 -2
- package/lib/constants.js +1 -1
- package/lib/markdownlint.d.ts +4 -0
- package/lib/markdownlint.js +21 -7
- package/lib/md022.js +80 -40
- package/lib/md026.js +19 -12
- package/lib/md032.js +57 -31
- package/lib/md033.js +19 -45
- package/lib/md034.js +30 -23
- package/lib/md037.js +74 -157
- package/lib/md038.js +1 -2
- package/lib/md044.js +34 -4
- package/lib/md045.js +17 -5
- package/lib/md049-md050.js +61 -48
- package/lib/md051.js +90 -68
- package/package.json +31 -29
- package/schema/.markdownlint.jsonc +3 -3
- package/schema/.markdownlint.yaml +3 -3
- package/schema/markdownlint-config-schema.json +19 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.30.0
|
|
4
|
+
|
|
5
|
+
- Use `micromark` in MD022/MD026/MD032/MD037/MD045/MD051
|
|
6
|
+
- Incorporate `micromark-extension-math` for math syntax
|
|
7
|
+
- Allow custom rules to override information URL
|
|
8
|
+
- Update dependencies
|
|
9
|
+
|
|
10
|
+
## 0.29.0
|
|
11
|
+
|
|
12
|
+
- Update `micromark` parser dependencies for better performance
|
|
13
|
+
- Use `micromark` in MD049/MD050
|
|
14
|
+
- Improve MD034/MD037/MD044/MD049/MD050
|
|
15
|
+
- Support multiple parsers in demo page
|
|
16
|
+
- Remove support for end-of-life Node version 14
|
|
17
|
+
- Update dependencies
|
|
18
|
+
|
|
3
19
|
## 0.28.2
|
|
4
20
|
|
|
5
21
|
- Update dependencies for CVE-2023-2251
|
|
@@ -13,7 +29,7 @@
|
|
|
13
29
|
- Introduce `micromark` parser for better positional data (internal only)
|
|
14
30
|
- Use `micromark` in MD013/MD033/MD034/MD035/MD038/MD044/MD052/MD053
|
|
15
31
|
- Simplify file-based test cases
|
|
16
|
-
- Unify browser script for demo
|
|
32
|
+
- Unify browser script for demo page
|
|
17
33
|
- Update dependencies
|
|
18
34
|
|
|
19
35
|
## 0.27.0
|
package/CONTRIBUTING.md
CHANGED
|
@@ -17,6 +17,11 @@ Do not add new [`dependencies` to `package.json`][dependencies]. The Markdown
|
|
|
17
17
|
parsers [`markdown-it`][markdown-it] and [`micromark`][micromark] are the
|
|
18
18
|
project's only dependencies.
|
|
19
19
|
|
|
20
|
+
Package versions for `dependencies` and `devDependencies` should be specified
|
|
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.)
|
|
24
|
+
|
|
20
25
|
If developing a new rule, start by creating a [custom rule][custom-rules] in its
|
|
21
26
|
own project. Once written, published, and tested in real world scenarios, open
|
|
22
27
|
an issue to consider adding it to this project. For rule ideas, see [issues
|
|
@@ -83,4 +88,5 @@ Thank you!
|
|
|
83
88
|
[micromark]: https://www.npmjs.com/package/micromark
|
|
84
89
|
[new-rule]: https://github.com/DavidAnson/markdownlint/labels/new%20rule
|
|
85
90
|
[npm-scripts]: https://docs.npmjs.com/misc/scripts
|
|
91
|
+
[pin-dependencies]: https://maxleiter.com/blog/pin-dependencies
|
|
86
92
|
[rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
|
package/README.md
CHANGED
|
@@ -70,6 +70,13 @@ and test cases came directly from that project.
|
|
|
70
70
|
[super-linter]: https://github.com/github/super-linter
|
|
71
71
|
[vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
|
|
72
72
|
|
|
73
|
+
### References
|
|
74
|
+
|
|
75
|
+
The following specifications are considered authoritative in cases of ambiguity:
|
|
76
|
+
|
|
77
|
+
- [CommonMark](https://spec.commonmark.org/current/)
|
|
78
|
+
- [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
|
79
|
+
|
|
73
80
|
## Demonstration
|
|
74
81
|
|
|
75
82
|
[`markdownlint` demo](https://dlaa.me/markdownlint/), an interactive, in-browser
|
|
@@ -185,7 +192,7 @@ rules at once.
|
|
|
185
192
|
## Configuration
|
|
186
193
|
|
|
187
194
|
Text passed to `markdownlint` is parsed as Markdown, analyzed, and any
|
|
188
|
-
issues reported. Two kinds of text are ignored:
|
|
195
|
+
issues reported. Two kinds of text are ignored by most rules:
|
|
189
196
|
|
|
190
197
|
- [HTML comments](https://www.w3.org/TR/html5/syntax.html#comments)
|
|
191
198
|
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see
|