@storm-software/markdownlint 0.9.0 β 0.11.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/.markdownlint.json +155 -0
- package/CHANGELOG.md +16 -0
- package/README.md +35 -11
- package/package.json +1 -1
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
{
|
|
2
|
+
"comment": "Be explicit by listing every available rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md",
|
|
3
|
+
"comment": "Note that there will be numeric gaps, not every MD number is implemented in markdownlint.",
|
|
4
|
+
|
|
5
|
+
"comment": "MD001: Header levels should only increment by one level at a time.",
|
|
6
|
+
"header-increment": true,
|
|
7
|
+
|
|
8
|
+
"comment": "MD002: First header should be a top level header.",
|
|
9
|
+
"first-header-h1": true,
|
|
10
|
+
|
|
11
|
+
"comment": "MD003: Header style: start with hashes.",
|
|
12
|
+
"header-style": {
|
|
13
|
+
"style": "atx"
|
|
14
|
+
},
|
|
15
|
+
|
|
16
|
+
"comment": "MD004: Unordered list style",
|
|
17
|
+
"ul-style": {
|
|
18
|
+
"style": "dash"
|
|
19
|
+
},
|
|
20
|
+
|
|
21
|
+
"comment": "MD005: Consistent indentation for list items at the same level.",
|
|
22
|
+
"list-indent": true,
|
|
23
|
+
|
|
24
|
+
"comment": "MD006: Consider starting bulleted lists at the beginning of the line.",
|
|
25
|
+
"ul-start-left": false,
|
|
26
|
+
|
|
27
|
+
"comment": "MD007: Unordered list indentation: 2 spaces.",
|
|
28
|
+
"ul-indent": {
|
|
29
|
+
"indent": 2,
|
|
30
|
+
"start_indented": true
|
|
31
|
+
},
|
|
32
|
+
|
|
33
|
+
"comment": "MD009: Disallow trailing spaces!",
|
|
34
|
+
"no-trailing-spaces": {
|
|
35
|
+
"br_spaces": 0,
|
|
36
|
+
"comment": "Empty lines inside list items should not be indented.",
|
|
37
|
+
"list_item_empty_lines": false
|
|
38
|
+
},
|
|
39
|
+
|
|
40
|
+
"comment": "MD010: No hard tabs, not even in code blocks.",
|
|
41
|
+
"no-hard-tabs": {
|
|
42
|
+
"code_blocks": true
|
|
43
|
+
},
|
|
44
|
+
|
|
45
|
+
"comment": "MD011: Prevent reversed link syntax",
|
|
46
|
+
"no-reversed-links": true,
|
|
47
|
+
|
|
48
|
+
"comment": "MD012: Disallow multiple consecutive blank lines.",
|
|
49
|
+
"no-multiple-blanks": {
|
|
50
|
+
"maximum": 1
|
|
51
|
+
},
|
|
52
|
+
|
|
53
|
+
"comment": "MD013: Line length",
|
|
54
|
+
"line-length": false,
|
|
55
|
+
|
|
56
|
+
"comment": "MD014: Disallow use of dollar signs($) before commands without showing output.",
|
|
57
|
+
"commands-show-output": true,
|
|
58
|
+
|
|
59
|
+
"comment": "MD018: Disallow space after hash on atx style header.",
|
|
60
|
+
"no-missing-space-atx": true,
|
|
61
|
+
|
|
62
|
+
"comment": "MD019: Disallow multiple spaces after hash on atx style header.",
|
|
63
|
+
"no-multiple-space-atx": true,
|
|
64
|
+
|
|
65
|
+
"comment": "MD020: No space should be inside hashes on closed atx style header.",
|
|
66
|
+
"no-missing-space-closed-atx": true,
|
|
67
|
+
|
|
68
|
+
"comment": "MD021: Disallow multiple spaces inside hashes on closed atx style header.",
|
|
69
|
+
"no-multiple-space-closed-atx": true,
|
|
70
|
+
|
|
71
|
+
"comment": "MD022: Headers should be surrounded by blank lines.",
|
|
72
|
+
"comment": "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",
|
|
73
|
+
"blanks-around-headers": false,
|
|
74
|
+
|
|
75
|
+
"comment": "MD023: Headers must start at the beginning of the line.",
|
|
76
|
+
"header-start-left": true,
|
|
77
|
+
|
|
78
|
+
"comment": "MD024: Disallow multiple headers with the same content.",
|
|
79
|
+
"no-duplicate-header": true,
|
|
80
|
+
|
|
81
|
+
"comment": "MD025: Disallow multiple top level headers in the same document.",
|
|
82
|
+
"comment": "Gotta have a matching closing brace at the end.",
|
|
83
|
+
"single-h1": false,
|
|
84
|
+
|
|
85
|
+
"comment": "MD026: Disallow trailing punctuation in header.",
|
|
86
|
+
"comment": "You must have a semicolon after the ending closing brace.",
|
|
87
|
+
"no-trailing-punctuation": {
|
|
88
|
+
"punctuation": ".,:!?"
|
|
89
|
+
},
|
|
90
|
+
"comment": "MD027: Dissalow multiple spaces after blockquote symbol",
|
|
91
|
+
"no-multiple-space-blockquote": true,
|
|
92
|
+
|
|
93
|
+
"comment": "MD028: Blank line inside blockquote",
|
|
94
|
+
"comment": "Some 'Why?' and 'Why not?' blocks are separated by a blank line",
|
|
95
|
+
"no-blanks-blockquote": false,
|
|
96
|
+
|
|
97
|
+
"comment": "MD029: Ordered list item prefix",
|
|
98
|
+
"ol-prefix": {
|
|
99
|
+
"style": "one"
|
|
100
|
+
},
|
|
101
|
+
|
|
102
|
+
"comment": "MD030: Spaces after list markers",
|
|
103
|
+
"list-marker-space": {
|
|
104
|
+
"ul_single": 1,
|
|
105
|
+
"ol_single": 1,
|
|
106
|
+
"ul_multi": 1,
|
|
107
|
+
"ol_multi": 1
|
|
108
|
+
},
|
|
109
|
+
|
|
110
|
+
"comment": "MD031: Fenced code blocks should be surrounded by blank lines",
|
|
111
|
+
"blanks-around-fences": true,
|
|
112
|
+
|
|
113
|
+
"comment": "MD032: Lists should be surrounded by blank lines",
|
|
114
|
+
"comment": "Some lists have preceding HTML anchors. Unfortunate that we have to disable this, as it otherwise catches a real problem that trips up some Markdown renderers",
|
|
115
|
+
"blanks-around-lists": false,
|
|
116
|
+
|
|
117
|
+
"comment": "MD033: Disallow inline HTML",
|
|
118
|
+
"comment": "HTML is needed for explicit anchors",
|
|
119
|
+
"no-inline-html": false,
|
|
120
|
+
|
|
121
|
+
"comment": "MD034: No bare URLs should be used",
|
|
122
|
+
"no-bare-urls": true,
|
|
123
|
+
|
|
124
|
+
"comment": "MD035: Horizontal rule style",
|
|
125
|
+
"hr-style": {
|
|
126
|
+
"style": "consistent"
|
|
127
|
+
},
|
|
128
|
+
|
|
129
|
+
"comment": "MD036: Do not use emphasis instead of a header.",
|
|
130
|
+
"no-emphasis-as-header": false,
|
|
131
|
+
|
|
132
|
+
"comment": "MD037: Disallow spaces inside emphasis markers.",
|
|
133
|
+
"no-space-in-emphasis": true,
|
|
134
|
+
|
|
135
|
+
"comment": "MD038: Disallow spaces inside code span elements.",
|
|
136
|
+
"no-space-in-code": true,
|
|
137
|
+
|
|
138
|
+
"comment": "MD039: Disallow spaces inside link text.",
|
|
139
|
+
"no-space-in-links": true,
|
|
140
|
+
|
|
141
|
+
"comment": "MD040: Fenced code blocks should have a language specified.",
|
|
142
|
+
"fenced-code-language": true,
|
|
143
|
+
|
|
144
|
+
"comment": "MD041: First line in file should be a top level header.",
|
|
145
|
+
"first-line-h1": true,
|
|
146
|
+
|
|
147
|
+
"comment": "MD042: No empty links",
|
|
148
|
+
"no-empty-links": true,
|
|
149
|
+
|
|
150
|
+
"comment": "MD043: Required header structure.",
|
|
151
|
+
"required-headers": false,
|
|
152
|
+
|
|
153
|
+
"comment": "MD044: Proper names should have the correct capitalization.",
|
|
154
|
+
"proper-names": false
|
|
155
|
+
}
|
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,19 @@
|
|
|
1
|
+
## 0.11.0 (2024-07-17)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### π Features
|
|
5
|
+
|
|
6
|
+
- **git-tools:** Added README header template to include table of contents ([6841042e](https://github.com/storm-software/storm-ops/commit/6841042e))
|
|
7
|
+
|
|
8
|
+
## 0.10.0 (2024-07-14)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### π Features
|
|
12
|
+
|
|
13
|
+
- **markdownlint:** Added markdownlint v1 json configuration ([9fbd4fd0](https://github.com/storm-software/storm-ops/commit/9fbd4fd0))
|
|
14
|
+
|
|
15
|
+
- **markdownlint:** Ensure markdownlint.json is included in package ([ddc5639b](https://github.com/storm-software/storm-ops/commit/ddc5639b))
|
|
16
|
+
|
|
1
17
|
## 0.9.0 (2024-06-22)
|
|
2
18
|
|
|
3
19
|
|
package/README.md
CHANGED
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
<div align="center">
|
|
10
10
|
<b>
|
|
11
|
-
<a href="https://stormsoftware.com" target="_blank">Website</a> β’
|
|
12
|
-
<a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> β’
|
|
13
|
-
<a href="https://discord.gg/MQ6YVzakM5">Discord</a> β’ <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> β’ <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> β’
|
|
11
|
+
<a href="https://stormsoftware.com" target="_blank">Website</a> β’
|
|
12
|
+
<a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> β’
|
|
13
|
+
<a href="https://discord.gg/MQ6YVzakM5">Discord</a> β’ <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> β’ <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> β’
|
|
14
14
|
<a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
|
|
15
15
|
</b>
|
|
16
16
|
</div>
|
|
@@ -21,14 +21,43 @@ 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
|
-
[](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://docusaurus.io/) 
|
|
24
|
+
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
<!-- prettier-ignore-start -->
|
|
27
|
+
<!-- markdownlint-disable -->
|
|
28
|
+
|
|
29
|
+
> [!IMPORTANT]
|
|
28
30
|
> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
|
|
29
31
|
|
|
32
|
+
<!-- markdownlint-restore -->
|
|
33
|
+
<!-- prettier-ignore-end -->
|
|
34
|
+
|
|
35
|
+
<div align="center">
|
|
36
|
+
<b>Be sure to β this repository on <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
30
39
|
<br />
|
|
31
40
|
|
|
41
|
+
<!-- START doctoc -->
|
|
42
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
43
|
+
## Table of Contents
|
|
44
|
+
|
|
45
|
+
- [Storm Markdownlint Rules](#storm-markdownlint-rules)
|
|
46
|
+
- [Installing](#installing)
|
|
47
|
+
- [Building](#building)
|
|
48
|
+
- [Running unit tests](#running-unit-tests)
|
|
49
|
+
- [Storm Workspaces](#storm-workspaces)
|
|
50
|
+
- [Roadmap](#roadmap)
|
|
51
|
+
- [Support](#support)
|
|
52
|
+
- [License](#license)
|
|
53
|
+
- [Changelog](#changelog)
|
|
54
|
+
- [Contributing](#contributing)
|
|
55
|
+
- [Contributors](#contributors)
|
|
56
|
+
- [π» Visit stormsoftware.com to stay up to date with this developer](#-visit-stormsoftwarecom-to-stay-up-to-date-with-this-developer)
|
|
57
|
+
|
|
58
|
+
<!-- END doctoc -->
|
|
59
|
+
|
|
60
|
+
<br />
|
|
32
61
|
|
|
33
62
|
<!-- markdownlint-restore -->
|
|
34
63
|
<!-- prettier-ignore-end -->
|
|
@@ -42,11 +71,6 @@ package includes the rules used by GitHub in the
|
|
|
42
71
|
[markdownlint-github](https://github.com/github/markdownlint-github) package, as
|
|
43
72
|
well as additional rules that are specific to Storm Software.
|
|
44
73
|
|
|
45
|
-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
46
|
-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
47
|
-
|
|
48
|
-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
49
|
-
|
|
50
74
|
## Installing
|
|
51
75
|
|
|
52
76
|
Using [pnpm](http://pnpm.io):
|