@kazupon/eslint-config 0.15.0 → 0.17.0

package/README.md

@@ -8,10 +8,11 @@ ESLint config for @kazupon
 ## 🌟 Features
 
 - Flat configuration via [vite](https://vitejs.dev/config/) flavor `defineConfig`
-- Support [built-in configurations](#built-in-configurations)
+- Support [built-in preset configurations](#built-in-preset-configurations)
   - `javascript`
   - `comments`
   - `typescript`
+  - `imports`
   - `jsdoc`
   - `regexp`
   - `promise`
@@ -107,27 +108,28 @@ Add the following settings to your `.vscode/settings.json`:
 }
 ```
 
-## 🔨Built-in configurations
-
-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                                       |
-| `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                                       |
-| `vitest`      | [`@vitest/eslint-plugin`](https://www.npmjs.com/package/@vitest/eslint-plugin)                                                                                                                                                                                 | 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                                       |
+## 🔨Built-in preset configurations
+
+The following built-in preset 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                                       |
+| `imports`     | [`eslint-plugin-import-x`](https://www.npmjs.com/package/eslint-plugin-import-x), [`eslint-plugin-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)                                                                                                                                                                                              | 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), [`eslint-plugin-vue-composable`](https://www.npmjs.com/package/eslint-plugin-vue-composable), [`eslint-plugin-vue-scoped-css`](https://www.npmjs.com/package/eslint-plugin-vue-scoped-css), [`eslint-plugin-vuejs-accessibility`](https://www.npmjs.com/package/eslint-plugin-vuejs-accessibility)) | 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                                       |
+| `vitest`      | [`@vitest/eslint-plugin`](https://www.npmjs.com/package/@vitest/eslint-plugin)                                                                                                                                                                                                                                                                                              | 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/comments.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, CommentsRules } from '../types';
+import type { CommentsRules, OverridesOptions } from '../types/index.ts';
 /**
  * eslint comments configuration options
  */

package/dist/configs/comments.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, CommentsRules } from '../types';
+import type { CommentsRules, OverridesOptions } from '../types/index.ts';
 /**
  * eslint comments configuration options
  */

package/dist/configs/imports.d.cts

@@ -0,0 +1,21 @@
+import type { Linter } from 'eslint';
+import type { ImportsRules, OverridesOptions } from '../types/index.ts';
+/**
+ * imports configuration options
+ */
+export interface ImportsOptions {
+    /**
+     * use typescript
+     * @default false
+     */
+    typescript?: boolean;
+}
+/**
+ * `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 `javascirpt` 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
+ */
+export declare function imports(options?: ImportsOptions & OverridesOptions<ImportsRules>): Promise<Linter.Config[]>;

package/dist/configs/imports.d.ts

@@ -0,0 +1,21 @@
+import type { Linter } from 'eslint';
+import type { ImportsRules, OverridesOptions } from '../types/index.ts';
+/**
+ * imports configuration options
+ */
+export interface ImportsOptions {
+    /**
+     * use typescript
+     * @default false
+     */
+    typescript?: boolean;
+}
+/**
+ * `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 `javascirpt` 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
+ */
+export declare function imports(options?: ImportsOptions & OverridesOptions<ImportsRules>): Promise<Linter.Config[]>;

package/dist/configs/index.d.cts

@@ -1,15 +1,16 @@
-export * from './javascript';
-export * from './comments';
-export * from './typescript';
-export * from './jsdoc';
-export * from './promise';
-export * from './regexp';
-export * from './toml';
-export * from './unicorn';
-export * from './prettier';
-export * from './jsonc';
-export * from './yml';
-export * from './vue';
-export * from './react';
-export * from './svelte';
-export * from './vitest';
+export * from './comments.ts';
+export * from './imports.ts';
+export * from './javascript.ts';
+export * from './jsdoc.ts';
+export * from './jsonc.ts';
+export * from './prettier.ts';
+export * from './promise.ts';
+export * from './react.ts';
+export * from './regexp.ts';
+export * from './svelte.ts';
+export * from './toml.ts';
+export * from './typescript.ts';
+export * from './unicorn.ts';
+export * from './vitest.ts';
+export * from './vue.ts';
+export * from './yml.ts';

package/dist/configs/index.d.ts

@@ -1,15 +1,16 @@
-export * from './javascript';
-export * from './comments';
-export * from './typescript';
-export * from './jsdoc';
-export * from './promise';
-export * from './regexp';
-export * from './toml';
-export * from './unicorn';
-export * from './prettier';
-export * from './jsonc';
-export * from './yml';
-export * from './vue';
-export * from './react';
-export * from './svelte';
-export * from './vitest';
+export * from './comments.ts';
+export * from './imports.ts';
+export * from './javascript.ts';
+export * from './jsdoc.ts';
+export * from './jsonc.ts';
+export * from './prettier.ts';
+export * from './promise.ts';
+export * from './react.ts';
+export * from './regexp.ts';
+export * from './svelte.ts';
+export * from './toml.ts';
+export * from './typescript.ts';
+export * from './unicorn.ts';
+export * from './vitest.ts';
+export * from './vue.ts';
+export * from './yml.ts';

package/dist/configs/javascript.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JavascriptRules } from '../types';
+import type { JavascriptRules, OverridesOptions } from '../types/index.ts';
 /**
  * JavaScript configuration options
  */

package/dist/configs/javascript.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JavascriptRules } from '../types';
+import type { JavascriptRules, OverridesOptions } from '../types/index.ts';
 /**
  * JavaScript configuration options
  */

package/dist/configs/jsdoc.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JsdocRules } from '../types';
+import type { JsdocRules, OverridesOptions } from '../types/index.ts';
 /**
  * jsdoc configuration options
  */

package/dist/configs/jsdoc.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JsdocRules } from '../types';
+import type { JsdocRules, OverridesOptions } from '../types/index.ts';
 /**
  * jsdoc configuration options
  */

