@kazupon/eslint-config 0.11.0 → 0.13.0

package/README.md

@@ -17,8 +17,10 @@ ESLint config for @kazupon
   - `promise`
   - `unicorn`
   - `prettier`
+  - `vue`
+  - `react`
+  - `svelte`
   - `jsonc`
-  - `vue`,
   - `yml`
   - `toml`
 - Support primitive eslint flat configuration
@@ -88,7 +90,17 @@ Add the following settings to your `.vscode/settings.json`:
     "source.fixAll.eslint": "explicit"
   },
   // Enable eslint for supported languages
-  "eslint.validate": ["javascript", "typescript", "json", "jsonc", "json5", "vue", "yaml", "toml"],
+  "eslint.validate": [
+    "javascript",
+    "typescript",
+    "vue",
+    "svelte",
+    "json",
+    "jsonc",
+    "json5",
+    "yaml",
+    "toml"
+  ],
   // Enable flat configuration
   "eslint.useFlatConfig": true
 }
@@ -98,20 +110,22 @@ Add the following settings to your `.vscode/settings.json`:
 
 The following built-in configurations are supported:
 
-| Configuration | Powered by eslint plugin or package                                                                                                | Need to install eslint plugin or package? |
-| ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
-| `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                                       |
-| `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                                       |
-| `unicorn`     | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn)                                                     | yes                                       |
-| `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)                                                   | yes                                       |
-| `jsonc`       | [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc)                                                         | yes                                       |
-| `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                                                             | 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                                       |
+| Configuration | Powered by eslint plugin or package                                                                                                                                                                                                                            | Need to install eslint plugin or package? |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
+| `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                                       |
+| `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                                       |
+| `unicorn`     | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn)                                                                                                                                                                                 | yes                                       |
+| `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)                                                                                                                                                                               | yes                                       |
+| `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                                                                                                                                                                                         | yes                                       |
+| `react`       | [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react), [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks), [`eslint-plugin-react-refresh`](https://www.npmjs.com/package/eslint-plugin-react-refresh) | yes                                       |
+| `svelte`      | [`eslint-plugin-svelte`](https://www.npmjs.com/package/eslint-plugin-svelte)                                                                                                                                                                                   | yes                                       |
+| `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                                       |
 
 You can use `import` syntax:
 

package/dist/configs/index.d.cts

@@ -10,3 +10,5 @@ export * from './prettier';
 export * from './jsonc';
 export * from './yml';
 export * from './vue';
+export * from './react';
+export * from './svelte';

package/dist/configs/index.d.ts

@@ -10,3 +10,5 @@ export * from './prettier';
 export * from './jsonc';
 export * from './yml';
 export * from './vue';
+export * from './react';
+export * from './svelte';

package/dist/configs/react.d.cts

@@ -0,0 +1,26 @@
+import type { Linter } from 'eslint';
+import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, ReactRules } from '../types';
+/**
+ * eslint react configuration options
+ */
+export interface ReactOptions {
+    /**
+     * use TypeScript
+     * @default true
+     */
+    typescript?: boolean;
+    /**
+     * enable `eslint-plugin-react-refresh` recommended rules
+     * @default false
+     */
+    refresh?: boolean;
+}
+/**
+ * `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
+ */
+export declare function react(options?: ReactOptions & TypeScriptOptions & OverridesOptions<ReactRules>): Promise<Linter.Config[]>;

package/dist/configs/react.d.ts

@@ -0,0 +1,26 @@
+import type { Linter } from 'eslint';
+import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, ReactRules } from '../types';
+/**
+ * eslint react configuration options
+ */
+export interface ReactOptions {
+    /**
+     * use TypeScript
+     * @default true
+     */
+    typescript?: boolean;
+    /**
+     * enable `eslint-plugin-react-refresh` recommended rules
+     * @default false
+     */
+    refresh?: boolean;
+}
+/**
+ * `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
+ */
+export declare function react(options?: ReactOptions & TypeScriptOptions & OverridesOptions<ReactRules>): Promise<Linter.Config[]>;

package/dist/configs/svelte.d.cts

@@ -0,0 +1,21 @@
+import type { Linter } from 'eslint';
+import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, SvelteRules } from '../types';
+/**
+ * Svelte configuration options
+ */
+export interface SvelteScriptOptions {
+    /**
+     * use TypeScript in `template` block
+     * @default false
+     */
+    typescript?: boolean;
+}
+/**
+ * `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
+ */
+export declare function svelte(options?: SvelteScriptOptions & TypeScriptOptions & OverridesOptions<SvelteRules>): Promise<Linter.Config[]>;

