@kazupon/eslint-config 0.7.0 → 0.9.0

package/dist/configs/yml.d.cts

@@ -1,7 +1,22 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, YmlRules } from '../types';
+/**
+ * eslint yml configuration options
+ */
 export interface YmlOptions {
-	prettier?: boolean;
+    /**
+     * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-yml/user-guide/#configuration
+     * @default false
+     */
+    prettier?: boolean;
 }
-export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-yml` and overrides configuration options
+ * @param {YmlOptions & OverridesOptions} options
+ *  eslint yml configuration options for yml, yaml
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-yml` and overrides
+ */
+export declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.FlatConfig[]>;
 export declare const yaml: typeof yml;

package/dist/configs/yml.d.ts

@@ -1,7 +1,22 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, YmlRules } from '../types';
+/**
+ * eslint yml configuration options
+ */
 export interface YmlOptions {
-	prettier?: boolean;
+    /**
+     * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-yml/user-guide/#configuration
+     * @default false
+     */
+    prettier?: boolean;
 }
-export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-yml` and overrides configuration options
+ * @param {YmlOptions & OverridesOptions} options
+ *  eslint yml configuration options for yml, yaml
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-yml` and overrides
+ */
+export declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.FlatConfig[]>;
 export declare const yaml: typeof yml;

package/dist/globs.d.cts

@@ -1,9 +1,9 @@
-export declare const GLOB_JS = '**/*.?([cm])js';
-export declare const GLOB_JSX = '**/*.?([cm])jsx';
-export declare const GLOB_TS = '**/*.?([cm])ts';
-export declare const GLOB_TSX = '**/*.?([cm])tsx';
-export declare const GLOB_JSON = '**/*.json';
-export declare const GLOB_JSON5 = '**/*.json5';
-export declare const GLOB_JSONC = '**/*.jsonc';
-export declare const GLOB_YAML = '**/*.y?(a)ml';
-export declare const GLOB_VUE = '**/*.vue';
+export declare const GLOB_JS = "**/*.?([cm])js";
+export declare const GLOB_JSX = "**/*.?([cm])jsx";
+export declare const GLOB_TS = "**/*.?([cm])ts";
+export declare const GLOB_TSX = "**/*.?([cm])tsx";
+export declare const GLOB_JSON = "**/*.json";
+export declare const GLOB_JSON5 = "**/*.json5";
+export declare const GLOB_JSONC = "**/*.jsonc";
+export declare const GLOB_YAML = "**/*.y?(a)ml";
+export declare const GLOB_VUE = "**/*.vue";

package/dist/globs.d.ts

@@ -1,9 +1,9 @@
-export declare const GLOB_JS = '**/*.?([cm])js';
-export declare const GLOB_JSX = '**/*.?([cm])jsx';
-export declare const GLOB_TS = '**/*.?([cm])ts';
-export declare const GLOB_TSX = '**/*.?([cm])tsx';
-export declare const GLOB_JSON = '**/*.json';
-export declare const GLOB_JSON5 = '**/*.json5';
-export declare const GLOB_JSONC = '**/*.jsonc';
-export declare const GLOB_YAML = '**/*.y?(a)ml';
-export declare const GLOB_VUE = '**/*.vue';
+export declare const GLOB_JS = "**/*.?([cm])js";
+export declare const GLOB_JSX = "**/*.?([cm])jsx";
+export declare const GLOB_TS = "**/*.?([cm])ts";
+export declare const GLOB_TSX = "**/*.?([cm])tsx";
+export declare const GLOB_JSON = "**/*.json";
+export declare const GLOB_JSON5 = "**/*.json5";
+export declare const GLOB_JSONC = "**/*.jsonc";
+export declare const GLOB_YAML = "**/*.y?(a)ml";
+export declare const GLOB_VUE = "**/*.vue";

package/dist/index.cjs