package/dist/configs/jsonc.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JsoncRules } from '../types';
+import type { JsoncRules, OverridesOptions } from '../types/index.ts';
 /**
  * eslint jsonc configuration options
  */

package/dist/configs/jsonc.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, JsoncRules } from '../types';
+import type { JsoncRules, OverridesOptions } from '../types/index.ts';
 /**
  * eslint jsonc configuration options
  */

package/dist/configs/prettier.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, PrettierRules } from '../types';
+import type { OverridesOptions, PrettierRules } from '../types/index.ts';
 /**
  * Prettier configuration options
  */

package/dist/configs/prettier.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, PrettierRules } from '../types';
+import type { OverridesOptions, PrettierRules } from '../types/index.ts';
 /**
  * Prettier configuration options
  */

package/dist/configs/promise.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, PromiseRules } from '../types';
+import type { OverridesOptions, PromiseRules } from '../types/index.ts';
 /**
  * eslint promise configuration options
  */

package/dist/configs/promise.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, PromiseRules } from '../types';
+import type { OverridesOptions, PromiseRules } from '../types/index.ts';
 /**
  * eslint promise configuration options
  */

package/dist/configs/react.d.cts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, ReactRules } from '../types';
+import type { OverridesOptions, ReactRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * eslint react configuration options
  */

package/dist/configs/react.d.ts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, ReactRules } from '../types';
+import type { OverridesOptions, ReactRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * eslint react configuration options
  */

package/dist/configs/regexp.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, RegexpRules } from '../types';
+import type { OverridesOptions, RegexpRules } from '../types/index.ts';
 /**
  * eslint regexp configuration options
  */

package/dist/configs/regexp.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, RegexpRules } from '../types';
+import type { OverridesOptions, RegexpRules } from '../types/index.ts';
 /**
  * eslint regexp configuration options
  */

