@alexlit/lint-kit 127.2.0 → 127.3.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/package.json +1 -1
- package/packages/config-markdownlint/node_modules/markdownlint/CHANGELOG.md +457 -0
- package/packages/config-markdownlint/node_modules/markdownlint/CONTRIBUTING.md +93 -0
- package/packages/config-markdownlint/node_modules/markdownlint/LICENSE +21 -0
- package/packages/config-markdownlint/node_modules/markdownlint/README.md +1047 -0
- package/packages/config-markdownlint/node_modules/markdownlint/demo/markdownlint-browser.js +7094 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/CustomRules.md +388 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/Prettier.md +27 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/ReleaseProcess.md +20 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/Rules.md +2528 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md001.md +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md003.md +59 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md004.md +49 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md005.md +53 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md007.md +52 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md009.md +51 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md010.md +56 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md011.md +30 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md012.md +38 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md013.md +58 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md014.md +54 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md018.md +27 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md019.md +28 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md020.md +29 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md021.md +31 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md022.md +52 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md023.md +33 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md024.md +44 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md025.md +49 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md026.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md027.md +24 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md028.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md029.md +98 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md030.md +82 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md031.md +50 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md032.md +55 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md033.md +27 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md034.md +55 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md035.md +42 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md036.md +45 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md037.md +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md038.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md039.md +21 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md040.md +52 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md041.md +49 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md042.md +32 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md043.md +69 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md044.md +45 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md045.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md046.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md047.md +34 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md048.md +41 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md049.md +35 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md050.md +35 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md051.md +87 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md052.md +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md053.md +38 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md054.md +100 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md055.md +54 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md056.md +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/doc/md058.md +48 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/LICENSE +21 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/README.md +46 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/helpers.js +793 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/micromark.cjs +544 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/package.json +26 -0
- package/packages/config-markdownlint/node_modules/markdownlint/helpers/shared.js +10 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/cache.js +70 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/configuration-strict.d.ts +1185 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/configuration.d.ts +8 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/constants.js +15 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/markdownlint.d.ts +488 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/markdownlint.js +1572 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md001.js +31 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md003.js +50 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md004.js +86 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md005.js +72 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md007.js +88 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md009.js +95 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md010.js +78 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md011.js +57 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md012.js +43 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md013.js +105 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md014.js +54 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md018.js +46 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md019-md021.js +80 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md020.js +71 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md022.js +106 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md023.js +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md024.js +48 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md025.js +40 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md026.js +49 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md027.js +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md028.js +42 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md029.js +76 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md030.js +60 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md031.js +63 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md032.js +66 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md033.js +41 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md034.js +100 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md035.js +26 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md036.js +51 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md037.js +94 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md038.js +100 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md039.js +83 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md040.js +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md041.js +37 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md042.js +63 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md043.js +73 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md044.js +110 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md045.js +62 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md046.js +34 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md047.js +31 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md048.js +39 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md049-md050.js +103 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md051.js +170 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md052.js +42 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md053.js +62 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md054.js +125 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md055.js +79 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md056.js +56 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/md058.js +43 -0
- package/packages/config-markdownlint/node_modules/markdownlint/lib/rules.js +74 -0
- package/packages/config-markdownlint/node_modules/markdownlint/package.json +105 -0
- package/packages/config-markdownlint/node_modules/markdownlint/schema/.markdownlint.jsonc +307 -0
- package/packages/config-markdownlint/node_modules/markdownlint/schema/.markdownlint.yaml +275 -0
- package/packages/config-markdownlint/node_modules/markdownlint/schema/ValidatingConfiguration.md +26 -0
- package/packages/config-markdownlint/node_modules/markdownlint/schema/markdownlint-config-schema-strict.json +1819 -0
- package/packages/config-markdownlint/node_modules/markdownlint/schema/markdownlint-config-schema.json +1824 -0
- package/packages/config-markdownlint/node_modules/markdownlint/style/all.json +5 -0
- package/packages/config-markdownlint/node_modules/markdownlint/style/cirosantilli.json +22 -0
- package/packages/config-markdownlint/node_modules/markdownlint/style/prettier.json +27 -0
- package/packages/config-markdownlint/node_modules/markdownlint/style/relaxed.json +12 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/LICENSE +21 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/README.md +10 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/micromark-browser.js +2 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/micromark-html-browser.js +2 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/micromark.cjs +1 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/micromark.d.cts +1751 -0
- package/packages/config-markdownlint/node_modules/markdownlint-micromark/package.json +46 -0
- package/packages/config-markdownlint/package.json +2 -2
package/package.json
CHANGED
|
@@ -0,0 +1,457 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.35.0
|
|
4
|
+
|
|
5
|
+
- Add MD058/blanks-around-tables
|
|
6
|
+
- Use `micromark` in MD001/MD003/MD009/MD010/MD013/MD014/MD019/MD021/MD023/
|
|
7
|
+
MD024/MD025/MD039/MD042/MD043
|
|
8
|
+
- Improve MD018/MD020/MD031/MD034/MD044
|
|
9
|
+
- `markdown-it` parser no longer invoked by default
|
|
10
|
+
- Add strict version of JSON schema
|
|
11
|
+
- Improve performance
|
|
12
|
+
- Update dependencies
|
|
13
|
+
|
|
14
|
+
## 0.34.0
|
|
15
|
+
|
|
16
|
+
- Use `micromark` in MD027/MD028/MD036/MD040/MD041/MD046/MD048
|
|
17
|
+
- Improve MD013/MD034/MD049/MD050/MD051
|
|
18
|
+
- Update custom rule requirements and documentation
|
|
19
|
+
- Improve various TypeScript declarations
|
|
20
|
+
- Update dependencies
|
|
21
|
+
|
|
22
|
+
## 0.33.0
|
|
23
|
+
|
|
24
|
+
- Add MD055/table-pipe-style, MD056/table-column-count
|
|
25
|
+
- Improve MD005/MD007/MD024/MD026/MD038
|
|
26
|
+
- Incorporate `micromark-extension-directive`
|
|
27
|
+
- Improve JSON schema, document validation
|
|
28
|
+
- Reduce size of browser script
|
|
29
|
+
- Update dependencies
|
|
30
|
+
|
|
31
|
+
## 0.32.1
|
|
32
|
+
|
|
33
|
+
- Fix behavior of MD054
|
|
34
|
+
|
|
35
|
+
## 0.32.0
|
|
36
|
+
|
|
37
|
+
- Remove deprecated MD002/MD006
|
|
38
|
+
- Remove rule aliases for "header"
|
|
39
|
+
- Add MD054/link-image-style
|
|
40
|
+
- Use `micromark` in MD005/MD007/MD030
|
|
41
|
+
- Improve MD022/MD026/MD034/MD037/MD038/MD045/MD051
|
|
42
|
+
- Improve JSON schema and related examples
|
|
43
|
+
- Provide type declaration for Configuration object
|
|
44
|
+
- Remove support for end-of-life Node version 16
|
|
45
|
+
- Update dependencies
|
|
46
|
+
|
|
47
|
+
## 0.31.1
|
|
48
|
+
|
|
49
|
+
- Improve MD032/MD034
|
|
50
|
+
- Update dependencies
|
|
51
|
+
|
|
52
|
+
## 0.31.0
|
|
53
|
+
|
|
54
|
+
- Improve MD032/MD037/MD043/MD044/MD051/MD052
|
|
55
|
+
- Improve performance
|
|
56
|
+
- Update dependencies
|
|
57
|
+
|
|
58
|
+
## 0.30.0
|
|
59
|
+
|
|
60
|
+
- Use `micromark` in MD022/MD026/MD032/MD037/MD045/MD051
|
|
61
|
+
- Incorporate `micromark-extension-math` for math syntax
|
|
62
|
+
- Allow custom rules to override information URL
|
|
63
|
+
- Update dependencies
|
|
64
|
+
|
|
65
|
+
## 0.29.0
|
|
66
|
+
|
|
67
|
+
- Update `micromark` parser dependencies for better performance
|
|
68
|
+
- Use `micromark` in MD049/MD050
|
|
69
|
+
- Improve MD034/MD037/MD044/MD049/MD050
|
|
70
|
+
- Support multiple parsers in demo page
|
|
71
|
+
- Remove support for end-of-life Node version 14
|
|
72
|
+
- Update dependencies
|
|
73
|
+
|
|
74
|
+
## 0.28.2
|
|
75
|
+
|
|
76
|
+
- Update dependencies for CVE-2023-2251
|
|
77
|
+
|
|
78
|
+
## 0.28.1
|
|
79
|
+
|
|
80
|
+
- Update dependencies
|
|
81
|
+
|
|
82
|
+
## 0.28.0
|
|
83
|
+
|
|
84
|
+
- Introduce `micromark` parser for better positional data (internal only)
|
|
85
|
+
- Use `micromark` in MD013/MD033/MD034/MD035/MD038/MD044/MD052/MD053
|
|
86
|
+
- Simplify file-based test cases
|
|
87
|
+
- Unify browser script for demo page
|
|
88
|
+
- Update dependencies
|
|
89
|
+
|
|
90
|
+
## 0.27.0
|
|
91
|
+
|
|
92
|
+
- Improve MD011/MD013/MD022/MD031/MD032/MD033/MD034/MD040/MD043/MD051/MD053
|
|
93
|
+
- Generate/separate documentation
|
|
94
|
+
- Improve documentation
|
|
95
|
+
- Update dependencies
|
|
96
|
+
|
|
97
|
+
## 0.26.2
|
|
98
|
+
|
|
99
|
+
- Improve MD037/MD051/MD053
|
|
100
|
+
|
|
101
|
+
## 0.26.1
|
|
102
|
+
|
|
103
|
+
- Improve MD051
|
|
104
|
+
|
|
105
|
+
## 0.26.0
|
|
106
|
+
|
|
107
|
+
- Add MD051/MD052/MD053 for validating link fragments & reference
|
|
108
|
+
links/images & link/image reference definitions (MD053 auto-fixable)
|
|
109
|
+
- Improve MD010/MD031/MD035/MD039/MD042/MD044/MD049/MD050
|
|
110
|
+
- Add `markdownlint-disable-line` inline comment
|
|
111
|
+
- Support `~` paths in `readConfig/Sync`
|
|
112
|
+
- Add `configParsers` option
|
|
113
|
+
- Remove support for end-of-life Node version 12
|
|
114
|
+
- Default `resultVersion` to 3
|
|
115
|
+
- Update browser script to use ES2015
|
|
116
|
+
- Simplify JSON schema
|
|
117
|
+
- Address remaining CodeQL issues
|
|
118
|
+
- Improve performance
|
|
119
|
+
- Update dependencies
|
|
120
|
+
|
|
121
|
+
## 0.25.1
|
|
122
|
+
|
|
123
|
+
- Update dependencies for CVE-2022-21670
|
|
124
|
+
|
|
125
|
+
## 0.25.0
|
|
126
|
+
|
|
127
|
+
- Add MD049/MD050 for consistent emphasis/strong style (both auto-fixable)
|
|
128
|
+
- Improve MD007/MD010/MD032/MD033/MD035/MD037/MD039
|
|
129
|
+
- Support asynchronous custom rules
|
|
130
|
+
- Improve performance
|
|
131
|
+
- Improve CI process
|
|
132
|
+
- Reduce dependencies
|
|
133
|
+
- Update dependencies
|
|
134
|
+
|
|
135
|
+
## 0.24.0
|
|
136
|
+
|
|
137
|
+
- Remove support for end-of-life Node version 10
|
|
138
|
+
- Add support for custom file system module
|
|
139
|
+
- Improve MD010/MD011/MD037/MD043/MD044
|
|
140
|
+
- Improve TypeScript declaration file and JSON schema
|
|
141
|
+
- Update dependencies
|
|
142
|
+
|
|
143
|
+
## 0.23.1
|
|
144
|
+
|
|
145
|
+
- Work around lack of webpack support for dynamic calls to `require`(`.resolve`)
|
|
146
|
+
|
|
147
|
+
## 0.23.0
|
|
148
|
+
|
|
149
|
+
- Add comprehensive example `.markdownlint.jsonc`/`.markdownlint.yaml` files
|
|
150
|
+
- Add fix information for MD004/ul-style
|
|
151
|
+
- Improve MD018/MD019/MD020/MD021/MD037/MD041
|
|
152
|
+
- Improve HTML comment handling
|
|
153
|
+
- Update test runner and test suite
|
|
154
|
+
- Update dependencies
|
|
155
|
+
|
|
156
|
+
## 0.22.0
|
|
157
|
+
|
|
158
|
+
- Allow `extends` in config to reference installed packages by name
|
|
159
|
+
- Add `markdownlint-disable-next-line` inline comment
|
|
160
|
+
- Support JSON front matter
|
|
161
|
+
- Improve MD009/MD026/MD028/MD043
|
|
162
|
+
- Update dependencies (including `markdown-it` to v12)
|
|
163
|
+
|
|
164
|
+
## 0.21.1
|
|
165
|
+
|
|
166
|
+
- Improve MD011/MD031
|
|
167
|
+
- Export `getVersion` API
|
|
168
|
+
|
|
169
|
+
## 0.21.0
|
|
170
|
+
|
|
171
|
+
- Lint concurrently for better performance (async only)
|
|
172
|
+
- Add Promise-based APIs
|
|
173
|
+
- Update TypeScript declaration file
|
|
174
|
+
- Hide `toString` on `LintResults`
|
|
175
|
+
- Add ability to fix in browser demo
|
|
176
|
+
- Allow custom rules in `.markdownlint.json` schema
|
|
177
|
+
- Improve MD042/MD044
|
|
178
|
+
- Improve documentation
|
|
179
|
+
- Update dependencies
|
|
180
|
+
|
|
181
|
+
## 0.20.4
|
|
182
|
+
|
|
183
|
+
- Fix regression in MD037
|
|
184
|
+
- Improve MD034/MD044
|
|
185
|
+
- Improve documentation
|
|
186
|
+
|
|
187
|
+
## 0.20.3
|
|
188
|
+
|
|
189
|
+
- Fix regression in MD037
|
|
190
|
+
- Improve MD044
|
|
191
|
+
- Add automatic regression testing
|
|
192
|
+
|
|
193
|
+
## 0.20.2
|
|
194
|
+
|
|
195
|
+
- Fix regression in MD037
|
|
196
|
+
- Improve MD038
|
|
197
|
+
|
|
198
|
+
## 0.20.1
|
|
199
|
+
|
|
200
|
+
- Fix regression in MD037
|
|
201
|
+
|
|
202
|
+
## 0.20.0
|
|
203
|
+
|
|
204
|
+
- Add `markdownlint-configure-file` inline comment
|
|
205
|
+
- Reimplement MD037
|
|
206
|
+
- Improve MD005/MD007/MD013/MD018/MD029/MD031/MD034/MD038/MD039
|
|
207
|
+
- Improve HTML comment handling
|
|
208
|
+
- Update dependencies
|
|
209
|
+
|
|
210
|
+
## 0.19.0
|
|
211
|
+
|
|
212
|
+
- Remove support for end-of-life Node version 8
|
|
213
|
+
- Add fix information for MD005/list-indent
|
|
214
|
+
- Improve MD007/MD013/MD014
|
|
215
|
+
- Deprecate MD006/ul-start-left
|
|
216
|
+
- Add rationale for every rule
|
|
217
|
+
- Update test runner and code coverage
|
|
218
|
+
- Add more JSDoc comments
|
|
219
|
+
- Update dependencies
|
|
220
|
+
|
|
221
|
+
## 0.18.0
|
|
222
|
+
|
|
223
|
+
- Add MD048/code-fence-style
|
|
224
|
+
- Add fix information for MD007/ul-indent
|
|
225
|
+
- Add `markdownlint-disable-file`/`markdownlint-enable-file` inline comments
|
|
226
|
+
- Add type declaration file (.d.ts) for TypeScript dependents
|
|
227
|
+
- Update schema
|
|
228
|
+
- Improve MD006/MD007/MD009/MD013/MD030
|
|
229
|
+
- Update dependencies
|
|
230
|
+
|
|
231
|
+
## 0.17.2
|
|
232
|
+
|
|
233
|
+
- Improve MD020/MD033/MD044
|
|
234
|
+
|
|
235
|
+
## 0.17.1
|
|
236
|
+
|
|
237
|
+
- Fix handling of front matter by fix information
|
|
238
|
+
|
|
239
|
+
## 0.17.0
|
|
240
|
+
|
|
241
|
+
- Add `resultVersion` 3 to support fix information for default and custom rules
|
|
242
|
+
- Add fix information for 24 rules
|
|
243
|
+
- Update newline handling to match latest CommonMark specification
|
|
244
|
+
- Improve MD014/MD037/MD039
|
|
245
|
+
- Update dependencies
|
|
246
|
+
|
|
247
|
+
## 0.16.0
|
|
248
|
+
|
|
249
|
+
- Add custom rule sample for linting code
|
|
250
|
+
- Improve MD026/MD031/MD033/MD038
|
|
251
|
+
- Update dependencies
|
|
252
|
+
|
|
253
|
+
## 0.15.0
|
|
254
|
+
|
|
255
|
+
- Add `markdownlint-capture`/`markdownlint-restore` inline comments
|
|
256
|
+
- Improve MD009/MD013/MD026/MD033/MD036
|
|
257
|
+
- Update dependencies
|
|
258
|
+
|
|
259
|
+
## 0.14.2
|
|
260
|
+
|
|
261
|
+
- Improve MD047
|
|
262
|
+
- Add `handleRuleFailures` option
|
|
263
|
+
|
|
264
|
+
## 0.14.1
|
|
265
|
+
|
|
266
|
+
- Improve MD033
|
|
267
|
+
|
|
268
|
+
## 0.14.0
|
|
269
|
+
|
|
270
|
+
- Remove support for end-of-life Node version 6
|
|
271
|
+
- Introduce `markdownlint-rule-helpers`
|
|
272
|
+
- Add MD046/MD047
|
|
273
|
+
- Improve MD033/MD034/MD039
|
|
274
|
+
- Improve custom rule validation and in-browser demo
|
|
275
|
+
- Update dependencies
|
|
276
|
+
|
|
277
|
+
## 0.13.0
|
|
278
|
+
|
|
279
|
+
- Improve MD013/MD022/MD025/MD029/MD031/MD032/MD037/MD041
|
|
280
|
+
- Deprecate MD002
|
|
281
|
+
- Improve Pandoc YAML support
|
|
282
|
+
- Update dependencies
|
|
283
|
+
|
|
284
|
+
## 0.12.0
|
|
285
|
+
|
|
286
|
+
- Add `information` link for custom rules
|
|
287
|
+
- Add `markdownItPlugins` for extensibility
|
|
288
|
+
- Improve MD023/MD032/MD038
|
|
289
|
+
- Update dependencies
|
|
290
|
+
|
|
291
|
+
## 0.11.0
|
|
292
|
+
|
|
293
|
+
- Improve MD005/MD024/MD029/MD038
|
|
294
|
+
- Improve custom rule example
|
|
295
|
+
- Add `CONTRIBUTING.md`
|
|
296
|
+
- Update dependencies
|
|
297
|
+
|
|
298
|
+
## 0.10.0
|
|
299
|
+
|
|
300
|
+
- Add support for non-JSON configuration files
|
|
301
|
+
- Pass file/string name to custom rules
|
|
302
|
+
- Update dependencies
|
|
303
|
+
|
|
304
|
+
## 0.9.0
|
|
305
|
+
|
|
306
|
+
- Remove support for end-of-life Node versions 0.10/0.12/4
|
|
307
|
+
- Change "header" to "heading" per spec (non-breaking)
|
|
308
|
+
- Improve MD003/MD009/MD041
|
|
309
|
+
- Handle uncommon line-break characters
|
|
310
|
+
- Refactor for ES6
|
|
311
|
+
- Update dependencies
|
|
312
|
+
|
|
313
|
+
## 0.8.1
|
|
314
|
+
|
|
315
|
+
- Update item loop to be iterative
|
|
316
|
+
- Improve MD014
|
|
317
|
+
- Update dependencies
|
|
318
|
+
|
|
319
|
+
## 0.8.0
|
|
320
|
+
|
|
321
|
+
- Add support for using and authoring custom rules
|
|
322
|
+
- Improve MD004/MD007/MD013
|
|
323
|
+
- Add `engines` to `package.json`
|
|
324
|
+
- Refactor
|
|
325
|
+
- Update dependencies
|
|
326
|
+
|
|
327
|
+
## 0.7.0
|
|
328
|
+
|
|
329
|
+
- `resultVersion` defaults to 2 (breaking change)
|
|
330
|
+
- Add MD045
|
|
331
|
+
- Improve MD029
|
|
332
|
+
- Remove `trimLeft`/`trimRight`
|
|
333
|
+
- Split rules
|
|
334
|
+
- Refactor
|
|
335
|
+
- Update dependencies
|
|
336
|
+
|
|
337
|
+
## 0.6.4
|
|
338
|
+
|
|
339
|
+
- Improve MD029/MD042
|
|
340
|
+
- Update dependencies
|
|
341
|
+
|
|
342
|
+
## 0.6.3
|
|
343
|
+
|
|
344
|
+
- Improve highlighting for MD020
|
|
345
|
+
|
|
346
|
+
## 0.6.2
|
|
347
|
+
|
|
348
|
+
- Improve MD013/MD027/MD034/MD037/MD038/MD041/MD044
|
|
349
|
+
- Update dependencies
|
|
350
|
+
|
|
351
|
+
## 0.6.1
|
|
352
|
+
|
|
353
|
+
- Update `markdown-it` versioning
|
|
354
|
+
- Exclude demo/test from publishing
|
|
355
|
+
|
|
356
|
+
## 0.6.0
|
|
357
|
+
|
|
358
|
+
- `resultVersion` defaults to 1 (breaking change)
|
|
359
|
+
- Ignore HTML comments
|
|
360
|
+
- TOML front matter
|
|
361
|
+
- Fixes for MD044
|
|
362
|
+
- Update dependencies
|
|
363
|
+
|
|
364
|
+
## 0.5.0
|
|
365
|
+
|
|
366
|
+
- Add shareable configuration
|
|
367
|
+
- Add `noInlineConfig` option
|
|
368
|
+
- Add `README.md` links
|
|
369
|
+
- Fix MD030
|
|
370
|
+
- Improve MD009/MD041
|
|
371
|
+
- Update dependencies
|
|
372
|
+
|
|
373
|
+
## 0.4.1
|
|
374
|
+
|
|
375
|
+
- Fixes for MD038/front matter
|
|
376
|
+
- Improvements to MD044
|
|
377
|
+
- Update dependencies
|
|
378
|
+
|
|
379
|
+
## 0.4.0
|
|
380
|
+
|
|
381
|
+
- Add MD044
|
|
382
|
+
- Enhance MD013/MD032/MD041/MD042/MD043
|
|
383
|
+
- Fix for MD038
|
|
384
|
+
- Update dependencies
|
|
385
|
+
|
|
386
|
+
## 0.3.1
|
|
387
|
+
|
|
388
|
+
- Fix regressions in MD032/MD038
|
|
389
|
+
- Update dependencies
|
|
390
|
+
|
|
391
|
+
## 0.3.0
|
|
392
|
+
|
|
393
|
+
- More detailed error reporting with `resultVersion`
|
|
394
|
+
- Enhance MD010/MD012/MD036
|
|
395
|
+
- Fixes for MD027/MD029/MD030
|
|
396
|
+
- Include JSON schema dependencies
|
|
397
|
+
|
|
398
|
+
## 0.2.0
|
|
399
|
+
|
|
400
|
+
- Add MD042/MD043
|
|
401
|
+
- Enhance MD002/MD003/MD004/MD007/MD011/MD025/MD041
|
|
402
|
+
- Update dependencies
|
|
403
|
+
|
|
404
|
+
## 0.1.1
|
|
405
|
+
|
|
406
|
+
- Fix bug handling HTML in tables
|
|
407
|
+
- Reference `markdownlint-cli`
|
|
408
|
+
|
|
409
|
+
## 0.1.0
|
|
410
|
+
|
|
411
|
+
- Add aliases
|
|
412
|
+
- Exceptions for MD033
|
|
413
|
+
- Exclusions for MD013
|
|
414
|
+
- Update dependencies
|
|
415
|
+
|
|
416
|
+
## 0.0.8
|
|
417
|
+
|
|
418
|
+
- Support disabling/enabling rules inline
|
|
419
|
+
- Improve code fence
|
|
420
|
+
- Update dependencies
|
|
421
|
+
|
|
422
|
+
## 0.0.7
|
|
423
|
+
|
|
424
|
+
- Add MD041
|
|
425
|
+
- Improve MD003
|
|
426
|
+
- Ignore front matter
|
|
427
|
+
- Update dependencies
|
|
428
|
+
|
|
429
|
+
## 0.0.6
|
|
430
|
+
|
|
431
|
+
- Improve performance
|
|
432
|
+
- Simplify in-browser
|
|
433
|
+
- Update dependencies
|
|
434
|
+
|
|
435
|
+
## 0.0.5
|
|
436
|
+
|
|
437
|
+
- Add `strings` option to enable file-less scenarios
|
|
438
|
+
- Add in-browser demo
|
|
439
|
+
|
|
440
|
+
## 0.0.4
|
|
441
|
+
|
|
442
|
+
- Add tests MD033-MD040
|
|
443
|
+
- Update dependencies
|
|
444
|
+
|
|
445
|
+
## 0.0.3
|
|
446
|
+
|
|
447
|
+
- Add synchronous API
|
|
448
|
+
- Improve documentation and code
|
|
449
|
+
|
|
450
|
+
## 0.0.2
|
|
451
|
+
|
|
452
|
+
- Improve documentation, tests, and code
|
|
453
|
+
|
|
454
|
+
## 0.0.1
|
|
455
|
+
|
|
456
|
+
- Initial release
|
|
457
|
+
- Includes tests MD001-MD032
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Interested in contributing? Great! Here are some suggestions to make it a good
|
|
4
|
+
experience:
|
|
5
|
+
|
|
6
|
+
Start by [opening an issue](https://github.com/DavidAnson/markdownlint/issues),
|
|
7
|
+
whether to identify a problem or outline a change. That issue should be used to
|
|
8
|
+
discuss the situation and agree on a plan of action before writing code or
|
|
9
|
+
sending a pull request. Maybe the problem isn't really a problem, or maybe there
|
|
10
|
+
are more things to consider. If so, it's best to realize that before spending
|
|
11
|
+
time and effort writing code that may not get used.
|
|
12
|
+
|
|
13
|
+
Match the coding style of the files you edit. Although everyone has their own
|
|
14
|
+
preferences and opinions, a pull request is not the right forum to debate them.
|
|
15
|
+
|
|
16
|
+
Do not add new [`dependencies` to `package.json`][dependencies]. The Markdown
|
|
17
|
+
parsers [`markdown-it`][markdown-it] and [`micromark`][micromark] are the
|
|
18
|
+
project's only dependencies.
|
|
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 [Why I
|
|
23
|
+
pin dependency versions in Node.js packages][version-pinning] for a longer
|
|
24
|
+
explanation.)
|
|
25
|
+
|
|
26
|
+
If developing a new rule, start by creating a [custom rule][custom-rules] in its
|
|
27
|
+
own project. Once written, published, and tested in real world scenarios, open
|
|
28
|
+
an issue to consider adding it to this project. For rule ideas, see [issues
|
|
29
|
+
tagged with the `new rule` label][new-rule].
|
|
30
|
+
|
|
31
|
+
Add tests for all new/changed functionality. Test positive and negative
|
|
32
|
+
scenarios. Try to break the new code now, or else it will get broken later.
|
|
33
|
+
|
|
34
|
+
Run tests before sending a pull request via `npm test` in the [usual
|
|
35
|
+
manner][npm-scripts]. Tests should all pass on all platforms. The test runner is
|
|
36
|
+
[AVA][ava] and test cases are located in `test/markdownlint-test*.js`. When
|
|
37
|
+
running tests, `test/*.md` files are enumerated, linted, and fail if any
|
|
38
|
+
violations are missing a corresponding `{MD###}` marker in the test file. For
|
|
39
|
+
example, the line `### Heading {MD001}` is expected to trigger the rule `MD001`.
|
|
40
|
+
For cases where the marker text can not be present on the same line, the syntax
|
|
41
|
+
`{MD###:#}` can be used to include a line number. If `some-test.md` needs custom
|
|
42
|
+
configuration, a `some-test.json` is used to provide a custom `options.config`
|
|
43
|
+
for that scenario. Tests run by `markdownlint-test-scenarios.js` use [AVA's
|
|
44
|
+
snapshot feature][ava-snapshots]. To update snapshots (for example, after
|
|
45
|
+
modifying a test file), run `npm run update-snapshots` and include the updated
|
|
46
|
+
files with the pull request.
|
|
47
|
+
|
|
48
|
+
Lint before sending a pull request by running `npm run lint`. There should be no
|
|
49
|
+
issues.
|
|
50
|
+
|
|
51
|
+
Run a full continuous integration pass before sending a pull request via `npm
|
|
52
|
+
run ci`. Code coverage should always be 100%. As part of a continuous
|
|
53
|
+
integration run, generated files may get updated and fail the run - commit them
|
|
54
|
+
to the repository and rerun continuous integration.
|
|
55
|
+
|
|
56
|
+
Pull requests should contain a single commit. If necessary, squash multiple
|
|
57
|
+
commits before creating the pull request and when making changes. (See [Git
|
|
58
|
+
Tools - Rewriting History][rewriting-history] for details.)
|
|
59
|
+
|
|
60
|
+
Open pull requests against the `next` branch. That's where the latest changes
|
|
61
|
+
are staged for the next release. Include the text "(fixes #??)" at the end of
|
|
62
|
+
the commit message so the pull request will be associated with the relevant
|
|
63
|
+
issue. End commit messages with a period (`.`). Once accepted, the tag `fixed in
|
|
64
|
+
next` will be added to the issue. When the commit is merged to the main branch
|
|
65
|
+
during the release process, the issue will be closed automatically. (See
|
|
66
|
+
[Closing issues using keywords][closing-keywords] for details.)
|
|
67
|
+
|
|
68
|
+
Please refrain from using slang or meaningless placeholder words. Sample content
|
|
69
|
+
can be "text", "code", "heading", or the like. Sample URLs should use
|
|
70
|
+
[example.com][example-com] which is safe for this purpose. Profanity is not
|
|
71
|
+
allowed.
|
|
72
|
+
|
|
73
|
+
In order to maintain the permissive MIT license this project uses, all
|
|
74
|
+
contributions must be your own and released under that license. Code you add
|
|
75
|
+
should be an original work and should not be copied from elsewhere. Taking code
|
|
76
|
+
from a different project, Stack Overflow, or the like is not allowed. The use of
|
|
77
|
+
tools such as GitHub Copilot, ChatGPT, LLMs (large language models), etc. that
|
|
78
|
+
incorporate code from other projects is not allowed.
|
|
79
|
+
|
|
80
|
+
Thank you!
|
|
81
|
+
|
|
82
|
+
[ava]: https://github.com/avajs/ava
|
|
83
|
+
[ava-snapshots]: https://github.com/avajs/ava/blob/main/docs/04-snapshot-testing.md
|
|
84
|
+
[closing-keywords]: https://help.github.com/articles/closing-issues-using-keywords/
|
|
85
|
+
[custom-rules]: doc/CustomRules.md
|
|
86
|
+
[dependencies]: https://docs.npmjs.com/files/package.json#dependencies
|
|
87
|
+
[example-com]: https://en.wikipedia.org/wiki/Example.com
|
|
88
|
+
[markdown-it]: https://www.npmjs.com/package/markdown-it
|
|
89
|
+
[micromark]: https://www.npmjs.com/package/micromark
|
|
90
|
+
[new-rule]: https://github.com/DavidAnson/markdownlint/labels/new%20rule
|
|
91
|
+
[npm-scripts]: https://docs.npmjs.com/misc/scripts
|
|
92
|
+
[rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
|
|
93
|
+
[version-pinning]: https://dlaa.me/blog/post/versionpinning
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) David Anson
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|