@kazupon/eslint-config 0.13.2 → 0.14.0

package/dist/configs/unicorn.d.cts

@@ -4,6 +4,11 @@ import type { OverridesOptions, UnicornRules } from '../types';
  * eslint unicorn configuration options
  */
 export interface UnicornOptions {
+    /**
+     * use TypeScript
+     * @default true
+     */
+    typescript?: boolean;
 }
 /**
  * `eslint-plugin-unicorn` and overrides configuration options

package/dist/configs/unicorn.d.ts

@@ -4,6 +4,11 @@ import type { OverridesOptions, UnicornRules } from '../types';
  * eslint unicorn configuration options
  */
 export interface UnicornOptions {
+    /**
+     * use TypeScript
+     * @default true
+     */
+    typescript?: boolean;
 }
 /**
  * `eslint-plugin-unicorn` and overrides configuration options

package/dist/index.cjs

@@ -31,6 +31,20 @@ function defineConfig(...configs) {
 	return new FlatConfigComposer().append(...baseConfigs, ...configs);
 }
 
+//#endregion
+//#region src/globs.ts
+const GLOB_JS = "**/*.?([cm])js";
+const GLOB_JSX = "**/*.?([cm])jsx";
+const GLOB_TS = "**/*.?([cm])ts";
+const GLOB_TSX = "**/*.?([cm])tsx";
+const GLOB_JSON = "**/*.json";
+const GLOB_JSON5 = "**/*.json5";
+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/utils.ts
 async function interopDefault(mod) {
@@ -48,6 +62,9 @@ async function getTypeScriptParser() {
 	const ts = await loadPlugin("typescript-eslint");
 	return ts.parser;
 }
+function getGlobSourceFiles(useTypeScript = false) {
+	return [GLOB_JS, GLOB_JSX, ...useTypeScript ? [GLOB_TS, GLOB_TSX] : []];
+}
 
 //#endregion
 //#region src/configs/javascript.ts
@@ -96,20 +113,6 @@ async function comments(options = {}) {
 	}];
 }
 
