@ntnyq/eslint-config 3.0.0-beta.8 → 3.0.0-beta.9

package/dist/index.d.ts

@@ -1,33 +1,34 @@
-import { Linter } from 'eslint';
+import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ESLintPluginCommandOptions } from 'eslint-plugin-command/types';
-import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import { Linter } from 'eslint';
 export { default as tseslint } from 'typescript-eslint';
+import * as vueEslintParser from 'vue-eslint-parser';
+export { vueEslintParser as parserVue };
+import * as tomlEslintParser from 'toml-eslint-parser';
+export { tomlEslintParser as parserToml };
+import * as yamlEslintParser from 'yaml-eslint-parser';
+export { yamlEslintParser as parserYaml };
+import * as jsoncEslintParser from 'jsonc-eslint-parser';
+export { jsoncEslintParser as parserJsonc };
 import * as eslintPluginRegexp from 'eslint-plugin-regexp';
 export { eslintPluginRegexp as pluginRegexp };
 export { default as pluginNode } from 'eslint-plugin-n';
 export { default as pluginVue } from 'eslint-plugin-vue';
 export { default as pluginYaml } from 'eslint-plugin-yml';
 export { default as pluginToml } from 'eslint-plugin-toml';
-export { default as pluginJsonc } from 'eslint-plugin-jsonc';
-export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
 export { default as pluginMarkdown } from '@eslint/markdown';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+export { default as pluginJsonc } from 'eslint-plugin-jsonc';
 export { default as pluginUnoCSS } from '@unocss/eslint-plugin';
 export { default as pluginVitest } from '@vitest/eslint-plugin';
-export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginImport } from 'eslint-plugin-import-x';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginPrettier } from 'eslint-plugin-prettier';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
-import * as tomlEslintParser from 'toml-eslint-parser';
-export { tomlEslintParser as parserToml };
-import * as yamlEslintParser from 'yaml-eslint-parser';
-export { yamlEslintParser as parserYaml };
-import * as vueEslintParser from 'vue-eslint-parser';
-export { vueEslintParser as parserVue };
-import * as jsoncEslintParser from 'jsonc-eslint-parser';
-export { jsoncEslintParser as parserJsonc };
 
 /**
  * @file Type Utils
@@ -726,6 +727,56 @@ interface RuleOptions {
      * @see https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
      */
     '@typescript-eslint/use-unknown-in-catch-callback-variable'?: Linter.RuleEntry<[]>;
