@kazupon/eslint-config 0.28.0 → 0.29.0

package/README.md

@@ -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)                             |
 | `stylistic`   | [`@stylistic/eslint-plugin`](https://www.npmjs.com/package/@stylistic/eslint-plugin)                                                                                                                                                                                                                                                                                                                                                                               | no (built-in)                             |
-| `comments`    | [`@eslint-community/eslint-plugin-eslint-comments`](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments)                                                                                                                                                                                                                                                                                                                                 | no (built-in)                             |
+| `comments`    | [`@eslint-community/eslint-plugin-eslint-comments`](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments), [`@kazupon/eslint-plugin`(comment config)](https://www.npmjs.com/package/@kazupon/eslint-plugin)                                                                                                                                                                                                                               | 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), [`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                                       |

package/dist/index.d.ts

@@ -3,6 +3,11 @@ import { Awaitable } from '@kazupon/jts-utils/types';
 import { Linter, ESLint } from 'eslint';
 import { StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * define eslint configurations
  * @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
@@ -10,6 +15,11 @@ import { StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
  */
 declare function defineConfig(...configs: Awaitable<Linter.Config | Linter.Config[]>[]): FlatConfigComposer;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 interface OverridesOptions<Rules = Linter.Config['rules']> {
     files?: Linter.Config['files'];
     ignores?: Linter.Config['ignores'];
@@ -64,6 +74,11 @@ interface CommentsRules {
      * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/require-description.html
      */
     '@eslint-community/eslint-comments/require-description'?: Linter.RuleEntry<EslintCommunityEslintCommentsRequireDescription>;
+    /**
+     * Enforce heading the comment in source code file
+     * @see https://eslint-plugin.kazupon.dev/rules/enforce-header-comment
+     */
+    '@kazupon/enforce-header-comment'?: Linter.RuleEntry<[]>;
 }
 type EslintCommunityEslintCommentsDisableEnablePair = [] | [
     {
@@ -15780,18 +15795,35 @@ declare module 'eslint' {
 }
 
 /**
- * eslint comments configuration options
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
+/**
+ * comments preset options
  */
 interface CommentsOptions {
+    /**
+     * An options for `@eslint-community/eslint-plugin-eslint-comments`
+     */
+    directives?: OverridesOptions<CommentsRules>;
+    /**
+     * An options for `@kazupon/eslint-plugin` comment config
+     */
+    kazupon?: OverridesOptions<CommentsRules>;
 }
 /**
- * `@eslint-community/eslint-plugin-eslint-comments` and overrides configuration options
- * @param {CommentsOptions & OverridesOptions} options
- *  eslint comments configuration options for eslint comment directives
- * @returns {Promise<Linter.Config[]>}
- *  eslint flat configurations with `@eslint-community/eslint-plugin-eslint-comments` and overrides
+ * configure comments preset for the below plugins
+ * - `@eslint-community/eslint-plugin-eslint-comments`
+ * @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
+ * @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
+ */
+declare function comments(options?: CommentsOptions): Promise<Linter.Config[]>;
+
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
  */
-declare function comments(options?: CommentsOptions & OverridesOptions<CommentsRules>): Promise<Linter.Config[]>;
 
 /**
  * eslint css configuration options
@@ -15823,6 +15855,11 @@ interface CssOptions {
  */
 declare function css(options?: CssOptions & OverridesOptions<CssRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * imports configuration options
  */
@@ -15848,6 +15885,11 @@ interface ImportsOptions {
  */
 declare function imports(options?: ImportsOptions & OverridesOptions<ImportsRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * JavaScript configuration options
  */
@@ -15860,6 +15902,11 @@ interface JavaScriptOptions {
  */
 declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * jsdoc configuration options
  */
@@ -15886,6 +15933,11 @@ interface JsDocumentOptions {
  */
 declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint jsonc configuration options
  */
@@ -15924,6 +15976,11 @@ interface JsoncOptions {
  */
 declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint unicorn configuration options
  */
@@ -15955,6 +16012,11 @@ interface MarkdownOptions {
 declare function markdown(options?: MarkdownOptions & OverridesOptions): Promise<Linter.Config[]>;
 declare const md: typeof markdown;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * Prettier configuration options
  */
@@ -15969,6 +16031,11 @@ interface PrettierOptions {
  */
 declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint promise configuration options
  */
@@ -16041,6 +16108,11 @@ interface TypeScriptProjectServiceOptions {
  */
 declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint react configuration options
  */
@@ -16065,6 +16137,11 @@ interface ReactOptions {
  */
 declare function react(options?: ReactOptions & TypeScriptOptions & OverridesOptions<ReactRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint regexp configuration options
  */
@@ -16079,6 +16156,11 @@ interface RegexpOptions {
  */
 declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * stylistic eslint plugin configuration options
  */
@@ -16098,6 +16180,11 @@ interface StylisticOptions {
  */
 declare function stylistic(options?: StylisticOptions & OverridesOptions<StylisticRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * Svelte configuration options
  */
@@ -16117,6 +16204,11 @@ interface SvelteScriptOptions {
  */
 declare function svelte(options?: SvelteScriptOptions & TypeScriptOptions & OverridesOptions<SvelteRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint toml configuration options
  */
@@ -16131,6 +16223,11 @@ interface TomlOptions {
  */
 declare function toml(options?: TomlOptions & OverridesOptions<TomlRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint unicorn configuration options
  */
@@ -16150,6 +16247,11 @@ interface UnicornOptions {
  */
 declare function unicorn(options?: UnicornOptions & OverridesOptions<UnicornRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint vitest configuration options
  */
@@ -16171,6 +16273,11 @@ interface VitestOptions {
  */
 declare function vitest(options?: VitestOptions & OverridesOptions<VitestRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * Vue configuration options
  */
@@ -16219,6 +16326,11 @@ interface VueI18nOptions {
  */
 declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.Config[]>;
 
+/**
+ * @author kazuya kawaguchi (a.k.a. @kazupon)
+ * @license MIT
+ */
+
 /**
  * eslint yml configuration options
  */

package/dist/index.js

@@ -68,17 +68,26 @@ function getGlobSourceFiles(useTypeScript = false) {
 //#endregion
 //#region src/configs/comments.ts
 async function comments(options = {}) {
-	const { rules: overrideRules = {} } = options;
 	const comments$1 = await loadPlugin("@eslint-community/eslint-plugin-eslint-comments");
+	const kazupon = await loadPlugin("@kazupon/eslint-plugin");
+	const directives = options.directives ?? {};
+	const kazuponOptions = options.kazupon ?? {};
 	return [{
-		name: "@eslint-community/eslint-comments/recommended",
-		ignores: [GLOB_MARKDOWN],
+		name: "@eslint-community/eslint-comments",
+		ignores: directives.ignores ? [GLOB_MARKDOWN, ...directives.ignores] : [GLOB_MARKDOWN],
 		plugins: { "@eslint-community/eslint-comments": comments$1 },
-		rules: { ...comments$1.configs.recommended.rules }
-	}, {
-		name: "@kazupon/eslint-comments",
-		rules: { ...overrideRules }
-	}];
+		rules: {
+			...comments$1.configs.recommended.rules,
+			...directives.rules
+		}
+	}, ...kazupon.configs.comment.map((config) => ({
+		...config,
+		ignores: [...config.ignores, ...kazuponOptions.ignores || []],
+		rules: {
+			...config.rules,
+			...kazuponOptions.rules
+		}
+	}))];
 }
 
 //#endregion
@@ -503,11 +512,9 @@ async function stylistic(options = {}) {
 				allowTypeStart: true
 			}],
 			"@stylistic/spaced-comment": ["error"],
-			"@stylistic/multiline-comment-style": ["error", "separate-lines"]
+			"@stylistic/multiline-comment-style": ["error", "separate-lines"],
+			...overrideRules
 		}
-	}, {
-		name: "@kazupon/@stylistic/overrides",
-		rules: { ...overrideRules }
 	}];
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-config",
   "description": "ESLint config for @kazupon",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "author": {
     "email": "kawakazu80@gmail.com",
     "name": "kazuya kawaguchi"
@@ -51,6 +51,7 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
     "@eslint/js": "^9.22.0",
+    "@kazupon/eslint-plugin": "^0.2.2",
     "@kazupon/jts-utils": "^0.6.0",
     "@stylistic/eslint-plugin": "^4.2.0",
     "eslint-flat-config-utils": "^2.0.1",