@kazupon/eslint-config 0.33.2 → 0.34.0

package/README.md

@@ -140,7 +140,7 @@ The following built-in preset configurations are supported:
 | `jsonc`       | [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc)                                                                                                                                                                                                                                                                                                                                                                                         | yes                                       |
 | `yml`         | [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml)                                                                                                                                                                                                                                                                                                                                                                                             | yes                                       |
 | `toml`        | [`eslint-plugin-toml`](https://www.npmjs.com/package/eslint-plugin-toml)                                                                                                                                                                                                                                                                                                                                                                                           | yes                                       |
-| `markdown`    | [`@eslint/markdown`](https://www.npmjs.com/package/@eslint/markdown)                                                                                                                                                                                                                                                                                                                                                                                               | yes                                       |
+| `markdown`    | [`@eslint/markdown`](https://www.npmjs.com/package/@eslint/markdown), [`eslint-plugin-markdown-preferences`](https://github.com/ota-meshi/eslint-plugin-markdown-preferences)                                                                                                                                                                                                                                                                                      | yes                                       |
 | `css`         | [`@eslint/css`](https://www.npmjs.com/package/@eslint/css)                                                                                                                                                                                                                                                                                                                                                                                                         | yes                                       |
 | `html`        | [`@html-eslint/eslint-plugin`](https://www.npmjs.com/package/@html-eslint/eslint-plugin)                                                                                                                                                                                                                                                                                                                                                                           | yes                                       |
 

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import { StylisticCustomizeOptions } from "@stylistic/eslint-plugin";
 /**
 * define eslint configurations
 *
-* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
+* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs - eslint flat configurations
 * @returns {FlatConfigComposer} eslint flat configuration composer
 */
 declare function defineConfig(...configs: Awaitable<Linter.Config | Linter.Config[]>[]): FlatConfigComposer;
@@ -5341,6 +5341,31 @@ type JsoncSpaceUnaryOps = [] | [{
 //#endregion
 //#region src/types/gens/markdown.d.ts
 interface MarkdownRules {
+  /**
+  * enforce consistent hard linebreak style.
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html
+  */
+  "markdown-preferences/hard-linebreak-style"?: Linter.RuleEntry<MarkdownPreferencesHardLinebreakStyle>;
+  /**
+  * 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
+  */
+  "markdown-preferences/no-text-backslash-linebreak"?: Linter.RuleEntry<[]>;
+  /**
+  * trailing whitespace at the end of lines in Markdown files.
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-trailing-spaces.html
+  */
+  "markdown-preferences/no-trailing-spaces"?: Linter.RuleEntry<MarkdownPreferencesNoTrailingSpaces>;
+  /**
+  * enforce the use of inline code for specific words.
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html
+  */
+  "markdown-preferences/prefer-inline-code-words"?: Linter.RuleEntry<MarkdownPreferencesPreferInlineCodeWords>;
+  /**
+  * enforce the specified word to be a link.
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html
+  */
+  "markdown-preferences/prefer-linked-words"?: Linter.RuleEntry<MarkdownPreferencesPreferLinkedWords>;
   /**
   * Require languages for fenced code blocks
   * @see https://github.com/eslint/markdown/blob/main/docs/rules/fenced-code-language.md
@@ -5433,6 +5458,27 @@ interface MarkdownRules {
   "markdown/table-column-count"?: Linter.RuleEntry<MarkdownTableColumnCount>;
 }
 /* ======= Declarations ======= */
+// ----- markdown-preferences/hard-linebreak-style -----
+type MarkdownPreferencesHardLinebreakStyle = [] | [{
+  style?: ("backslash" | "spaces");
+}];
+// ----- markdown-preferences/no-trailing-spaces -----
+type MarkdownPreferencesNoTrailingSpaces = [] | [{
+  skipBlankLines?: boolean;
+  ignoreComments?: boolean;
+}];
+// ----- markdown-preferences/prefer-inline-code-words -----
+type MarkdownPreferencesPreferInlineCodeWords = [] | [{
+  words: string[];
+  [k: string]: unknown | undefined;
+}];
+// ----- markdown-preferences/prefer-linked-words -----
+type MarkdownPreferencesPreferLinkedWords = [] | [{
+  words: ({
+    [k: string]: (string | null);
+  } | string[]);
+  [k: string]: unknown | undefined;
+}];
 // ----- markdown/fenced-code-language -----
 type MarkdownFencedCodeLanguage = [] | [{
   required?: string[];
@@ -15688,9 +15734,10 @@ interface CommentsOptions {
 }
 /**
 * configure comments preset for the below plugins
+*
 * - `@eslint-community/eslint-plugin-eslint-comments`
 *
-* @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
+* @param {CommentsOptions} options - {@link CommentsOptions | comments preset options}
 * @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
 */
 declare function comments(options?: CommentsOptions): Promise<Linter.Config[]>;
@@ -15724,7 +15771,7 @@ interface CssOptions {
 * `@eslint/css` and overrides configuration options
 *
 * @param {CssOptions & OverridesOptions} options
-*  eslint css configuration options
+*  - eslint css configuration options
 * @returns {Promise<Linter.Config[]>}
 *  eslint flat configurations with `@eslint/css` and overrides
 */
@@ -15760,9 +15807,8 @@ interface HtmlOptions {
 /**
 * `@html-eslint/eslint-plugin` and overrides configuration options
 *
-* @param {HtmlOptions & OverridesOptions} options eslint configuration options for HTML
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
+* @param {HtmlOptions & OverridesOptions} options - eslint configuration options for HTML
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
 */
 declare function html(options?: HtmlOptions & OverridesOptions<HtmlRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -15788,10 +15834,9 @@ interface ImportsOptions {
 * `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
 *
 * @description if you want to use this preset, you need to put after `javascript` and `typescript` presets**
-* @param {ImportsOptions & OverridesOptions} options
-*  import configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
+*
+* @param {ImportsOptions & OverridesOptions} options - import configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
 */
 declare function imports(options?: ImportsOptions & OverridesOptions<ImportsRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -15804,7 +15849,7 @@ interface JavaScriptOptions {}
 /**
 * `@eslint/js` and overrides configuration options
 *
-* @param {JavaScriptOptions & OverridesOptions} options eslint configuration options for JavaScript
+* @param {JavaScriptOptions & OverridesOptions} options - eslint configuration options for JavaScript
 * @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/js` and overrides
 */
 declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.Config[]>;
@@ -15834,11 +15879,8 @@ interface JsDocumentOptions {
 /**
 * `eslint-plugin-jsdoc` and overrides configuration options
 *
-* @param {JsDocOptions & OverridesOptions} options
-* eslint configuration options for JavaScript
-*
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-jsdoc` and overrides
+* @param {JsDocOptions & OverridesOptions} options - eslint configuration options for JavaScript
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsdoc` and overrides
 */
 declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -15879,10 +15921,8 @@ interface JsoncOptions {
 /**
 * `eslint-plugin-jsonc` and overrides configuration options
 *
-* @param {JsoncOptions & OverridesOptions} options
-*  eslint jsonc configuration options for json, jsonc, json5
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-jsonc` and overrides
+* @param {JsoncOptions & OverridesOptions} options - eslint jsonc configuration options for json, jsonc, json5
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsonc` and overrides
 */
 declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -15909,6 +15949,29 @@ interface MarkdownOptions {
   * enable block extensions
   */
   blockExtensions?: string[];
+  /**
+  * enable preferences
+  *
+  * @see https://github.com/ota-meshi/eslint-plugin-markdown-preferences
+  * @default true
+  */
+  preferences?: boolean;
+  /**
+  * detect inline code words for back-quoted in markdown (`words` option of `markdown-preferences/prefer-inline-code-words`)
+  *
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-inline-code-words.html#%F0%9F%94%A7-options
+  * @default []
+  */
+  inlineCodeWords?: string[];
+  /**
+  * detect linked words for linked in markdown (`words` option of `markdown-preferences/prefer-linked-words`)
+  *
+  * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html#%F0%9F%94%A7-options
+  * @default []
+  */
+  linkedWords?: {
+    [k: string]: string | null;
+  } | string[];
 }
 // export const parserPlain: Linter.Parser = {
 // meta: {
@@ -15933,10 +15996,8 @@ interface MarkdownOptions {
 /**
 * `@eslint/markdown` and overrides configuration options
 *
-* @param {MarkdownOptions & OverridesOptions} options
-*  eslint unicorn configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@eslint/markdown` and overrides
+* @param {MarkdownOptions & OverridesOptions} options - eslint unicorn configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/markdown` and overrides
 */
 declare function markdown(options?: MarkdownOptions & OverridesOptions): Promise<Linter.Config[]>;
 // alias
@@ -15951,10 +16012,8 @@ interface PrettierOptions {}
 /**
 * `eslint-config-prettier` and overrides configuration options
 *
-* @param {PrettierOptions & OverridesOptions} options
-* eslint configuration options for Prettier
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-config-prettier` and overrides
+* @param {PrettierOptions & OverridesOptions} options - eslint configuration options for Prettier
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-config-prettier` and overrides
 */
 declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -15967,10 +16026,8 @@ interface PromiseOptions {}
 /**
 * `eslint-plugin-promise` and overrides configuration options
 *
-* @param {PromiseOptions & OverridesOptions} options
-*  eslint promise configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-promise` and overrides
+* @param {PromiseOptions & OverridesOptions} options - eslint promise configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-promise` and overrides
 */
 declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16034,10 +16091,8 @@ interface TypeScriptProjectServiceOptions {
 /**
 * `typescript-eslint` and overrides configuration options
 *
-* @param {TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for TypeScript
-* @returns {Promise<Linter.FlatConfig[]>}
-* eslint flat configurations with `typescript-eslint` and overrides
+* @param {TypeScriptOptions & OverridesOptions} options - eslint configuration options for TypeScript
+* @returns {Promise<Linter.FlatConfig[]>} eslint flat configurations with `typescript-eslint` and overrides
 */
 declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16062,10 +16117,8 @@ interface ReactOptions {
 /**
 * `eslint-plugin-react` and overrides configuration options
 *
-* @param {ReactOptions & OverridesOptions} options
-*  eslint react configuration options for regular expressions
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-react` and overrides
+* @param {ReactOptions & OverridesOptions} options - eslint react configuration options for regular expressions
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-react` and overrides
 */
 declare function react(options?: ReactOptions & TypeScriptOptions & OverridesOptions<ReactRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16078,10 +16131,8 @@ interface RegexpOptions {}
 /**
 * `eslint-plugin-regexp` and overrides configuration options
 *
-* @param {RegexpOptions & OverridesOptions} options
-*  eslint regexp configuration options for regular expressions
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-regexp` and overrides
+* @param {RegexpOptions & OverridesOptions} options - eslint regexp configuration options for regular expressions
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-regexp` and overrides
 */
 declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16100,10 +16151,8 @@ interface StylisticOptions {
 /**
 * `@stylistic/eslint-plugin` and overrides configuration options
 *
-* @param {StylisticOptions & OverridesOptions} options
-*  stylistic eslint plugin configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@stylistic/eslint-plugin` and overrides
+* @param {StylisticOptions & OverridesOptions} options - stylistic eslint plugin configuration options
+* @returns {Promise<Linter.Config[]>}  eslint flat configurations with `@stylistic/eslint-plugin` and overrides
 */
 declare function stylistic(options?: StylisticOptions & OverridesOptions<StylisticRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16128,10 +16177,8 @@ interface SvelteScriptOptions {
 /**
 * `eslint-plugin-svelte` and overrides configuration options
 *
-* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for Vue
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-svelte` and overrides
+* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-svelte` and overrides
 */
 declare function svelte(options?: SvelteScriptOptions & TypeScriptOptions & OverridesOptions<SvelteRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16144,10 +16191,8 @@ interface TomlOptions {}
 /**
 * `eslint-plugin-yml` and overrides configuration options
 *
-* @param {YmlOptions & OverridesOptions} options
-*  eslint yml configuration options for yml, yaml
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-yml` and overrides
+* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
 */
 declare function toml(options?: TomlOptions & OverridesOptions<TomlRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16166,8 +16211,7 @@ interface UnicornOptions {
 /**
 * `eslint-plugin-unicorn` and overrides configuration options
 *
-* @param {UnicornOptions & OverridesOptions} options
-*  eslint unicorn configuration options
+* @param {UnicornOptions & OverridesOptions} options - eslint unicorn configuration options
 * @returns {Promise<Linter.Config[]>}
 *  eslint flat configurations with `eslint-plugin-unicorn` and overrides
 */
@@ -16190,10 +16234,8 @@ interface VitestOptions {
 /**
 * `@vitest/eslint-plugin` and overrides configuration options
 *
-* @param {VitestOptions & OverridesOptions} options
-*  eslint vitest configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@vitest/eslint-plugin` and overrides
+* @param {VitestOptions & OverridesOptions} options - eslint vitest configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@vitest/eslint-plugin` and overrides
 */
 declare function vitest(options?: VitestOptions & OverridesOptions<VitestRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16251,10 +16293,8 @@ interface VueI18nOptions {
 /**
 * `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides configuration options
 *
-* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for Vue
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
+* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
 */
 declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.Config[]>;
 //#endregion
@@ -16274,10 +16314,8 @@ interface YmlOptions {
 /**
 * `eslint-plugin-yml` and overrides configuration options
 *
-* @param {YmlOptions & OverridesOptions} options
-*  eslint yml configuration options for yml, yaml
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-yml` and overrides
+* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
 */
 declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.Config[]>;
 // alias

package/dist/index.js

@@ -8,7 +8,7 @@ import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
 /**
 * define eslint configurations
 *
-* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
+* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs - eslint flat configurations
 * @returns {FlatConfigComposer} eslint flat configuration composer
 */
 function defineConfig(...configs) {
@@ -60,7 +60,9 @@ const GLOB_TESTS_TYPE = [`**/*.test-d.${GLOB_SRC_EXT}`, `**/*.spec-d.${GLOB_SRC_
 /**
 * load eslint plugin
 *
-* @param {string} name plugin name
+* @typeParam T - plugin type
+*
+* @param {string} name - plugin name
 * @returns {Promise<T>} loaded plugin
 */
 async function loadPlugin(name) {
@@ -84,7 +86,7 @@ async function getTypeScriptParser() {
 /**
 * get glob source files
 *
-* @param {boolean} useTypeScript use TypeScript, default `false`
+* @param {boolean} useTypeScript - use TypeScript, default `false`
 * @returns {string[]} files
 */
 function getGlobSourceFiles(useTypeScript = false) {
@@ -99,9 +101,10 @@ function getGlobSourceFiles(useTypeScript = false) {
 //#region src/configs/comments.ts
 /**
 * configure comments preset for the below plugins
+*
 * - `@eslint-community/eslint-plugin-eslint-comments`
 *
-* @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
+* @param {CommentsOptions} options - {@link CommentsOptions | comments preset options}
 * @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
 */
 async function comments(options = {}) {
@@ -134,7 +137,7 @@ async function comments(options = {}) {
 * `@eslint/css` and overrides configuration options
 *
 * @param {CssOptions & OverridesOptions} options
-*  eslint css configuration options
+*  - eslint css configuration options
 * @returns {Promise<Linter.Config[]>}
 *  eslint flat configurations with `@eslint/css` and overrides
 */
@@ -169,9 +172,8 @@ async function css(options = {}) {
 /**
 * `@html-eslint/eslint-plugin` and overrides configuration options
 *
-* @param {HtmlOptions & OverridesOptions} options eslint configuration options for HTML
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
+* @param {HtmlOptions & OverridesOptions} options - eslint configuration options for HTML
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
 */
 async function html(options = {}) {
 	const { rules: overrideRules = {}, prettier: prettier$1 = false, frontmatter = false, templateEngineSyntax } = options;
@@ -241,10 +243,9 @@ const IMPORTS_FILES = [
 * `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
 *
 * @description if you want to use this preset, you need to put after `javascript` and `typescript` presets**
-* @param {ImportsOptions & OverridesOptions} options
-*  import configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
+*
+* @param {ImportsOptions & OverridesOptions} options - import configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
 */
 async function imports(options = {}) {
 	const { rules: overrideRules = {}, interop = true } = options;
@@ -304,7 +305,7 @@ async function imports(options = {}) {
 /**
 * `@eslint/js` and overrides configuration options
 *
-* @param {JavaScriptOptions & OverridesOptions} options eslint configuration options for JavaScript
+* @param {JavaScriptOptions & OverridesOptions} options - eslint configuration options for JavaScript
 * @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/js` and overrides
 */
 async function javascript(options = {}) {
@@ -343,11 +344,8 @@ async function javascript(options = {}) {
 /**
 * `eslint-plugin-jsdoc` and overrides configuration options
 *
-* @param {JsDocOptions & OverridesOptions} options
-* eslint configuration options for JavaScript
-*
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-jsdoc` and overrides
+* @param {JsDocOptions & OverridesOptions} options - eslint configuration options for JavaScript
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsdoc` and overrides
 */
 async function jsdoc(options = {}) {
 	const { rules: overrideRules = {}, ignores: overrideIgnores = [], typescript: typescript$1, error = false } = options;
@@ -411,6 +409,11 @@ async function jsdoc(options = {}) {
 			"jsdoc/require-param": ["error", { checkDestructuredRoots: false }],
 			"jsdoc/check-param-names": ["error", { checkDestructured: false }],
 			"jsdoc/check-tag-names": ["error", { definedTags: ["typeParam"] }],
+			"jsdoc/require-hyphen-before-param-description": [
+				"error",
+				"always",
+				{ tags: { typeParam: "always" } }
+			],
 			...overrideRules
 		}
 	}];
@@ -421,10 +424,8 @@ async function jsdoc(options = {}) {
 /**
 * `eslint-plugin-jsonc` and overrides configuration options
 *
-* @param {JsoncOptions & OverridesOptions} options
-*  eslint jsonc configuration options for json, jsonc, json5
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-jsonc` and overrides
+* @param {JsoncOptions & OverridesOptions} options - eslint jsonc configuration options for json, jsonc, json5
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsonc` and overrides
 */
 async function jsonc(options = {}) {
 	const { rules: overrideRules = {} } = options;
@@ -550,13 +551,11 @@ function jsoncSort() {
 /**
 * `@eslint/markdown` and overrides configuration options
 *
-* @param {MarkdownOptions & OverridesOptions} options
-*  eslint unicorn configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@eslint/markdown` and overrides
+* @param {MarkdownOptions & OverridesOptions} options - eslint unicorn configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/markdown` and overrides
 */
 async function markdown(options = {}) {
-	const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [] } = options;
+	const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [], preferences = true, inlineCodeWords = [], linkedWords = [] } = options;
 	const language = options.language || "gfm";
 	/**
 	* TODO: remove this option
@@ -567,7 +566,7 @@ async function markdown(options = {}) {
 	const recommended = { ...markdown$1.configs["recommended"][0] };
 	const codeblocks = markdown$1.configs.processor[2];
 	recommended.language = `markdown/${language}`;
-	return [
+	const configs = [
 		recommended,
 		{
 			name: "markdown/makedown-in-markdown",
@@ -579,20 +578,34 @@ async function markdown(options = {}) {
 			name: "makrdown/ignore-lint-blocks-in-typescript",
 			files: ["**/*.md/**"],
 			languageOptions: { parserOptions: { project: null } }
-		},
-		{
-			name: "@kazupon/markdown",
-			files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, ...blockExtensions.map((ext) => `${GLOB_MARKDOWN}/**/*.${ext}`)],
-			languageOptions: { parserOptions: { ecmaFeatures: { impliedStrict: true } } },
+		}
+	];
+	if (preferences) {
+		const preferencesPlugin = await loadPlugin("eslint-plugin-markdown-preferences");
+		configs.push({
+			...preferencesPlugin.configs.recommended,
 			rules: {
-				...codeblocks.rules,
-				"import/no-unresolved": "off",
-				"unused-imports/no-unused-vars": "off",
-				"@typescript-eslint/no-unused-vars": "off",
-				...overrideRules
+				...preferencesPlugin.configs.recommended.rules,
+				"markdown-preferences/no-trailing-spaces": "error",
+				"markdown-preferences/prefer-linked-words": ["error", { words: linkedWords }],
+				"markdown-preferences/prefer-inline-code-words": ["error", { words: inlineCodeWords }]
 			}
+		});
+	}
+	const custom = {
+		name: "@kazupon/markdown",
+		files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, ...blockExtensions.map((ext) => `${GLOB_MARKDOWN}/**/*.${ext}`)],
+		languageOptions: { parserOptions: { ecmaFeatures: { impliedStrict: true } } },
+		rules: {
+			...codeblocks.rules,
+			"import/no-unresolved": "off",
+			"unused-imports/no-unused-vars": "off",
+			"@typescript-eslint/no-unused-vars": "off",
+			...overrideRules
 		}
-	];
+	};
+	configs.push(custom);
+	return configs;
 }
 const md = markdown;
 
@@ -601,10 +614,8 @@ const md = markdown;
 /**
 * `eslint-config-prettier` and overrides configuration options
 *
-* @param {PrettierOptions & OverridesOptions} options
-* eslint configuration options for Prettier
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-config-prettier` and overrides
+* @param {PrettierOptions & OverridesOptions} options - eslint configuration options for Prettier
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-config-prettier` and overrides
 */
 async function prettier(options = {}) {
 	const { rules: overrideRules = {} } = options;
@@ -623,10 +634,8 @@ async function prettier(options = {}) {
 /**
 * `eslint-plugin-promise` and overrides configuration options
 *
-* @param {PromiseOptions & OverridesOptions} options
-*  eslint promise configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-promise` and overrides
+* @param {PromiseOptions & OverridesOptions} options - eslint promise configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-promise` and overrides
 */
 async function promise(options = {}) {
 	const { rules: overrideRules = {} } = options;
@@ -645,10 +654,8 @@ async function promise(options = {}) {
 /**
 * `eslint-plugin-react` and overrides configuration options
 *
-* @param {ReactOptions & OverridesOptions} options
-*  eslint react configuration options for regular expressions
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-react` and overrides
+* @param {ReactOptions & OverridesOptions} options - eslint react configuration options for regular expressions
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-react` and overrides
 */
 async function react(options = {}) {
 	const { rules: overrideRules = {}, settings = {} } = options;
@@ -694,10 +701,8 @@ async function react(options = {}) {
 /**
 * `eslint-plugin-regexp` and overrides configuration options
 *
-* @param {RegexpOptions & OverridesOptions} options
-*  eslint regexp configuration options for regular expressions
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-regexp` and overrides
+* @param {RegexpOptions & OverridesOptions} options - eslint regexp configuration options for regular expressions
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-regexp` and overrides
 */
 async function regexp(options = {}) {
 	const { rules: overrideRules = {} } = options;
@@ -717,10 +722,8 @@ async function regexp(options = {}) {
 /**
 * `@stylistic/eslint-plugin` and overrides configuration options
 *
-* @param {StylisticOptions & OverridesOptions} options
-*  stylistic eslint plugin configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@stylistic/eslint-plugin` and overrides
+* @param {StylisticOptions & OverridesOptions} options - stylistic eslint plugin configuration options
+* @returns {Promise<Linter.Config[]>}  eslint flat configurations with `@stylistic/eslint-plugin` and overrides
 */
 async function stylistic(options = {}) {
 	const { rules: overrideRules = {}, customize = {
@@ -763,10 +766,8 @@ async function stylistic(options = {}) {
 /**
 * `eslint-plugin-svelte` and overrides configuration options
 *
-* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for Vue
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-svelte` and overrides
+* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-svelte` and overrides
 */
 async function svelte(options = {}) {
 	const { rules: overrideRules = {}, parserOptions = { projectService: true }, svelteConfig = {} } = options;
@@ -800,10 +801,8 @@ async function svelte(options = {}) {
 /**
 * `eslint-plugin-yml` and overrides configuration options
 *
-* @param {YmlOptions & OverridesOptions} options
-*  eslint yml configuration options for yml, yaml
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-yml` and overrides
+* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
 */
 async function toml(options = {}) {
 	const { rules: overrideRules = {} } = options;
@@ -831,10 +830,8 @@ async function toml(options = {}) {
 /**
 * `typescript-eslint` and overrides configuration options
 *
-* @param {TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for TypeScript
-* @returns {Promise<Linter.FlatConfig[]>}
-* eslint flat configurations with `typescript-eslint` and overrides
+* @param {TypeScriptOptions & OverridesOptions} options - eslint configuration options for TypeScript
+* @returns {Promise<Linter.FlatConfig[]>} eslint flat configurations with `typescript-eslint` and overrides
 */
 async function typescript(options = {}) {
 	const { rules: overrideRules = {}, extraFileExtensions = [], parserOptions = { project: true } } = options;
@@ -911,8 +908,7 @@ async function typescript(options = {}) {
 /**
 * `eslint-plugin-unicorn` and overrides configuration options
 *
-* @param {UnicornOptions & OverridesOptions} options
-*  eslint unicorn configuration options
+* @param {UnicornOptions & OverridesOptions} options - eslint unicorn configuration options
 * @returns {Promise<Linter.Config[]>}
 *  eslint flat configurations with `eslint-plugin-unicorn` and overrides
 */
@@ -935,10 +931,8 @@ async function unicorn(options = {}) {
 /**
 * `@vitest/eslint-plugin` and overrides configuration options
 *
-* @param {VitestOptions & OverridesOptions} options
-*  eslint vitest configuration options
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `@vitest/eslint-plugin` and overrides
+* @param {VitestOptions & OverridesOptions} options - eslint vitest configuration options
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@vitest/eslint-plugin` and overrides
 */
 async function vitest(options = {}) {
 	const { rules: overrideRules = {}, files: overrideFiles = [] } = options;
@@ -970,10 +964,8 @@ async function vitest(options = {}) {
 /**
 * `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides configuration options
 *
-* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
-* eslint configuration options for Vue
-* @returns {Promise<Linter.Config[]>}
-* eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
+* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
 */
 async function vue(options = {}) {
 	const { rules: overrideRules = {}, parserOptions = { projectService: true } } = options;
@@ -1049,10 +1041,8 @@ async function vue(options = {}) {
 /**
 * `eslint-plugin-yml` and overrides configuration options
 *
-* @param {YmlOptions & OverridesOptions} options
-*  eslint yml configuration options for yml, yaml
-* @returns {Promise<Linter.Config[]>}
-*  eslint flat configurations with `eslint-plugin-yml` and overrides
+* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
+* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
 */
 async function yml(options = {}) {
 	const { rules: overrideRules = {} } = options;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-config",
   "description": "ESLint config for @kazupon",
-  "version": "0.33.2",
+  "version": "0.34.0",
   "author": {
     "email": "kawakazu80@gmail.com",
     "name": "kazuya kawaguchi"
@@ -70,6 +70,7 @@
     "eslint-plugin-import": ">=2.31.0",
     "eslint-plugin-jsdoc": ">=51.0.0",
     "eslint-plugin-jsonc": ">=2.16.0",
+    "eslint-plugin-markdown-preferences": ">=0.4.0",
     "eslint-plugin-module-interop": ">=0.3.0",
     "eslint-plugin-promise": ">=6.4.0",
     "eslint-plugin-react": ">=7.35.0",
@@ -119,6 +120,9 @@
     "eslint-plugin-jsonc": {
       "optional": true
     },
+    "eslint-plugin-markdown-preferences": {
+      "optional": true
+    },
     "eslint-plugin-module-interop": {
       "optional": true
     },
@@ -188,6 +192,7 @@
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsdoc": "^52.0.0",
     "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-markdown-preferences": "^0.4.0",
     "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.5",