package/dist/configs/svelte.d.cts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, SvelteRules } from '../types';
+import type { OverridesOptions, SvelteRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * Svelte configuration options
  */

package/dist/configs/svelte.d.ts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, SvelteRules } from '../types';
+import type { OverridesOptions, SvelteRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * Svelte configuration options
  */

package/dist/configs/toml.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, TomlRules } from '../types';
+import type { OverridesOptions, TomlRules } from '../types/index.ts';
 /**
  * eslint toml configuration options
  */

package/dist/configs/toml.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, TomlRules } from '../types';
+import type { OverridesOptions, TomlRules } from '../types/index.ts';
 /**
  * eslint toml configuration options
  */

package/dist/configs/typescript.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, TypescriptRules } from '../types';
+import type { OverridesOptions, TypescriptRules } from '../types/index.ts';
 /**
  * TypeScript configuration options
  */

package/dist/configs/typescript.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, TypescriptRules } from '../types';
+import type { OverridesOptions, TypescriptRules } from '../types/index.ts';
 /**
  * TypeScript configuration options
  */

package/dist/configs/unicorn.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, UnicornRules } from '../types';
+import type { OverridesOptions, UnicornRules } from '../types/index.ts';
 /**
  * eslint unicorn configuration options
  */

package/dist/configs/unicorn.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, UnicornRules } from '../types';
+import type { OverridesOptions, UnicornRules } from '../types/index.ts';
 /**
  * eslint unicorn configuration options
  */

package/dist/configs/vitest.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, VitestRules } from '../types';
+import type { OverridesOptions, VitestRules } from '../types/index.ts';
 /**
  * eslint vitest configuration options
  */

package/dist/configs/vitest.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, VitestRules } from '../types';
+import type { OverridesOptions, VitestRules } from '../types/index.ts';
 /**
  * eslint vitest configuration options
  */

package/dist/configs/vue.d.cts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, VueRules } from '../types';
+import type { OverridesOptions, VueRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * Vue configuration options
  */
@@ -10,12 +10,27 @@ export interface VueScriptOptions {
      * @default false
      */
     typescript?: boolean;
+    /**
+     * enable `eslint-plugin-vue-composable` rules
+     * @default false
+     */
+    composable?: boolean;
+    /**
+     * enable `eslint-plugin-vue-scoped-css` rules
+     * @default false
+     */
+    scopedCss?: boolean;
+    /**
+     * enable `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` rules
+     * @default false
+     */
+    a11y?: boolean;
 }
 /**
- * `eslint-plugin-vue` and overrides configuration 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` and overrides
+ * eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
  */
 export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.Config[]>;

package/dist/configs/vue.d.ts

@@ -1,6 +1,6 @@
 import type { Linter } from 'eslint';
-import type { TypeScriptOptions } from './typescript';
-import type { OverridesOptions, VueRules } from '../types';
+import type { OverridesOptions, VueRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * Vue configuration options
  */
@@ -10,12 +10,27 @@ export interface VueScriptOptions {
      * @default false
      */
     typescript?: boolean;
+    /**
+     * enable `eslint-plugin-vue-composable` rules
+     * @default false
+     */
+    composable?: boolean;
+    /**
+     * enable `eslint-plugin-vue-scoped-css` rules
+     * @default false
+     */
+    scopedCss?: boolean;
+    /**
+     * enable `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` rules
+     * @default false
+     */
+    a11y?: boolean;
 }
 /**
- * `eslint-plugin-vue` and overrides configuration 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` and overrides
+ * eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
  */
 export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.Config[]>;

package/dist/configs/yml.d.cts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, YmlRules } from '../types';
+import type { OverridesOptions, YmlRules } from '../types/index.ts';
 /**
  * eslint yml configuration options
  */

package/dist/configs/yml.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions, YmlRules } from '../types';
+import type { OverridesOptions, YmlRules } from '../types/index.ts';
 /**
  * eslint yml configuration options
  */