virtualPlugin() — vite Function Reference

Architecture documentation for the virtualPlugin() function in vite.config.ts from the vite codebase.

Function typescript ViteCore ConfigEngine

Entity Profile

ViteCore→ ConfigEngine→ virtualPlugin() — vite Function Reference

Dependency Diagram

graph TD
  d0cad17e_edb4_18bb_6fe0_8672dee39efc["virtualPlugin()"]
  c816e784_0e00_b166_e645_64c52c7c4d00["vite.config.ts"]
  d0cad17e_edb4_18bb_6fe0_8672dee39efc -->|defined in| c816e784_0e00_b166_e645_64c52c7c4d00
  style d0cad17e_edb4_18bb_6fe0_8672dee39efc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

playground/hmr-ssr/vite.config.ts lines 41–70

function virtualPlugin(): Plugin {
  let num = 0
  return {
    name: 'virtual-file',
    resolveId(id, importer) {
      if (id === 'virtual:file' || id === '\0virtual:file') {
        return '\0virtual:file'
      }
    },
    load(id) {
      if (id === '\0virtual:file') {
        return `\
import { virtual as _virtual } from "/importedVirtual.js";
export const virtual = _virtual + '${num}';`
      }
    },
    configureServer(server) {
      server.environments.ssr.hot.on('virtual:increment', async () => {
        const mod =
          await server.environments.ssr.moduleGraph.getModuleByUrl(
            '\0virtual:file',
          )
        if (mod) {
          num++
          server.environments.ssr.reloadModule(mod)
        }
      })
    },
  }
}