UNPKG

rolldown

Version:

Fast JavaScript/TypeScript bundler in Rust with Rollup-compatible API.

1,355 lines (1,354 loc) 50.3 kB
import { BindingAssetPluginConfig, BindingBuildImportAnalysisPluginConfig, BindingBuiltinPluginName, BindingBundlerImpl, BindingDynamicImportVarsPluginConfig, BindingHmrUpdate, BindingHookResolveIdExtraArgs, BindingImportGlobPluginConfig, BindingIsolatedDeclarationPluginConfig, BindingJsonPluginConfig, BindingManifestPluginConfig, BindingMinifyOptions, BindingModulePreloadPolyfillPluginConfig, BindingRenderedChunk, BindingReporterPluginConfig, BindingTransformHookExtraArgs, BindingViteResolvePluginConfig, BindingWasmHelperPluginConfig, BindingWatcherEvent, ParserOptions, PreRenderedChunk, TransformOptions } from "./binding-CFhvYkVn.mjs"; import { TopLevelFilterExpression } from "@rolldown/pluginutils"; import { Program } from "@oxc-project/types"; //#region src/log/logging.d.ts type LogLevel = "info" | "debug" | "warn"; type LogLevelOption = LogLevel | "silent"; type LogLevelWithError = LogLevel | "error"; interface RollupLog { binding?: string; cause?: unknown; code?: string; exporter?: string; frame?: string; hook?: string; id?: string; ids?: string[]; loc?: { column: number; file?: string; line: number; }; message: string; meta?: any; names?: string[]; plugin?: string; pluginCode?: unknown; pos?: number; reexporter?: string; stack?: string; url?: string; } type RollupLogWithString = RollupLog | string; interface RollupError extends RollupLog { name?: string; stack?: string; watchFiles?: string[]; } type LogOrStringHandler = (level: LogLevelWithError, log: RollupLogWithString) => void; //#endregion //#region src/types/misc.d.ts type SourcemapPathTransformOption = (relativeSourcePath: string, sourcemapPath: string) => string; type SourcemapIgnoreListOption = (relativeSourcePath: string, sourcemapPath: string) => boolean; //#endregion //#region src/types/module-info.d.ts interface ModuleInfo extends ModuleOptions { /** * Unsupported at rolldown */ ast: any; code: string | null; id: string; importers: string[]; dynamicImporters: string[]; importedIds: string[]; dynamicallyImportedIds: string[]; exports: string[]; isEntry: boolean; } //#endregion //#region src/utils/asset-source.d.ts type AssetSource = string | Uint8Array; //#endregion //#region src/types/rolldown-output.d.ts interface OutputAsset { type: "asset"; fileName: string; /** @deprecated Use "originalFileNames" instead. */ originalFileName: string | null; originalFileNames: string[]; source: AssetSource; /** @deprecated Use "names" instead. */ name: string | undefined; names: string[]; } interface SourceMap { file: string; mappings: string; names: string[]; sources: string[]; sourcesContent: string[]; version: number; debugId?: string; x_google_ignoreList?: number[]; toString(): string; toUrl(): string; } interface RenderedModule { readonly code: string | null; renderedLength: number; renderedExports: string[]; } interface RenderedChunk extends Omit<BindingRenderedChunk, "modules"> { type: "chunk"; modules: { [id: string]: RenderedModule; }; name: string; isEntry: boolean; isDynamicEntry: boolean; facadeModuleId: string | null; moduleIds: Array<string>; exports: Array<string>; fileName: string; imports: Array<string>; dynamicImports: Array<string>; } interface OutputChunk { type: "chunk"; code: string; name: string; isEntry: boolean; exports: string[]; fileName: string; modules: { [id: string]: RenderedModule; }; imports: string[]; dynamicImports: string[]; facadeModuleId: string | null; isDynamicEntry: boolean; moduleIds: string[]; map: SourceMap | null; sourcemapFileName: string | null; preliminaryFileName: string; } interface RolldownOutput { output: [OutputChunk, ...(OutputChunk | OutputAsset)[]]; } //#endregion //#region src/types/utils.d.ts type MaybePromise<T> = T | Promise<T>; type NullValue<T = void> = T | undefined | null | void; type PartialNull<T> = { [P in keyof T]: T[P] | null }; type MakeAsync<Function_> = Function_ extends ((this: infer This, ...parameters: infer Arguments) => infer Return) ? (this: This, ...parameters: Arguments) => Return | Promise<Return> : never; type MaybeArray<T> = T | T[]; type StringOrRegExp = string | RegExp; //#endregion //#region src/options/output-options.d.ts type ModuleFormat = "es" | "cjs" | "esm" | "module" | "commonjs" | "iife" | "umd"; type AddonFunction = (chunk: RenderedChunk) => string | Promise<string>; type ChunkFileNamesFunction = (chunkInfo: PreRenderedChunk) => string; interface PreRenderedAsset { type: "asset"; name?: string; names: string[]; originalFileName?: string; originalFileNames: string[]; source: string | Uint8Array; } type AssetFileNamesFunction = (chunkInfo: PreRenderedAsset) => string; type GlobalsFunction = (name: string) => string; type MinifyOptions = BindingMinifyOptions; interface ChunkingContext { getModuleInfo(moduleId: string): ModuleInfo | null; } interface OutputOptions { dir?: string; file?: string; exports?: "auto" | "named" | "default" | "none"; hashCharacters?: "base64" | "base36" | "hex"; /** * Expected format of generated code. * - `'es'`, `'esm'` and `'module'` are the same format, all stand for ES module. * - `'cjs'` and `'commonjs'` are the same format, all stand for CommonJS module. * - `'iife'` stands for [Immediately Invoked Function Expression](https://developer.mozilla.org/en-US/docs/Glossary/IIFE). * - `'umd'` stands for [Universal Module Definition](https://github.com/umdjs/umd). * * @default 'esm' */ format?: ModuleFormat; sourcemap?: boolean | "inline" | "hidden"; sourcemapBaseUrl?: string; sourcemapDebugIds?: boolean; sourcemapIgnoreList?: boolean | SourcemapIgnoreListOption; sourcemapPathTransform?: SourcemapPathTransformOption; banner?: string | AddonFunction; footer?: string | AddonFunction; intro?: string | AddonFunction; outro?: string | AddonFunction; extend?: boolean; esModule?: boolean | "if-default-prop"; assetFileNames?: string | AssetFileNamesFunction; entryFileNames?: string | ChunkFileNamesFunction; chunkFileNames?: string | ChunkFileNamesFunction; cssEntryFileNames?: string | ChunkFileNamesFunction; cssChunkFileNames?: string | ChunkFileNamesFunction; sanitizeFileName?: boolean | ((name: string) => string); minify?: boolean | "dce-only" | MinifyOptions; name?: string; globals?: Record<string, string> | GlobalsFunction; externalLiveBindings?: boolean; inlineDynamicImports?: boolean; /** * - Type: `((moduleId: string, meta: { getModuleInfo: (moduleId: string) => ModuleInfo | null }) => string | NullValue)` * - Object form is not supported. * * :::warning * - This option is deprecated. Please use `advancedChunks` instead. * - If `manualChunks` and `advancedChunks` are both specified, `manualChunks` option will be ignored. * ::: * * You could use this option for migration purpose. Under the hood, * * ```js * { * manualChunks: (moduleId, meta) => { * if (moduleId.includes('node_modules')) { * return 'vendor'; * } * return null; * } * } * ``` * * will be transformed to * * ```js * { * advancedChunks: { * groups: [ * { * name(moduleId) { * if (moduleId.includes('node_modules')) { * return 'vendor'; * } * return null; * }, * }, * ], * } * } * * ``` * * @deprecated Please use `advancedChunks` instead. */ manualChunks?: (moduleId: string, meta: { getModuleInfo: (moduleId: string) => ModuleInfo | null; }) => string | NullValue; /** * Allows you to do manual chunking. For deeper understanding, please refer to the in-depth [documentation](https://rolldown.rs/guide/in-depth/advanced-chunks). */ advancedChunks?: { /** * - Type: `boolean` * - Default: `true` * * By default, each group will also include captured modules' dependencies. This reduces the chance of generating circular chunks. * * If you want to disable this behavior, it's recommended to both set * - `preserveEntrySignatures: false` * - `strictExecutionOrder: true` * * to avoid generating invalid chunks. */ includeDependenciesRecursively?: boolean; /** * - Type: `number` * * Global fallback of [`{group}.minSize`](#advancedchunks-groups-minsize), if it's not specified in the group. */ minSize?: number; /** * - Type: `number` * * Global fallback of [`{group}.maxSize`](#advancedchunks-groups-maxsize), if it's not specified in the group. */ maxSize?: number; /** * - Type: `number` * * Global fallback of [`{group}.maxModuleSize`](#advancedchunks-groups-maxmodulesize), if it's not specified in the group. */ maxModuleSize?: number; /** * - Type: `number` * * Global fallback of [`{group}.minModuleSize`](#advancedchunks-groups-minmodulesize), if it's not specified in the group. */ minModuleSize?: number; /** * - Type: `number` * * Global fallback of [`{group}.minShareCount`](#advancedchunks-groups-minsharecount), if it's not specified in the group. */ minShareCount?: number; /** * Groups to be used for advanced chunking. */ groups?: { /** * - Type: `string | ((moduleId: string, ctx: { getModuleInfo: (moduleId: string) => ModuleInfo | null }) => string | NullValue)` * * Name of the group. It will be also used as the name of the chunk and replaced the `[name]` placeholder in the `chunkFileNames` option. * * For example, * * ```js * import { defineConfig } from 'rolldown'; * * export default defineConfig({ * advancedChunks: { * groups: [ * { * name: 'libs', * test: /node_modules/, * }, * ], * }, * }); * ``` * will create a chunk named `libs-[hash].js` in the end. * * It's ok to have the same name for different groups. Rolldown will deduplicate the chunk names if necessary. * * # Dynamic `name()` * * If `name` is a function, it will be called with the module id as the argument. The function should return a string or `null`. If it returns `null`, the module will be ignored by this group. * * Notice, each returned new name will be treated as a separate group. * * For example, * * ```js * import { defineConfig } from 'rolldown'; * * export default defineConfig({ * advancedChunks: { * groups: [ * { * name: (moduleId) => moduleId.includes('node_modules') ? 'libs' : 'app', * minSize: 100 * 1024, * }, * ], * }, * }); * ``` * * :::warning * Constraints like `minSize`, `maxSize`, etc. are applied separately for different names returned by the function. * ::: */ name: string | ((moduleId: string, ctx: ChunkingContext) => string | NullValue); /** * - Type: `string | RegExp | ((id: string) => boolean | undefined | void);` * * Controls which modules are captured in this group. * * - If `test` is a string, the module whose id contains the string will be captured. * - If `test` is a regular expression, the module whose id matches the regular expression will be captured. * - If `test` is a function, modules for which `test(id)` returns `true` will be captured. * - If `test` is empty, any module will be considered as matched. * * :::warning * When using regular expression, it's recommended to use `[\\/]` to match the path separator instead of `/` to avoid potential issues on Windows. * - ✅ Recommended: `/node_modules[\\/]react/` * - ❌ Not recommended: `/node_modules/react/` * ::: */ test?: StringOrRegExp | ((id: string) => boolean | undefined | void); /** * - Type: `number` * - Default: `0` * * Priority of the group. Group with higher priority will be chosen first to match modules and create chunks. When converting the group to a chunk, modules of that group will be removed from other groups. * * If two groups have the same priority, the group whose index is smaller will be chosen. * * For example, * * ```js * import { defineConfig } from 'rolldown'; * * export default defineConfig({ * advancedChunks: { * groups: [ * { * name: 'react', * test: /node_modules[\\/]react/, * priority: 1, * }, * { * name: 'other-libs', * test: /node_modules/, * priority: 2, * }, * ], * }); * ``` * * This is a clearly __incorrect__ example. Though `react` group is defined before `other-libs`, it has a lower priority, so the modules in `react` group will be captured in `other-libs` group. */ priority?: number; /** * - Type: `number` * - Default: `0` * * Minimum size in bytes of the desired chunk. If the accumulated size of the captured modules by this group is smaller than this value, it will be ignored. Modules in this group will fall back to the `automatic chunking` if they are not captured by any other group. */ minSize?: number; /** * - Type: `number` * - Default: `1` * * Controls if a module should be captured based on how many entry chunks reference it. */ minShareCount?: number; /** * - Type: `number` * - Default: `Infinity` * * If the accumulated size in bytes of the captured modules by this group is larger than this value, this group will be split into multiple groups that each has size close to this value. */ maxSize?: number; /** * - Type: `number` * - Default: `Infinity` * * Controls a module could only be captured if its size in bytes is smaller or equal than this value. */ maxModuleSize?: number; /** * - Type: `number` * - Default: `0` * * Controls a module could only be captured if its size in bytes is larger or equal than this value. */ minModuleSize?: number; }[]; }; /** * Control comments in the output. * * - `none`: no comments * - `inline`: preserve comments that contain `@license`, `@preserve` or starts with `//!` `/*!` */ legalComments?: "none" | "inline"; plugins?: RolldownOutputPluginOption; polyfillRequire?: boolean; hoistTransitiveImports?: false; preserveModules?: boolean; virtualDirname?: string; preserveModulesRoot?: string; topLevelVar?: boolean; /** * - Type: `boolean` * - Default: `false` * * Whether to minify internal exports. */ minifyInternalExports?: boolean; } //#endregion //#region src/api/build.d.ts interface BuildOptions extends InputOptions { /** * Write the output to the file system * * @default true */ write?: boolean; output?: OutputOptions; } declare function build(options: BuildOptions): Promise<RolldownOutput>; /** * Build multiple outputs __sequentially__. */ declare function build(options: BuildOptions[]): Promise<RolldownOutput[]>; //#endregion //#region src/api/rolldown/rolldown-build.d.ts declare class RolldownBuild { #private; constructor(inputOptions: InputOptions); get closed(): boolean; generate(outputOptions?: OutputOptions): Promise<RolldownOutput>; write(outputOptions?: OutputOptions): Promise<RolldownOutput>; close(): Promise<void>; [Symbol.asyncDispose](): Promise<void>; generateHmrPatch(changedFiles: string[]): Promise<BindingHmrUpdate[]>; hmrInvalidate(file: string, firstInvalidatedBy?: string): Promise<BindingHmrUpdate>; get watchFiles(): Promise<string[]>; } //#endregion //#region src/api/rolldown/index.d.ts declare const rolldown: (input: InputOptions) => Promise<RolldownBuild>; //#endregion //#region src/options/watch-options.d.ts interface WatchOptions extends InputOptions { output?: OutputOptions | OutputOptions[]; } //#endregion //#region src/api/watch/watch-emitter.d.ts type WatcherEvent = "close" | "event" | "restart" | "change"; type ChangeEvent$1 = "create" | "update" | "delete"; type RolldownWatchBuild = BindingBundlerImpl; type RolldownWatcherEvent = { code: "START"; } | { code: "BUNDLE_START"; } | { code: "BUNDLE_END"; duration: number; output: readonly string[]; result: RolldownWatchBuild; } | { code: "END"; } | { code: "ERROR"; error: Error; result: RolldownWatchBuild; }; declare class WatcherEmitter { listeners: Map<WatcherEvent, Array<(...parameters: any[]) => MaybePromise<void>>>; timer: any; constructor(); on(event: "change", listener: (id: string, change: { event: ChangeEvent$1; }) => MaybePromise<void>): this; on(event: "event", listener: (data: RolldownWatcherEvent) => MaybePromise<void>): this; on(event: "restart" | "close", listener: () => MaybePromise<void>): this; off(event: WatcherEvent, listener: (...parameters: any[]) => MaybePromise<void>): this; clear(event: WatcherEvent): void; onEvent(event: BindingWatcherEvent): Promise<void>; close(): Promise<void>; } type RolldownWatcher = WatcherEmitter; //#endregion //#region src/api/watch/index.d.ts declare const watch: (input: WatchOptions | WatchOptions[]) => RolldownWatcher; //#endregion //#region src/log/log-handler.d.ts type LoggingFunction = (log: RollupLog | string | (() => RollupLog | string)) => void; type LoggingFunctionWithPosition = (log: RollupLog | string | (() => RollupLog | string), pos?: number | { column: number; line: number; }) => void; type WarningHandlerWithDefault = (warning: RollupLog, defaultHandler: LoggingFunction) => void; //#endregion //#region src/options/normalized-input-options.d.ts interface NormalizedInputOptions { input: string[] | Record<string, string>; cwd: string | undefined; platform: InputOptions["platform"]; shimMissingExports: boolean; context: string; } //#endregion //#region src/options/normalized-output-options.d.ts type InternalModuleFormat = "es" | "cjs" | "iife" | "umd"; interface NormalizedOutputOptions { name: string | undefined; file: string | undefined; dir: string | undefined; entryFileNames: string | ChunkFileNamesFunction; chunkFileNames: string | ChunkFileNamesFunction; assetFileNames: string | AssetFileNamesFunction; format: InternalModuleFormat; exports: NonNullable<OutputOptions["exports"]>; sourcemap: boolean | "inline" | "hidden"; sourcemapBaseUrl: string | undefined; cssEntryFileNames: string | ChunkFileNamesFunction; cssChunkFileNames: string | ChunkFileNamesFunction; inlineDynamicImports: boolean; externalLiveBindings: boolean; banner: AddonFunction; footer: AddonFunction; intro: AddonFunction; outro: AddonFunction; esModule: boolean | "if-default-prop"; extend: boolean; globals: Record<string, string> | GlobalsFunction; hashCharacters: "base64" | "base36" | "hex"; sourcemapDebugIds: boolean; sourcemapIgnoreList: SourcemapIgnoreListOption; sourcemapPathTransform: SourcemapPathTransformOption | undefined; minify: false | BindingMinifyOptions; legalComments: "none" | "inline"; polyfillRequire: boolean; plugins: RolldownPlugin[]; preserveModules: boolean; virtualDirname: string; preserveModulesRoot?: string; topLevelVar?: boolean; minifyInternalExports?: boolean; } //#endregion //#region src/plugin/fs.d.ts interface RolldownFsModule { appendFile(path: string, data: string | Uint8Array, options?: { encoding?: BufferEncoding | null; mode?: string | number; flag?: string | number; }): Promise<void>; copyFile(source: string, destination: string, mode?: string | number): Promise<void>; mkdir(path: string, options?: { recursive?: boolean; mode?: string | number; }): Promise<void>; mkdtemp(prefix: string): Promise<string>; readdir(path: string, options?: { withFileTypes?: false; }): Promise<string[]>; readdir(path: string, options?: { withFileTypes: true; }): Promise<RolldownDirectoryEntry[]>; readFile(path: string, options?: { encoding?: null; flag?: string | number; signal?: AbortSignal; }): Promise<Uint8Array>; readFile(path: string, options?: { encoding: BufferEncoding; flag?: string | number; signal?: AbortSignal; }): Promise<string>; realpath(path: string): Promise<string>; rename(oldPath: string, newPath: string): Promise<void>; rmdir(path: string, options?: { recursive?: boolean; }): Promise<void>; stat(path: string): Promise<RolldownFileStats>; lstat(path: string): Promise<RolldownFileStats>; unlink(path: string): Promise<void>; writeFile(path: string, data: string | Uint8Array, options?: { encoding?: BufferEncoding | null; mode?: string | number; flag?: string | number; }): Promise<void>; } type BufferEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "base64" | "base64url" | "latin1" | "binary" | "hex"; interface RolldownDirectoryEntry { isFile(): boolean; isDirectory(): boolean; isSymbolicLink(): boolean; name: string; } interface RolldownFileStats { isFile(): boolean; isDirectory(): boolean; isSymbolicLink(): boolean; size: number; mtime: Date; ctime: Date; atime: Date; birthtime: Date; } //#endregion //#region src/plugin/hook-filter.d.ts type GeneralHookFilter<Value = StringOrRegExp> = MaybeArray<Value> | { include?: MaybeArray<Value>; exclude?: MaybeArray<Value>; }; interface FormalModuleTypeFilter { include?: ModuleType[]; } type ModuleTypeFilter = ModuleType[] | FormalModuleTypeFilter; interface HookFilter { /** * This filter is used to do a pre-test to determine whether the hook should be called. * * @example * Include all `id`s that contain `node_modules` in the path. * ```js * { id: '**'+'/node_modules/**' } * ``` * @example * Include all `id`s that contain `node_modules` or `src` in the path. * ```js * { id: ['**'+'/node_modules/**', '**'+'/src/**'] } * ``` * @example * Include all `id`s that start with `http` * ```js * { id: /^http/ } * ``` * @example * Exclude all `id`s that contain `node_modules` in the path. * ```js * { id: { exclude: '**'+'/node_modules/**' } } * ``` * @example * Formal pattern to define includes and excludes. * ``` * { id : { * include: ['**'+'/foo/**', /bar/], * exclude: ['**'+'/baz/**', /qux/] * }} * ``` */ id?: GeneralHookFilter; moduleType?: ModuleTypeFilter; code?: GeneralHookFilter; } type TUnionWithTopLevelFilterExpressionArray<T> = T | TopLevelFilterExpression[]; //#endregion //#region src/plugin/minimal-plugin-context.d.ts interface PluginContextMeta { rollupVersion: string; rolldownVersion: string; watchMode: boolean; } interface MinimalPluginContext { readonly pluginName: string; error: (e: RollupError | string) => never; info: LoggingFunction; warn: LoggingFunction; debug: LoggingFunction; meta: PluginContextMeta; } //#endregion //#region src/plugin/parallel-plugin.d.ts type ParallelPlugin = { /** @internal */ _parallel: { fileUrl: string; options: unknown; }; }; type DefineParallelPluginResult<Options> = (options: Options) => ParallelPlugin; declare function defineParallelPlugin<Options>(pluginPath: string): DefineParallelPluginResult<Options>; //#endregion //#region src/plugin/plugin-context.d.ts interface EmittedAsset { type: "asset"; name?: string; fileName?: string; originalFileName?: string; source: AssetSource; } interface EmittedChunk { type: "chunk"; name?: string; fileName?: string; preserveSignature?: "strict" | "allow-extension" | "exports-only" | false; id: string; importer?: string; } type EmittedFile = EmittedAsset | EmittedChunk; interface PluginContextResolveOptions { isEntry?: boolean; skipSelf?: boolean; custom?: CustomPluginOptions; } type GetModuleInfo = (moduleId: string) => ModuleInfo | null; interface PluginContext extends MinimalPluginContext { fs: RolldownFsModule; emitFile(file: EmittedFile): string; getFileName(referenceId: string): string; getModuleIds(): IterableIterator<string>; getModuleInfo: GetModuleInfo; addWatchFile(id: string): void; load(options: { id: string; resolveDependencies?: boolean; } & Partial<PartialNull<ModuleOptions>>): Promise<ModuleInfo>; parse(input: string, options?: ParserOptions | undefined | null): Program; resolve(source: string, importer?: string, options?: PluginContextResolveOptions): Promise<ResolvedId | null>; } //#endregion //#region src/plugin/transform-plugin-context.d.ts interface TransformPluginContext extends PluginContext { debug: LoggingFunctionWithPosition; info: LoggingFunctionWithPosition; warn: LoggingFunctionWithPosition; error(e: RollupError | string, pos?: number | { column: number; line: number; }): never; getCombinedSourcemap(): SourceMap; } //#endregion //#region src/types/module-side-effects.d.ts interface ModuleSideEffectsRule { test?: RegExp; external?: boolean; sideEffects: boolean; } type ModuleSideEffectsOption = boolean | readonly string[] | ModuleSideEffectsRule[] | ((id: string, external: boolean) => boolean | undefined) | "no-external"; type TreeshakingOptions = { moduleSideEffects?: ModuleSideEffectsOption; annotations?: boolean; manualPureFunctions?: readonly string[]; unknownGlobalSideEffects?: boolean; commonjs?: boolean; }; //#endregion //#region src/types/output-bundle.d.ts interface OutputBundle { [fileName: string]: OutputAsset | OutputChunk; } //#endregion //#region src/types/sourcemap.d.ts interface ExistingRawSourceMap { file?: string | null; mappings: string; names?: string[]; sources?: (string | null)[]; sourcesContent?: (string | null)[]; sourceRoot?: string; version?: number; x_google_ignoreList?: number[]; } type SourceMapInput = ExistingRawSourceMap | string | null; //#endregion //#region src/index.d.ts declare const VERSION: string; //#endregion //#region src/builtin-plugin/constructors.d.ts declare class BuiltinPlugin { name: BindingBuiltinPluginName; _options?: unknown; constructor(name: BindingBuiltinPluginName, _options?: unknown); } declare function modulePreloadPolyfillPlugin(config?: BindingModulePreloadPolyfillPluginConfig): BuiltinPlugin; type DynamicImportVarsPluginConfig = Omit<BindingDynamicImportVarsPluginConfig, "include" | "exclude"> & { include?: StringOrRegExp | StringOrRegExp[]; exclude?: StringOrRegExp | StringOrRegExp[]; }; declare function dynamicImportVarsPlugin(config?: DynamicImportVarsPluginConfig): BuiltinPlugin; declare function importGlobPlugin(config?: BindingImportGlobPluginConfig): BuiltinPlugin; declare function reporterPlugin(config?: BindingReporterPluginConfig): BuiltinPlugin; declare function manifestPlugin(config?: BindingManifestPluginConfig): BuiltinPlugin; declare function wasmHelperPlugin(config?: BindingWasmHelperPluginConfig): BuiltinPlugin; declare function wasmFallbackPlugin(): BuiltinPlugin; declare function loadFallbackPlugin(): BuiltinPlugin; declare function jsonPlugin(config?: BindingJsonPluginConfig): BuiltinPlugin; declare function buildImportAnalysisPlugin(config: BindingBuildImportAnalysisPluginConfig): BuiltinPlugin; declare function viteResolvePlugin(config: BindingViteResolvePluginConfig): BuiltinPlugin; declare function isolatedDeclarationPlugin(config?: BindingIsolatedDeclarationPluginConfig): BuiltinPlugin; declare function assetPlugin(config?: BindingAssetPluginConfig): BuiltinPlugin; declare function webWorkerPostPlugin(): BuiltinPlugin; //#endregion //#region src/constants/plugin.d.ts declare const ENUMERATED_INPUT_PLUGIN_HOOK_NAMES: readonly ["options", "buildStart", "resolveId", "load", "transform", "moduleParsed", "buildEnd", "onLog", "resolveDynamicImport", "closeBundle", "closeWatcher", "watchChange"]; declare const ENUMERATED_OUTPUT_PLUGIN_HOOK_NAMES: readonly ["augmentChunkHash", "outputOptions", "renderChunk", "renderStart", "renderError", "writeBundle", "generateBundle"]; declare const ENUMERATED_PLUGIN_HOOK_NAMES: [...typeof ENUMERATED_INPUT_PLUGIN_HOOK_NAMES, ...typeof ENUMERATED_OUTPUT_PLUGIN_HOOK_NAMES, "footer", "banner", "intro", "outro"]; /** * Names of all defined hooks. It's like * ```ts * type DefinedHookNames = { * options: 'options', * buildStart: 'buildStart', * ... * } * ``` */ type DefinedHookNames = { readonly [K in typeof ENUMERATED_PLUGIN_HOOK_NAMES[number]]: K }; /** * Names of all defined hooks. It's like * ```js * const DEFINED_HOOK_NAMES ={ * options: 'options', * buildStart: 'buildStart', * ... * } * ``` */ declare const DEFINED_HOOK_NAMES: DefinedHookNames; //#endregion //#region src/plugin/with-filter.d.ts type OverrideFilterObject = { transform?: HookFilterExtension<"transform">["filter"]; resolveId?: HookFilterExtension<"resolveId">["filter"]; load?: HookFilterExtension<"load">["filter"]; pluginNamePattern?: StringOrRegExp[]; }; declare function withFilter<A, T extends RolldownPluginOption<A>>(pluginOption: T, filterObject: OverrideFilterObject | OverrideFilterObject[]): T; //#endregion //#region src/plugin/index.d.ts type ModuleSideEffects = boolean | "no-treeshake" | null; type ModuleType = "js" | "jsx" | "ts" | "tsx" | "json" | "text" | "base64" | "dataurl" | "binary" | "empty" | (string & {}); type ImportKind = BindingHookResolveIdExtraArgs["kind"]; interface CustomPluginOptions { [plugin: string]: any; } interface ModuleOptions { moduleSideEffects: ModuleSideEffects; meta: CustomPluginOptions; invalidate?: boolean; } interface ResolvedId extends ModuleOptions { external: boolean | "absolute"; id: string; } interface PartialResolvedId extends Partial<PartialNull<ModuleOptions>> { external?: boolean | "absolute" | "relative"; id: string; } interface SourceDescription extends Partial<PartialNull<ModuleOptions>> { code: string; map?: SourceMapInput; moduleType?: ModuleType; } interface ResolveIdExtraOptions { custom?: CustomPluginOptions; isEntry: boolean; kind: BindingHookResolveIdExtraArgs["kind"]; } type ResolveIdResult = string | NullValue | false | PartialResolvedId; type LoadResult = NullValue | string | SourceDescription; type TransformResult = NullValue | string | Partial<SourceDescription>; type RenderedChunkMeta = { chunks: Record<string, RenderedChunk>; }; interface FunctionPluginHooks { [DEFINED_HOOK_NAMES.onLog]: (this: MinimalPluginContext, level: LogLevel, log: RollupLog) => NullValue | boolean; [DEFINED_HOOK_NAMES.options]: (this: MinimalPluginContext, options: InputOptions) => NullValue | InputOptions; [DEFINED_HOOK_NAMES.outputOptions]: (this: MinimalPluginContext, options: OutputOptions) => NullValue | OutputOptions; [DEFINED_HOOK_NAMES.buildStart]: (this: PluginContext, options: NormalizedInputOptions) => void; [DEFINED_HOOK_NAMES.resolveId]: (this: PluginContext, source: string, importer: string | undefined, extraOptions: ResolveIdExtraOptions) => ResolveIdResult; /** * @deprecated * This hook is only for rollup plugin compatibility. Please use `resolveId` instead. */ [DEFINED_HOOK_NAMES.resolveDynamicImport]: (this: PluginContext, source: string, importer: string | undefined) => ResolveIdResult; [DEFINED_HOOK_NAMES.load]: (this: PluginContext, id: string) => MaybePromise<LoadResult>; [DEFINED_HOOK_NAMES.transform]: (this: TransformPluginContext, code: string, id: string, meta: BindingTransformHookExtraArgs & { moduleType: ModuleType; }) => TransformResult; [DEFINED_HOOK_NAMES.moduleParsed]: (this: PluginContext, moduleInfo: ModuleInfo) => void; [DEFINED_HOOK_NAMES.buildEnd]: (this: PluginContext, err?: Error) => void; [DEFINED_HOOK_NAMES.renderStart]: (this: PluginContext, outputOptions: NormalizedOutputOptions, inputOptions: NormalizedInputOptions) => void; [DEFINED_HOOK_NAMES.renderChunk]: (this: PluginContext, code: string, chunk: RenderedChunk, outputOptions: NormalizedOutputOptions, meta: RenderedChunkMeta) => NullValue | string | { code: string; map?: SourceMapInput; }; [DEFINED_HOOK_NAMES.augmentChunkHash]: (this: PluginContext, chunk: RenderedChunk) => string | void; [DEFINED_HOOK_NAMES.renderError]: (this: PluginContext, error: Error) => void; [DEFINED_HOOK_NAMES.generateBundle]: (this: PluginContext, outputOptions: NormalizedOutputOptions, bundle: OutputBundle, isWrite: boolean) => void; [DEFINED_HOOK_NAMES.writeBundle]: (this: PluginContext, outputOptions: NormalizedOutputOptions, bundle: OutputBundle) => void; [DEFINED_HOOK_NAMES.closeBundle]: (this: PluginContext) => void; [DEFINED_HOOK_NAMES.watchChange]: (this: PluginContext, id: string, event: { event: ChangeEvent; }) => void; [DEFINED_HOOK_NAMES.closeWatcher]: (this: PluginContext) => void; } type ChangeEvent = "create" | "update" | "delete"; type PluginOrder = "pre" | "post" | null; type ObjectHookMeta = { order?: PluginOrder; }; type ObjectHook<T, O = {}> = T | ({ handler: T; } & ObjectHookMeta & O); type SyncPluginHooks = DefinedHookNames["augmentChunkHash" | "onLog" | "outputOptions"]; type AsyncPluginHooks = Exclude<keyof FunctionPluginHooks, SyncPluginHooks>; type FirstPluginHooks = DefinedHookNames["load" | "resolveDynamicImport" | "resolveId"]; type SequentialPluginHooks = DefinedHookNames["augmentChunkHash" | "generateBundle" | "onLog" | "options" | "outputOptions" | "renderChunk" | "transform"]; type AddonHooks = DefinedHookNames["banner" | "footer" | "intro" | "outro"]; type OutputPluginHooks = DefinedHookNames["augmentChunkHash" | "generateBundle" | "outputOptions" | "renderChunk" | "renderError" | "renderStart" | "writeBundle"]; type ParallelPluginHooks = Exclude<keyof FunctionPluginHooks | AddonHooks, FirstPluginHooks | SequentialPluginHooks>; type HookFilterExtension<K extends keyof FunctionPluginHooks> = K extends "transform" ? { filter?: TUnionWithTopLevelFilterExpressionArray<HookFilter>; } : K extends "load" ? { filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "id">>; } : K extends "resolveId" ? { filter?: TUnionWithTopLevelFilterExpressionArray<{ id?: GeneralHookFilter<RegExp>; }>; } : K extends "renderChunk" ? { filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "code">>; } : {}; type PluginHooks = { [K in keyof FunctionPluginHooks]: ObjectHook<K extends AsyncPluginHooks ? MakeAsync<FunctionPluginHooks[K]> : FunctionPluginHooks[K], HookFilterExtension<K> & (K extends ParallelPluginHooks ? { /** * @deprecated * this is only for rollup Plugin type compatibility. * hooks always work as `sequential: true`. */ sequential?: boolean; } : {})> }; type AddonHookFunction = (this: PluginContext, chunk: RenderedChunk) => string | Promise<string>; type AddonHook = string | AddonHookFunction; interface OutputPlugin extends Partial<{ [K in OutputPluginHooks]: PluginHooks[K] }>, Partial<{ [K in AddonHooks]: ObjectHook<AddonHook> }> { name: string; } interface Plugin<A = any> extends OutputPlugin, Partial<PluginHooks> { api?: A; } type RolldownPlugin<A = any> = Plugin<A> | BuiltinPlugin | ParallelPlugin; type RolldownPluginOption<A = any> = MaybePromise<NullValue<RolldownPlugin<A>> | { name: string; } | false | RolldownPluginOption[]>; type RolldownOutputPlugin = OutputPlugin | BuiltinPlugin; type RolldownOutputPluginOption = MaybePromise<NullValue<RolldownOutputPlugin> | { name: string; } | false | RolldownOutputPluginOption[]>; //#endregion //#region src/options/generated/checks-options.d.ts interface ChecksOptions { /** * Whether to emit warning when detecting circular dependency * @default false */ circularDependency?: boolean; /** * Whether to emit warning when detecting eval * @default true */ eval?: boolean; /** * Whether to emit warning when detecting missing global name * @default true */ missingGlobalName?: boolean; /** * Whether to emit warning when detecting missing name option for iife export * @default true */ missingNameOptionForIifeExport?: boolean; /** * Whether to emit warning when detecting mixed export * @default true */ mixedExport?: boolean; /** * Whether to emit warning when detecting unresolved entry * @default true */ unresolvedEntry?: boolean; /** * Whether to emit warning when detecting unresolved import * @default true */ unresolvedImport?: boolean; /** * Whether to emit warning when detecting filename conflict * @default true */ filenameConflict?: boolean; /** * Whether to emit warning when detecting common js variable in esm * @default true */ commonJsVariableInEsm?: boolean; /** * Whether to emit warning when detecting import is undefined * @default true */ importIsUndefined?: boolean; /** * Whether to emit warning when detecting empty import meta * @default true */ emptyImportMeta?: boolean; /** * Whether to emit warning when detecting configuration field conflict * @default true */ configurationFieldConflict?: boolean; } //#endregion //#region src/options/input-options.d.ts type InputOption = string | string[] | Record<string, string>; type OxcTransformOption = Omit<TransformOptions, "sourceType" | "lang" | "cwd" | "sourcemap" | "define" | "inject">; type ExternalOption = StringOrRegExp | StringOrRegExp[] | ((id: string, parentId: string | undefined, isResolved: boolean) => NullValue<boolean>); type ModuleTypes = Record<string, "js" | "jsx" | "ts" | "tsx" | "json" | "text" | "base64" | "dataurl" | "binary" | "empty" | "css" | "asset">; interface WatcherOptions { skipWrite?: boolean; buildDelay?: number; notify?: { pollInterval?: number; compareContents?: boolean; }; include?: StringOrRegExp | StringOrRegExp[]; exclude?: StringOrRegExp | StringOrRegExp[]; onInvalidate?: (id: string) => void; clearScreen?: boolean; } type MakeAbsoluteExternalsRelative = boolean | "ifRelativeSource"; type HmrOptions = boolean | { host?: string; port?: number; implement?: string; }; type OptimizationOptions = { inlineConst?: boolean; }; type AttachDebugOptions = "none" | "simple" | "full"; type ChunkModulesOrder = "exec-order" | "module-id"; interface RollupJsxOptions { mode?: "classic" | "automatic" | "preserve"; factory?: string; fragment?: string; importSource?: string; jsxImportSource?: string; } interface InputOptions { input?: InputOption; plugins?: RolldownPluginOption; external?: ExternalOption; resolve?: { /** * > [!WARNING] * > `resolve.alias` will not call `resolveId` hooks of other plugin. * > If you want to call `resolveId` hooks of other plugin, use `aliasPlugin` from `rolldown/experimental` instead. * > You could find more discussion in [this issue](https://github.com/rolldown/rolldown/issues/3615) */ alias?: Record<string, string[] | string>; aliasFields?: string[][]; conditionNames?: string[]; /** * Map of extensions to alternative extensions. * * With writing `import './foo.js'` in a file, you want to resolve it to `foo.ts` instead of `foo.js`. * You can achieve this by setting: `extensionAlias: { '.js': ['.ts', '.js'] }`. */ extensionAlias?: Record<string, string[]>; exportsFields?: string[][]; extensions?: string[]; mainFields?: string[]; mainFiles?: string[]; modules?: string[]; symlinks?: boolean; tsconfigFilename?: string; }; cwd?: string; /** * Expected platform where the code run. * * When the platform is set to neutral: * - When bundling is enabled the default output format is set to esm, which uses the export syntax introduced with ECMAScript 2015 (i.e. ES6). You can change the output format if this default is not appropriate. * - The main fields setting is empty by default. If you want to use npm-style packages, you will likely have to configure this to be something else such as main for the standard main field used by node. * - The conditions setting does not automatically include any platform-specific values. * * @default * - 'node' if the format is 'cjs' * - 'browser' for other formats */ platform?: "node" | "browser" | "neutral"; shimMissingExports?: boolean; treeshake?: boolean | TreeshakingOptions; logLevel?: LogLevelOption; onLog?: (level: LogLevel, log: RollupLog, defaultHandler: LogOrStringHandler) => void; onwarn?: (warning: RollupLog, defaultHandler: (warning: RollupLogWithString | (() => RollupLogWithString)) => void) => void; moduleTypes?: ModuleTypes; experimental?: { strictExecutionOrder?: boolean; disableLiveBindings?: boolean; viteMode?: boolean; resolveNewUrlToAsset?: boolean; hmr?: HmrOptions; /** * Control which order should use when rendering modules in chunk * * - Type: `'exec-order' | 'module-id' * - Default: `'exec-order'` * * - `exec-order`: Almost equivalent to the topological order of the module graph, but specially handling when module graph has cycle. * - `module-id`: This is more friendly for gzip compression, especially for some javascript static asset lib (e.g. icon library) * > [!NOTE] * > Try to sort the modules by their module id if possible(Since rolldown scope hoist all modules in the chunk, we only try to sort those modules by module id if we could ensure runtime behavior is correct after sorting). */ chunkModulesOrder?: ChunkModulesOrder; /** * Attach debug information to the output bundle. * * - Type: `'none' | 'simple' | 'full'` * - Default: `'simple'` * * - `none`: No debug information is attached. * - `simple`: Attach comments indicating which files the bundled code comes from. These comments could be removed by the minifier. * - `full`: Attach detailed debug information to the output bundle. These comments are using legal comment syntax, so they won't be removed by the minifier. * * > [!WARNING] * > You shouldn't use `full` in the production build. */ attachDebugInfo?: AttachDebugOptions; /** * Enables automatic generation of a chunk import map asset during build. * * This map only includes chunks with hashed filenames, where keys are derived from the facade module * name or primary chunk name. It produces stable and unique hash-based filenames, effectively preventing * cascading cache invalidation caused by content hashes and maximizing browser cache reuse. * * The output defaults to `importmap.json` unless overridden via `fileName`. A base URL prefix * (default `"/"`) can be applied to all paths. The resulting JSON is a valid import map and can be * directly injected into HTML via `<script type="importmap">`. * * Example configuration snippet: * * ```js * { * experimental: { * chunkImportMap: { * baseUrl: '/', * fileName: 'importmap.json' * } * }, * plugins: [ * { * name: 'inject-import-map', * generateBundle(_, bundle) { * const chunkImportMap = bundle['importmap.json']; * if (chunkImportMap?.type === 'asset') { * const htmlPath = path.resolve('index.html'); * let html = fs.readFileSync(htmlPath, 'utf-8'); * * html = html.replace( * /<script\s+type="importmap"[^>]*>[\s\S]*?<\/script>/i, * `<script type="importmap">${chunkImportMap.source}<\/script>` * ); * * fs.writeFileSync(htmlPath, html); * delete bundle['importmap.json']; * } * } * } * ] * } * ``` * * > [!NOTE] * > If you want to learn more, you can check out the example here: [examples/chunk-import-map](https://github.com/rolldown/rolldown/tree/main/examples/chunk-import-map) */ chunkImportMap?: boolean | { baseUrl?: string; fileName?: string; }; onDemandWrapping?: boolean; /** * Required to be used with `watch` mode. */ incrementalBuild?: boolean; transformHiresSourcemap?: boolean | "boundary"; }; /** * Replace global variables or [property accessors](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors) with the provided values. * * # Examples * * - Replace the global variable `IS_PROD` with `true` * * ```js rolldown.config.js * export default defineConfig({ define: { IS_PROD: 'true' // or JSON.stringify(true) } }) * ``` * * Result: * * ```js * // Input * if (IS_PROD) { * console.log('Production mode') * } * * // After bundling * if (true) { * console.log('Production mode') * } * ``` * * - Replace the property accessor `process.env.NODE_ENV` with `'production'` * * ```js rolldown.config.js * export default defineConfig({ define: { 'process.env.NODE_ENV': "'production'" } }) * ``` * * Result: * * ```js * // Input * if (process.env.NODE_ENV === 'production') { * console.log('Production mode') * } * * // After bundling * if ('production' === 'production') { * console.log('Production mode') * } * * ``` */ define?: Record<string, string>; /** * Inject import statements on demand. * * ## Supported patterns * ```js * { * // import { Promise } from 'es6-promise' * Promise: ['es6-promise', 'Promise'], * * // import { Promise as P } from 'es6-promise' * P: ['es6-promise', 'Promise'], * * // import $ from 'jquery' * $: 'jquery', * * // import * as fs from 'node:fs' * fs: ['node:fs', '*'], * * // Inject shims for property access pattern * 'Object.assign': path.resolve( 'src/helpers/object-assign.js' ), * } * ``` */ inject?: Record<string, string | [string, string]>; profilerNames?: boolean; /** * - `false` disables the JSX parser, resulting in a syntax error if JSX syntax is used. * - `"preserve"` disables the JSX transformer, preserving the original JSX syntax in the output. * - `"react"` enables the `classic` JSX transformer. * - `"react-jsx"` enables the `automatic` JSX transformer. * * @default runtime = "automatic" */ jsx?: false | "react" | "react-jsx" | "preserve" | RollupJsxOptions; /** * Configure how the code is transformed. This process happens after the `transform` hook. * * To transpile [legacy decorators](https://github.com/tc39/proposal-decorators/tree/4ac0f4cd31bd0f2e8170cb4c5136e51671e46c8d), you could use * * ```js * export default defineConfig({ * transform: { * decorator: { * legacy: true, * }, * }, * }) * ``` * * For latest decorators proposal, rolldown is able to bundle them but doesn't support transpiling them yet. */ transform?: OxcTransformOption; watch?: WatcherOptions | false; dropLabels?: string[]; keepNames?: boolean; checks?: ChecksOptions; makeAbsoluteExternalsRelative?: MakeAbsoluteExternalsRelative; debug?: { sessionId?: string; }; preserveEntrySignatures?: false | "strict" | "allow-extension" | "exports-only"; optimization?: OptimizationOptions; context?: string; } //#endregion //#region src/types/rolldown-options.d.ts interface RolldownOptions extends InputOptions { output?: OutputOptions | OutputOptions[]; } //#endregion //#region src/types/config-export.d.ts /** * Type for `default export` of `rolldown.config.js` file. */ type ConfigExport = RolldownOptions | RolldownOptions[]; //#endregion //#region src/utils/define-config.d.ts declare function defineConfig(config: RolldownOptions): RolldownOptions; declare function defineConfig(config: RolldownOptions[]): RolldownOptions[]; declare function defineConfig(config: ConfigExport): ConfigExport; //#endregion export { type AddonFunction, type AsyncPluginHooks, type BufferEncoding, type BuildOptions, BuiltinPlugin, type ChunkFileNamesFunction, type ChunkingContext, type ConfigExport, type CustomPluginOptions, type DefineParallelPluginResult, type EmittedAsset, type EmittedFile, type ExistingRawSourceMap, type ExternalOption, type FunctionPluginHooks, type GeneralHookFilter, type GetModuleInfo, type GlobalsFunction, type HookFilter, type HookFilterExtension, type ImportKind, type InputOption, type InputOptions, type InternalModuleFormat, type LoadResult, type LogLevel, type LogLevelOption, type LogOrStringHandler, type LoggingFunction, MaybePromise, type MinifyOptions, type MinimalPluginContext, type ModuleFormat, type ModuleInfo, type ModuleOptions, type ModuleType, type ModuleTypeFilter, type ModuleTypes, type NormalizedInputOptions, type NormalizedOutputOptions, type ObjectHook, type OptimizationOptions, type OutputAsset, type OutputBundle, type OutputChunk, type OutputOptions, type ParallelPluginHooks, type PartialNull, type PartialResolvedId, type Plugin, type PluginContext, type PluginContextMeta, type PreRenderedAsset, type RenderedChunk, type RenderedModule, type ResolveIdExtraOptions, type ResolveIdResult, type ResolvedId, type RolldownBuild, type RolldownDirectoryEntry, type RolldownFileStats, type RolldownFsModule, type RolldownOptions, type RolldownOutput, type RolldownPlugin, type RolldownPluginOption, type RolldownWatcher, type RolldownWatcherEvent, type RollupError, type RollupLog, type RollupLogWithString, type SourceDescription, type SourceMap, type SourceMapInput, type SourcemapIgnoreListOption, type TransformPluginContext, type TransformResult, type TreeshakingOptions, VERSION, type WarningHandlerWithDefault, type WatchOptions, type WatcherOptions, assetPlugin, build, buildImportAnalysisPlugin, defi