eslint-plugin-markdown-preferences 0.7.0 → 0.9.0

package/README.md

@@ -13,10 +13,10 @@ A specialized ESLint plugin that helps enforce consistent writing style and form
 
 ## 📛 Features
 
-- **🔧 Auto-fixable rules** - Automatically format your Markdown files to match your style preferences
-- **📝 Line break consistency** - Enforce consistent hard line break styles (backslash `\` vs trailing spaces)
-- **🔗 Link enforcement** - Ensure specific words or terms are properly linked to their documentation
-- **🎯 Customizable** - Configure rules to match your team's specific requirements
+- **⚡ Effortless automation** - Transform your Markdown with auto-fixing that handles formatting, linking, and style consistency automatically
+- **📖 Professional documentation** - Enforce consistent line breaks, clean up trailing spaces, and organize link definitions for enterprise-ready documentation
+- **🎯 Smart terminology management** - Automatically convert specified words into inline code or clickable links based on your configuration
+- **⚙️ Highly customizable configuration** - Fine-tune every aspect with granular rule options, word lists, ignore patterns, and flexible thresholds to match your exact requirements
 
 **Try it live:** Check out the [Online Demo](https://eslint-online-playground.netlify.app/#eslint-plugin-markdown-preferences) to see the plugin in action!
 
@@ -28,7 +28,7 @@ For detailed usage instructions, rule configurations, and examples, visit our co
 
 ## 💿 Installation
 
-```bash
+```sh
 npm install --save-dev eslint eslint-plugin-markdown-preferences
 ```
 
@@ -86,17 +86,25 @@ The rules with the following star ⭐ are included in the configs.
 
 <!--RULES_TABLE_START-->
 
-### Markdown Rules
+### Preference Rules
 
 | Rule ID | Description | Fixable | RECOMMENDED |
 |:--------|:------------|:-------:|:-----------:|
+| [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/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. | 🔧 |  |
+
+### Stylistic Rules
+
+| 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/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-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/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html) | enforce consistent casing in headings. | 🔧 |  |
 | [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/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-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 | 🔧 |  |
-| [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/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 | 🔧 |  |
 
 <!--RULES_TABLE_END-->
 <!--RULES_SECTION_END-->

package/lib/index.d.ts

@@ -10,6 +10,11 @@ declare module 'eslint' {
   }
 }
 interface RuleOptions {
+  /**
+   * enforce canonical language names in code blocks
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/canonical-code-block-language.html
+   */
+  'markdown-preferences/canonical-code-block-language'?: Linter.RuleEntry<MarkdownPreferencesCanonicalCodeBlockLanguage>;
   /**
    * require link definitions and footnote definitions to be placed at the end of the document
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/definitions-last.html
@@ -20,6 +25,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
    */
   'markdown-preferences/hard-linebreak-style'?: Linter.RuleEntry<MarkdownPreferencesHardLinebreakStyle>;
+  /**
+   * enforce consistent casing in headings.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html
+   */
+  'markdown-preferences/heading-casing'?: Linter.RuleEntry<MarkdownPreferencesHeadingCasing>;
   /**
    * disallow text backslash at the end of a line.
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-text-backslash-linebreak.html
@@ -45,10 +55,26 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html
    */
   'markdown-preferences/prefer-linked-words'?: Linter.RuleEntry<MarkdownPreferencesPreferLinkedWords>;
+  /**
+   * enforce a specific order for link definitions and footnote definitions
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/sort-definitions.html
+   */
+  'markdown-preferences/sort-definitions'?: Linter.RuleEntry<MarkdownPreferencesSortDefinitions>;
 }
+type MarkdownPreferencesCanonicalCodeBlockLanguage = [] | [{
+  languages?: {
+    [k: string]: string;
+  };
+}];
 type MarkdownPreferencesHardLinebreakStyle = [] | [{
   style?: ("backslash" | "spaces");
 }];
+type MarkdownPreferencesHeadingCasing = [] | [{
+  style?: ("Title Case" | "Sentence case");
+  preserveWords?: string[];
+  ignorePatterns?: string[];
+  minorWords?: string[];
+}];
 type MarkdownPreferencesNoTrailingSpaces = [] | [{
   skipBlankLines?: boolean;
   ignoreComments?: boolean;
@@ -80,6 +106,13 @@ type MarkdownPreferencesPreferLinkedWords = [] | [{
   }[];
   [k: string]: unknown | undefined;
 }];
+type MarkdownPreferencesSortDefinitions = [] | [{
+  order?: (string | [string, ...(string)[]] | {
+    match: (string | [string, ...(string)[]]);
+    sort: ("alphabetical" | "ignore");
+  })[];
+  alphabetical?: boolean;
+}];
 declare namespace recommended_d_exports {
   export { files, language, name$1 as name, plugins, rules$1 as rules };
 }
@@ -95,19 +128,27 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.7.0";
+declare const version: "0.9.0";
 //#endregion
 //#region src/index.d.ts
 declare const configs: {
   recommended: typeof recommended_d_exports;
 };
 declare const rules: Record<string, RuleDefinition>;
+declare const resources: {
+  defaultPreserveWords: string[];
+  defaultMinorWords: string[];
+};
 declare const _default: {
   meta: typeof meta_d_exports;
   configs: {
     recommended: typeof recommended_d_exports;
   };
   rules: Record<string, RuleDefinition<_eslint_core0.RuleDefinitionTypeOptions>>;
+  resources: {
+    defaultPreserveWords: string[];
+    defaultMinorWords: string[];
+  };
 };
 //#endregion
-export { RuleOptions, configs, _default as default, meta_d_exports as meta, rules };
+export { RuleOptions, configs, _default as default, meta_d_exports as meta, resources, rules };