Plugin Type — vite Architecture

Source Code

packages/vite/src/node/plugin.ts lines 101–371

export interface Plugin<A = any> extends RolldownPlugin<A> {
  /**
   * Perform custom handling of HMR updates.
   * The handler receives an options containing changed filename, timestamp, a
   * list of modules affected by the file change, and the dev server instance.
   *
   * - The hook can return a filtered list of modules to narrow down the update.
   *   e.g. for a Vue SFC, we can narrow down the part to update by comparing
   *   the descriptors.
   *
   * - The hook can also return an empty array and then perform custom updates
   *   by sending a custom hmr payload via environment.hot.send().
   *
   * - If the hook doesn't return a value, the hmr update will be performed as
   *   normal.
   */
  hotUpdate?: ObjectHook<
    (
      this: MinimalPluginContext & { environment: DevEnvironment },
      options: HotUpdateOptions,
    ) =>
      | Array<EnvironmentModuleNode>
      | void
      | Promise<Array<EnvironmentModuleNode> | void>
  >

  /**
   * extend hooks with ssr flag
   */
  resolveId?: ObjectHook<
    (
      this: PluginContext,
      source: string,
      importer: string | undefined,
      options: {
        kind?: ImportKind
        custom?: CustomPluginOptions
        ssr?: boolean | undefined
        /**
         * @internal
         */
        scan?: boolean | undefined
        isEntry: boolean
      },
    ) => Promise<ResolveIdResult> | ResolveIdResult,
    { filter?: { id?: StringFilter<RegExp> } }
  >
  load?: ObjectHook<
    (
      this: PluginContext,
      id: string,
      options?: {
        ssr?: boolean | undefined
      },
    ) => Promise<LoadResult> | LoadResult,
    { filter?: { id?: StringFilter } }
  >
  transform?: ObjectHook<
    (
      this: TransformPluginContext,
      code: string,
      id: string,
      options?: {
        moduleType: ModuleType
        ssr?: boolean | undefined
      },
    ) => Promise<TransformResult> | TransformResult,
    {
      filter?: {
        id?: StringFilter
        code?: StringFilter
        moduleType?: ModuleTypeFilter
      }
    }
  >
  /**
   * Opt-in this plugin into the shared plugins pipeline.
   * For backward-compatibility, plugins are re-recreated for each environment
   * during `vite build --app`
   * We have an opt-in per plugin, and a general `builder.sharedPlugins`
   * In a future major, we'll flip the default to be shared by default