@kazupon/eslint-config 0.13.3 → 0.14.1

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 './types';
+import type { Awaitable } from '@kazupon/jts-utils/types';
 /**
  * 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 './types';
+import type { Awaitable } from '@kazupon/jts-utils/types';
 /**
  * define eslint configurations
  * @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations

package/dist/index.cjs

@@ -46,11 +46,14 @@ const GLOB_VUE = "**/*.vue";
 const GLOB_SVELTE = "**/*.svelte";
 
 //#endregion
-//#region src/utils.ts
+//#region node_modules/.pnpm/@kazupon+jts-utils@0.1.0/node_modules/@kazupon/jts-utils/dist/module/index.mjs
 async function interopDefault(mod) {
 	const resolved = await mod;
 	return resolved.default || resolved;
 }
+
+//#endregion
+//#region src/utils.ts
 async function loadPlugin(name) {
 	const mod = await import(name).catch((error) => {
 		console.error(error);

package/dist/index.js

@@ -22,11 +22,14 @@ const GLOB_VUE = "**/*.vue";
 const GLOB_SVELTE = "**/*.svelte";
 
 //#endregion
-//#region src/utils.ts
+//#region node_modules/.pnpm/@kazupon+jts-utils@0.1.0/node_modules/@kazupon/jts-utils/dist/module/index.mjs
 async function interopDefault(mod) {
 	const resolved = await mod;
 	return resolved.default || resolved;
 }
+
+//#endregion
+//#region src/utils.ts
 async function loadPlugin(name) {
 	const mod = await import(name).catch((error) => {
 		console.error(error);

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 | {