@vue/eslint-config-typescript/dist/index.d.mts

ESLint config for TypeScript + Vue.js projects

import { TSESLint } from '@typescript-eslint/utils';
import { FlatConfig } from '@typescript-eslint/utils/ts-eslint';

type ScriptLang = 'ts' | 'tsx' | 'js' | 'jsx';

type ConfigItem = TSESLint.FlatConfig.Config;
type ConfigInput = ConfigItemWithExtendsAndVueSupport | ConfigInput[];
interface ConfigItemWithExtendsAndVueSupport extends ConfigItem {
    extends?: ConfigInput[];
}
type ProjectOptions = {
    /**
     * Whether to parse TypeScript syntax in Vue templates.
     * Defaults to `true`.
     * Setting it to `false` could improve performance.
     * But TypeScript syntax in Vue templates will then lead to syntax errors.
     * Also, type-aware rules won't be applied to expressions in templates in that case.
     */
    tsSyntaxInTemplates?: boolean;
    /**
     * Allowed script languages in `vue` files.
     * Defaults to `['ts']`
     */
    scriptLangs?: ScriptLang[];
    /**
     * Whether to override some `no-unsafe-*` rules to avoid false positives on Vue component operations.
     * Defaults to `true`.
     *
     * Due to limitations in the integration between Vue and TypeScript-ESLint,
     * TypeScript-ESLint cannot get the full type information for `.vue` files
     * and will use fallback types that contain some `any`s.
     * Therefore, some `no-unsafe-*` rules will error on functions that operate on Vue components,
     * such as `createApp`, `createRouter`, `useTemplateRef`, etc.
     *
     * Setting this option to `true` will override those `no-unsafe-*` rules
     * to allow these patterns in the project.
     *
     * If you're using a metaframework such as Nuxt or Quasar
     * that handles app creation & router configuration for you,
     * you might not need to interact with component types directly.
     * Similarly, if you're using TSX exclusively,
     * you can set this to `false` for stricter type checking.
     */
    allowComponentTypeUnsafety?: boolean;
    /**
     * Allow patterns to match entries that begin with a period (.).
     * Default is `false`.
     */
    includeDotFolders?: boolean;
    /**
     * The root directory of the project.
     * Defaults to `process.cwd()`.
     */
    rootDir?: string;
};
type MaybePromise<T> = T | PromiseLike<T>;
type AwaitableConfigInput = MaybePromise<ConfigInput | ConfigInput[]>;
declare function configureVueProject(userOptions: ProjectOptions): void;
declare function defineConfigWithVueTs(...configs: ConfigInput[]): ConfigItem[];
declare function withVueTs(...configs: AwaitableConfigInput[]): Promise<ConfigItem[]>;
declare function withVueTs(options: ProjectOptions, ...configs: AwaitableConfigInput[]): Promise<ConfigItem[]>;

declare const CONFIG_NAMES: readonly ["all", "base", "disableTypeChecked", "eslintRecommended", "recommended", "recommendedTypeChecked", "recommendedTypeCheckedOnly", "strict", "strictTypeChecked", "strictTypeCheckedOnly", "stylistic", "stylisticTypeChecked", "stylisticTypeCheckedOnly"];
type ExtendableConfigName = (typeof CONFIG_NAMES)[number];
declare const vueTsConfigs: Record<ExtendableConfigName, FlatConfig.Config | FlatConfig.ConfigArray>;

type ConfigOptions = ProjectOptions & {
    extends?: ExtendableConfigName[];
    supportedScriptLangs?: Record<ScriptLang, boolean>;
};
/**
 * @deprecated Use `defineConfigWithVueTs` + `vueTsConfigs` instead.
 */
declare function createConfig({ extends: configNamesToExtend, supportedScriptLangs, rootDir, }?: ConfigOptions): FlatConfig.ConfigArray;

/**
 * @deprecated `defineConfig` is renamed to `defineConfigWithVueTs` in 14.3.0
 */
declare const defineConfig: typeof defineConfigWithVueTs;

export { configureVueProject, createConfig, createConfig as default, defineConfig, defineConfigWithVueTs, vueTsConfigs, withVueTs };