package/dist/configs/svelte.d.ts

@@ -0,0 +1,21 @@
+import type { Linter } from 'eslint';
+import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, SvelteRules } from '../types';
+/**
+ * Svelte configuration options
+ */
+export interface SvelteScriptOptions {
+    /**
+     * use TypeScript in `template` block
+     * @default false
+     */
+    typescript?: boolean;
+}
+/**
+ * `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
+ */
+export declare function svelte(options?: SvelteScriptOptions & TypeScriptOptions & OverridesOptions<SvelteRules>): Promise<Linter.Config[]>;

package/dist/globs.d.cts

@@ -8,3 +8,4 @@ export declare const GLOB_JSONC = "**/*.jsonc";
 export declare const GLOB_YAML = "**/*.y?(a)ml";
 export declare const GLOB_TOML = "**/*.toml";
 export declare const GLOB_VUE = "**/*.vue";
+export declare const GLOB_SVELTE = "**/*.svelte";

package/dist/globs.d.ts

@@ -8,3 +8,4 @@ export declare const GLOB_JSONC = "**/*.jsonc";
 export declare const GLOB_YAML = "**/*.y?(a)ml";
 export declare const GLOB_TOML = "**/*.toml";
 export declare const GLOB_VUE = "**/*.vue";
+export declare const GLOB_SVELTE = "**/*.svelte";

package/dist/index.cjs

@@ -44,6 +44,10 @@ async function loadPlugin(name) {
 	});
 	return interopDefault(mod);
 }
+async function getTypeScriptParser() {
+	const ts = await loadPlugin("typescript-eslint");
+	return ts.parser;
+}
 
 //#endregion
 //#region src/configs/javascript.ts
@@ -104,6 +108,7 @@ const GLOB_JSONC = "**/*.jsonc";
 const GLOB_YAML = "**/*.y?(a)ml";
 const GLOB_TOML = "**/*.toml";
 const GLOB_VUE = "**/*.vue";
+const GLOB_SVELTE = "**/*.svelte";
 
 //#endregion
 //#region src/configs/typescript.ts