@@ -82,10 +82,10 @@ async function javascript(options = {}) {
 //#region src/configs/comments.ts
 async function comments(options = {}) {
 	const { rules: overrideRules = {} } = options;
-	const comments$1 = await loadPlugin('eslint-plugin-eslint-comments');
+	const comments$1 = await loadPlugin('@eslint-community/eslint-plugin-eslint-comments');
 	return [{
-		name: 'eslint-comments/recommended',
-		plugins: {'eslint-comments': comments$1},
+		name: '@eslint-community/eslint-comments/recommended',
+		plugins: {'@eslint-community/eslint-comments': comments$1},
 		rules: {...(comments$1.configs.recommended.rules)}
 	}, {
 		name: '@kazupon/eslint-comments',
@@ -163,6 +163,20 @@ async function jsdoc(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/promise.ts
+async function promise(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const promise$1 = await loadPlugin('eslint-plugin-promise');
+	return [{
+		name: 'promise/flat/recommended',
+		...(promise$1.configs['flat/recommended'])
+	}, {
+		name: '@kazupon/promise',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/regexp.ts
 async function regexp(options = {}) {
@@ -313,6 +327,7 @@ exports.javascript = javascript;
 exports.jsdoc = jsdoc;
 exports.jsonc = jsonc;
 exports.prettier = prettier;
+exports.promise = promise;
 exports.regexp = regexp;
 exports.typescript = typescript;
 exports.unicorn = unicorn;

package/dist/index.d.cts

@@ -1,2 +1,3 @@
 export * from './config';
 export * from './configs';
+export * from './types';

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './config';
 export * from './configs';
+export * from './types';

package/dist/index.js

@@ -57,10 +57,10 @@ async function javascript(options = {}) {
 //#region src/configs/comments.ts
 async function comments(options = {}) {
 	const { rules: overrideRules = {} } = options;
-	const comments$1 = await loadPlugin('eslint-plugin-eslint-comments');
+	const comments$1 = await loadPlugin('@eslint-community/eslint-plugin-eslint-comments');
 	return [{
-		name: 'eslint-comments/recommended',
-		plugins: {'eslint-comments': comments$1},
+		name: '@eslint-community/eslint-comments/recommended',
+		plugins: {'@eslint-community/eslint-comments': comments$1},
 		rules: {...(comments$1.configs.recommended.rules)}
 	}, {
 		name: '@kazupon/eslint-comments',
@@ -138,6 +138,20 @@ async function jsdoc(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/promise.ts
+async function promise(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const promise$1 = await loadPlugin('eslint-plugin-promise');
+	return [{
+		name: 'promise/flat/recommended',
+		...(promise$1.configs['flat/recommended'])
+	}, {
+		name: '@kazupon/promise',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/regexp.ts
 async function regexp(options = {}) {
@@ -281,4 +295,4 @@ async function vue(options = {}) {
 }
 
 //#endregion
-export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, regexp, typescript, unicorn, vue, yaml, yml };
+export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, promise, regexp, typescript, unicorn, vue, yaml, yml };

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

@@ -0,0 +1,65 @@
+import type { Linter } from 'eslint';
+export interface CommentsRules {
+    /**
+     * require a `eslint-enable` comment for every `eslint-disable` comment
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/disable-enable-pair.html
+     */
+    '@eslint-community/eslint-comments/disable-enable-pair'?: Linter.RuleEntry<EslintCommunityEslintCommentsDisableEnablePair>;
+    /**
+     * disallow a `eslint-enable` comment for multiple `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-aggregating-enable.html
+     */
+    '@eslint-community/eslint-comments/no-aggregating-enable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow duplicate `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-duplicate-disable.html
+     */
+    '@eslint-community/eslint-comments/no-duplicate-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow `eslint-disable` comments about specific rules
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-restricted-disable.html
+     */
+    '@eslint-community/eslint-comments/no-restricted-disable'?: Linter.RuleEntry<EslintCommunityEslintCommentsNoRestrictedDisable>;
+    /**
+     * disallow `eslint-disable` comments without rule names
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unlimited-disable.html
+     */
+    '@eslint-community/eslint-comments/no-unlimited-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow unused `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-disable.html
+     */
+    '@eslint-community/eslint-comments/no-unused-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow unused `eslint-enable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-enable.html
+     */
+    '@eslint-community/eslint-comments/no-unused-enable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow ESLint directive-comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-use.html
+     */
+    '@eslint-community/eslint-comments/no-use'?: Linter.RuleEntry<EslintCommunityEslintCommentsNoUse>;
+    /**
+     * require include descriptions in ESLint directive-comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/require-description.html
+     */
+    '@eslint-community/eslint-comments/require-description'?: Linter.RuleEntry<EslintCommunityEslintCommentsRequireDescription>;
+}
+type EslintCommunityEslintCommentsDisableEnablePair = [] | [
+    {
+        allowWholeFile?: boolean;
+    }
+];
+type EslintCommunityEslintCommentsNoRestrictedDisable = string[];
+type EslintCommunityEslintCommentsNoUse = [] | [
+    {
+        allow?: ("eslint" | "eslint-disable" | "eslint-disable-line" | "eslint-disable-next-line" | "eslint-enable" | "eslint-env" | "exported" | "global" | "globals")[];
+    }
+];
+type EslintCommunityEslintCommentsRequireDescription = [] | [
+    {
+        ignore?: ("eslint" | "eslint-disable" | "eslint-disable-line" | "eslint-disable-next-line" | "eslint-enable" | "eslint-env" | "exported" | "global" | "globals")[];
+    }
+];
+export {};

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

@@ -0,0 +1,65 @@
+import type { Linter } from 'eslint';
+export interface CommentsRules {
+    /**
+     * require a `eslint-enable` comment for every `eslint-disable` comment
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/disable-enable-pair.html
+     */
+    '@eslint-community/eslint-comments/disable-enable-pair'?: Linter.RuleEntry<EslintCommunityEslintCommentsDisableEnablePair>;
+    /**
+     * disallow a `eslint-enable` comment for multiple `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-aggregating-enable.html
+     */
+    '@eslint-community/eslint-comments/no-aggregating-enable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow duplicate `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-duplicate-disable.html
+     */
+    '@eslint-community/eslint-comments/no-duplicate-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow `eslint-disable` comments about specific rules
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-restricted-disable.html
+     */
+    '@eslint-community/eslint-comments/no-restricted-disable'?: Linter.RuleEntry<EslintCommunityEslintCommentsNoRestrictedDisable>;
+    /**
+     * disallow `eslint-disable` comments without rule names
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unlimited-disable.html
+     */
+    '@eslint-community/eslint-comments/no-unlimited-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow unused `eslint-disable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-disable.html
+     */
+    '@eslint-community/eslint-comments/no-unused-disable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow unused `eslint-enable` comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-enable.html
+     */
+    '@eslint-community/eslint-comments/no-unused-enable'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow ESLint directive-comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-use.html
+     */
+    '@eslint-community/eslint-comments/no-use'?: Linter.RuleEntry<EslintCommunityEslintCommentsNoUse>;
+    /**
+     * require include descriptions in ESLint directive-comments
+     * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/require-description.html
+     */
+    '@eslint-community/eslint-comments/require-description'?: Linter.RuleEntry<EslintCommunityEslintCommentsRequireDescription>;
+}
+type EslintCommunityEslintCommentsDisableEnablePair = [] | [
+    {
+        allowWholeFile?: boolean;
+    }
+];
+type EslintCommunityEslintCommentsNoRestrictedDisable = string[];
+type EslintCommunityEslintCommentsNoUse = [] | [
+    {
+        allow?: ("eslint" | "eslint-disable" | "eslint-disable-line" | "eslint-disable-next-line" | "eslint-enable" | "eslint-env" | "exported" | "global" | "globals")[];
+    }
+];
+type EslintCommunityEslintCommentsRequireDescription = [] | [
+    {
+        ignore?: ("eslint" | "eslint-disable" | "eslint-disable-line" | "eslint-disable-next-line" | "eslint-enable" | "eslint-env" | "exported" | "global" | "globals")[];
+    }
+];
+export {};

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

@@ -0,0 +1,17 @@
+import type { CommentsRules } from './comments';
+import type { JavascriptRules } from './javascript';
+import type { JsdocRules } from './jsdoc';
+import type { JsoncRules } from './jsonc';
+import type { PrettierRules } from './prettier';
+import type { PromiseRules } from './promise';
+import type { RegexpRules } from './regexp';
+import type { TypescriptRules } from './typescript';
+import type { UnicornRules } from './unicorn';
+import type { VueRules } from './vue';
+import type { YmlRules } from './yml';
+declare module 'eslint' {
+    namespace Linter {
+        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, RegexpRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
+        }
+    }
+}

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

@@ -0,0 +1,17 @@
+import type { CommentsRules } from './comments';
+import type { JavascriptRules } from './javascript';
+import type { JsdocRules } from './jsdoc';
+import type { JsoncRules } from './jsonc';
+import type { PrettierRules } from './prettier';
+import type { PromiseRules } from './promise';
+import type { RegexpRules } from './regexp';
+import type { TypescriptRules } from './typescript';
+import type { UnicornRules } from './unicorn';
+import type { VueRules } from './vue';
+import type { YmlRules } from './yml';
+declare module 'eslint' {
+    namespace Linter {
+        interface RulesRecord extends CommentsRules, JavascriptRules, JsdocRules, JsoncRules, PrettierRules, PromiseRules, RegexpRules, TypescriptRules, UnicornRules, VueRules, YmlRules {
+        }
+    }
+}