Option Reference

externals

• Type: ExternalFn | boolean | string | RegExp | Array<string | RegExp> | Record<string, string>
• Required: false

Configure external dependencies. Example

logLevel

• Type: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "OFF"
• Required: false
• Default: "WARN"

Sets the logging level.

nodeBuiltins

• Type: boolean
• Required: false

Whether to exclude Node.js built-in modules. Example

externalizeDeps

• Type: Array<string | RegExp>
• Required: false

Specify dependencies to exclude from bundling. Example

externalGlobals

• Type: (globals: Record<string, any>) => rollup.Plugin
• Required: false

Resolve IIFE Packaging Issues Rollup Issue #3188. Example

rollback

• Type: boolean
• Required: false

Whether to revert to the legacy implementation.

interop

• Type: "auto" | undefined
• Required: false

This option controls how Vite adjust build strategies . Example

enforce

• Type: 'pre' | 'post'
• Required: false

Enforce order. Values: pre (before) or post (after). Refer to Vite Plugin Ordering.

cwd

• Type: string
• Required: false
• Default: process.cwd()

Sets the current directory for resolving cacheDir relative paths.

cacheDir

• Type: string
• Required: false
• Default: ${cwd}/node_modules/.vite_external

Cache directory path.

[mode: string]

• Type: BasicOptions
• Required: false

Configure external dependencies for specific modes. Example

---

TypeScript Definitions

import type { NullValue, Plugin as RollupPlugin } from 'rollup';
import type { ConfigEnv } from 'vite';
import type { LogLevel } from 'vp-runtime-helper';

export type ExternalFn = (
  source: string,
  importer: string | undefined,
  isResolved: boolean
) => string | boolean | NullValue;

export type ModuleNameMap = Record<string, string> | ((id: string) => string);

export type { LogLevel } from 'base-log-factory';

export interface BasicOptions {
  /**
   * Current working directory for resolving `cacheDir` paths.
   * @default `process.cwd()`
   */
  cwd?: string;

  /**
   * Cache directory path
   * @default `${cwd}/node_modules/.vite_external`
   */
  cacheDir?: string;

  /**
   * External dependencies configuration
   */
  externals?:
    | ExternalFn
    | boolean
    | string
    | RegExp
    | Array<string | RegExp>
    | Record<string, string>;

  /**
   * Logging level configuration
   */
  logLevel?: LogLevel;
}

export interface Options extends BasicOptions {
  /**
   * Mode-specific external dependencies configuration
   */
  [mode: string]: BasicOptions | any;

  /**
   * Revert to legacy implementation
   */
  rollback?: boolean;

  /**
   * Controls Vite's default handling behavior
   */
  interop?: 'auto';

  /**
   * Plugin execution order ("pre" or "post")
   */
  enforce?: 'pre' | 'post';

  /**
   * Exclude Node.js built-in modules
   */
  nodeBuiltins?: boolean;

  /**
   * Dependencies to exclude from bundling
   */
  externalizeDeps?: Array<string | RegExp>;

  /**
   * Fix Rollup#3188 issue (https://github.com/rollup/rollup/issues/3188)
   */
  externalGlobals?: (globals: ModuleNameMap) => RollupPlugin;
}

export interface ResolvedOptions extends Options, ConfigEnv {
  cwd: string;
  cacheDir: string;
}