@fabdeh/eslint-config 0.1.2 → 0.2.0

package/dist/index.d.ts

@@ -1,782 +0,0 @@
-import { ConfigArray, ConfigWithExtends } from 'typescript-eslint';
-import { StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
-import { TSESLint } from '@typescript-eslint/utils';
-import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
-
-/**
- * Vendor types from Prettier so we don't rely on the dependency.
- */
-type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
-interface VendoredPrettierOptionsRequired {
-    /**
-     * Specify the line length that the printer will wrap on.
-     *
-     * @default 120
-     */
-    printWidth: number;
-    /**
-     * Specify the number of spaces per indentation-level.
-     */
-    tabWidth: number;
-    /**
-     * Indent lines with tabs instead of spaces
-     */
-    useTabs?: boolean;
-    /**
-     * Print semicolons at the ends of statements.
-     */
-    semi: boolean;
-    /**
-     * Use single quotes instead of double quotes.
-     */
-    singleQuote: boolean;
-    /**
-     * Use single quotes in JSX.
-     */
-    jsxSingleQuote: boolean;
-    /**
-     * Print trailing commas wherever possible.
-     */
-    trailingComma: 'all' | 'es5' | 'none';
-    /**
-     * Print spaces between brackets in object literals.
-     */
-    bracketSpacing: boolean;
-    /**
-     * Put the `>` of a multi-line HTML (HTML, XML, JSX, Vue, Angular) element at the end of the last line instead of being
-     * alone on the next line (does not apply to self closing elements).
-     */
-    bracketSameLine: boolean;
-    /**
-     * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
-     *
-     * @deprecated use bracketSameLine instead
-     */
-    jsxBracketSameLine: boolean;
-    /**
-     * Format only a segment of a file.
-     */
-    rangeStart: number;
-    /**
-     * Format only a segment of a file.
-     *
-     * @default Number.POSITIVE_INFINITY
-     */
-    rangeEnd: number;
-    /**
-     * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
-     * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
-     *
-     * @default "preserve"
-     */
-    proseWrap: 'always' | 'never' | 'preserve';
-    /**
-     * Include parentheses around a sole arrow function parameter.
-     *
-     * @default "always"
-     */
-    arrowParens: 'always' | 'avoid';
-    /**
-     * Provide ability to support new languages to prettier.
-     */
-    plugins: (any | string)[];
-    /**
-     * How to handle whitespaces in HTML.
-     *
-     * @default "css"
-     */
-    htmlWhitespaceSensitivity: 'css' | 'ignore' | 'strict';
-    /**
-     * Which end of line characters to apply.
-     *
-     * @default "lf"
-     */
-    endOfLine: 'auto' | 'cr' | 'crlf' | 'lf';
-    /**
-     * Change when properties in objects are quoted.
-     *
-     * @default "as-needed"
-     */
-    quoteProps: 'as-needed' | 'consistent' | 'preserve';
-    /**
-     * Whether or not to indent the code inside <script> and <style> tags in Vue files.
-     *
-     * @default false
-     */
-    vueIndentScriptAndStyle: boolean;
-    /**
-     * Enforce single attribute per line in HTML, XML, Vue and JSX.
-     *
-     * @default false
-     */
-    singleAttributePerLine: boolean;
-    /**
-     * How to handle whitespaces in XML.
-     *
-     * @default "preserve"
-     */
-    xmlQuoteAttributes: 'double' | 'preserve' | 'single';
-    /**
-     * Whether to put a space inside the brackets of self-closing XML elements.
-     *
-     * @default true
-     */
-    xmlSelfClosingSpace: boolean;
-    /**
-     * Whether to sort attributes by key in XML elements.
-     *
-     * @default false
-     */
-    xmlSortAttributesByKey: boolean;
-    /**
-     * How to handle whitespaces in XML.
-     *
-     * @default "ignore"
-     */
-    xmlWhitespaceSensitivity: 'ignore' | 'preserve' | 'strict';
-}
-
-/**
- * A type that can be awaited. Promise<T> or T.
- */
-type Awaitable<T> = Promise<T> | T;
-/**
- * Options for determining if the code is running in an editor environment.
- */
-interface IsInEditorOptions {
-    /**
-     * Optional property that allows specifying if the code is running in an editor environment.
-     */
-    isInEditor?: boolean;
-}
-/**
- * Interface representing options for overriding default ESLint rules.
- */
-interface OverridesOptions {
-    /**
-     * Optional property that allows specifying custom rules to override the default ones.
-     */
-    overrides?: TSESLint.FlatConfig.Config['rules'];
-}
-/**
- * Options for specifying files.
- */
-interface FilesOptions {
-    /**
-     * Override the `files` option to provide custom globs.
-     */
-    files?: string[];
-}
-/**
- * Options for configuring the behavior of the Unicorn config.
- */
-interface UnicornOptions {
-    /**
-     * If set to `true`, enables all recommended settings from unicorn plugin.
-     *
-     * @default false
-     */
-    allRecommended?: boolean;
-}
-/**
- * An alias for the `StylisticCustomizeOptions` type without the `flat`, `name`, and `pluginName` properties.
- */
-type StylisticConfig = Omit<StylisticCustomizeOptions, 'flat' | 'name' | 'pluginName'>;
-/**
- * Interface representing the stylistic options.
- */
-interface StylisticOptions {
-    /**
-     * Optional property that allows specifying stylistic options.
-     */
-    stylistic?: StylisticConfig | boolean;
-}
-/**
- * Options for configuring the TypeScript parser.
- */
-interface TypeScriptParserOptions {
-    /**
-     * Optional parser options to be used by the TypeScript parser.
-     */
-    parserOptions?: TSESLint.FlatConfig.ParserOptions;
-}
-/**
- * Options for configuring Angular-specific linting rules.
- */
-interface AngularOptions {
-    /**
-     * Whether to enable accessibility rules.
-     *
-     * @default true
-     */
-    enableAccessibilityRules?: boolean;
-    /**
-     * Prefix to use for Angular components, directives, and pipes.
-     * Can be a single string or an array of strings.
-     *
-     * @default 'app'
-     */
-    prefix?: string[] | string;
-    /**
-     * TypeScript-specific linting rule overrides.
-     */
-    tsOverrides?: TSESLint.FlatConfig.Config['rules'];
-    /**
-     * HTML-specific linting rule overrides.
-     */
-    htmlOverrides?: TSESLint.FlatConfig.Config['rules'];
-}
-/**
- * Interface representing configuration options for enforcing NgRx operators rules.
- */
-interface NgrxOperators {
-    /**
-     * Whether to enforce NgRx operators rules.
-     *
-     * @default true
-     */
-    enforceOperatorsRules?: boolean;
-}
-/**
- * Configuration options for NGRX.
- */
-interface NgrxOptions {
-    /**
-     * Configuration for the NGRX store.
-     *
-     * If set to `true`, the default configuration will be used.
-     * If set to an object, it should contain options for files, NGRX operators, and overrides.
-     */
-    store?: boolean | (FilesOptions & NgrxOperators & OverridesOptions);
-    /**
-     * Configuration for NGRX effects.
-     *
-     * If set to `true`, the default configuration will be used.
-     * If set to an object, it should contain options for files, NGRX operators, and overrides.
-     */
-    effects?: boolean | (FilesOptions & NgrxOperators & OverridesOptions);
-    /**
-     * Configuration for NGRX signals.
-     *
-     * If set to `true`, the default configuration will be used.
-     * If set to an object, it should contain options for files, NGRX operators, and overrides.
-     */
-    signals?: boolean | (FilesOptions & NgrxOperators & OverridesOptions);
-}
-/**
- * Options for configuring testing utilities.
- */
-interface TestingOptions {
-    /**
-     * Indicates whether to include Jest DOM matchers.
-     *
-     * @default auto-detect based on the dependencies.
-     */
-    useJestDom?: boolean;
-    /**
-     * Indicates whether to include Testing Library utilities.
-     *
-     * @default auto-detect based on the dependencies.
-     */
-    useTestingLibrary?: boolean;
-}
-interface FormattersOptions {
-    css?: boolean;
-    html?: boolean;
-    xml?: boolean;
-    svg?: boolean;
-    markdown?: boolean;
-    graphql?: boolean;
-    options?: VendoredPrettierOptions;
-    slidev?: boolean | {
-        files?: string[];
-    };
-}
-/**
- * Options for creating an ESLint configuration.
- *
- * @see createConfig function
- */
-interface CreateConfigOptions {
-    /**
-     * Enable gitignore support.
-     *
-     * Passing an object to configure the options.
-     *
-     * @see https://github.com/antfu/eslint-config-flat-gitignore
-     * @default true
-     */
-    gitignore?: FlatGitignoreOptions | boolean;
-    /**
-     * JavaScript rules overrides. Can't be disabled.
-     */
-    javascript?: OverridesOptions;
-    /**
-     * TypeScript rules overrides and parser configuration.
-     *
-     * @default auto-detected
-     */
-    typescript?: OverridesOptions & TypeScriptParserOptions;
-    /**
-     * Enable stylistic rules.
-     *
-     * @see https://eslint.style/
-     * @default true
-     */
-    stylistic?: boolean | (OverridesOptions & StylisticConfig);
-    /**
-     * Options for eslint-plugin-unicorn.
-     *
-     * @default true
-     */
-    unicorn?: UnicornOptions | boolean;
-    /**
-     * Options for the angular linting rules
-     *
-     * @default auto-detect based on the dependencies.
-     */
-    angular?: AngularOptions | boolean;
-    /**
-     * Options for the ngrx linting rules.
-     *
-     * @default auto-detect based on dependencies.
-     */
-    ngrx?: NgrxOptions | boolean;
-    /**
-     * Options for the jest linting rules. This option is mutually exclusive with vitest.
-     *
-     * @default auto-detect based on dependencies.
-     */
-    jest?: boolean | (OverridesOptions & TestingOptions);
-    /**
-     * Options for the vitest linting rules. This option is mutually exclusive with jest.
-     *
-     * @default auto-detect based on dependencies.
-     */
-    vitest?: boolean | (OverridesOptions & TestingOptions);
-    /**
-     * Options for the TailwindCSS linting rules.
-     *
-     * @default auto-detect based on dependencies.
-     */
-    tailwindcss?: OverridesOptions | boolean;
-    /**
-     * Enable JSONC support.
-     *
-     * @default true
-     */
-    jsonc?: OverridesOptions | boolean;
-    /**
-     * Enable YAML support.
-     *
-     * @default true
-     */
-    yaml?: OverridesOptions | boolean;
-    /**
-     * Enable TOML support.
-     *
-     * @default true
-     */
-    toml?: OverridesOptions | boolean;
-    /**
-     * Enable linting for **code snippets** in Markdown.
-     *
-     * For formatting Markdown content, enable also `formatters.markdown`.
-     *
-     * @default true
-     */
-    markdown?: OverridesOptions | boolean;
-    /**
-     * Use external formatters to format files.
-     *
-     * Requires installing:
-     * - `eslint-plugin-format`
-     *
-     * When set to `true`, it will enable all formatters.
-     *
-     * @default false
-     */
-    formatters?: FormattersOptions | boolean;
-    /**
-     * Control to disable some rules in editors.
-     *
-     * @default auto-detect based on the process.env
-     */
-    isInEditor?: boolean;
-}
-
-/**
- * Generates an ESLint configuration for Angular projects.
- *
- * @param options - Configuration options for Angular ESLint.
- * @param options.enableAccessibilityRules - Whether to enable accessibility rules for HTML templates.
- * @param options.tsOverrides - Additional TypeScript rule overrides.
- * @param options.htmlOverrides - Additional HTML rule overrides.
- * @param options.prefix - The prefix to use for Angular component and directive selectors.
- * @returns A promise that resolves to an array of ESLint configurations.
- */
-declare function angular(options?: AngularOptions): Promise<ConfigArray>;
-
-/**
- * Generates a configuration array for ESLint comments rules.
- *
- * This function returns a configuration array that includes rules for managing
- * ESLint comments in the codebase. It uses the `@eslint-community/eslint-comments`
- * plugin to enforce best practices and prevent common issues with ESLint comments.
- *
- * @returns The configuration array for ESLint comments rules.
- */
-declare function comments(): ConfigArray;
-
-/**
- * Generates a configuration array for ESLint with default and user-defined ignore patterns.
- *
- * @param userIgnores - An array of user-defined glob patterns to ignore. Defaults to an empty array.
- * @returns A ConfigArray object containing the combined ignore patterns.
- */
-declare function ignores(userIgnores?: string[]): ConfigArray;
-
-/**
- * Generates an ESLint configuration array for import rules.
- *
- * @param options - An object containing stylistic options.
- * @param options.stylistic - A boolean indicating whether to include stylistic rules. Defaults to true.
- * @returns A ConfigArray object with the specified import rules.
- */
-declare function imports(options?: StylisticOptions): ConfigArray;
-
-/**
- * Generates a configuration array for JavaScript projects with ESLint.
- *
- * This function sets up ESLint configurations for JavaScript projects, including language options,
- * linter options, and specific rules. It supports options for Angular decorators and unused imports
- * handling based on the environment (editor or not).
- *
- * @param options - Configuration options for the JavaScript setup.
- * @param options.isInEditor - Indicates if the configuration is being used in an editor.
- * @param options.overrides - Additional rule overrides.
- * @param options.allowAngularDecorator - Allows specific Angular decorators to be used without new-cap errors.
- * @returns A configuration array for ESLint.
- * @example
- * ```typescript
- * const config = javascript({ isInEditor: true, allowAngularDecorator: true });
- * ```
- */
-declare function javascript(options?: IsInEditorOptions & OverridesOptions & {
-    allowAngularDecorator?: boolean;
-}): ConfigArray;
-
-/**
- * Generates an ESLint configuration for Jest testing environments.
- *
- * @param options - Configuration options for the Jest setup.
- * @param options.overrides - Custom rule overrides to apply.
- * @param options.useJestDom - Whether to include `@testing-library/jest-dom` plugin. Defaults to checking if the package exists.
- * @param options.useTestingLibrary - Whether to include `@testing-library/angular` plugin. Defaults to checking if the package exists.
- * @param options.stylistic - Whether to include stylistic rules. Defaults to `true`.
- * @returns A promise that resolves to a `ConfigArray` containing the ESLint configuration.
- */
-declare function jest(options?: OverridesOptions & StylisticOptions & TestingOptions): Promise<ConfigArray>;
-
-/**
- * Generates a configuration array for JSDoc rules.
- *
- * @param options - An object containing stylistic options.
- * @param options.stylistic - A boolean indicating whether to include stylistic rules. Defaults to true.
- * @returns A configuration array for JSDoc rules.
- */
-declare function jsdoc(options?: StylisticOptions): ConfigArray;
-
-/**
- * Generates an ESLint configuration for JSONC files.
- *
- * @param options - Configuration options for the JSONC setup.
- * @param options.files - An array of glob patterns to specify the JSONC files to lint. Defaults to `[GLOB_JSON, GLOB_JSON5, GLOB_JSONC]`.
- * @param options.overrides - Additional rules or configurations to override the default settings.
- * @param options.stylistic - A boolean or object to enable or configure stylistic rules. Defaults to `true`.
- * @returns A promise that resolves to a `ConfigArray` containing the ESLint configuration.
- * @example
- * ```typescript
- * const config = await jsonc({
- *   files: ['**\/*.json'],
- *   stylistic: {
- *     indent: 4,
- *   },
- * });
- * ```
- */
-declare function jsonc(options?: FilesOptions & OverridesOptions & StylisticOptions): Promise<ConfigArray>;
-
-/**
- * Configures ESLint for Markdown files.
- *
- * This function sets up ESLint configurations specifically for Markdown files,
- * including custom parsers, plugins, processors, and rule overrides.
- *
- * @param options - An object containing file and override options.
- * @param options.files - An array of glob patterns to specify the Markdown files to lint.
- * @param options.overrides - An object containing rule overrides.
- * @returns A promise that resolves to a ConfigArray containing the ESLint configurations.
- * @example
- * ```typescript
- * const config = await markdown({
- *   files: ['**\/*.md'],
- *   overrides: {
- *     'no-console': 'warn',
- *   },
- * });
- * ```
- */
-declare function markdown(options?: FilesOptions & OverridesOptions): Promise<ConfigArray>;
-
-/**
- * Generates an ESLint configuration array for NgRx based on the provided options.
- *
- * @param [options] - The options to configure NgRx rules.
- * @param [options.store] - If true or an object, includes NgRx store rules.
- * @param [options.effects] - If true or an object, includes NgRx effects rules.
- * @param [options.signals] - If true or an object, includes NgRx signals rules.
- * @returns A promise that resolves to the ESLint configuration array.
- * @example
- * // Basic usage
- * const config = await ngrx();
- * @example
- * ```ts
- * // With custom options
- * const config = await ngrx({
- *   store: { files: ['**\/*.store.ts'] },
- *   effects: { files: ['**\/*.effects.ts'] },
- *   signals: { files: ['**\/*.signals.ts'] }
- * });
- * ```
- */
-declare function ngrx(options?: NgrxOptions): Promise<ConfigArray>;
-
-/**
- * Generates a configuration array for the "perfectionist" ESLint plugin.
- *
- * This configuration includes rules for sorting various elements in the codebase
- * such as exports, imports, intersection types, named exports, named imports,
- * switch cases, and union types. The sorting order is set to ascending and the
- * type is natural.
- *
- * @returns The configuration array for the "perfectionist" plugin.
- */
-declare function perfectionist(): ConfigArray;
-
-/**
- * Configures ESLint rules for sorting keys and array values in `package.json` files.
- *
- * This function returns a configuration array that enforces specific sorting rules
- * for various sections of `package.json` files. The rules include:
- * - Sorting array values in ascending order for the `files` field.
- * - Sorting keys in a predefined order for the root level of `package.json`.
- * - Sorting dependency fields (`dependencies`, `devDependencies`, `peerDependencies`, etc.) in ascending order.
- * - Sorting specific fields within the `exports` section.
- * - Sorting client hooks in a predefined order for `gitHooks`, `husky`, and `simple-git-hooks`.
- *
- * @returns The ESLint configuration array with sorting rules.
- */
-declare function sortPackageJson(): ConfigArray;
-/**
- * Generates a TypeScript ESLint configuration array that enforces sorting rules for `tsconfig.json` files.
- *
- * The configuration includes rules to:
- * - Sort the top-level keys of `tsconfig.json` files in a specific order.
- * - Sort the keys within the `compilerOptions` section of `tsconfig.json` files in a specific order.
- *
- * @returns The TypeScript ESLint configuration array with sorting rules.
- */
-declare function sortTsConfig(): ConfigArray;
-
-declare const STYLISTIC_CONFIG_DEFAULT: StylisticConfig;
-/**
- * Generates a stylistic ESLint configuration.
- *
- * @param [options] - Optional configuration options to customize the stylistic rules.
- * @returns A promise that resolves to an array of ESLint configurations.
- * @example
- * const config = await stylistic({ semi: false });
- */
-declare function stylistic(options?: StylisticOptions): Promise<ConfigArray>;
-
-/**
- * Generates an ESLint configuration array for Tailwind CSS.
- *
- * @param [options] - Optional overrides for the configuration.
- * @returns  A promise that resolves to the ESLint configuration array.
- * @example
- * const config = await tailwindcss({
- *   overrides: {
- *     'tailwindcss/classnames-order': 'warn',
- *   },
- * });
- */
-declare function tailwindcss(options?: OverridesOptions): Promise<ConfigArray>;
-
-/**
- * Generates an ESLint configuration for TOML files.
- *
- * @param options -  The configuration options.
- * @param options.files - The glob patterns for the files to lint.
- * @param options.overrides - The rules to override the default configuration.
- * @param options.stylistic - Whether to apply stylistic rules or a configuration object for stylistic rules.
- * @param options.stylistic.indent - The indentation style for stylistic rules.
- * @returns A promise that resolves to the ESLint configuration array.
- */
-declare function toml(options?: FilesOptions & OverridesOptions & StylisticOptions): Promise<ConfigArray>;
-
-/**
- * Generates a TypeScript ESLint configuration.
- *
- * @param options - Configuration options that include overrides, stylistic preferences, and parser options.
- * @param options.stylistic - A boolean indicating whether stylistic rules should be included. Defaults to true.
- * @param options.parserOptions - Options for the TypeScript parser.
- * @param options.overrides - Additional rule overrides.
- * @returns A ConfigArray containing the TypeScript ESLint configuration.
- */
-declare function typescript(options?: OverridesOptions & StylisticOptions & TypeScriptParserOptions): ConfigArray;
-
-/**
- * Generates a configuration array for the Unicorn plugin with the specified options.
- *
- * @param [options] - The options to customize the Unicorn rules.
- * @returns The configuration array for the Unicorn plugin.
- */
-declare function unicorn(options?: UnicornOptions): ConfigArray;
-
-/**
- * Configures and returns an ESLint configuration array for Vitest.
- *
- * @param [options] - The options to customize the configuration.
- * @param [options.overrides] - Custom rule overrides.
- * @param [options.useJestDom] - Whether to use the `@testing-library/jest-dom` plugin.
- * @param [options.useTestingLibrary] - Whether to use the `@testing-library/angular` plugin.
- * @returns A promise that resolves to the ESLint configuration array.
- * @example
- * const config = await vitest({
- *   overrides: {
- *     'no-console': 'warn',
- *   },
- *   useJestDom: true,
- *   useTestingLibrary: false,
- * });
- */
-declare function vitest(options?: OverridesOptions & TestingOptions): Promise<ConfigArray>;
-
-/**
- * Generates an ESLint configuration for YAML files.
- *
- * @param options - Configuration options for the YAML setup.
- * @param options.files - An array of glob patterns to specify the YAML files to lint. Defaults to `[GLOB_YAML]`.
- * @param options.overrides - An object containing rule overrides.
- * @param options.stylistic - A boolean or object to specify stylistic rules. Defaults to `true`.
- * @param options.stylistic.indent - The number of spaces for indentation or 'tab'. Defaults to `2`.
- * @param options.stylistic.quotes - The type of quotes to use ('single', 'double', or 'backtick'). Defaults to `'single'`.
- * @returns A promise that resolves to a `ConfigArray` containing the ESLint configuration.
- */
-declare function yaml(options?: FilesOptions & OverridesOptions & StylisticOptions): Promise<ConfigArray>;
-
-/**
- * Creates an ESLint configuration array based on the provided options and user configurations.
- *
- * @param options - Configuration options that extend `ConfigWithExtends` and `CreateConfigOptions`.
- * @param userConfigs - Additional user configurations that can be awaited.
- * @returns A promise that resolves to a `ConfigArray`.
- * @throws Will throw an error if both `jest` and `vitest` are enabled.
- * @example
- * ```typescript
- * const config = await createConfig({ jest: true, typescript: { parserOptions: { project: './tsconfig.json' } } });
- * ```
- */
-declare function createConfig(options?: ConfigWithExtends & CreateConfigOptions, ...userConfigs: Awaitable<ConfigWithExtends | ConfigWithExtends[]>[]): Promise<ConfigArray>;
-
-/**
- * A glob pattern that matches JavaScript and TypeScript source files (including JSX/TSX).
- */
-declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
-/**
- * A glob pattern that matches JavaScript source files (including JSX).
- */
-declare const GLOB_JS = "**/*.?([cm])js?(x)";
-/**
- * A glob pattern that matches TypeScript source files (including TSX).
- */
-declare const GLOB_TS = "**/*.?([cm])ts?(x)";
-/**
- * A glob pattern that matches HTML files.
- */
-declare const GLOB_HTML = "**/*.htm?(l)";
-/**
- * A glob pattern that matches test files.
- */
-declare const GLOB_TESTS: string[];
-
-/**
- * Determines if the current environment is an editor environment.
- *
- * This function checks various environment variables to determine if the code
- * is running within a known editor environment such as VSCode, IntelliJ, JetBrains,
- * Vim, or NeoVim. It also ensures that the code is not running in a CI environment
- * or within git hooks.
- *
- * @returns `true` if the code is running in an editor environment, otherwise `false`.
- */
-declare function isInEditorEnv(): boolean;
-/**
- * Converts a value to an array. If the value is already an array, it returns the value as is.
- * Otherwise, it wraps the value in an array.
- *
- * @template T - The type of the value.
- * @param value - The value to convert to an array.
- * @returns The value converted to an array.
- */
-declare function toArray<T>(value: T | T[]): T[];
-/**
- * A utility function to handle the default export of a module.
- *
- * This function takes an `Awaitable` module and returns its default export if it exists,
- * otherwise, it returns the module itself.
- *
- * @template T - The type of the module.
- * @param m - The module to resolve.
- * @returns A promise that resolves to the default export of the module if it exists, otherwise the module itself.
- */
-declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
-    default: infer U;
-} ? U : T>;
-/**
- * Retrieves the root directory of the workspace.
- *
- * This function determines the root directory of the workspace by checking for specific files
- * and directories that indicate the presence of an Nx workspace. If the `NX_WORKSPACE_ROOT_PATH`
- * environment variable is set, it returns that value. Otherwise, it recursively checks parent
- * directories until it finds the workspace root or reaches the filesystem root.
- *
- * @param dir - The current directory to start the search from.
- * @param candidateRoot - The initial candidate root directory.
- * @returns The root directory of the workspace.
- */
-declare function getWorkspaceRoot(dir: string, candidateRoot: string): string;
-/**
- * Checks if a package is within the specified scope.
- *
- * @param name - The name of the package to check.
- * @returns A boolean indicating whether the package is in scope.
- */
-declare function isPackageInScope(name: string): boolean;
-/**
- * Ensures that the specified packages are installed. If running in a CI environment,
- * or if the terminal is not interactive, or if the current working directory is not in scope,
- * the function will return immediately without doing anything.
- *
- * The function filters out packages that are already in scope and prompts the user to confirm
- * the installation of the remaining packages. If the user confirms, the packages are installed
- * as development dependencies.
- *
- * @param packages - An array of package names (or undefined) to check and install if necessary.
- * @returns A promise that resolves when the operation is complete.
- */
-declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
-
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type IsInEditorOptions, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };