eslint-plugin-markdown-preferences 0.8.0 → 0.10.0

package/README.md

@@ -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
 ```
 
@@ -50,7 +50,7 @@ Example **eslint.config.js**:
 ```js
 import { defineConfig } from "eslint/config";
 // import markdown from "@eslint/markdown";
-import markdownPreferences from 'eslint-plugin-markdown-preferences';
+import markdownPreferences from "eslint-plugin-markdown-preferences";
 export default [
   // add more generic rule sets here, such as:
   // markdown.configs.recommended,
@@ -59,8 +59,8 @@ export default [
     rules: {
       // override/add rules settings here, such as:
       // 'markdown-preferences/prefer-linked-words': 'error'
-    }
-  }
+    },
+  },
 ];
 ```
 
@@ -86,6 +86,8 @@ The rules with the following star ⭐ are included in the configs.
 
 <!--RULES_TABLE_START-->
 
+<!-- prettier-ignore-start -->
+
 ### Preference Rules
 
 | Rule ID | Description | Fixable | RECOMMENDED |
@@ -98,12 +100,18 @@ The rules with the following star ⭐ are included in the configs.
 
 | 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/heading-casing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/heading-casing.html) | enforce consistent casing in headings. | 🔧 |  |
+| [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-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-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/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 | 🔧 |  |
 
+<!-- prettier-ignore-end -->
+
 <!--RULES_TABLE_END-->
 <!--RULES_SECTION_END-->
 <!--DOCS_IGNORE_START-->

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,21 @@ 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 laziness in blockquotes
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-laziness-blockquotes.html
+   */
+  'markdown-preferences/no-laziness-blockquotes'?: Linter.RuleEntry<[]>;
+  /**
+   * disallow multiple empty lines in Markdown files.
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-multiple-empty-lines.html
+   */
+  'markdown-preferences/no-multiple-empty-lines'?: Linter.RuleEntry<MarkdownPreferencesNoMultipleEmptyLines>;
   /**
    * 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
@@ -51,9 +71,25 @@ interface RuleOptions {
    */
   '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 MarkdownPreferencesNoMultipleEmptyLines = [] | [{
+  max?: number;
+  maxEOF?: number;
+  maxBOF?: number;
+}];
 type MarkdownPreferencesNoTrailingSpaces = [] | [{
   skipBlankLines?: boolean;
   ignoreComments?: boolean;
@@ -107,19 +143,27 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.8.0";
+declare const version: "0.10.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 };