esbuildBannerFooterCompatPlugin() — vite Function Reference

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

Function typescript PluginSystem LegacySupport calls 1 called by 1

Entity Profile

PluginSystem→ LegacySupport→ esbuildBannerFooterCompatPlugin() — vite Function Reference

Dependency Diagram

graph TD
  3168f37c_e1d2_c968_a409_e850ae573541["esbuildBannerFooterCompatPlugin()"]
  e9538fc4_20d7_ac58_698b_cf82f4e5db36["esbuildBannerFooterCompatPlugin.ts"]
  3168f37c_e1d2_c968_a409_e850ae573541 -->|defined in| e9538fc4_20d7_ac58_698b_cf82f4e5db36
  b1b40b5b_3e43_2197_dea0_d36389d312a1["resolvePlugins()"]
  b1b40b5b_3e43_2197_dea0_d36389d312a1 -->|calls| 3168f37c_e1d2_c968_a409_e850ae573541
  10b9dea8_362c_1af2_93be_afa4dd9aed9e["cleanUrl()"]
  3168f37c_e1d2_c968_a409_e850ae573541 -->|calls| 10b9dea8_362c_1af2_93be_afa4dd9aed9e
  style 3168f37c_e1d2_c968_a409_e850ae573541 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/plugins/esbuildBannerFooterCompatPlugin.ts lines 13–61

export function esbuildBannerFooterCompatPlugin(
  config: ResolvedConfig,
): Plugin | undefined {
  const options = config.esbuild
  if (!options) return

  const { include, exclude, banner, footer } = options
  if (!banner && !footer) return

  const filter = createFilter(include || /\.(m?ts|[jt]sx)$/, exclude || /\.js$/)

  return {
    name: 'vite:esbuild-banner-footer-compat',
    transform(code, id) {
      if (filter(id) || filter(cleanUrl(id))) {
        const needsSourcemap =
          this.environment.mode === 'dev' ||
          (this.environment.mode === 'build' &&
            this.environment.config.build.sourcemap)
        if (!needsSourcemap) {
          if (banner) {
            code = `${banner}\n${code}`
          }
          if (footer) {
            code = `${code}\n${footer}`
          }
          return code
        }

        let s: MagicString | undefined
        const str = () => s || (s = new MagicString(code))

        if (banner) {
          str().prepend(`${banner}\n`)
        }
        if (footer) {
          str().append(`${footer}\n`)
        }

        if (s) {
          return {
            code: s.toString(),
            map: s.generateMap({ hires: 'boundary' }),
          }
        }
      }
    },
  }
}