@ntnyq/eslint-config 2.8.0 → 2.8.2

package/dist/index.d.ts

@@ -9,11 +9,13 @@ 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 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 pluginPrettier } from 'eslint-plugin-prettier';
 export { default as pluginMarkdown } from 'eslint-plugin-markdown';
-export { default as pluginUnusedImports } from '@antfu/eslint-plugin-unused-imports';
+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 };
@@ -495,7 +497,7 @@ interface RuleOptions {
     '@typescript-eslint/no-unused-expressions'?: Linter.RuleEntry<TypescriptEslintNoUnusedExpressions>;
     /**
      * Disallow unused variables
-     * @see https://github.com/sweepline/eslint-plugin-unused-imports/blob/master/docs/rules/no-unused-imports.md
+     * @see https://typescript-eslint.io/rules/no-unused-vars
      */
     '@typescript-eslint/no-unused-vars'?: Linter.RuleEntry<TypescriptEslintNoUnusedVars>;
     /**
@@ -984,7 +986,7 @@ interface RuleOptions {
     '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/require-template.md#repos-sticky-header
+     * @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<[]>;
     /**
@@ -1022,6 +1024,11 @@ interface RuleOptions {
      * @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
@@ -1637,6 +1644,101 @@ interface RuleOptions {
      * @deprecated
      */
     'node/shebang'?: Linter.RuleEntry<NodeShebang>;
+    /**
+     * Enforce sorted arrays before include method.
+     * @see https://perfectionist.dev/rules/sort-array-includes
+     */
+    'perfectionist/sort-array-includes'?: Linter.RuleEntry<PerfectionistSortArrayIncludes>;
+    /**
+     * Enforce sorted Astro attributes.
+     * @see https://perfectionist.dev/rules/sort-astro-attributes
+     */
+    'perfectionist/sort-astro-attributes'?: Linter.RuleEntry<PerfectionistSortAstroAttributes>;
+    /**
+     * Enforce sorted classes.
+     * @see https://perfectionist.dev/rules/sort-classes
+     */
+    'perfectionist/sort-classes'?: Linter.RuleEntry<PerfectionistSortClasses>;
+    /**
+     * Enforce sorted TypeScript enums.
+     * @see https://perfectionist.dev/rules/sort-enums
+     */
+    'perfectionist/sort-enums'?: Linter.RuleEntry<PerfectionistSortEnums>;
+    /**
+     * Enforce sorted exports.
+     * @see https://perfectionist.dev/rules/sort-exports
+     */
+    'perfectionist/sort-exports'?: Linter.RuleEntry<PerfectionistSortExports>;
+    /**
+     * Enforce sorted imports.
+     * @see https://perfectionist.dev/rules/sort-imports
+     */
+    'perfectionist/sort-imports'?: Linter.RuleEntry<PerfectionistSortImports>;
+    /**
+     * Enforce sorted interface properties.
+     * @see https://perfectionist.dev/rules/sort-interfaces
+     */
+    'perfectionist/sort-interfaces'?: Linter.RuleEntry<PerfectionistSortInterfaces>;
+    /**
+     * Enforce sorted intersection types.
+     * @see https://perfectionist.dev/rules/sort-intersection-types
+     */
+    'perfectionist/sort-intersection-types'?: Linter.RuleEntry<PerfectionistSortIntersectionTypes>;
+    /**
+     * Enforce sorted JSX props.
+     * @see https://perfectionist.dev/rules/sort-jsx-props
+     */
+    'perfectionist/sort-jsx-props'?: Linter.RuleEntry<PerfectionistSortJsxProps>;
+    /**
+     * Enforce sorted Map elements.
+     * @see https://perfectionist.dev/rules/sort-maps
+     */
+    'perfectionist/sort-maps'?: Linter.RuleEntry<PerfectionistSortMaps>;
+    /**
+     * Enforce sorted named exports.
+     * @see https://perfectionist.dev/rules/sort-named-exports
+     */
+    'perfectionist/sort-named-exports'?: Linter.RuleEntry<PerfectionistSortNamedExports>;
+    /**
+     * Enforce sorted named imports.
+     * @see https://perfectionist.dev/rules/sort-named-imports
+     */
+    'perfectionist/sort-named-imports'?: Linter.RuleEntry<PerfectionistSortNamedImports>;
+    /**
+     * Enforce sorted object types.
+     * @see https://perfectionist.dev/rules/sort-object-types
+     */
+    'perfectionist/sort-object-types'?: Linter.RuleEntry<PerfectionistSortObjectTypes>;
+    /**
+     * Enforce sorted objects.
+     * @see https://perfectionist.dev/rules/sort-objects
+     */
+    'perfectionist/sort-objects'?: Linter.RuleEntry<PerfectionistSortObjects>;
+    /**
+     * Enforce sorted Svelte attributes.
+     * @see https://perfectionist.dev/rules/sort-svelte-attributes
+     */
+    'perfectionist/sort-svelte-attributes'?: Linter.RuleEntry<PerfectionistSortSvelteAttributes>;
+    /**
+     * Enforce sorted switch cases.
+     * @see https://perfectionist.dev/rules/sort-switch-case
+     */
+    'perfectionist/sort-switch-case'?: Linter.RuleEntry<PerfectionistSortSwitchCase>;
+    /**
+     * Enforce sorted union types.
+     * @see https://perfectionist.dev/rules/sort-union-types
+     */
+    'perfectionist/sort-union-types'?: Linter.RuleEntry<PerfectionistSortUnionTypes>;
+    /**
+     * Enforce sorted variable declarations.
+     * @see https://perfectionist.dev/rules/sort-variable-declarations
+     */
+    'perfectionist/sort-variable-declarations'?: Linter.RuleEntry<PerfectionistSortVariableDeclarations>;
+    /**
+     * Enforce sorted Vue attributes.
+     * @see https://perfectionist.dev/rules/sort-vue-attributes
+     */
+    'perfectionist/sort-vue-attributes'?: Linter.RuleEntry<PerfectionistSortVueAttributes>;
     /**
      * @see https://github.com/prettier/eslint-plugin-prettier#options
      */
@@ -5541,6 +5643,13 @@ type JsdocInformativeDocs = [] | [
         uselessWords?: string[];
     }
 ];
