@kazupon/eslint-config 0.16.0 → 0.18.0

package/README.md

@@ -25,6 +25,7 @@ ESLint config for @kazupon
   - `jsonc`
   - `yml`
   - `toml`
+  - `markdown`
 - Support primitive eslint flat configuration
 - Support overrides for built-in configurations
   - `rules`
@@ -85,6 +86,8 @@ Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?it
 
 Add the following settings to your `.vscode/settings.json`:
 
+<!-- eslint-skip -->
+
 ```jsonc
 {
   // Auto fix
@@ -94,12 +97,15 @@ Add the following settings to your `.vscode/settings.json`:
   // Enable eslint for supported languages
   "eslint.validate": [
     "javascript",
+    "javascriptreact",
     "typescript",
+    "typescriptreact",
     "vue",
     "svelte",
     "json",
     "jsonc",
     "json5",
+    "markdown",
     "yaml",
     "toml"
   ],
@@ -117,7 +123,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-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)                                                                                                                                                                                                  | 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                                       |
@@ -130,6 +136,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                                       |
 
 You can use `import` syntax:
 

package/dist/config.d.cts

@@ -1,6 +1,6 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
-import type { Linter } from 'eslint';
 import type { Awaitable } from '@kazupon/jts-utils/types';
+import type { Linter } from 'eslint';
 /**
  * define eslint configurations
  * @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations

package/dist/config.d.ts

@@ -1,6 +1,6 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
-import type { Linter } from 'eslint';
 import type { Awaitable } from '@kazupon/jts-utils/types';
+import type { Linter } from 'eslint';
 /**
  * define eslint configurations
  * @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations

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

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

package/dist/configs/imports.d.ts

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

package/dist/configs/index.d.cts

@@ -1,16 +1,17 @@
-export * from './javascript';
-export * from './comments';
-export * from './typescript';
-export * from './jsdoc';
-export * from './imports';
-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 './markdown.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,16 +1,17 @@
-export * from './javascript';
-export * from './comments';
-export * from './typescript';
-export * from './jsdoc';
-export * from './imports';
-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 './markdown.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/markdown.d.cts

@@ -0,0 +1,28 @@
+import type { Linter } from 'eslint';
+import type { MarkdownRules, OverridesOptions } from '../types/index.ts';
+/**
+ * eslint unicorn configuration options
+ */
+export interface MarkdownOptions {
+    /**
+     * makrdown language
+     * @see https://github.com/eslint/markdown?tab=readme-ov-file#languages
+     * @default 'gfm'
+     */
+    language?: 'commonmark' | 'gfm';
+    /**
+     * enable fenced code blocks
+     * @see https://github.com/eslint/markdown/blob/main/docs/processors/markdown.md
+     * @default true
+     */
+    fencedCodeBlocks?: boolean;
+}
+/**
+ * `@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
+ */
+export declare function markdown(options?: MarkdownOptions & OverridesOptions<MarkdownRules>): Promise<Linter.Config[]>;
+export declare const md: typeof markdown;

package/dist/configs/markdown.d.ts

@@ -0,0 +1,28 @@
+import type { Linter } from 'eslint';
+import type { MarkdownRules, OverridesOptions } from '../types/index.ts';
+/**
+ * eslint unicorn configuration options
+ */
+export interface MarkdownOptions {
+    /**
+     * makrdown language
+     * @see https://github.com/eslint/markdown?tab=readme-ov-file#languages
+     * @default 'gfm'
+     */
+    language?: 'commonmark' | 'gfm';
+    /**
+     * enable fenced code blocks
+     * @see https://github.com/eslint/markdown/blob/main/docs/processors/markdown.md
+     * @default true
+     */
+    fencedCodeBlocks?: boolean;
+}
+/**
+ * `@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
+ */
+export declare function markdown(options?: MarkdownOptions & OverridesOptions<MarkdownRules>): Promise<Linter.Config[]>;
+export declare const md: typeof markdown;

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 { OverridesOptions, VueRules } from '../types';
-import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, VueRules } from '../types/index.ts';
+import type { TypeScriptOptions } from './typescript.ts';
 /**
  * Vue configuration options
  */

package/dist/configs/vue.d.ts

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

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
  */

package/dist/globs.d.cts

@@ -9,5 +9,6 @@ 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";
+export declare const GLOB_MARKDOWN = "**/*.md";
 export declare const GLOB_TESTS: string[];
 export declare const GLOB_TESTS_TYPE: string[];

package/dist/globs.d.ts

@@ -9,5 +9,6 @@ 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";
+export declare const GLOB_MARKDOWN = "**/*.md";
 export declare const GLOB_TESTS: string[];
 export declare const GLOB_TESTS_TYPE: string[];