@@ -332,10 +337,6 @@ async function vue(options = {}) {
 	const useTypeScript = !!options.typescript;
 	const vue$1 = await loadPlugin("eslint-plugin-vue");
 	const vueParser = vue$1.configs["flat/base"][1]["languageOptions"]["parser"];
-	async function getTypeScriptParser() {
-		const ts = await loadPlugin("typescript-eslint");
-		return ts.parser;
-	}
 	const customConfig = {
 		name: "@kazupon/vue",
 		files: [GLOB_VUE],
@@ -356,6 +357,74 @@ async function vue(options = {}) {
 	return [...vue$1.configs["flat/recommended"], customConfig];
 }
 
+//#endregion
+//#region src/configs/react.ts
+async function react(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = { project: true }, settings = {} } = options;
+	const useTypeScript = !options.typescript;
+	const enableRefresh = !!options.refresh;
+	const [react$1, reactHooks, reactRefresh] = await Promise.all([loadPlugin("eslint-plugin-react"), loadPlugin("eslint-plugin-react-hooks"), enableRefresh ? loadPlugin("eslint-plugin-react-refresh") : null]);
+	function getFiles() {
+		return [GLOB_JS, GLOB_JSX, ...useTypeScript ? [GLOB_TS, GLOB_TSX] : []];
+	}
+	const customConfig = {
+		name: "@kazupon/react",
+		files: getFiles(),
+		rules: { ...overrideRules }
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: await getTypeScriptParser(),
+			parserOptions: { ...parserOptions }
+		};
+	}
+	const configs = [{
+		name: "react/flat/recommended",
+		files: getFiles(),
+		settings,
+		...react$1.configs.flat.recommended
+	}, {
+		name: "react-hooks/flat",
+		files: getFiles(),
+		plugins: { "react-hooks": reactHooks }
+	}];
+	if (enableRefresh) {
+		configs.push({
+			name: "react-refresh/flat",
+			files: getFiles(),
+			plugins: { "react-refresh": reactRefresh }
+		});
+	}
+	return [...configs, customConfig];
+}
+
+//#endregion
+//#region src/configs/svelte.ts
+async function svelte(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = { project: true } } = options;
+	const useTypeScript = !!options.typescript;
+	const svelte$1 = await loadPlugin("eslint-plugin-svelte");
+	const svelteParser = svelte$1.configs["flat/base"][1]["languageOptions"]["parser"];
+	const customConfig = {
+		name: "@kazupon/svelte",
+		files: [GLOB_SVELTE],
+		rules: { ...overrideRules }
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: svelteParser,
+			parserOptions: {
+				sourceType: "module",
+				parser: await getTypeScriptParser(),
+				ecmaFeatures: { jsx: true },
+				extraFileExtensions: [".svelte"],
+				...parserOptions
+			}
+		};
+	}
+	return [...svelte$1.configs["flat/recommended"], customConfig];
+}
+
 //#endregion
 Object.defineProperty(exports, 'comments', {
   enumerable: true,
@@ -399,12 +468,24 @@ Object.defineProperty(exports, 'promise', {
     return promise;
   }
 });
+Object.defineProperty(exports, 'react', {
+  enumerable: true,
+  get: function () {
+    return react;
+  }
+});
 Object.defineProperty(exports, 'regexp', {
   enumerable: true,
   get: function () {
     return regexp;
   }
 });
+Object.defineProperty(exports, 'svelte', {
+  enumerable: true,
+  get: function () {
+    return svelte;
+  }
+});
 Object.defineProperty(exports, 'toml', {
   enumerable: true,
   get: function () {

package/dist/index.js

@@ -20,6 +20,10 @@ async function loadPlugin(name) {
 	});
 	return interopDefault(mod);
 }
+async function getTypeScriptParser() {
+	const ts = await loadPlugin("typescript-eslint");
+	return ts.parser;
+}
 
 //#endregion
 //#region src/configs/javascript.ts
@@ -80,6 +84,7 @@ const GLOB_JSONC = "**/*.jsonc";
 const GLOB_YAML = "**/*.y?(a)ml";
 const GLOB_TOML = "**/*.toml";
 const GLOB_VUE = "**/*.vue";
+const GLOB_SVELTE = "**/*.svelte";
 
 //#endregion
 //#region src/configs/typescript.ts
@@ -308,10 +313,6 @@ async function vue(options = {}) {
 	const useTypeScript = !!options.typescript;
 	const vue$1 = await loadPlugin("eslint-plugin-vue");
 	const vueParser = vue$1.configs["flat/base"][1]["languageOptions"]["parser"];
-	async function getTypeScriptParser() {
-		const ts = await loadPlugin("typescript-eslint");
-		return ts.parser;
-	}
 	const customConfig = {
 		name: "@kazupon/vue",
 		files: [GLOB_VUE],
@@ -333,4 +334,72 @@ async function vue(options = {}) {
 }
 
 //#endregion
-export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, promise, regexp, toml, typescript, unicorn, vue, yaml, yml };
+//#region src/configs/react.ts
+async function react(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = { project: true }, settings = {} } = options;
+	const useTypeScript = !options.typescript;
+	const enableRefresh = !!options.refresh;
+	const [react$1, reactHooks, reactRefresh] = await Promise.all([loadPlugin("eslint-plugin-react"), loadPlugin("eslint-plugin-react-hooks"), enableRefresh ? loadPlugin("eslint-plugin-react-refresh") : null]);
+	function getFiles() {
+		return [GLOB_JS, GLOB_JSX, ...useTypeScript ? [GLOB_TS, GLOB_TSX] : []];
+	}
+	const customConfig = {
+		name: "@kazupon/react",
+		files: getFiles(),
+		rules: { ...overrideRules }
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: await getTypeScriptParser(),
+			parserOptions: { ...parserOptions }
+		};
+	}
+	const configs = [{
+		name: "react/flat/recommended",
+		files: getFiles(),
+		settings,
+		...react$1.configs.flat.recommended
+	}, {
+		name: "react-hooks/flat",
+		files: getFiles(),
+		plugins: { "react-hooks": reactHooks }
+	}];
+	if (enableRefresh) {
+		configs.push({
+			name: "react-refresh/flat",
+			files: getFiles(),
+			plugins: { "react-refresh": reactRefresh }
+		});
+	}
+	return [...configs, customConfig];
+}
+
+//#endregion
+//#region src/configs/svelte.ts
+async function svelte(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = { project: true } } = options;
+	const useTypeScript = !!options.typescript;
+	const svelte$1 = await loadPlugin("eslint-plugin-svelte");
+	const svelteParser = svelte$1.configs["flat/base"][1]["languageOptions"]["parser"];
+	const customConfig = {
+		name: "@kazupon/svelte",
+		files: [GLOB_SVELTE],
+		rules: { ...overrideRules }
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: svelteParser,
+			parserOptions: {
+				sourceType: "module",
+				parser: await getTypeScriptParser(),
+				ecmaFeatures: { jsx: true },
+				extraFileExtensions: [".svelte"],
+				...parserOptions
+			}
+		};
+	}
+	return [...svelte$1.configs["flat/recommended"], customConfig];
+}
+
+//#endregion
+export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, promise, react, regexp, svelte, toml, typescript, unicorn, vue, yaml, yml };