+type JsdocLinesBeforeBlock = [] | [
+    {
+        excludedTags?: string[];
+        ignoreSameLine?: boolean;
+        lines?: number;
+    }
+];
 type JsdocMatchDescription = [] | [
     {
         contexts?: (string | {
@@ -6454,6 +6563,209 @@ type NodeShebang = [] | [
         };
     }
 ];
+type PerfectionistSortArrayIncludes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groupKind?: ("mixed" | "literals-first" | "spreads-first");
+    }
+];
+type PerfectionistSortAstroAttributes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortClasses = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        partitionByComment?: (string[] | boolean | string);
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortEnums = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        partitionByComment?: (string[] | boolean | string);
+    }
+];
+type PerfectionistSortExports = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+    }
+];
+type PerfectionistSortImports = [] | [_PerfectionistSortImportsSortImports];
+type _PerfectionistSortImportsSortImports = (_PerfectionistSortImportsMaxLineLengthRequiresLineLengthType & {
+    type?: ("alphabetical" | "natural" | "line-length");
+    order?: ("asc" | "desc");
+    ignoreCase?: boolean;
+    internalPattern?: string[];
+    newlinesBetween?: ("ignore" | "always" | "never");
+    maxLineLength?: number;
+    groups?: (string | string[])[];
+    customGroups?: {
+        type?: {
+            [k: string]: unknown | undefined;
+        };
+        value?: {
+            [k: string]: unknown | undefined;
+        };
+    };
+    environment?: ("node" | "bun");
+});
+type _PerfectionistSortImportsMaxLineLengthRequiresLineLengthType = ({
+    [k: string]: unknown | undefined;
+} | _PerfectionistSortImports_IsLineLength);
+interface _PerfectionistSortImports_IsLineLength {
+    type: "line-length";
+    [k: string]: unknown | undefined;
+}
+type PerfectionistSortInterfaces = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        ignorePattern?: string[];
+        partitionByNewLine?: boolean;
+        groupKind?: ("mixed" | "optional-first" | "required-first");
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortIntersectionTypes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groups?: (string | string[])[];
+    }
+];
+type PerfectionistSortJsxProps = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        ignorePattern?: string[];
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortMaps = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+    }
+];
+type PerfectionistSortNamedExports = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groupKind?: ("mixed" | "values-first" | "types-first");
+    }
+];
+type PerfectionistSortNamedImports = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        ignoreAlias?: boolean;
+        groupKind?: ("mixed" | "values-first" | "types-first");
+    }
+];
+type PerfectionistSortObjectTypes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        partitionByNewLine?: boolean;
+        groupKind?: ("mixed" | "required-first" | "optional-first");
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortObjects = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        partitionByComment?: (string[] | boolean | string);
+        partitionByNewLine?: boolean;
+        styledComponents?: boolean;
+        destructureOnly?: boolean;
+        ignorePattern?: string[];
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortSvelteAttributes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
+type PerfectionistSortSwitchCase = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+    }
+];
+type PerfectionistSortUnionTypes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groups?: (string | string[])[];
+    }
+];
+type PerfectionistSortVariableDeclarations = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+    }
+];
+type PerfectionistSortVueAttributes = [] | [
+    {
+        type?: ("alphabetical" | "natural" | "line-length");
+        order?: ("asc" | "desc");
+        ignoreCase?: boolean;
+        groups?: (string | string[])[];
+        customGroups?: {
+            [k: string]: (string | string[]) | undefined;
+        };
+    }
+];
 type PrettierPrettier = [] | [
     {
         [k: string]: unknown | undefined;
@@ -8458,7 +8770,7 @@ type YmlSpacedComment = [] | [("always" | "never")] | [
         markers?: string[];
     }
 ];
-type ConfigName = 'command' | 'ntnyq/eslint-comments' | 'ntnyq/ignores' | 'ntnyq/imports' | 'ntnyq/js/recommended' | 'ntnyq/js/core' | 'ntnyq/js/script' | 'ntnyq/js/test' | 'ntnyq/jsdoc' | 'ntnyq/jsonc' | 'ntnyq/jsx' | 'markdown/recommended/plugin' | 'markdown/recommended/processor' | 'markdown/recommended/code-blocks' | 'ntnyq/markdown/extensions' | 'ntnyq/node' | 'ntnyq/prettier' | 'ntnyq/prettier/ignore' | 'ntnyq/regexp' | '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 = 'command' | 'ntnyq/eslint-comments' | 'ntnyq/ignores' | 'ntnyq/imports' | 'ntnyq/js/recommended' | 'ntnyq/js/core' | 'ntnyq/js/script' | 'ntnyq/js/test' | 'ntnyq/jsdoc' | 'ntnyq/jsonc' | 'ntnyq/jsx' | 'markdown/recommended/plugin' | 'markdown/recommended/processor' | 'markdown/recommended/code-blocks' | 'ntnyq/markdown/extensions' | 'ntnyq/node' | 'ntnyq/prettier' | 'ntnyq/prettier/ignore' | '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';
 
 /**
  * Parser options
@@ -8508,15 +8820,17 @@ interface OverridesOptions<Rules = TypedConfigItem['rules']> {
 /**
  * Custom framework support
  */
-declare function ntnyq(config?: TypedConfigItem | TypedConfigItem[], { vue: enableVue, unocss: enableUnoCSS, prettier: enablePrettier, markdown: enableMarkdown, command: enableCommand, }?: {
+declare function ntnyq(config?: TypedConfigItem | TypedConfigItem[], { vue: enableVue, unocss: enableUnoCSS, vitest: enableVitest, prettier: enablePrettier, markdown: enableMarkdown, command: enableCommand, }?: {
     vue?: boolean | undefined;
     unocss?: boolean | undefined;
+    vitest?: boolean | undefined;
     prettier?: boolean | undefined;
     markdown?: boolean | undefined;
     command?: boolean | undefined;
 }): TypedConfigItem[];
 
 declare const hasTypeScript: boolean;
+declare const hasVitest: boolean;
 declare const hasVue: boolean;
 declare const hasUnoCSS: boolean;
 
@@ -8549,6 +8863,7 @@ declare const GLOB_JSX = "**/*.?([cm])jsx";
 declare const GLOB_TS = "**/*.?([cm])ts";
 declare const GLOB_TSX = "**/*.?([cm])tsx";
 declare const GLOB_DTS = "**/*.d.?([cm])ts";
+declare const GLOB_TEST = "**/*.{test,spec}.?([cm])[jt]s?(x)";
 declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
 declare const GLOB_CSS = "**/*.css";
 declare const GLOB_LESS = "**/*.less";
@@ -8592,12 +8907,19 @@ declare const typescript: TypedConfigItem[];
 
 declare const unusedImports: TypedConfigItem[];
 
+declare const perfectionist: TypedConfigItem[];
+
 declare const regexp: TypedConfigItem[];
 
 declare const unocss: TypedConfigItem[];
 
 declare const command: TypedConfigItem[];
 
+declare const vitest: TypedConfigItem[];
+
+declare function getVueVersion(): number;
+declare const vue: TypedConfigItem[];
+
 declare const yml: TypedConfigItem[];
 
 declare const toml: TypedConfigItem[];
@@ -8609,7 +8931,4 @@ declare const jsonc: TypedConfigItem[];
 
 declare const markdown: TypedConfigItem[];
 
-declare function getVueVersion(): number;
-declare const vue: TypedConfigItem[];
-
-export { type Arrayable, type Awaitable, type ConfigName, 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_NODE_MODULES, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type InteropModuleDefault, type OverridesOptions, type ParserOptions, type RuleOptions, type RuleRecord, type RuleRecordEntry, type Rules, type TypedConfigItem, command, comments, defineConfig, getVueVersion, hasTypeScript, hasUnoCSS, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, node, ntnyq, prettier, regexp, sortPackageJson, sortTsConfig, toml, typescript, typescriptCore, unicorn, unocss, unusedImports, vue, yml };
+export { type Arrayable, type Awaitable, type ConfigName, 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_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 OverridesOptions, type ParserOptions, type RuleOptions, type RuleRecord, type RuleRecordEntry, type Rules, type TypedConfigItem, command, comments, defineConfig, getVueVersion, hasTypeScript, hasUnoCSS, hasVitest, hasVue, ignores, imports, interopDefault, javascript, jsdoc, jsonc, jsx, loadPlugin, markdown, node, ntnyq, perfectionist, prettier, regexp, sortPackageJson, sortTsConfig, toml, typescript, typescriptCore, unicorn, unocss, unusedImports, vitest, vue, yml };