+    /**
+     * Having line breaks styles to object, array and named imports
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/consistent-chaining.md
+     */
+    'antfu/consistent-chaining'?: Linter.RuleEntry<AntfuConsistentChaining>;
+    /**
+     * Having line breaks styles to object, array and named imports
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/consistent-list-newline.md
+     */
+    'antfu/consistent-list-newline'?: Linter.RuleEntry<AntfuConsistentListNewline>;
+    /**
+     * Enforce Anthony's style of curly bracket
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/curly.md
+     */
+    'antfu/curly'?: Linter.RuleEntry<[]>;
+    /**
+     * Newline after if
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/if-newline.md
+     */
+    'antfu/if-newline'?: Linter.RuleEntry<[]>;
+    /**
+     * Fix duplication in imports
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/import-dedupe.md
+     */
+    'antfu/import-dedupe'?: Linter.RuleEntry<[]>;
+    /**
+     * Enforce consistent indentation in `unindent` template tag
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/indent-unindent.md
+     */
+    'antfu/indent-unindent'?: Linter.RuleEntry<AntfuIndentUnindent>;
+    /**
+     * Prevent importing modules in `dist` folder
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/no-import-dist.test.ts
+     */
+    'antfu/no-import-dist'?: Linter.RuleEntry<[]>;
+    /**
+     * Prevent importing modules in `node_modules` folder by relative or absolute path
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/no-import-node-modules-by-path.test.ts
+     */
+    'antfu/no-import-node-modules-by-path'?: Linter.RuleEntry<[]>;
+    /**
+     * Do not use `exports =`
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/no-ts-export-equal.test.ts
+     */
+    'antfu/no-ts-export-equal'?: Linter.RuleEntry<[]>;
+    /**
+     * Enforce top-level functions to be declared with function keyword
+     * @see https://github.com/antfu/eslint-plugin-antfu/blob/main/src/rules/top-level-function.md
+     */
+    'antfu/top-level-function'?: Linter.RuleEntry<[]>;
     /**
      * Comment-as-command for one-off codemod with ESLint
      * @see https://github.com/antfu/eslint-plugin-command
@@ -5346,6 +5397,41 @@ type TypescriptEslintUnifiedSignatures = [] | [
         ignoreDifferentlyNamedParameters?: boolean;
     }
 ];
+type AntfuConsistentChaining = [] | [
+    {
+        allowLeadingPropertyAccess?: boolean;
+    }
+];
+type AntfuConsistentListNewline = [] | [
+    {
+        ArrayExpression?: boolean;
+        ArrayPattern?: boolean;
+        ArrowFunctionExpression?: boolean;
+        CallExpression?: boolean;
+        ExportNamedDeclaration?: boolean;
+        FunctionDeclaration?: boolean;
+        FunctionExpression?: boolean;
+        ImportDeclaration?: boolean;
+        JSONArrayExpression?: boolean;
+        JSONObjectExpression?: boolean;
+        JSXOpeningElement?: boolean;
+        NewExpression?: boolean;
+        ObjectExpression?: boolean;
+        ObjectPattern?: boolean;
+        TSFunctionType?: boolean;
+        TSInterfaceDeclaration?: boolean;
+        TSTupleType?: boolean;
+        TSTypeLiteral?: boolean;
+        TSTypeParameterDeclaration?: boolean;
+        TSTypeParameterInstantiation?: boolean;
+    }
+];
+type AntfuIndentUnindent = [] | [
+    {
+        indent?: number;
+        tags?: string[];
+    }
+];
 type ImportConsistentTypeSpecifierStyle = [] | [("prefer-inline" | "prefer-top-level")];
 type ImportDynamicImportChunkname = [] | [
     {
@@ -8903,7 +8989,7 @@ type YmlSpacedComment = [] | [("always" | "never")] | [
         markers?: string[];
     }
 ];
-type ConfigName = 'ntnyq/command' | 'ntnyq/eslint-comments' | 'ntnyq/ignores' | 'ntnyq/imports' | 'ntnyq/gitignore' | 'ntnyq/js/recommended' | 'ntnyq/js/core' | 'ntnyq/js/scripts' | 'ntnyq/js/test' | 'ntnyq/jsdoc' | 'ntnyq/jsonc' | 'ntnyq/jsx' | 'ntnyq/markdown/recommended/plugin' | 'ntnyq/markdown/recommended/processor' | 'ntnyq/markdown/recommended/code-blocks' | 'ntnyq/markdown/disabled/code-blocks' | 'ntnyq/node' | 'ntnyq/prettier' | 'ntnyq/prettier/disabled' | 'ntnyq/regexp' | 'ntnyq/perfectionist' | 'ntnyq/sort/package-json' | 'ntnyq/sort/tsconfig' | 'typescript-eslint/base' | 'typescript-eslint/eslint-recommended' | 'typescript-eslint/recommended' | 'ntnyq/ts/core' | 'ntnyq/ts/dts' | 'ntnyq/ts/test' | 'ntnyq/ts/cjs' | 'ntnyq/unicorn' | 'ntnyq/unocss' | 'typescript-eslint/base' | 'typescript-eslint/eslint-recommended' | 'typescript-eslint/recommended' | 'ntnyq/ts/core' | 'ntnyq/vue/ts' | 'ntnyq/vue/core' | 'ntnyq/yaml' | 'ntnyq/toml';
+type ConfigName = 'ntnyq/antfu' | 'ntnyq/command' | 'ntnyq/eslint-comments' | 'ntnyq/ignores' | 'ntnyq/imports' | 'ntnyq/gitignore' | 'ntnyq/js/recommended' | 'ntnyq/js/core' | 'ntnyq/js/scripts' | 'ntnyq/js/test' | 'ntnyq/jsdoc' | 'ntnyq/jsonc' | 'ntnyq/jsx' | 'ntnyq/markdown/recommended/plugin' | 'ntnyq/markdown/recommended/processor' | 'ntnyq/markdown/recommended/code-blocks' | 'ntnyq/markdown/disabled/code-blocks' | 'ntnyq/node' | 'ntnyq/prettier' | 'ntnyq/prettier/disabled' | 'ntnyq/regexp' | 'ntnyq/perfectionist' | 'ntnyq/sort/package-json' | 'ntnyq/sort/tsconfig' | 'typescript-eslint/base' | 'typescript-eslint/eslint-recommended' | 'typescript-eslint/recommended' | 'ntnyq/ts/core' | 'ntnyq/ts/dts' | 'ntnyq/ts/test' | 'ntnyq/ts/cjs' | 'ntnyq/unicorn' | 'ntnyq/unocss' | 'typescript-eslint/base' | 'typescript-eslint/eslint-recommended' | 'typescript-eslint/recommended' | 'ntnyq/ts/core' | 'ntnyq/vue/ts' | 'ntnyq/vue/core' | 'ntnyq/yaml' | 'ntnyq/toml';
 
 /**
  * Typed flat config item
@@ -8948,6 +9034,8 @@ interface ConfigImportsOptions extends OptionsOverrides {
 }
 interface ConfigNodeOptions extends OptionsOverrides {
 }
+interface ConfigAntfuOptions extends OptionsOverrides {
+}
 interface ConfigPrettierOptions extends OptionsOverrides {
     /**
      * Prettier level
@@ -9011,19 +9099,20 @@ interface ConfigOptions {
     command?: boolean | ConfigCommandOptions;
     gitignore?: boolean | ConfigGitIgnoreOptions;
     imports?: ConfigImportsOptions;
-    javascript?: ConfigJavaScriptOptions;
-    typescript?: ConfigTypeScriptOptions;
     node?: ConfigNodeOptions;
+    javascript?: ConfigJavaScriptOptions;
+    typescript?: boolean | ConfigTypeScriptOptions;
     unicorn?: boolean | ConfigUnicornOptions;
     prettier?: boolean | ConfigPrettierOptions;
+    perfectionist?: boolean | ConfigPerfectionistOptions;
     /**
      * @internal
      */
