@ntnyq/eslint-config 3.5.1 → 3.6.0

package/dist/index.d.cts

@@ -7,6 +7,7 @@ import { Linter } from 'eslint';
 import { ConfigWithExtends } from 'typescript-eslint';
 export { plugin as pluginTypeScript, configs as typescriptConfigs } from 'typescript-eslint';
 import { RequiredOptions, BuiltInParserName } from 'prettier';
+import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 import * as eslintPluginRegexp from 'eslint-plugin-regexp';
 export { eslintPluginRegexp as pluginRegexp };
 export { default as pluginNode } from 'eslint-plugin-n';
@@ -9872,6 +9873,7 @@ type JsdocInformativeDocs = [] | [
 ];
 type JsdocLinesBeforeBlock = [] | [
     {
+        checkBlockStarts?: boolean;
         excludedTags?: string[];
         ignoreSameLine?: boolean;
         lines?: number;
@@ -12159,9 +12161,13 @@ type PerfectionistSortObjectTypes = [] | [
 ];
 type PerfectionistSortObjects = [] | [
     {
+        destructuredObjects?: (boolean | {
+            groups?: boolean;
+        });
         ignorePattern?: string[];
         partitionByComment?: (string[] | boolean | string);
         destructureOnly?: boolean;
+        objectDeclarations?: boolean;
         styledComponents?: boolean;
         partitionByNewLine?: boolean;
         specialCharacters?: ("remove" | "trim" | "keep");
@@ -14687,7 +14693,7 @@ interface OptionsExtensions {
  */
 type OptionsFeatures = {
     /**
-     * Support typescript
+     * Enable typescript support
      */
     typescript?: boolean;
 };
@@ -14707,7 +14713,7 @@ type ConfigGitIgnoreOptions = Omit<FlatGitignoreOptions, 'strict'> & {
     strict?: boolean;
 };
 type ConfigCommandOptions = ESLintPluginCommandOptions;
-interface ConfigJsdocOptions extends OptionsOverrides {
+interface ConfigJsdocOptions extends OptionsOverrides, OptionsFeatures {
 }
 interface ConfigUnoCSSOptions extends OptionsOverrides {
     /**
@@ -14857,6 +14863,24 @@ interface ConfigTestOptions extends OptionsOverrides {
      */
     overridesVitestRules?: TypedConfigItem['rules'];
 }
+interface ConfigSpecialsOptions {
+    /**
+     * Overrides scripts rules
+     */
+    overridesScriptsRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides cli rules
+     */
+    overridesCliRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides user scripts rules
+     */
+    overridesUserScriptsRules?: TypedConfigItem['rules'];
+    /**
+     * More special case configs
+     */
+    specialCaseConfigs?: TypedConfigItem[];
+}
 interface ConfigFormatOptions {
     /**
      * Enable formatter support for css, less, scss, sass and etc.
@@ -14912,6 +14936,7 @@ interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions {
     command?: ConfigCommandOptions;
     comments?: ConfigCommentsOptions;
     javascript?: ConfigJavaScriptOptions;
+    specials?: ConfigSpecialsOptions;
     sort?: boolean | ConfigSortOptions;
     gitignore?: boolean | ConfigGitIgnoreOptions;
     stylistic?: boolean | ConfigStylisticOptions;
@@ -14945,7 +14970,7 @@ type PrettierOptions = Partial<Pick<RequiredOptions, 'semi' | 'useTabs' | 'tabWi
 /**
  * Config factory
  */
-declare function defineESLintConfig(options?: ConfigOptions, ...userConfigs: Awaitable<TypedConfigItem | TypedConfigItem[] | ESLintConfig[]>[]): Promise<FlatConfigComposer<TypedConfigItem, ConfigNames>>;
+declare function defineESLintConfig(options?: ConfigOptions, ...userConfigs: Awaitable<TypedConfigItem | TypedConfigItem[] | ESLintConfig[]>[]): FlatConfigComposer<TypedConfigItem, ConfigNames>;
 
 /**
  * @file globs constants
@@ -15014,24 +15039,12 @@ declare function resolveSubOptions<K extends keyof ConfigOptions>(options: Confi
 
 declare function mergePrettierOptions(options?: PrettierOptions, overrides?: PrettierOptions): PrettierOptions;
 
-/**
- * @file ESLint parsers
- */
-
 /**
  * With meta
  */
 declare const parserTypeScript: {
-    meta?: {
-        name?: string | undefined;
-        version?: string | undefined;
-    };
-    parseForESLint(text: string, options?: unknown): {
-        ast: unknown;
-        scopeManager?: unknown;
-        services?: unknown;
-        visitorKeys?: unknown;
-    };
+    meta?: { [K in keyof _typescript_eslint_utils_ts_eslint.Parser.ParserMeta]?: _typescript_eslint_utils_ts_eslint.Parser.ParserMeta[K] | undefined; };
+    parseForESLint(text: string, options?: unknown): { [k in keyof _typescript_eslint_utils_ts_eslint.Parser.ParseResult]: unknown; };
 };
 
 /**
@@ -15082,7 +15095,7 @@ declare const imports: (options?: ConfigImportsOptions) => TypedConfigItem[];
 
 declare const unicorn: (options?: ConfigUnicornOptions) => TypedConfigItem[];
 
-declare const specials: () => TypedConfigItem[];
+declare const specials: (options?: ConfigSpecialsOptions) => TypedConfigItem[];
 
 declare const comments: (options?: ConfigCommentsOptions) => TypedConfigItem[];
 
@@ -15110,4 +15123,4 @@ declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConf
  */
 declare const DEFAULT_PRETTIER_OPTIONS: PrettierOptions;
 
-export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type LiteralUnion, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PerfectionistSortOrder, type PerfectionistSortType, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };
+export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigSpecialsOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type LiteralUnion, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PerfectionistSortOrder, type PerfectionistSortType, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { Linter } from 'eslint';
 import { ConfigWithExtends } from 'typescript-eslint';
 export { plugin as pluginTypeScript, configs as typescriptConfigs } from 'typescript-eslint';
 import { RequiredOptions, BuiltInParserName } from 'prettier';
+import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 import * as eslintPluginRegexp from 'eslint-plugin-regexp';
 export { eslintPluginRegexp as pluginRegexp };
 export { default as pluginNode } from 'eslint-plugin-n';
@@ -9872,6 +9873,7 @@ type JsdocInformativeDocs = [] | [
 ];
 type JsdocLinesBeforeBlock = [] | [
     {
+        checkBlockStarts?: boolean;
         excludedTags?: string[];
         ignoreSameLine?: boolean;
         lines?: number;
@@ -12159,9 +12161,13 @@ type PerfectionistSortObjectTypes = [] | [
 ];
 type PerfectionistSortObjects = [] | [
     {
+        destructuredObjects?: (boolean | {
+            groups?: boolean;
+        });
         ignorePattern?: string[];
         partitionByComment?: (string[] | boolean | string);
         destructureOnly?: boolean;
+        objectDeclarations?: boolean;
         styledComponents?: boolean;
         partitionByNewLine?: boolean;
         specialCharacters?: ("remove" | "trim" | "keep");
@@ -14687,7 +14693,7 @@ interface OptionsExtensions {
  */
 type OptionsFeatures = {
     /**
-     * Support typescript
+     * Enable typescript support
      */
     typescript?: boolean;
 };
@@ -14707,7 +14713,7 @@ type ConfigGitIgnoreOptions = Omit<FlatGitignoreOptions, 'strict'> & {
     strict?: boolean;
 };
 type ConfigCommandOptions = ESLintPluginCommandOptions;
-interface ConfigJsdocOptions extends OptionsOverrides {
+interface ConfigJsdocOptions extends OptionsOverrides, OptionsFeatures {
 }
 interface ConfigUnoCSSOptions extends OptionsOverrides {
     /**
@@ -14857,6 +14863,24 @@ interface ConfigTestOptions extends OptionsOverrides {
      */
     overridesVitestRules?: TypedConfigItem['rules'];
 }
+interface ConfigSpecialsOptions {
+    /**
+     * Overrides scripts rules
+     */
+    overridesScriptsRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides cli rules
+     */
+    overridesCliRules?: TypedConfigItem['rules'];
+    /**
+     * Overrides user scripts rules
+     */
+    overridesUserScriptsRules?: TypedConfigItem['rules'];
+    /**
+     * More special case configs
+     */
+    specialCaseConfigs?: TypedConfigItem[];
+}
 interface ConfigFormatOptions {
     /**
      * Enable formatter support for css, less, scss, sass and etc.
@@ -14912,6 +14936,7 @@ interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions {
     command?: ConfigCommandOptions;
     comments?: ConfigCommentsOptions;
     javascript?: ConfigJavaScriptOptions;
+    specials?: ConfigSpecialsOptions;
     sort?: boolean | ConfigSortOptions;
     gitignore?: boolean | ConfigGitIgnoreOptions;
     stylistic?: boolean | ConfigStylisticOptions;
@@ -14945,7 +14970,7 @@ type PrettierOptions = Partial<Pick<RequiredOptions, 'semi' | 'useTabs' | 'tabWi
 /**
  * Config factory
  */
-declare function defineESLintConfig(options?: ConfigOptions, ...userConfigs: Awaitable<TypedConfigItem | TypedConfigItem[] | ESLintConfig[]>[]): Promise<FlatConfigComposer<TypedConfigItem, ConfigNames>>;
+declare function defineESLintConfig(options?: ConfigOptions, ...userConfigs: Awaitable<TypedConfigItem | TypedConfigItem[] | ESLintConfig[]>[]): FlatConfigComposer<TypedConfigItem, ConfigNames>;
 
 /**
  * @file globs constants
@@ -15014,24 +15039,12 @@ declare function resolveSubOptions<K extends keyof ConfigOptions>(options: Confi
 
 declare function mergePrettierOptions(options?: PrettierOptions, overrides?: PrettierOptions): PrettierOptions;
 
-/**
- * @file ESLint parsers
- */
-
 /**
  * With meta
  */
 declare const parserTypeScript: {
-    meta?: {
-        name?: string | undefined;
-        version?: string | undefined;
-    };
-    parseForESLint(text: string, options?: unknown): {
-        ast: unknown;
-        scopeManager?: unknown;
-        services?: unknown;
-        visitorKeys?: unknown;
-    };
+    meta?: { [K in keyof _typescript_eslint_utils_ts_eslint.Parser.ParserMeta]?: _typescript_eslint_utils_ts_eslint.Parser.ParserMeta[K] | undefined; };
+    parseForESLint(text: string, options?: unknown): { [k in keyof _typescript_eslint_utils_ts_eslint.Parser.ParseResult]: unknown; };
 };
 
 /**
@@ -15082,7 +15095,7 @@ declare const imports: (options?: ConfigImportsOptions) => TypedConfigItem[];
 
 declare const unicorn: (options?: ConfigUnicornOptions) => TypedConfigItem[];
 
-declare const specials: () => TypedConfigItem[];
+declare const specials: (options?: ConfigSpecialsOptions) => TypedConfigItem[];
 
 declare const comments: (options?: ConfigCommentsOptions) => TypedConfigItem[];
 
@@ -15110,4 +15123,4 @@ declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConf
  */
 declare const DEFAULT_PRETTIER_OPTIONS: PrettierOptions;
 
-export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type LiteralUnion, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PerfectionistSortOrder, type PerfectionistSortType, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };
+export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigFormatOptions, type ConfigGitHubActionOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigNames, type ConfigNodeOptions, type ConfigNtnyqOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigSortOptions, type ConfigSpecialsOptions, type ConfigStylisticOptions, type ConfigTestOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVueOptions, type ConfigYmlOptions, DEFAULT_PRETTIER_OPTIONS, type ESLintConfig, type ESLintParser, type ESLintParserOptions, type ESLintProcessor, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, GLOB_GITHUB_ACTION, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LOCKFILE, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_NESTED, GLOB_NODE_MODULES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type LiteralUnion, type OptionsExtensions, type OptionsFeatures, type OptionsFiles, type OptionsOverrides, type PerfectionistSortOrder, type PerfectionistSortType, type PrettierOptions, type Pretty, type ResolvedOptions, type RuleOptions, type TSESLintParserOptions, type TypedConfigItem, antfu, command, comments, defineESLintConfig, format, getOverrides, githubAction, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, mergePrettierOptions, node, ntnyq, parserPlain, parserTypeScript, perfectionist, prettier, regexp, resolveSubOptions, sort, specials, stylistic, test, toArray, toml, typescript, unicorn, unocss, unusedImports, vitest, vue, yml };