eslint-plugin-markdown-preferences 0.24.0 → 0.25.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 +74 -49
- package/lib/index.d.ts +35 -1
- package/lib/index.js +996 -61
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -96,62 +96,87 @@ The rules with the following 💄 are included in the `standard` config.
|
|
|
96
96
|
|
|
97
97
|
<!-- prettier-ignore-start -->
|
|
98
98
|
|
|
99
|
-
| Rule ID
|
|
100
|
-
|
|
101
|
-
| [markdown-preferences/canonical-code-block-language](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html) | enforce canonical language names in code blocks
|
|
102
|
-
| [markdown-preferences/emoji-notation](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html)
|
|
103
|
-
| [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html)
|
|
104
|
-
| [markdown-preferences/ordered-list-marker-start](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-start.html)
|
|
105
|
-
| [markdown-preferences/prefer-inline-code-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html)
|
|
106
|
-
| [markdown-preferences/prefer-linked-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html)
|
|
107
|
-
| [markdown-preferences/table-header-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html)
|
|
99
|
+
| Rule ID | Description | Fixable | Config |
|
|
100
|
+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------- | :-----: | :----: |
|
|
101
|
+
| [markdown-preferences/canonical-code-block-language](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html) | enforce canonical language names in code blocks | 🔧 | |
|
|
102
|
+
| [markdown-preferences/emoji-notation](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html) | enforce consistent emoji notation style in Markdown files. | 🔧 | |
|
|
103
|
+
| [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html) | enforce consistent casing in headings. | 🔧 | |
|
|
104
|
+
| [markdown-preferences/ordered-list-marker-start](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-start.html) | enforce that ordered list markers start with 1 or 0 | 🔧 | 💄 |
|
|
105
|
+
| [markdown-preferences/prefer-inline-code-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html) | enforce the use of inline code for specific words. | 🔧 | |
|
|
106
|
+
| [markdown-preferences/prefer-linked-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html) | enforce the specified word to be a link. | 🔧 | |
|
|
107
|
+
| [markdown-preferences/table-header-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html) | enforce consistent casing in table header cells. | 🔧 | |
|
|
108
108
|
|
|
109
109
|
<!-- prettier-ignore-end -->
|
|
110
110
|
|
|
111
|
-
###
|
|
111
|
+
### Notation Rules
|
|
112
112
|
|
|
113
|
-
- Rules related to
|
|
113
|
+
- Rules related to notation styles in Markdown.
|
|
114
114
|
|
|
115
115
|
<!-- prettier-ignore-start -->
|
|
116
116
|
|
|
117
|
-
| Rule ID
|
|
118
|
-
|
|
119
|
-
| [markdown-preferences/
|
|
120
|
-
| [markdown-preferences/
|
|
121
|
-
| [markdown-preferences/
|
|
122
|
-
| [markdown-preferences/
|
|
123
|
-
| [markdown-preferences/
|
|
124
|
-
| [markdown-preferences/
|
|
125
|
-
| [markdown-preferences/
|
|
126
|
-
| [markdown-preferences/
|
|
127
|
-
| [markdown-preferences/
|
|
128
|
-
| [markdown-preferences/
|
|
129
|
-
| [markdown-preferences/
|
|
130
|
-
| [markdown-preferences/
|
|
131
|
-
| [markdown-preferences/
|
|
132
|
-
| [markdown-preferences/link-
|
|
133
|
-
| [markdown-preferences/
|
|
134
|
-
| [markdown-preferences/
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
| [markdown-preferences/
|
|
147
|
-
| [markdown-preferences/
|
|
148
|
-
| [markdown-preferences/
|
|
149
|
-
| [markdown-preferences/
|
|
150
|
-
| [markdown-preferences/
|
|
151
|
-
| [markdown-preferences/
|
|
152
|
-
| [markdown-preferences/
|
|
153
|
-
| [markdown-preferences/
|
|
154
|
-
| [markdown-preferences/
|
|
117
|
+
| Rule ID | Description | Fixable | Config |
|
|
118
|
+
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- | :-----: | :----: |
|
|
119
|
+
| [markdown-preferences/bullet-list-marker-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/bullet-list-marker-style.html) | enforce consistent bullet list (unordered list) marker style | 🔧 | 💄 |
|
|
120
|
+
| [markdown-preferences/code-fence-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-style.html) | enforce a consistent code fence style (backtick or tilde) in Markdown fenced code blocks. | 🔧 | 💄 |
|
|
121
|
+
| [markdown-preferences/definitions-last](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html) | require link definitions and footnote definitions to be placed at the end of the document | 🔧 | |
|
|
122
|
+
| [markdown-preferences/emphasis-delimiters-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emphasis-delimiters-style.html) | enforce a consistent delimiter style for emphasis and strong emphasis | 🔧 | 💄 |
|
|
123
|
+
| [markdown-preferences/hard-linebreak-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html) | enforce consistent hard linebreak style. | 🔧 | ⭐💄 |
|
|
124
|
+
| [markdown-preferences/level1-heading-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/level1-heading-style.html) | enforce consistent style for level 1 headings | 🔧 | 💄 |
|
|
125
|
+
| [markdown-preferences/level2-heading-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/level2-heading-style.html) | enforce consistent style for level 2 headings | 🔧 | 💄 |
|
|
126
|
+
| [markdown-preferences/link-destination-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-destination-style.html) | enforce a consistent style for link destinations | 🔧 | 💄 |
|
|
127
|
+
| [markdown-preferences/link-title-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-title-style.html) | enforce a consistent style for link titles | 🔧 | 💄 |
|
|
128
|
+
| [markdown-preferences/no-text-backslash-linebreak](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-text-backslash-linebreak.html) | disallow text backslash at the end of a line. | | ⭐💄 |
|
|
129
|
+
| [markdown-preferences/ordered-list-marker-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-style.html) | enforce consistent ordered list marker style | 🔧 | 💄 |
|
|
130
|
+
| [markdown-preferences/prefer-autolinks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-autolinks.html) | enforce the use of autolinks for URLs | 🔧 | ⭐💄 |
|
|
131
|
+
| [markdown-preferences/prefer-fenced-code-blocks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-fenced-code-blocks.html) | enforce the use of fenced code blocks over indented code blocks | 🔧 | ⭐💄 |
|
|
132
|
+
| [markdown-preferences/prefer-link-reference-definitions](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-link-reference-definitions.html) | enforce using link reference definitions instead of inline links | 🔧 | |
|
|
133
|
+
| [markdown-preferences/strikethrough-delimiters-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/strikethrough-delimiters-style.html) | enforce a consistent delimiter style for strikethrough | 🔧 | 💄 |
|
|
134
|
+
| [markdown-preferences/thematic-break-character-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-character-style.html) | enforce consistent character style for thematic breaks (horizontal rules) in Markdown. | 🔧 | 💄 |
|
|
135
|
+
|
|
136
|
+
<!-- prettier-ignore-end -->
|
|
137
|
+
|
|
138
|
+
### Whitespace Rules
|
|
139
|
+
|
|
140
|
+
- Rules related to whitespace styles in Markdown.
|
|
141
|
+
|
|
142
|
+
<!-- prettier-ignore-start -->
|
|
143
|
+
|
|
144
|
+
| Rule ID | Description | Fixable | Config |
|
|
145
|
+
| :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------- | :-----: | :----: |
|
|
146
|
+
| [markdown-preferences/blockquote-marker-alignment](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/blockquote-marker-alignment.html) | enforce consistent alignment of blockquote markers | 🔧 | ⭐💄 |
|
|
147
|
+
| [markdown-preferences/indent](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/indent.html) | enforce consistent indentation in Markdown files | 🔧 | 💄 |
|
|
148
|
+
| [markdown-preferences/link-bracket-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-newline.html) | enforce linebreaks after opening and before closing link brackets | 🔧 | 💄 |
|
|
149
|
+
| [markdown-preferences/link-bracket-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-bracket-spacing.html) | enforce consistent spacing inside link brackets | 🔧 | 💄 |
|
|
150
|
+
| [markdown-preferences/link-paren-newline](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-newline.html) | enforce linebreaks after opening and before closing link parentheses | 🔧 | 💄 |
|
|
151
|
+
| [markdown-preferences/link-paren-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-paren-spacing.html) | enforce consistent spacing inside link parentheses | 🔧 | 💄 |
|
|
152
|
+
| [markdown-preferences/list-marker-alignment](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/list-marker-alignment.html) | enforce consistent alignment of list markers | 🔧 | ⭐💄 |
|
|
153
|
+
| [markdown-preferences/no-multi-spaces](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multi-spaces.html) | disallow multiple spaces | 🔧 | 💄 |
|
|
154
|
+
| [markdown-preferences/no-multiple-empty-lines](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multiple-empty-lines.html) | disallow multiple empty lines in Markdown files. | 🔧 | 💄 |
|
|
155
|
+
| [markdown-preferences/no-trailing-spaces](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-trailing-spaces.html) | disallow trailing whitespace at the end of lines in Markdown files. | 🔧 | 💄 |
|
|
156
|
+
| [markdown-preferences/padding-line-between-blocks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/padding-line-between-blocks.html) | require or disallow padding lines between blocks | 🔧 | 💄 |
|
|
157
|
+
| [markdown-preferences/table-pipe-spacing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-spacing.html) | enforce consistent spacing around table pipes | 🔧 | 💄 |
|
|
158
|
+
|
|
159
|
+
<!-- prettier-ignore-end -->
|
|
160
|
+
|
|
161
|
+
### Decorative Rules
|
|
162
|
+
|
|
163
|
+
- Rules related to visual or stylistic decorations in Markdown.
|
|
164
|
+
|
|
165
|
+
<!-- prettier-ignore-start -->
|
|
166
|
+
|
|
167
|
+
| Rule ID | Description | Fixable | Config |
|
|
168
|
+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------- | :-----: | :----: |
|
|
169
|
+
| [markdown-preferences/atx-heading-closing-sequence-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-heading-closing-sequence-length.html) | enforce consistent length for the closing sequence (trailing #s) in ATX headings. | 🔧 | 💄 |
|
|
170
|
+
| [markdown-preferences/atx-heading-closing-sequence](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-heading-closing-sequence.html) | enforce consistent use of closing sequence in ATX headings. | 🔧 | 💄 |
|
|
171
|
+
| [markdown-preferences/code-fence-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/code-fence-length.html) | enforce consistent code fence length in fenced code blocks. | 🔧 | 💄 |
|
|
172
|
+
| [markdown-preferences/no-laziness-blockquotes](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-laziness-blockquotes.html) | disallow laziness in blockquotes | | ⭐💄 |
|
|
173
|
+
| [markdown-preferences/ordered-list-marker-sequence](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-sequence.html) | enforce that ordered list markers use sequential numbers | 🔧 | 💄 |
|
|
174
|
+
| [markdown-preferences/setext-heading-underline-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/setext-heading-underline-length.html) | enforce setext heading underline length | 🔧 | 💄 |
|
|
175
|
+
| [markdown-preferences/sort-definitions](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/sort-definitions.html) | enforce a specific order for link definitions and footnote definitions | 🔧 | 💄 |
|
|
176
|
+
| [markdown-preferences/table-leading-trailing-pipes](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-leading-trailing-pipes.html) | enforce consistent use of leading and trailing pipes in tables. | 🔧 | 💄 |
|
|
177
|
+
| [markdown-preferences/table-pipe-alignment](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-alignment.html) | enforce consistent alignment of table pipes | 🔧 | 💄 |
|
|
178
|
+
| [markdown-preferences/thematic-break-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-length.html) | enforce consistent length for thematic breaks (horizontal rules) in Markdown. | 🔧 | 💄 |
|
|
179
|
+
| [markdown-preferences/thematic-break-sequence-pattern](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-sequence-pattern.html) | enforce consistent repeating patterns for thematic breaks (horizontal rules) in Markdown. | 🔧 | 💄 |
|
|
155
180
|
|
|
156
181
|
<!-- prettier-ignore-end -->
|
|
157
182
|
|
package/lib/index.d.ts
CHANGED
|
@@ -210,6 +210,21 @@ interface RuleOptions {
|
|
|
210
210
|
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html
|
|
211
211
|
*/
|
|
212
212
|
'markdown-preferences/table-header-casing'?: Linter.RuleEntry<MarkdownPreferencesTableHeaderCasing>;
|
|
213
|
+
/**
|
|
214
|
+
* enforce consistent use of leading and trailing pipes in tables.
|
|
215
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-leading-trailing-pipes.html
|
|
216
|
+
*/
|
|
217
|
+
'markdown-preferences/table-leading-trailing-pipes'?: Linter.RuleEntry<MarkdownPreferencesTableLeadingTrailingPipes>;
|
|
218
|
+
/**
|
|
219
|
+
* enforce consistent alignment of table pipes
|
|
220
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-alignment.html
|
|
221
|
+
*/
|
|
222
|
+
'markdown-preferences/table-pipe-alignment'?: Linter.RuleEntry<MarkdownPreferencesTablePipeAlignment>;
|
|
223
|
+
/**
|
|
224
|
+
* enforce consistent spacing around table pipes
|
|
225
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-pipe-spacing.html
|
|
226
|
+
*/
|
|
227
|
+
'markdown-preferences/table-pipe-spacing'?: Linter.RuleEntry<MarkdownPreferencesTablePipeSpacing>;
|
|
213
228
|
/**
|
|
214
229
|
* enforce consistent character style for thematic breaks (horizontal rules) in Markdown.
|
|
215
230
|
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/thematic-break-character-style.html
|
|
@@ -413,6 +428,25 @@ type MarkdownPreferencesTableHeaderCasing = [] | [{
|
|
|
413
428
|
ignorePatterns?: string[];
|
|
414
429
|
minorWords?: string[];
|
|
415
430
|
}];
|
|
431
|
+
type MarkdownPreferencesTableLeadingTrailingPipes = [] | [(("always" | "never") | {
|
|
432
|
+
leading?: ("always" | "never");
|
|
433
|
+
trailing?: ("always" | "never");
|
|
434
|
+
})];
|
|
435
|
+
type MarkdownPreferencesTablePipeAlignment = [] | [{
|
|
436
|
+
column?: ("minimum" | "consistent");
|
|
437
|
+
}];
|
|
438
|
+
type MarkdownPreferencesTablePipeSpacing = [] | [{
|
|
439
|
+
space?: (("always" | "never") | {
|
|
440
|
+
leading?: ("always" | "never");
|
|
441
|
+
trailing?: ("always" | "never");
|
|
442
|
+
});
|
|
443
|
+
cellAlign?: (("left" | "center" | "right") | {
|
|
444
|
+
defaultDelimiter?: ("left" | "center" | "right" | "ignore");
|
|
445
|
+
leftAlignmentDelimiter?: ("left" | "center" | "right" | "ignore");
|
|
446
|
+
centerAlignmentDelimiter?: ("left" | "center" | "right" | "ignore");
|
|
447
|
+
rightAlignmentDelimiter?: ("left" | "center" | "right" | "ignore");
|
|
448
|
+
});
|
|
449
|
+
}];
|
|
416
450
|
type MarkdownPreferencesThematicBreakCharacterStyle = [] | [{
|
|
417
451
|
style?: ("-" | "*" | "_");
|
|
418
452
|
}];
|
|
@@ -454,7 +488,7 @@ declare namespace meta_d_exports {
|
|
|
454
488
|
export { name, version };
|
|
455
489
|
}
|
|
456
490
|
declare const name: "eslint-plugin-markdown-preferences";
|
|
457
|
-
declare const version: "0.
|
|
491
|
+
declare const version: "0.25.0";
|
|
458
492
|
//#endregion
|
|
459
493
|
//#region src/index.d.ts
|
|
460
494
|
declare const configs: {
|