@kazupon/eslint-config 0.24.0 → 0.25.0

package/README.md

@@ -63,7 +63,7 @@ export default defineConfig(
 )
 ```
 
-> [!IMPORTANT]
+> [!IMPORTANT] <!-- eslint-disable-line markdown/no-missing-label-refs -->
 > Support flat configuration only, **not supported Legacy style (`.eslintrc`)**
 
 ### Lint with npm scripts `package.json`
@@ -125,7 +125,7 @@ The following built-in preset configurations are supported:
 | `javascript`  | [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                                                                                                                                                                                                                                                                                                                    | no (built-in)                             |
 | `comments`    | [`@eslint-community/eslint-plugin-eslint-comments`](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments)                                                                                                                                                                                                                                          | no (built-in)                             |
 | `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)                                                                                                                                                                                                                                                                                                      | yes                                       |
-| `imports`     | [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import), [`eslint-plugin-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)                                                                                                                                                                                                  | yes                                       |
+| `imports`     | [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import), [`eslint-plugin-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports), [`eslint-plugin-module-interop`](https://www.npmjs.com/package/eslint-plugin-module-interop)                                                                                                    | yes                                       |
 | `jsdoc`       | [`eslint-plugin-jsdoc`](https://www.npmjs.com/package/eslint-plugin-jsdoc)                                                                                                                                                                                                                                                                                                  | yes                                       |
 | `regexp`      | [`eslint-plugin-regexp`](https://www.npmjs.com/package/eslint-plugin-regexp)                                                                                                                                                                                                                                                                                                | yes                                       |
 | `promise`     | [`eslint-plugin-promise`](https://www.npmjs.com/package/eslint-plugin-promise)                                                                                                                                                                                                                                                                                              | yes                                       |

package/dist/index.d.ts

@@ -362,6 +362,21 @@ interface ImportsRules {
      * @see https://github.com/import-js/eslint-plugin-import/blob/v2.31.0/docs/rules/unambiguous.md
      */
     'import/unambiguous'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow importing CommonJS modules
+     * @see https://ota-meshi.github.io/eslint-plugin-module-interop/rules/no-import-cjs.html
+     */
+    'module-interop/no-import-cjs'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow `require(esm)`
+     * @see https://ota-meshi.github.io/eslint-plugin-module-interop/rules/no-require-esm.html
+     */
+    'module-interop/no-require-esm'?: Linter.RuleEntry<[]>;
+    /**
+     * enforce json imports to have the `{type: "json"}` attribute.
+     * @see https://ota-meshi.github.io/eslint-plugin-module-interop/rules/prefer-json-modules.html
+     */
+    'module-interop/prefer-json-modules'?: Linter.RuleEntry<[]>;
     /**
      * Disallow unused variables
      * @see https://github.com/sweepline/eslint-plugin-unused-imports/blob/master/docs/rules/no-unused-imports.md
@@ -13932,6 +13947,11 @@ interface ImportsOptions {
      * @default false
      */
     typescript?: boolean;
+    /**
+     * use `eslint-plugin-module-interop`
+     * @default true
+     */
+    interop?: boolean;
 }
 /**
  * `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
@@ -14037,6 +14057,10 @@ interface MarkdownOptions {
      * @default true
      */
     fencedCodeBlocks?: boolean;
+    /**
+     * enable block extensions
+     */
+    blockExtensions?: string[];
 }
 /**
  * `@eslint/markdown` and overrides configuration options

package/dist/index.js

@@ -2,6 +2,7 @@ import { FlatConfigComposer } from "eslint-flat-config-utils";
 import { interopDefault } from "@kazupon/jts-utils/module";
 import { isObject } from "@kazupon/jts-utils/object";
 import globals from "globals";
+import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
 
 //#region src/config.ts
 function defineConfig(...configs) {
@@ -25,6 +26,7 @@ const GLOB_SVELTE = "**/*.svelte";
 const GLOB_MARKDOWN = "**/*.md";
 const GLOB_CSS = "**/*.css";
 const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
 const GLOB_TESTS = [
 	`**/test/**/*.${GLOB_SRC_EXT}`,
 	`**/tests/**/*.${GLOB_SRC_EXT}`,
@@ -66,6 +68,7 @@ async function comments(options = {}) {
 	const comments$1 = await loadPlugin("@eslint-community/eslint-plugin-eslint-comments");
 	return [{
 		name: "@eslint-community/eslint-comments/recommended",
+		ignores: [GLOB_MARKDOWN],
 		plugins: { "@eslint-community/eslint-comments": comments$1 },
 		rules: { ...comments$1.configs.recommended.rules }
 	}, {
@@ -82,6 +85,7 @@ async function css(options = {}) {
 	const customSyntax = !!options.customSyntax;
 	const css$1 = await loadPlugin("@eslint/css");
 	const core = {
+		name: "@eslint/css/recommended",
 		files: [GLOB_CSS],
 		language: "css/css",
 		...css$1.configs["recommended"]
@@ -110,20 +114,29 @@ const IMPORTS_FILES = [
 	GLOB_TSX
 ];
 async function imports(options = {}) {
-	const { rules: overrideRules = {} } = options;
-	const unused = await loadPlugin(
-		// eslint-disable-line @typescript-eslint/no-unsafe-assignment
-		"eslint-plugin-unused-imports"
-);
+	const { rules: overrideRules = {}, interop = true } = options;
+	const unused = await loadPlugin("eslint-plugin-unused-imports");
 	const imports$1 = await loadPlugin("eslint-plugin-import");
 	const configs = [imports$1.flatConfigs.recommended];
 	if (options.typescript) try {
 		await loadPlugin("eslint-import-resolver-typescript");
 		imports$1.flatConfigs.typescript.settings["import/resolver"]["typescript"] = true;
-		configs.push(imports$1.flatConfigs.typescript);
+		configs.push({
+			name: "import/typescript",
+			...imports$1.flatConfigs.typescript
+		});
 	} catch (error) {
 		throw new Error(`Not found eslint-import-resolver-typescript: ${error.message}`);
 	}
+	if (interop) try {
+		const modInterop = await loadPlugin("eslint-plugin-module-interop");
+		configs.push({
+			name: "module-interop",
+			...modInterop.configs.recommended
+		});
+	} catch (error) {
+		throw new Error(`Not found eslint-plugin-module-interop: ${error.message}`);
+	}
 	configs.push({
 		name: "unused-imports",
 		plugins: { "unused-imports": unused },
@@ -159,10 +172,11 @@ async function javascript(options = {}) {
 	const { rules: overrideRules = {} } = options;
 	const js = await loadPlugin("@eslint/js");
 	return [{
-		name: "eslint/defaults/rules",
+		name: "@kazupon/javascript/markdown-block",
+		files: ["**/*.md/*.{js,cjs,mjs}"],
 		...js.configs.recommended
 	}, {
-		name: "@kazupon/javascript/@eslint/js",
+		name: "@kazupon/javascript/overrides",
 		languageOptions: {
 			ecmaVersion: 2022,
 			globals: {
@@ -197,7 +211,10 @@ async function jsdoc(options = {}) {
 		if (error) preset = `${preset}-error`;
 		return preset;
 	}
-	return [jsdoc$1.configs[`flat/${resolvePreset()}`], {
+	return [{
+		ignores: [GLOB_MARKDOWN],
+		...jsdoc$1.configs[`flat/${resolvePreset()}`]
+	}, {
 		name: "@kazupon/jsdoc",
 		rules: { ...overrideRules }
 	}];
@@ -216,16 +233,20 @@ async function jsonc(options = {}) {
 	const jsonc$1 = await loadPlugin("eslint-plugin-jsonc");
 	const configs = [];
 	for (const kind of kinds) if (kind) configs.push(...jsonc$1.configs[`flat/recommended-with-${kind}`].map((config, index) => {
-		return config.name ? config : {
-			name: `jsonc/flat/recommended-with-${kind}/${index}`,
-			...config
+		const mapped = {
+			...config,
+			ignores: [GLOB_MARKDOWN]
 		};
+		if (!config.name) mapped.name = `jsonc/flat/recommended-with-${kind}/${index}`;
+		return mapped;
 	}));
 	if (usePrettier) configs.push(...jsonc$1.configs["flat/prettier"].map((config, index) => {
-		return config.name ? config : {
-			name: `jsonc/flat/prettier/${index}`,
-			...config
+		const mapped = {
+			...config,
+			ignores: [GLOB_MARKDOWN]
 		};
+		if (!config.name) mapped.name = `jsonc/flat/prettier/${index}`;
+		return mapped;
 	}));
 	const overriddenConfig = {
 		name: "@kazupon/jsonc",
@@ -322,19 +343,36 @@ function jsoncSort() {
 //#endregion
 //#region src/configs/markdown.ts
 async function markdown(options = {}) {
-	const { rules: overrideRules = {} } = options;
+	const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [] } = options;
 	const language = options.language || "gfm";
-	const fencedCodeBlocks = typeof options.fencedCodeBlocks === "boolean" ? options.fencedCodeBlocks : true;
 	const markdown$1 = await loadPlugin("@eslint/markdown");
-	const recommended = markdown$1.configs["recommended"][0];
+	const recommended = { ...markdown$1.configs["recommended"][0] };
+	const codeblocks = markdown$1.configs.processor[2];
 	recommended.language = `markdown/${language}`;
 	return [
 		recommended,
-		...fencedCodeBlocks ? markdown$1.configs["processor"] : [],
+		{
+			name: "markdown/makedown-in-markdown",
+			files,
+			ignores: [`${GLOB_MARKDOWN}/**`],
+			processor: mergeProcessors([markdown$1.processors.markdown, processorPassThrough])
+		},
+		{
+			name: "makrdown/ignore-lint-blocks-in-typescript",
+			files: ["**/*.md/**"],
+			languageOptions: { parserOptions: {} }
+		},
 		{
 			name: "@kazupon/markdown",
-			files: [GLOB_MARKDOWN],
-			rules: { ...overrideRules }
+			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
+			}
 		}
 	];
 }
@@ -345,7 +383,10 @@ const md = markdown;
 async function prettier(options = {}) {
 	const { rules: overrideRules = {} } = options;
 	const prettier$1 = await loadPlugin("eslint-config-prettier");
-	return [prettier$1, {
+	return [{
+		name: "config-prettier",
+		...prettier$1
+	}, {
 		name: "@kazupon/prettier",
 		rules: { ...overrideRules }
 	}];
@@ -405,6 +446,7 @@ async function regexp(options = {}) {
 	const regexp$1 = await loadPlugin("eslint-plugin-regexp");
 	return [{
 		name: "regexp/flat/recommended",
+		ignores: [GLOB_MARKDOWN],
 		...regexp$1.configs["flat/recommended"]
 	}, {
 		name: "@kazupon/eslint-regexp",
@@ -434,7 +476,10 @@ async function svelte(options = {}) {
 			...parserOptions
 		}
 	};
-	return [...svelte$1.configs["flat/recommended"], customConfig];
+	return [...svelte$1.configs["flat/recommended"].map((config) => ({
+		...config,
+		ignores: [GLOB_MARKDOWN]
+	})), customConfig];
 }
 
 //#endregion
@@ -444,10 +489,12 @@ async function toml(options = {}) {
 	const toml$1 = await loadPlugin("eslint-plugin-toml");
 	const configs = [];
 	configs.push(...toml$1.configs["flat/standard"].map((config, index) => {
-		return config.name ? config : {
-			name: `toml/flat/standard/${index}`,
-			...config
+		const mapped = {
+			...config,
+			ignores: [GLOB_MARKDOWN]
 		};
+		if (!config.name) mapped.name = `toml/flat/standard/${index}`;
+		return mapped;
 	}));
 	const overriddenConfig = {
 		name: "@kazupon/toml",
@@ -466,11 +513,16 @@ async function typescript(options = {}) {
 	const baseFiles = [
 		GLOB_TS,
 		GLOB_TSX,
-		...extraFileExtensions.map((ext) => `**/*${ext}`)
+		...extraFileExtensions.map((ext) => `**/*.${ext}`)
 	];
 	const files = [...options.files ?? [], ...baseFiles];
+	const extendedPreset = ts.configs.recommendedTypeChecked.map((config) => {
+		const mapped = { ...config };
+		if (config.files) mapped.files = [...config.files, `${GLOB_MARKDOWN}/**/${GLOB_TS}`];
+		return mapped;
+	});
 	return [
-		...ts.configs.recommendedTypeChecked,
+		...extendedPreset,
 		{
 			files: [
 				GLOB_JS,
@@ -479,17 +531,23 @@ async function typescript(options = {}) {
 				GLOB_JSON5,
 				GLOB_JSONC,
 				GLOB_YAML,
-				GLOB_TOML
+				GLOB_TOML,
+				GLOB_MARKDOWN,
+				`${GLOB_MARKDOWN}/**`
 			],
 			...ts.configs.disableTypeChecked
 		},
+		{
+			name: "@kazupon/typescipt/typescript-eslint/overrides-for-disable-type-checked",
+			rules: { ...ts.configs.disableTypeChecked.rules }
+		},
 		{
 			name: "@kazupon/typescipt/typescript-eslint",
 			files,
 			languageOptions: {
 				parser: ts.parser,
 				parserOptions: {
-					extraFileExtensions: extraFileExtensions.map((ext) => `${ext}`),
+					extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
 					sourceType: "module",
 					...parserOptions
 				}
@@ -560,7 +618,10 @@ async function vue(options = {}) {
 	const vue$1 = await loadPlugin("eslint-plugin-vue");
 	const vueParser = vue$1.configs["flat/base"][1]["languageOptions"]?.parser;
 	const configs = [];
-	configs.push(...vue$1.configs["flat/recommended"]);
+	configs.push(...vue$1.configs["flat/recommended"].map((config) => ({
+		...config,
+		ignores: [GLOB_MARKDOWN]
+	})));
 	if (options.composable) {
 		const composable = await loadPlugin("eslint-plugin-vue-composable");
 		const composableBase = { ...composable.configs["flat/recommended"][0] };
@@ -572,10 +633,12 @@ async function vue(options = {}) {
 		const scopedCssMapped = scopedCss.configs["flat/recommended"].map(
 			// eslint-disable-next-line @typescript-eslint/no-explicit-any
 			(config, index) => {
-				return config.name ? config : {
-					name: `vue/scoped-css/recommended/${index}`,
-					...config
+				const mapped = {
+					...config,
+					ignores: [GLOB_MARKDOWN]
 				};
+				if (!config.name) mapped.name = `vue/scoped-css/recommended/${index}`;
+				return mapped;
 			}
 );
 		configs.push(scopedCssMapped[0], scopedCssMapped[2]);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-config",
   "description": "ESLint config for @kazupon",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "author": {
     "email": "kawakazu80@gmail.com",
     "name": "kazuya kawaguchi"
@@ -53,6 +53,7 @@
     "@eslint/js": "^9.22.0",
     "@kazupon/jts-utils": "^0.6.0",
     "eslint-flat-config-utils": "^2.0.1",
+    "eslint-merge-processors": "^2.0.0",
     "globals": "^16.0.0"
   },
   "peerDependencies": {
@@ -65,6 +66,7 @@
     "eslint-plugin-import": ">=2.31.0",
     "eslint-plugin-jsdoc": ">=48.5.0",
     "eslint-plugin-jsonc": ">=2.16.0",
+    "eslint-plugin-module-interop": ">=0.3.0",
     "eslint-plugin-promise": ">=6.4.0",
     "eslint-plugin-react": ">=7.35.0",
     "eslint-plugin-react-hooks": ">=5.2.0",
@@ -107,6 +109,9 @@
     "eslint-plugin-jsonc": {
       "optional": true
     },
+    "eslint-plugin-module-interop": {
+      "optional": true
+    },
     "eslint-plugin-promise": {
       "optional": true
     },
@@ -170,6 +175,7 @@
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsdoc": "^50.6.8",
     "eslint-plugin-jsonc": "^2.19.1",
+    "eslint-plugin-module-interop": "^0.3.0",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.2.0",