@kazupon/eslint-config 0.34.0 → 0.35.0

package/dist/index.d.ts

@@ -99,6 +99,11 @@ interface CommentsRules {
   */
   "@kazupon/no-tag-comments"?: Linter.RuleEntry<KazuponNoTagComments>;
   /**
+  * enforce the use of inline code for specific words on comments
+  * @see https://eslint-plugin.kazupon.dev/rules/prefer-inline-code-words-comments
+  */
+  "@kazupon/prefer-inline-code-words-comments"?: Linter.RuleEntry<KazuponPreferInlineCodeWordsComments>;
+  /**
   * enforce adding a scope to tag comments
   * @see https://eslint-plugin.kazupon.dev/rules/prefer-scope-on-tag-comment
   */
@@ -123,6 +128,10 @@ type EslintCommunityEslintCommentsRequireDescription = [] | [{
 type KazuponNoTagComments = [] | [{
   tags?: [string, ...(string)[]];
 }];
+// ----- @kazupon/prefer-inline-code-words-comments -----
+type KazuponPreferInlineCodeWordsComments = [] | [{
+  words: string[];
+}];
 // ----- @kazupon/prefer-scope-on-tag-comment -----
 type KazuponPreferScopeOnTagComment = [] | [{
   tags?: [string, ...(string)[]];
@@ -5352,7 +5361,7 @@ interface MarkdownRules {
   */
   "markdown-preferences/no-text-backslash-linebreak"?: Linter.RuleEntry<[]>;
   /**
-  * trailing whitespace at the end of lines in Markdown files.
+  * disallow 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>;
@@ -5470,6 +5479,13 @@ type MarkdownPreferencesNoTrailingSpaces = [] | [{
 // ----- markdown-preferences/prefer-inline-code-words -----
 type MarkdownPreferencesPreferInlineCodeWords = [] | [{
   words: string[];
+  ignores?: {
+    words?: (string | string[]);
+    node?: {
+      [k: string]: unknown | undefined;
+    };
+    [k: string]: unknown | undefined;
+  }[];
   [k: string]: unknown | undefined;
 }];
 // ----- markdown-preferences/prefer-linked-words -----
@@ -5477,6 +5493,13 @@ type MarkdownPreferencesPreferLinkedWords = [] | [{
   words: ({
     [k: string]: (string | null);
   } | string[]);
+  ignores?: {
+    words?: (string | string[]);
+    node?: {
+      [k: string]: unknown | undefined;
+    };
+    [k: string]: unknown | undefined;
+  }[];
   [k: string]: unknown | undefined;
 }];
 // ----- markdown/fenced-code-language -----
@@ -15731,6 +15754,13 @@ interface CommentsOptions {
   * An options for `@kazupon/eslint-plugin` comment config
   */
   kazupon?: OverridesOptions<CommentsRules>;
+  /**
+  * enforce inline code for specific words on comments
+  *
+  * @see https://eslint-plugin.kazupon.dev/rules/prefer-inline-code-words-comments#options
+  * @default []
+  */
+  inlineCodeWords?: string[];
 }
 /**
 * configure comments preset for the below plugins
@@ -15964,6 +15994,19 @@ interface MarkdownOptions {
   */
   inlineCodeWords?: string[];
   /**
+  * ignore inline code words for back-quoted in markdown (`ignores` 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 []
+  */
+  inlineCodeWordsIgnores?: {
+    words?: string | string[];
+    node?: {
+      [k: string]: unknown | undefined;
+    };
+    [k: string]: unknown | undefined;
+  }[];
+  /**
   * 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
@@ -15972,6 +16015,19 @@ interface MarkdownOptions {
   linkedWords?: {
     [k: string]: string | null;
   } | string[];
+  /**
+  * ignore linked words for linked in markdown (`ignores` 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 []
+  */
+  linkedWordsIgnores?: {
+    words?: string | string[];
+    node?: {
+      [k: string]: unknown | undefined;
+    };
+    [k: string]: unknown | undefined;
+  }[];
 }
 // export const parserPlain: Linter.Parser = {
 // meta: {

package/dist/index.js

@@ -112,6 +112,7 @@ async function comments(options = {}) {
 	const kazupon = await loadPlugin("@kazupon/eslint-plugin");
 	const directives = options.directives ?? {};
 	const kazuponOptions = options.kazupon ?? {};
+	const inlineCodeWords = options.inlineCodeWords ?? [];
 	return [{
 		name: "@eslint-community/eslint-comments",
 		ignores: directives.ignores ? [GLOB_MARKDOWN, ...directives.ignores] : [GLOB_MARKDOWN],
@@ -126,6 +127,7 @@ async function comments(options = {}) {
 		ignores: [...config.ignores, ...kazuponOptions.ignores || []],
 		rules: {
 			...config.rules,
+			"@kazupon/prefer-inline-code-words-comments": ["error", { words: inlineCodeWords }],
 			...kazuponOptions.rules
 		}
 	}))];
@@ -555,7 +557,7 @@ function jsoncSort() {
 * @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/markdown` and overrides
 */
 async function markdown(options = {}) {
-	const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [], preferences = true, inlineCodeWords = [], linkedWords = [] } = options;
+	const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [], preferences = true, inlineCodeWords = [], inlineCodeWordsIgnores = [], linkedWords = [], linkedWordsIgnores = [] } = options;
 	const language = options.language || "gfm";
 	/**
 	* TODO: remove this option
@@ -587,8 +589,14 @@ async function markdown(options = {}) {
 			rules: {
 				...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 }]
+				"markdown-preferences/prefer-linked-words": ["error", {
+					words: linkedWords,
+					ignores: linkedWordsIgnores
+				}],
+				"markdown-preferences/prefer-inline-code-words": ["error", {
+					words: inlineCodeWords,
+					ignores: inlineCodeWordsIgnores
+				}]
 			}
 		});
 	}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-config",
   "description": "ESLint config for @kazupon",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "author": {
     "email": "kawakazu80@gmail.com",
     "name": "kazuya kawaguchi"
@@ -51,7 +51,7 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
     "@eslint/js": "^9.32.0",
-    "@kazupon/eslint-plugin": "^0.5.0",
+    "@kazupon/eslint-plugin": "^0.6.1",
     "@kazupon/jts-utils": "^0.6.0",
     "@stylistic/eslint-plugin": "^4.4.1",
     "eslint-flat-config-utils": "^2.1.0",
@@ -70,7 +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-markdown-preferences": ">=0.5.0",
     "eslint-plugin-module-interop": ">=0.3.0",
     "eslint-plugin-promise": ">=6.4.0",
     "eslint-plugin-react": ">=7.35.0",
@@ -192,7 +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-markdown-preferences": "^0.5.0",
     "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.5",