@storm-software/markdownlint 0.13.14 → 0.14.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/README.md +1 -1
- package/config/base.markdownlint-cli2.json +31 -0
- package/config/base.markdownlint.jsonc +227 -0
- package/config/link-check.json +10 -0
- package/package.json +8 -5
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
21
21
|
|
|
22
22
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
|
|
23
23
|
|
|
24
|
-
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
25
25
|
|
|
26
26
|
<!-- prettier-ignore-start -->
|
|
27
27
|
<!-- markdownlint-disable -->
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.17.2/schema/markdownlint-cli2-config-schema.json",
|
|
3
|
+
"config": {
|
|
4
|
+
"extends": "base.markdownlint.jsonc"
|
|
5
|
+
},
|
|
6
|
+
"customRules": ["@storm-software/markdownlint/rules"],
|
|
7
|
+
"fix": true,
|
|
8
|
+
"globs": ["**/*.md", "**/*.markdown", "**/*.mdx"],
|
|
9
|
+
"ignores": [
|
|
10
|
+
"**/node_modules/**/*",
|
|
11
|
+
"**/dist/**/*",
|
|
12
|
+
"**/tmp/**/*",
|
|
13
|
+
"**/out/**/*",
|
|
14
|
+
"**/coverage/**/*",
|
|
15
|
+
"**/generated/**/*",
|
|
16
|
+
"**/__generated__/**/*",
|
|
17
|
+
"**/__tests__/**/*",
|
|
18
|
+
"**/__mocks__/**/*",
|
|
19
|
+
"**/.nx/**/*",
|
|
20
|
+
"**/.vscode/**/*",
|
|
21
|
+
"**/.github/**/*",
|
|
22
|
+
"**/.git/**/*",
|
|
23
|
+
"**/.husky/**/*",
|
|
24
|
+
"**/.yarn/**/*",
|
|
25
|
+
"**/.pnp/**/*",
|
|
26
|
+
"**/.cache/**/*",
|
|
27
|
+
"**/.next/**/*",
|
|
28
|
+
"**/.nuxt/**/*",
|
|
29
|
+
"**/.idea/**/*"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
{
|
|
2
|
+
//Be explicit by listing every available rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md
|
|
3
|
+
// Note that there will be numeric gaps, not every MD number is implemented in markdownlint.
|
|
4
|
+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.37.4/schema/markdownlint-config-schema.json",
|
|
5
|
+
|
|
6
|
+
// MD001: Header levels should only increment by one level at a time.
|
|
7
|
+
"header-increment": true,
|
|
8
|
+
|
|
9
|
+
// MD002: First header should be a top level header.
|
|
10
|
+
"first-header-h1": false,
|
|
11
|
+
|
|
12
|
+
// MD003: Header style: start with hashes.
|
|
13
|
+
"heading-style": {
|
|
14
|
+
"style": "atx"
|
|
15
|
+
},
|
|
16
|
+
|
|
17
|
+
// MD004: Unordered list style
|
|
18
|
+
"ul-style": {
|
|
19
|
+
"style": "dash"
|
|
20
|
+
},
|
|
21
|
+
|
|
22
|
+
// MD005: Consistent indentation for list items at the same level.
|
|
23
|
+
"list-indent": true,
|
|
24
|
+
|
|
25
|
+
// MD006: Consider starting bulleted lists at the beginning of the line.
|
|
26
|
+
"ul-start-left": false,
|
|
27
|
+
|
|
28
|
+
// MD007: Unordered list indentation: 2 spaces.
|
|
29
|
+
"ul-indent": {
|
|
30
|
+
"indent": 2,
|
|
31
|
+
"start_indented": true
|
|
32
|
+
},
|
|
33
|
+
|
|
34
|
+
// MD009: Disallow trailing spaces!
|
|
35
|
+
"no-trailing-spaces": {
|
|
36
|
+
"br_spaces": 0,
|
|
37
|
+
// Empty lines inside list items should not be indented.",
|
|
38
|
+
"list_item_empty_lines": false
|
|
39
|
+
},
|
|
40
|
+
|
|
41
|
+
// MD010: No hard tabs, not even in code blocks.
|
|
42
|
+
"no-hard-tabs": {
|
|
43
|
+
"code_blocks": true
|
|
44
|
+
},
|
|
45
|
+
|
|
46
|
+
// MD011: Prevent reversed link syntax
|
|
47
|
+
"no-reversed-links": true,
|
|
48
|
+
|
|
49
|
+
// MD012: Disallow multiple consecutive blank lines.
|
|
50
|
+
"no-multiple-blanks": {
|
|
51
|
+
"maximum": 1
|
|
52
|
+
},
|
|
53
|
+
|
|
54
|
+
// MD013: Line length
|
|
55
|
+
"line-length": {
|
|
56
|
+
"tables": false,
|
|
57
|
+
"code_blocks": true,
|
|
58
|
+
"headings": true,
|
|
59
|
+
"line_length": 80,
|
|
60
|
+
"heading_line_length": 80,
|
|
61
|
+
"code_block_line_length": 80
|
|
62
|
+
},
|
|
63
|
+
|
|
64
|
+
// MD014: Disallow use of dollar signs($) before commands without showing output.
|
|
65
|
+
"commands-show-output": true,
|
|
66
|
+
|
|
67
|
+
// MD018: No space after hash on atx style heading
|
|
68
|
+
"no-missing-space-atx": true,
|
|
69
|
+
|
|
70
|
+
// MD019: No multiple spaces after hash on atx style heading
|
|
71
|
+
"no-multiple-space-atx": true,
|
|
72
|
+
|
|
73
|
+
// MD020: No space inside hashes on closed atx style heading
|
|
74
|
+
"no-missing-space-closed-atx": true,
|
|
75
|
+
|
|
76
|
+
// MD021: No multiple spaces inside hashes on closed atx style heading
|
|
77
|
+
"no-multiple-space-closed-atx": true,
|
|
78
|
+
|
|
79
|
+
// MD022: Headers should be surrounded by blank lines.
|
|
80
|
+
// Some headers have preceding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers
|
|
81
|
+
"blanks-around-headers": false,
|
|
82
|
+
|
|
83
|
+
// MD023: Headers must start at the beginning of the line.
|
|
84
|
+
"header-start-left": true,
|
|
85
|
+
|
|
86
|
+
// MD024: Multiple headers with the same content
|
|
87
|
+
"no-duplicate-heading": true,
|
|
88
|
+
|
|
89
|
+
// MD025: Disallow multiple top level headers in the same document.
|
|
90
|
+
// Gotta have a matching closing brace at the end.
|
|
91
|
+
"single-h1": false,
|
|
92
|
+
|
|
93
|
+
// MD026: Disallow trailing punctuation in header.
|
|
94
|
+
// You must have a semicolon after the ending closing brace.
|
|
95
|
+
"no-trailing-punctuation": {
|
|
96
|
+
"punctuation": ".,:!?"
|
|
97
|
+
},
|
|
98
|
+
|
|
99
|
+
// MD027: Multiple spaces after blockquote symbol
|
|
100
|
+
"no-multiple-space-blockquote": true,
|
|
101
|
+
|
|
102
|
+
// MD028: Blank line inside blockquote
|
|
103
|
+
// Some 'Why?' and 'Why not?' blocks are separated by a blank line
|
|
104
|
+
"no-blanks-blockquote": false,
|
|
105
|
+
|
|
106
|
+
// MD029: Ordered list item prefix
|
|
107
|
+
"ol-prefix": {
|
|
108
|
+
"style": "one"
|
|
109
|
+
},
|
|
110
|
+
|
|
111
|
+
// MD030: Spaces after list markers
|
|
112
|
+
"list-marker-space": {
|
|
113
|
+
"ul_single": 1,
|
|
114
|
+
"ol_single": 1,
|
|
115
|
+
"ul_multi": 1,
|
|
116
|
+
"ol_multi": 1
|
|
117
|
+
},
|
|
118
|
+
|
|
119
|
+
// MD031: Fenced code blocks should be surrounded by blank lines
|
|
120
|
+
"no-empty-code-blocks": true,
|
|
121
|
+
|
|
122
|
+
// MD032: Lists should be surrounded by blank lines
|
|
123
|
+
"no-empty-lists": true,
|
|
124
|
+
|
|
125
|
+
// MD033: Inline HTML
|
|
126
|
+
"no-inline-html": false,
|
|
127
|
+
|
|
128
|
+
// MD034: Bare URL used
|
|
129
|
+
"no-bare-urls": true,
|
|
130
|
+
|
|
131
|
+
// MD035: Horizontal rule style
|
|
132
|
+
"hr-style": {
|
|
133
|
+
"style": "---"
|
|
134
|
+
},
|
|
135
|
+
|
|
136
|
+
// MD036: Do not use emphasis instead of a header.
|
|
137
|
+
"no-emphasis-as-header": false,
|
|
138
|
+
|
|
139
|
+
// MD037: Disallow spaces inside emphasis markers.
|
|
140
|
+
"no-space-in-emphasis": true,
|
|
141
|
+
|
|
142
|
+
// MD038: Disallow spaces inside code span elements.
|
|
143
|
+
"no-space-in-code": true,
|
|
144
|
+
|
|
145
|
+
// MD039: Disallow spaces inside link text.
|
|
146
|
+
"no-space-in-links": false,
|
|
147
|
+
|
|
148
|
+
// MD040: Fenced code blocks should have a language specified.
|
|
149
|
+
"fenced-code-language": true,
|
|
150
|
+
|
|
151
|
+
// MD041: First line in file should be a top level header.
|
|
152
|
+
"first-line-h1": false,
|
|
153
|
+
|
|
154
|
+
// MD042: No empty links
|
|
155
|
+
"no-empty-links": true,
|
|
156
|
+
|
|
157
|
+
// MD043: Required header structure.
|
|
158
|
+
"required-headers": false,
|
|
159
|
+
|
|
160
|
+
// MD044: Proper names should have the correct capitalization.
|
|
161
|
+
"proper-names": false,
|
|
162
|
+
|
|
163
|
+
// MD045 - Images should have alternate text (alt text)
|
|
164
|
+
"no-alt-text": false,
|
|
165
|
+
|
|
166
|
+
// MD046 - Code block style
|
|
167
|
+
"code-block-style": {
|
|
168
|
+
"style": "fenced"
|
|
169
|
+
},
|
|
170
|
+
|
|
171
|
+
// MD047 - Files should end with a single newline character
|
|
172
|
+
"single-trailing-newline": true,
|
|
173
|
+
|
|
174
|
+
// MD048 - Code fence style
|
|
175
|
+
"code-fence-style": {
|
|
176
|
+
"style": "backtick"
|
|
177
|
+
},
|
|
178
|
+
|
|
179
|
+
// MD049 - Emphasis style
|
|
180
|
+
"emphasis-style": {
|
|
181
|
+
"style": "consistent"
|
|
182
|
+
},
|
|
183
|
+
|
|
184
|
+
// MD050 - Strong style
|
|
185
|
+
"strong-style": {
|
|
186
|
+
"style": "asterisk"
|
|
187
|
+
},
|
|
188
|
+
|
|
189
|
+
// MD051 - Link fragments should be valid
|
|
190
|
+
"link-fragments": true,
|
|
191
|
+
|
|
192
|
+
// MD052 - Reference links and images should use a label that is defined
|
|
193
|
+
"reference-links-images": {
|
|
194
|
+
"shortcut_syntax": false
|
|
195
|
+
},
|
|
196
|
+
|
|
197
|
+
// MD053 - Link and image reference definitions should be needed
|
|
198
|
+
"link-image-reference-definitions": {
|
|
199
|
+
"ignored_definitions": ["//"]
|
|
200
|
+
},
|
|
201
|
+
|
|
202
|
+
// MD054 - Link and image style
|
|
203
|
+
"link-image-style": {
|
|
204
|
+
"autolink": true,
|
|
205
|
+
"collapsed": true,
|
|
206
|
+
"full": true,
|
|
207
|
+
"inline": true,
|
|
208
|
+
"shortcut": true,
|
|
209
|
+
"url_inline": true
|
|
210
|
+
},
|
|
211
|
+
|
|
212
|
+
// MD055 - Table pipe style
|
|
213
|
+
"table-pipe-style": {
|
|
214
|
+
"style": "consistent"
|
|
215
|
+
},
|
|
216
|
+
|
|
217
|
+
// MD056 - Table column count
|
|
218
|
+
"table-column-count": true,
|
|
219
|
+
|
|
220
|
+
// MD058 - Tables should be surrounded by blank lines
|
|
221
|
+
"blanks-around-tables": true,
|
|
222
|
+
|
|
223
|
+
// MD059 - Spaces inside link text
|
|
224
|
+
"spaces-around-links": {
|
|
225
|
+
"both": true
|
|
226
|
+
}
|
|
227
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-software/markdownlint",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"description": "An opinionated collection of markdownlint rules used by Storm Software.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "github",
|
|
@@ -75,13 +75,16 @@
|
|
|
75
75
|
"default": "./dist/rules/*.js"
|
|
76
76
|
}
|
|
77
77
|
},
|
|
78
|
-
"./.markdownlint.jsonc": "./config
|
|
79
|
-
"
|
|
80
|
-
"
|
|
78
|
+
"./.markdownlint.jsonc": "./config/base.markdownlint.jsonc",
|
|
79
|
+
"./base.markdownlint.jsonc": "./config/base.markdownlint.jsonc",
|
|
80
|
+
"./.markdownlint-cli2.json": "./config/base.markdownlint-cli2.json",
|
|
81
|
+
"./base.markdownlint-cli2.json": "./config/base.markdownlint-cli2.json",
|
|
82
|
+
"./markdown-link-check.json": "./config/link-check.json",
|
|
83
|
+
"./link-check.json": "./config/link-check.json",
|
|
81
84
|
"./config/*": "./config/*"
|
|
82
85
|
},
|
|
83
86
|
"types": "./dist/index.d.ts",
|
|
84
|
-
"files": ["dist/**/*"],
|
|
87
|
+
"files": ["config/**/*", "dist/**/*"],
|
|
85
88
|
"keywords": [
|
|
86
89
|
"markdownlint",
|
|
87
90
|
"markdownlint-cli",
|