Interface TransformPluginContext

fs

meta

getModuleInfo

addWatchFile

• addWatchFile(id: string): void

  Adds additional files to be monitored in watch mode so that changes to these files will trigger rebuilds.

  Parameters

  • id: string

  Returns void

emitFile

• emitFile(file: EmittedAsset | EmittedChunk | EmittedPrebuiltChunk): string

  Emits a new file that is included in the build output. You can emit chunks, prebuilt chunks or assets.

  Parameters

  • file: EmittedAsset | EmittedChunk | EmittedPrebuiltChunk

  Returns string

  A referenceId for the emitted file that can be used in various places to reference the emitted file.

getCombinedSourcemap

• getCombinedSourcemap(): SourceMap

  Get the combined source maps of all previous plugins.

  Returns SourceMap

getFileName

• getFileName(referenceId: string): string

  Get the file name of a chunk or asset that has been emitted via this.emitFile.

  Parameters

  • referenceId: string

  Returns string

  The file name of the emitted file. Relative to output.dir.

getModuleIds

• getModuleIds(): IterableIterator<string>

  Get all module ids in the current module graph.

  Returns IterableIterator<string>

  An iterator of module ids. It can be iterated via

  for (const moduleId of this.getModuleIds()) {
    // ...
  }
  Copy

  or converted into an array via Array.from(this.getModuleIds()).

load

• load(
      options: { id: string; resolveDependencies?: boolean } & Partial<
          PartialNull<ModuleOptions>,
      >,
  ): Promise<ModuleInfo>

  Loads and parses the module corresponding to the given id, attaching additional meta information to the module if provided. This will trigger the same load, transform and moduleParsed hooks as if the module was imported by another module.

  Parameters

  • options: { id: string; resolveDependencies?: boolean } & Partial<
        PartialNull<ModuleOptions>,
    >

  Returns Promise<ModuleInfo>

parse

• parse(input: string, options?: ParserOptions | null): Program

  Use Rolldown's internal parser to parse code to an ESTree-compatible AST.

  Parameters

  • input: string
  • Optionaloptions: ParserOptions | null

  Returns Program

resolve

• resolve(
      source: string,
      importer?: string,
      options?: PluginContextResolveOptions,
  ): Promise<ResolvedId | null>

  Resolve imports to module ids (i.e. file names) using the same plugins that Rolldown uses, and determine if an import should be external.

  When calling this function from a resolveId hook, you should always check if it makes sense for you to pass along the options.

  Parameters

  • source: string
  • Optionalimporter: string
  • Optionaloptions: PluginContextResolveOptions

  Returns Promise<ResolvedId | null>

  If Promise<null> is returned, the import could not be resolved by Rolldown or any plugin but was not explicitly marked as external by the user. If an absolute external id is returned that should remain absolute in the output either via the makeAbsoluteExternalsRelative option or by explicit plugin choice in the resolveId hook, external will be "absolute" instead of true.

debug

info

warn

error

• error(
      e: string | RolldownError,
      pos?: number | { column: number; line: number },
  ): never

  Same as PluginContext.error, but the id of the current module will also be added and a position param can be supplied.

  Parameters

  • e: string | RolldownError
  • Optionalpos: number | { column: number; line: number }

  Returns never