vite-tsconfig-paths/dist/index.d.ts

Vite resolver for TypeScript compilerOptions.paths

import * as vite from 'vite';

interface PluginOptions {
    /**
     * The directory to crawl for `tsconfig.json` files.
     *
     * When the `projects` option is set, crawling is skipped, so this is
     * used to resolve `projects` paths into absolute paths instead.
     *
     * @default
     * // The config root is used for resolving project paths, and the
     * // workspace root is used for crawling.
     * options.projects ? viteConfig.root : vite.searchForWorkspaceRoot(viteConfig.root)
     */
    root?: string;
    /**
     * An array of `.json` files and/or directories that contain a
     * `tsconfig.json` file. These JSON files must adhere to the
     * {@link https://www.typescriptlang.org/tsconfig TypeScript config interface}.
     * The `extends` property is supported.
     *
     * This disables crawling for `tsconfig.json` files when defined.
     *
     * **Note:** When using `projectDiscovery: "lazy"`, this option is perfect
     * for ensuring your
     * {@link https://www.typescriptlang.org/docs/handbook/project-references.html project references}
     * are discovered.
     */
    projects?: string[];
    /**
     * Disable strictness that limits path resolution to TypeScript and
     * JavaScript modules.
     *
     * Useful if you want asset URLs in Vue templates to be resolved, or when
     * `"allowJs": true` in your tsconfig isn't good enough.
     */
    loose?: boolean;
    /**
     * Fine-grained control over which files should have their imports
     * resolved by this plugin. This has no effect when `loose` is true.
     */
    importerFilter?: (importer: string) => boolean;
    /**
     * Enable use of `tsconfck.parseNative` function, which delegates the
     * loading of `tsconfig.json` files to the TypeScript compiler. You'll
     * probably never need this, but I added it just in case.
     *
     * ⚠️ This option can slow down Vite's startup time by as much as 600ms,
     * due to the size of the TypeScript compiler. Only use it when
     * necessary.
     */
    parseNative?: boolean;
    /**
     * Silence the warning about malformed `tsconfig.json` files.
     */
    ignoreConfigErrors?: boolean;
    /**
     * An array of `tsconfig.json` file names to search for.
     *
     * @default ["tsconfig.json", "jsconfig.json"]
     */
    configNames?: string[];
    /**
     * A function that determines which directories to skip when searching
     * for tsconfig.json files. While `.git` and `node_modules` directories
     * are always skipped, this option allows you to skip additional
     * directories, which is useful in large monorepos to improve
     * performance.
     *
     * **Note:** This is not used when the `projects` option is set, unless
     * `projectDiscovery` is set to `lazy`.
     */
    skip?: (dir: string) => boolean;
    /**
     * With the "lazy" strategy, the `tsconfig.json` files are parsed when an
     * import is encountered in a module with a supported file extension that
     * exists in the same directory as the `tsconfig.json` file (or one of
     * its subdirectories).
     *
     * **Note 1:** If your `tsconfig.json` files have `../*` paths in their
     * `include` or `files` array, the "lazy" strategy is not recommended,
     * since the tsconfig file won't be discovered for those cases.
     *
     * **Note 2:** You can combine the `projects` option with "lazy" to
     * ensure your project references are discovered. Alternatively, the
     * `configNames` option allows for custom-named tsconfig files to be
     * discovered.
     *
     * With the "eager" strategy, all `tsconfig.json` files are loaded and
     * parsed when the plugin is initialized. This means they won't be
     * reloaded if their file is edited. This was the only parsing strategy
     * prior to v5.2.0 and may be deprecated in a future version.
     *
     * @default "eager"
     */
    projectDiscovery?: 'eager' | 'lazy';
    /**
     * A file to write detailed logs of the resolver process.
     */
    logFile?: string | boolean;
}

declare const _default: (opts?: PluginOptions) => {
    readonly name: "vite-tsconfig-paths";
    readonly enforce: "pre";
    readonly configResolved: (config: Pick<vite.ResolvedConfig, "logger" | "root">) => void;
    readonly configureServer: (server: Pick<vite.ViteDevServer, "watcher">) => void;
    readonly buildStart: () => void;
    readonly resolveId: (this: Pick<vite.Rollup.PluginContext, "resolve">, id: string, importer: string | undefined, options: {}) => Promise<string | undefined>;
};

export { PluginOptions, _default as default };