-//#endregion
-//#region src/globs.ts
-const GLOB_JS = "**/*.?([cm])js";
-const GLOB_JSX = "**/*.?([cm])jsx";
-const GLOB_TS = "**/*.?([cm])ts";
-const GLOB_TSX = "**/*.?([cm])tsx";
-const GLOB_JSON = "**/*.json";
-const GLOB_JSON5 = "**/*.json5";
-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
 async function typescript(options = {}) {
@@ -221,9 +224,14 @@ async function toml(options = {}) {
 //#region src/configs/unicorn.ts
 async function unicorn(options = {}) {
 	const { rules: overrideRules = {} } = options;
+	const useTypeScript = !options.typescript;
 	const unicorn$1 = await loadPlugin("eslint-plugin-unicorn");
-	return [unicorn$1.configs["flat/recommended"], {
+	return [{
+		files: getGlobSourceFiles(useTypeScript),
+		...unicorn$1.configs["flat/recommended"]
+	}, {
 		name: "@kazupon/unicorn",
+		files: getGlobSourceFiles(useTypeScript),
 		rules: { ...overrideRules }
 	}];
 }
@@ -364,28 +372,25 @@ async function react(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(),
+		files: getGlobSourceFiles(useTypeScript),
 		rules: { ...overrideRules }
 	};
 	const configs = [{
 		name: "react/flat/recommended",
-		files: getFiles(),
+		files: getGlobSourceFiles(useTypeScript),
 		settings,
 		...react$1.configs.flat.recommended
 	}, {
 		name: "react-hooks/flat",
-		files: getFiles(),
+		files: getGlobSourceFiles(useTypeScript),
 		plugins: { "react-hooks": reactHooks }
 	}];
 	if (enableRefresh) {
 		configs.push({
 			name: "react-refresh/flat",
-			files: getFiles(),
+			files: getGlobSourceFiles(useTypeScript),
 			plugins: { "react-refresh": reactRefresh }
 		});
 	}

package/dist/index.js

@@ -7,6 +7,20 @@ function defineConfig(...configs) {
 	return new FlatConfigComposer().append(...baseConfigs, ...configs);
 }
 
+//#endregion
+//#region src/globs.ts
+const GLOB_JS = "**/*.?([cm])js";
+const GLOB_JSX = "**/*.?([cm])jsx";
+const GLOB_TS = "**/*.?([cm])ts";
+const GLOB_TSX = "**/*.?([cm])tsx";
+const GLOB_JSON = "**/*.json";
+const GLOB_JSON5 = "**/*.json5";
+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/utils.ts
 async function interopDefault(mod) {
@@ -24,6 +38,9 @@ async function getTypeScriptParser() {
 	const ts = await loadPlugin("typescript-eslint");
 	return ts.parser;
 }
+function getGlobSourceFiles(useTypeScript = false) {
+	return [GLOB_JS, GLOB_JSX, ...useTypeScript ? [GLOB_TS, GLOB_TSX] : []];
+}
 
 //#endregion
 //#region src/configs/javascript.ts
@@ -72,20 +89,6 @@ async function comments(options = {}) {
 	}];
 }
 
-//#endregion
-//#region src/globs.ts
-const GLOB_JS = "**/*.?([cm])js";
-const GLOB_JSX = "**/*.?([cm])jsx";
-const GLOB_TS = "**/*.?([cm])ts";
-const GLOB_TSX = "**/*.?([cm])tsx";
-const GLOB_JSON = "**/*.json";
-const GLOB_JSON5 = "**/*.json5";
-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
 async function typescript(options = {}) {
@@ -197,9 +200,14 @@ async function toml(options = {}) {
 //#region src/configs/unicorn.ts
 async function unicorn(options = {}) {
 	const { rules: overrideRules = {} } = options;
+	const useTypeScript = !options.typescript;
 	const unicorn$1 = await loadPlugin("eslint-plugin-unicorn");
-	return [unicorn$1.configs["flat/recommended"], {
+	return [{
+		files: getGlobSourceFiles(useTypeScript),
+		...unicorn$1.configs["flat/recommended"]
+	}, {
 		name: "@kazupon/unicorn",
+		files: getGlobSourceFiles(useTypeScript),
 		rules: { ...overrideRules }
 	}];
 }
@@ -340,28 +348,25 @@ async function react(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(),
+		files: getGlobSourceFiles(useTypeScript),
 		rules: { ...overrideRules }
 	};
 	const configs = [{
 		name: "react/flat/recommended",
-		files: getFiles(),
+		files: getGlobSourceFiles(useTypeScript),
 		settings,
 		...react$1.configs.flat.recommended
 	}, {
 		name: "react-hooks/flat",
-		files: getFiles(),
+		files: getGlobSourceFiles(useTypeScript),
 		plugins: { "react-hooks": reactHooks }
 	}];
 	if (enableRefresh) {
 		configs.push({
 			name: "react-refresh/flat",
-			files: getFiles(),
+			files: getGlobSourceFiles(useTypeScript),
 			plugins: { "react-refresh": reactRefresh }
 		});
 	}

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

@@ -45,6 +45,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header
      */
     'jsdoc/check-tag-names'?: Linter.RuleEntry<JsdocCheckTagNames>;
+    /**
+     * Checks that any `@template` names are actually used in the connected `@typedef` or type alias.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md#repos-sticky-header
+     */
+    'jsdoc/check-template-names'?: Linter.RuleEntry<[]>;
     /**
      * Reports invalid types.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header
@@ -55,6 +60,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md#repos-sticky-header
      */
     'jsdoc/check-values'?: Linter.RuleEntry<JsdocCheckValues>;
+    /**
+     * Converts non-JSDoc comments preceding or following nodes into JSDoc ones
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header
+     */
+    'jsdoc/convert-to-jsdoc-comments'?: Linter.RuleEntry<JsdocConvertToJsdocComments>;
     /**
      * Expects specific tags to be empty of any content.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header
@@ -75,6 +85,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header
      */
     'jsdoc/informative-docs'?: Linter.RuleEntry<JsdocInformativeDocs>;
+    /**
+     * Enforces minimum number of newlines before JSDoc comment blocks
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header
+     */
+    'jsdoc/lines-before-block'?: Linter.RuleEntry<JsdocLinesBeforeBlock>;
     /**
      * Enforces a regular expression pattern on descriptions.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header
@@ -229,6 +244,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header
      */
     'jsdoc/require-returns-type'?: Linter.RuleEntry<JsdocRequireReturnsType>;
+    /**
+     * Requires template tags for each generic type parameter
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header
+     */
+    'jsdoc/require-template'?: Linter.RuleEntry<JsdocRequireTemplate>;
     /**
      * Requires that throw statements are documented.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header
@@ -351,6 +371,26 @@ type JsdocCheckValues = [] | [
         numericOnlyVariation?: boolean;
     }
 ];
+type JsdocConvertToJsdocComments = [] | [
+    {
+        allowedPrefixes?: string[];
+        contexts?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        contextsAfter?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        contextsBeforeAndAfter?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        enableFixer?: boolean;
+        enforceJsdocLineStyle?: ("multi" | "single");
+        lineOrBlockStyle?: ("block" | "line" | "both");
+    }
+];
 type JsdocEmptyTags = [] | [
     {
         tags?: string[];
@@ -373,6 +413,13 @@ type JsdocInformativeDocs = [] | [
         uselessWords?: string[];
     }
 ];
+type JsdocLinesBeforeBlock = [] | [
+    {
+        excludedTags?: string[];
+        ignoreSameLine?: boolean;
+        lines?: number;
+    }
+];
 type JsdocMatchDescription = [] | [
     {
         contexts?: (string | {
@@ -669,6 +716,11 @@ type JsdocRequireReturnsType = [] | [
         })[];
     }
 ];
+type JsdocRequireTemplate = [] | [
+    {
+        requireSeparateTemplates?: boolean;
+    }
+];
 type JsdocRequireThrows = [] | [
     {
         contexts?: (string | {

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

@@ -45,6 +45,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header
      */
     'jsdoc/check-tag-names'?: Linter.RuleEntry<JsdocCheckTagNames>;
+    /**
+     * Checks that any `@template` names are actually used in the connected `@typedef` or type alias.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md#repos-sticky-header
+     */
+    'jsdoc/check-template-names'?: Linter.RuleEntry<[]>;
     /**
      * Reports invalid types.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header
@@ -55,6 +60,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md#repos-sticky-header
      */
     'jsdoc/check-values'?: Linter.RuleEntry<JsdocCheckValues>;
+    /**
+     * Converts non-JSDoc comments preceding or following nodes into JSDoc ones
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header
+     */
+    'jsdoc/convert-to-jsdoc-comments'?: Linter.RuleEntry<JsdocConvertToJsdocComments>;
     /**
      * Expects specific tags to be empty of any content.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header
@@ -75,6 +85,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header
      */
     'jsdoc/informative-docs'?: Linter.RuleEntry<JsdocInformativeDocs>;
+    /**
+     * Enforces minimum number of newlines before JSDoc comment blocks
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header
+     */
+    'jsdoc/lines-before-block'?: Linter.RuleEntry<JsdocLinesBeforeBlock>;
     /**
      * Enforces a regular expression pattern on descriptions.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header
@@ -229,6 +244,11 @@ export interface JsdocRules {
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header
      */
     'jsdoc/require-returns-type'?: Linter.RuleEntry<JsdocRequireReturnsType>;
+    /**
+     * Requires template tags for each generic type parameter
+     * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header
+     */
+    'jsdoc/require-template'?: Linter.RuleEntry<JsdocRequireTemplate>;
     /**
      * Requires that throw statements are documented.
      * @see https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header
@@ -351,6 +371,26 @@ type JsdocCheckValues = [] | [
         numericOnlyVariation?: boolean;
     }
 ];
+type JsdocConvertToJsdocComments = [] | [
+    {
+        allowedPrefixes?: string[];
+        contexts?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        contextsAfter?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        contextsBeforeAndAfter?: (string | {
+            context?: string;
+            inlineCommentBlock?: boolean;
+        })[];
+        enableFixer?: boolean;
+        enforceJsdocLineStyle?: ("multi" | "single");
+        lineOrBlockStyle?: ("block" | "line" | "both");
+    }
+];
 type JsdocEmptyTags = [] | [
     {
         tags?: string[];
@@ -373,6 +413,13 @@ type JsdocInformativeDocs = [] | [
         uselessWords?: string[];
     }
 ];
+type JsdocLinesBeforeBlock = [] | [
+    {
+        excludedTags?: string[];
+        ignoreSameLine?: boolean;
+        lines?: number;
+    }
+];
 type JsdocMatchDescription = [] | [
     {
         contexts?: (string | {
@@ -669,6 +716,11 @@ type JsdocRequireReturnsType = [] | [
         })[];
     }
 ];
+type JsdocRequireTemplate = [] | [
+    {
+        requireSeparateTemplates?: boolean;
+    }
+];
 type JsdocRequireThrows = [] | [
     {
         contexts?: (string | {