-    perfectionist?: boolean | ConfigPerfectionistOptions;
+    unusedImports?: boolean | ConfigUnusedImportsOptions;
     /**
      * @internal
      */
-    unusedImports?: boolean | ConfigUnusedImportsOptions;
+    antfu?: boolean | ConfigAntfuOptions;
     comments?: boolean | ConfigCommentsOptions;
     jsdoc?: boolean | ConfigJsdocOptions;
     unocss?: boolean | ConfigUnoCSSOptions;
@@ -9045,31 +9134,6 @@ interface ConfigOptions {
  */
 declare function ntnyq(options?: ConfigOptions, userConfigs?: Arrayable<TypedConfigItem>): FlatConfigComposer<TypedConfigItem, ConfigName>;
 
-declare const hasTypeScript: boolean;
-declare const hasVitest: boolean;
-declare const hasVue: boolean;
-declare const hasUnoCSS: boolean;
-
-declare function toArray<T>(val?: Arrayable<T>): T[];
-
-/**
- * Load an ESLint plugin by name.
- * @param name - The name of the plugin
- * @returns The plugin module
- */
-declare function loadPlugin<T = unknown>(name: string): Promise<T>;
-
-declare function getOverrides<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): Partial<TypedConfigItem['rules'] & RuleOptions>;
-
-/**
- * Interop default export from a module
- * @param mod - The module
- * @returns The default export
- */
-declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
-
-declare function resolveSubOptions<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): ResolvedOptions<ConfigOptions[K]>;
-
 /**
  * @file globs constants
  */
