eslint-plugin-markdown-preferences 0.12.0 → 0.13.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 +3 -0
- package/lib/index.d.ts +28 -1
- package/lib/index.js +2524 -192
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -93,6 +93,7 @@ The rules with the following star ⭐ are included in the configs.
|
|
|
93
93
|
| Rule ID | Description | Fixable | RECOMMENDED |
|
|
94
94
|
|:--------|:------------|:-------:|:-----------:|
|
|
95
95
|
| [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 | 🔧 | |
|
|
96
|
+
| [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. | 🔧 | |
|
|
96
97
|
| [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html) | enforce consistent casing in headings. | 🔧 | |
|
|
97
98
|
| [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. | | ⭐ |
|
|
98
99
|
| [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 | 🔧 | |
|
|
@@ -103,6 +104,8 @@ The rules with the following star ⭐ are included in the configs.
|
|
|
103
104
|
|
|
104
105
|
| Rule ID | Description | Fixable | RECOMMENDED |
|
|
105
106
|
|:--------|:------------|:-------:|:-----------:|
|
|
107
|
+
| [markdown-preferences/atx-headings-closing-sequence-length](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence-length.html) | enforce consistent length for the closing sequence (trailing #s) in ATX headings. | 🔧 | |
|
|
108
|
+
| [markdown-preferences/atx-headings-closing-sequence](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence.html) | enforce consistent use of closing sequence in ATX headings. | 🔧 | |
|
|
106
109
|
| [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 | 🔧 | |
|
|
107
110
|
| [markdown-preferences/hard-linebreak-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html) | enforce consistent hard linebreak style. | 🔧 | ⭐ |
|
|
108
111
|
| [markdown-preferences/no-laziness-blockquotes](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-laziness-blockquotes.html) | disallow laziness in blockquotes | | ⭐ |
|
package/lib/index.d.ts
CHANGED
|
@@ -10,6 +10,16 @@ declare module 'eslint' {
|
|
|
10
10
|
}
|
|
11
11
|
}
|
|
12
12
|
interface RuleOptions {
|
|
13
|
+
/**
|
|
14
|
+
* enforce consistent use of closing sequence in ATX headings.
|
|
15
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence.html
|
|
16
|
+
*/
|
|
17
|
+
'markdown-preferences/atx-headings-closing-sequence'?: Linter.RuleEntry<MarkdownPreferencesAtxHeadingsClosingSequence>;
|
|
18
|
+
/**
|
|
19
|
+
* enforce consistent length for the closing sequence (trailing #s) in ATX headings.
|
|
20
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence-length.html
|
|
21
|
+
*/
|
|
22
|
+
'markdown-preferences/atx-headings-closing-sequence-length'?: Linter.RuleEntry<MarkdownPreferencesAtxHeadingsClosingSequenceLength>;
|
|
13
23
|
/**
|
|
14
24
|
* enforce canonical language names in code blocks
|
|
15
25
|
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html
|
|
@@ -20,6 +30,11 @@ interface RuleOptions {
|
|
|
20
30
|
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html
|
|
21
31
|
*/
|
|
22
32
|
'markdown-preferences/definitions-last'?: Linter.RuleEntry<[]>;
|
|
33
|
+
/**
|
|
34
|
+
* Enforce consistent emoji notation style in Markdown files.
|
|
35
|
+
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html
|
|
36
|
+
*/
|
|
37
|
+
'markdown-preferences/emoji-notation'?: Linter.RuleEntry<MarkdownPreferencesEmojiNotation>;
|
|
23
38
|
/**
|
|
24
39
|
* enforce consistent hard linebreak style.
|
|
25
40
|
* @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
|
|
@@ -91,11 +106,23 @@ interface RuleOptions {
|
|
|
91
106
|
*/
|
|
92
107
|
'markdown-preferences/sort-definitions'?: Linter.RuleEntry<MarkdownPreferencesSortDefinitions>;
|
|
93
108
|
}
|
|
109
|
+
type MarkdownPreferencesAtxHeadingsClosingSequence = [] | [{
|
|
110
|
+
closingSequence?: ("always" | "never");
|
|
111
|
+
}];
|
|
112
|
+
type MarkdownPreferencesAtxHeadingsClosingSequenceLength = [] | [{
|
|
113
|
+
mode?: ("match-opening" | "length" | "consistent" | "consistent-line-length" | "fixed-line-length");
|
|
114
|
+
length?: number;
|
|
115
|
+
}];
|
|
94
116
|
type MarkdownPreferencesCanonicalCodeBlockLanguage = [] | [{
|
|
95
117
|
languages?: {
|
|
96
118
|
[k: string]: string;
|
|
97
119
|
};
|
|
98
120
|
}];
|
|
121
|
+
type MarkdownPreferencesEmojiNotation = [] | [{
|
|
122
|
+
prefer?: ("unicode" | "colon");
|
|
123
|
+
ignoreUnknown?: boolean;
|
|
124
|
+
ignoreList?: string[];
|
|
125
|
+
}];
|
|
99
126
|
type MarkdownPreferencesHardLinebreakStyle = [] | [{
|
|
100
127
|
style?: ("backslash" | "spaces");
|
|
101
128
|
}];
|
|
@@ -169,7 +196,7 @@ declare namespace meta_d_exports {
|
|
|
169
196
|
export { name, version };
|
|
170
197
|
}
|
|
171
198
|
declare const name: "eslint-plugin-markdown-preferences";
|
|
172
|
-
declare const version: "0.
|
|
199
|
+
declare const version: "0.13.0";
|
|
173
200
|
//#endregion
|
|
174
201
|
//#region src/index.d.ts
|
|
175
202
|
declare const configs: {
|