eslint-plugin-markdown-preferences 0.12.0 → 0.14.0

package/README.md

@@ -29,7 +29,7 @@ For detailed usage instructions, rule configurations, and examples, visit our co
 ## 💿 Installation
 
 ```sh
-npm install --save-dev eslint eslint-plugin-markdown-preferences
+npm install --save-dev eslint @eslint/markdown eslint-plugin-markdown-preferences
 ```
 
 <!--DOCS_IGNORE_END-->
@@ -90,23 +90,31 @@ The rules with the following star ⭐ are included in the configs.
 
 ### Preference Rules
 
+- Rules to unify the expression and description style of documents.
+
 | Rule ID | Description | Fixable | RECOMMENDED |
 |:--------|:------------|:-------:|:-----------:|
 | [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 | 🔧 |  |
+| [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. | 🔧 |  |
 | [markdown-preferences/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html) | enforce consistent casing in headings. | 🔧 |  |
-| [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. |  | ⭐ |
 | [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 | 🔧 |  |
 | [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. | 🔧 |  |
 | [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. | 🔧 |  |
+| [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. | 🔧 |  |
 
 ### Stylistic Rules
 
+- Rules related to the formatting and visual style of Markdown.
+
 | Rule ID | Description | Fixable | RECOMMENDED |
 |:--------|:------------|:-------:|:-----------:|
+| [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. | 🔧 |  |
+| [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. | 🔧 |  |
 | [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 | 🔧 |  |
 | [markdown-preferences/hard-linebreak-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html) | enforce consistent hard linebreak style. | 🔧 | ⭐ |
 | [markdown-preferences/no-laziness-blockquotes](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-laziness-blockquotes.html) | disallow laziness in blockquotes |  | ⭐ |
 | [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. | 🔧 |  |
+| [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. |  | ⭐ |
 | [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. | 🔧 |  |
 | [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 | 🔧 |  |
 | [markdown-preferences/prefer-autolinks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-autolinks.html) | enforce the use of autolinks for URLs | 🔧 | ⭐ |

package/lib/index.d.ts

@@ -10,6 +10,16 @@ declare module 'eslint' {
   }
 }
 interface RuleOptions {
+  /**
+   * enforce consistent use of closing sequence in ATX headings.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence.html
+   */
+  'markdown-preferences/atx-headings-closing-sequence'?: Linter.RuleEntry<MarkdownPreferencesAtxHeadingsClosingSequence>;
+  /**
+   * enforce consistent length for the closing sequence (trailing #s) in ATX headings.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/atx-headings-closing-sequence-length.html
+   */
+  'markdown-preferences/atx-headings-closing-sequence-length'?: Linter.RuleEntry<MarkdownPreferencesAtxHeadingsClosingSequenceLength>;
   /**
    * enforce canonical language names in code blocks
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html
@@ -20,6 +30,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html
    */
   'markdown-preferences/definitions-last'?: Linter.RuleEntry<[]>;
+  /**
+   * enforce consistent emoji notation style in Markdown files.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/emoji-notation.html
+   */
+  'markdown-preferences/emoji-notation'?: Linter.RuleEntry<MarkdownPreferencesEmojiNotation>;
   /**
    * enforce consistent hard linebreak style.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
@@ -90,12 +105,29 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/sort-definitions.html
    */
   'markdown-preferences/sort-definitions'?: Linter.RuleEntry<MarkdownPreferencesSortDefinitions>;
+  /**
+   * enforce consistent casing in table header cells.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/table-header-casing.html
+   */
+  'markdown-preferences/table-header-casing'?: Linter.RuleEntry<MarkdownPreferencesTableHeaderCasing>;
 }
+type MarkdownPreferencesAtxHeadingsClosingSequence = [] | [{
+  closingSequence?: ("always" | "never");
+}];
+type MarkdownPreferencesAtxHeadingsClosingSequenceLength = [] | [{
+  mode?: ("match-opening" | "length" | "consistent" | "consistent-line-length" | "fixed-line-length");
+  length?: number;
+}];
 type MarkdownPreferencesCanonicalCodeBlockLanguage = [] | [{
   languages?: {
     [k: string]: string;
   };
 }];
+type MarkdownPreferencesEmojiNotation = [] | [{
+  prefer?: ("unicode" | "colon");
+  ignoreUnknown?: boolean;
+  ignoreList?: string[];
+}];
 type MarkdownPreferencesHardLinebreakStyle = [] | [{
   style?: ("backslash" | "spaces");
 }];
@@ -151,6 +183,12 @@ type MarkdownPreferencesSortDefinitions = [] | [{
   })[];
   alphabetical?: boolean;
 }];
+type MarkdownPreferencesTableHeaderCasing = [] | [{
+  style?: ("Title Case" | "Sentence case");
+  preserveWords?: string[];
+  ignorePatterns?: string[];
+  minorWords?: string[];
+}];
 declare namespace recommended_d_exports {
   export { files, language, languageOptions, name$1 as name, plugins, rules$1 as rules };
 }
@@ -169,7 +207,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.12.0";
+declare const version: "0.14.0";
 //#endregion
 //#region src/index.d.ts
 declare const configs: {