@@ -9101,55 +9165,82 @@ declare const GLOB_DIST = "**/dist/**";
 declare const GLOB_LOCKFILE: string[];
 declare const GLOB_EXCLUDE: string[];
 
+declare const hasTypeScript: boolean;
+declare const hasVitest: boolean;
+declare const hasVue: boolean;
+declare const hasUnoCSS: boolean;
+
+declare function toArray<T>(val?: Arrayable<T>): T[];
+
 /**
- * @see https://eslint.org/docs/latest/use/configure/configuration-files-new#globally-ignoring-files-with-ignores
+ * Load an ESLint plugin by name.
+ * @param name - The name of the plugin
+ * @returns The plugin module
  */
-declare const ignores: (customIgnores?: ConfigIgnoresOptions) => TypedConfigItem[];
+declare function loadPlugin<T = unknown>(name: string): Promise<T>;
 
-declare const node: (options?: ConfigNodeOptions) => TypedConfigItem[];
+declare function getOverrides<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): Partial<TypedConfigItem['rules'] & RuleOptions>;
 
-declare const jsdoc: (options?: ConfigJsdocOptions) => TypedConfigItem[];
+/**
+ * Interop default export from a module
+ * @param mod - The module
+ * @returns The default export
+ */
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
 
-declare const imports: (options?: ConfigImportsOptions) => TypedConfigItem[];
+declare function resolveSubOptions<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): ResolvedOptions<ConfigOptions[K]>;
 
-declare const unicorn: (options?: ConfigUnicornOptions) => TypedConfigItem[];
+declare const vue: (options?: ConfigVueOptions) => TypedConfigItem[];
 
-declare const prettier: (options?: ConfigPrettierOptions) => TypedConfigItem[];
+declare const yml: (options?: ConfigYmlOptions) => TypedConfigItem[];
 
-declare const comments: (options?: ConfigCommentsOptions) => TypedConfigItem[];
+declare const node: (options?: ConfigNodeOptions) => TypedConfigItem[];
 
-declare const javascript: (options?: ConfigJavaScriptOptions) => TypedConfigItem[];
-declare const jsx: () => TypedConfigItem[];
+declare const sortPackageJson: () => TypedConfigItem[];
+declare const sortTsConfig: () => TypedConfigItem[];
+declare const sortI18nLocale: () => TypedConfigItem[];
 
-declare const typescriptCore: (options?: ConfigTypeScriptOptions) => TypedConfigItem[];
-declare const typescript: (options?: ConfigTypeScriptOptions) => TypedConfigItem[];
+declare const toml: (options?: ConfigTomlOptions) => TypedConfigItem[];
 
-declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConfigItem[];
+declare const antfu: (options?: ConfigAntfuOptions) => TypedConfigItem[];
 
-declare const perfectionist: (options?: ConfigPerfectionistOptions) => TypedConfigItem[];
+declare const jsdoc: (options?: ConfigJsdocOptions) => TypedConfigItem[];
+
+declare const jsonc: (options?: ConfigJsoncOptions) => TypedConfigItem[];
 
 declare const regexp: (options?: ConfigRegexpOptions) => TypedConfigItem[];
 
 declare const unocss: (options?: ConfigUnoCSSOptions) => TypedConfigItem[];
 
-declare const gitignore: (options?: ConfigGitIgnoreOptions) => TypedConfigItem[];
+declare const vitest: (options?: ConfigVitestOptions) => TypedConfigItem[];
 
 declare const command: (options?: ConfigCommandOptions) => TypedConfigItem[];
 
-declare const vitest: (options?: ConfigVitestOptions) => TypedConfigItem[];
+/**
+ * @see https://eslint.org/docs/latest/use/configure/configuration-files-new#globally-ignoring-files-with-ignores
+ */
+declare const ignores: (customIgnores?: ConfigIgnoresOptions) => TypedConfigItem[];
 