package/dist/types/gens/eslint.d.cts

@@ -4,7 +4,9 @@ import type { JsdocRules } from './jsdoc';
 import type { JsoncRules } from './jsonc';
 import type { PrettierRules } from './prettier';
 import type { PromiseRules } from './promise';
+import type { ReactRules } from './react';
 import type { RegexpRules } from './regexp';
+import type { SvelteRules } from './svelte';
 import type { TomlRules } from './toml';
 import type { TypescriptRules } from './typescript';
 import type { UnicornRules } from './unicorn';
@@ -12,7 +14,7 @@ import type { VueRules } from './vue';
 import type { YmlRules } from './yml';
 declare module 'eslint' {
     namespace Linter {
-        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, RegexpRules, TomlRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
+        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, ReactRules, RegexpRules, SvelteRules, TomlRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
         }
     }
 }

package/dist/types/gens/eslint.d.ts

@@ -4,7 +4,9 @@ import type { JsdocRules } from './jsdoc';
 import type { JsoncRules } from './jsonc';
 import type { PrettierRules } from './prettier';
 import type { PromiseRules } from './promise';
+import type { ReactRules } from './react';
 import type { RegexpRules } from './regexp';
+import type { SvelteRules } from './svelte';
 import type { TomlRules } from './toml';
 import type { TypescriptRules } from './typescript';
 import type { UnicornRules } from './unicorn';
@@ -12,7 +14,7 @@ import type { VueRules } from './vue';
 import type { YmlRules } from './yml';
 declare module 'eslint' {
     namespace Linter {
-        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, RegexpRules, TomlRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
+        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, ReactRules, RegexpRules, SvelteRules, TomlRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
         }
     }
 }