-declare const vue: (options?: ConfigVueOptions) => TypedConfigItem[];
+declare const imports: (options?: ConfigImportsOptions) => TypedConfigItem[];
 
-declare const yml: (options?: ConfigYmlOptions) => TypedConfigItem[];
+declare const unicorn: (options?: ConfigUnicornOptions) => TypedConfigItem[];
 
-declare const toml: (options?: ConfigTomlOptions) => TypedConfigItem[];
+declare const comments: (options?: ConfigCommentsOptions) => TypedConfigItem[];
 
-declare const sortPackageJson: () => TypedConfigItem[];
-declare const sortTsConfig: () => TypedConfigItem[];
-declare const sortI18nLocale: () => TypedConfigItem[];
+declare const markdown: (options?: ConfigMarkdownOptions) => TypedConfigItem[];
 
-declare const jsonc: (options?: ConfigJsoncOptions) => TypedConfigItem[];
+declare const prettier: (options?: ConfigPrettierOptions) => TypedConfigItem[];
 
-declare const markdown: (options?: ConfigMarkdownOptions) => TypedConfigItem[];
+declare const gitignore: (options?: ConfigGitIgnoreOptions) => TypedConfigItem[];
+
+declare const javascript: (options?: ConfigJavaScriptOptions) => TypedConfigItem[];
+declare const jsx: () => TypedConfigItem[];
+
+declare const typescriptCore: (options?: ConfigTypeScriptOptions) => TypedConfigItem[];
+declare const typescript: (options?: ConfigTypeScriptOptions) => TypedConfigItem[];
+
+declare const perfectionist: (options?: ConfigPerfectionistOptions) => TypedConfigItem[];
+
+declare const unusedImports: (options?: ConfigUnusedImportsOptions) => TypedConfigItem[];
 
-export { type Arrayable, type Awaitable, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigName, type ConfigNodeOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVitestOptions, type ConfigVueOptions, type ConfigYmlOptions, GLOB_ALL_SRC, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, 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_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type OptionsFiles, type OptionsOverrides, type ParserOptions, type ResolvedOptions, type RuleOptions, type TypedConfigItem, command, comments, getOverrides, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, node, ntnyq, perfectionist, prettier, regexp, resolveSubOptions, sortI18nLocale, sortPackageJson, sortTsConfig, toArray, toml, typescript, typescriptCore, unicorn, unocss, unusedImports, vitest, vue, yml };
+export { type Arrayable, type Awaitable, type ConfigAntfuOptions, type ConfigCommandOptions, type ConfigCommentsOptions, type ConfigGitIgnoreOptions, type ConfigIgnoresOptions, type ConfigImportsOptions, type ConfigJavaScriptOptions, type ConfigJsdocOptions, type ConfigJsoncOptions, type ConfigMarkdownOptions, type ConfigName, type ConfigNodeOptions, type ConfigOptions, type ConfigPerfectionistOptions, type ConfigPrettierOptions, type ConfigRegexpOptions, type ConfigTomlOptions, type ConfigTypeScriptOptions, type ConfigUnicornOptions, type ConfigUnoCSSOptions, type ConfigUnusedImportsOptions, type ConfigVitestOptions, type ConfigVueOptions, type ConfigYmlOptions, GLOB_ALL_SRC, GLOB_CSS, GLOB_DIST, GLOB_DTS, GLOB_EXCLUDE, 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_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TEST, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type OptionsFiles, type OptionsOverrides, type ParserOptions, type ResolvedOptions, type RuleOptions, type TypedConfigItem, antfu, command, comments, getOverrides, gitignore, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, node, ntnyq, perfectionist, prettier, regexp, resolveSubOptions, sortI18nLocale, sortPackageJson, sortTsConfig, toArray, toml, typescript, typescriptCore, unicorn, unocss, unusedImports, vitest, vue, yml };