使用 esbuild 混合插件为多个文件打包 IIFE 和单个 ESM 包-js教程-PHP中文网

使用 esbuild 混合插件为多个文件打包 IIFE 和单个 ESM 包

霞舞

发布： 2025-10-29 13:39:27

原创

581人浏览过

使用 esbuild 混合插件为多个文件打包 iife 和单个 esm 包

本文介绍如何使用 esbuild 插件和 `define` 特性，为 JavaScript 项目同时生成 IIFE (Immediately Invoked Function Expression) 和 ESM (ECMAScript Module) 两种格式的包。通过自定义插件移除 IIFE 构建中的 imports，并利用 `define` 标志在代码中区分不同构建环境，最终实现代码的按需引入和精简输出，从而优化构建产物的大小和性能。

背景

在开发 JavaScript 库或框架时，通常需要支持多种模块化格式，以满足不同用户的需求。例如，一些用户可能仍然喜欢使用传统的 <script> 标签引入 IIFE 格式的包，而另一些用户则更倾向于使用 ESM 格式的包，以便利用现代 JavaScript 的特性，如 tree shaking。

本文将以 SlickGrid 项目为例，介绍如何使用 esbuild 插件和 define 特性，同时生成 IIFE 和 ESM 两种格式的包，并确保每种格式的包都只包含必要的代码，从而优化构建产物的大小和性能。

解决方案

该解决方案的核心在于使用 esbuild 插件来处理 IIFE 构建中的 imports，并使用 define 特性在代码中区分不同的构建环境。

立即进入“豆包AI人工智官网入口”；

立即学习“豆包AI人工智能在线问答入口”；

1. 自定义 esbuild 插件移除 Imports

首先，我们需要创建一个 esbuild 插件，用于在 IIFE 构建中移除所有的 import 语句。这是因为 IIFE 格式的包通常依赖于全局变量，而不是模块导入。

import { build } from 'esbuild';

const removeImportsPlugin= {
    name: 'remove-imports-plugin',
    setup(build) {
      build.onResolve({ filter: /.*/ }, (args) => {
        if (args.kind !== 'entry-point') {
          return { path: args.path + '.js', namespace: 'import-ns' }
        }
      });
      build.onLoad({ filter: /.*/, namespace: 'import-ns' }, () => ({
        contents: `// empty string, do nothing`,
        loader: 'js',
      }));
    }
};

登录后复制

这个插件使用了 onResolve 和 onLoad 钩子。onResolve 钩子拦截所有非入口文件的导入请求，并将其重定向到 import-ns 命名空间。onLoad 钩子则拦截 import-ns 命名空间下的所有文件加载请求，并返回一个空字符串，从而有效地移除了所有的 import 语句。

2. 使用 define 特性区分构建环境

接下来，我们需要使用 esbuild 的 define 特性，在代码中定义一个全局变量，用于区分 IIFE 和 ESM 构建环境。

豆包爱学

豆包旗下AI学习应用

674

查看详情

/** build as iife, every file will be bundled separately */
export async function buildIifeFile(file) {
  build({
    entryPoints: [file],
    format: 'iife',
    // add Slick to global only when filename `slick.core.js` is detected
    globalName: /slick.core.js/.test(file) ? 'Slick' : undefined,
    define: { IIFE_ONLY: 'true' },
    outfile: `dist/browser/${file.replace(/.[j|t]s/, '')}.js`,
    plugins: [removeImportsPlugin],
  });
}

// bundle in ESM format into single file index.js
export function buildEsm() {
  build({
    entryPoints: ['index.js'],
    format: 'esm',
    target: 'es2020',
    treeShaking: true,
    define: { IIFE_ONLY: 'false' },
    outdir: `dist/esm`,
  });
}

登录后复制

在 IIFE 构建中，我们将 IIFE_ONLY 定义为 'true'，而在 ESM 构建中，我们将 IIFE_ONLY 定义为 'false'。

3. 在代码中使用 IIFE_ONLY 变量

现在，我们可以在代码中使用 IIFE_ONLY 变量来区分不同的构建环境。例如：

// imports will be auto-dropped in iife by custom plugin
import { SlickEvent as SlickEvent_, Utils as Utils_ } from '../slick.core';

// for (iife) load `Slick` methods from global window object, or use imports for (cjs/esm)
const SlickEvent = IIFE_ONLY ? Slick.Event : SlickEvent_;
const Utils = IIFE_ONLY ? Slick.Utils : Utils_;

// ...

// then use it normally in the code...
const options = Utils.extend(true, {}, defaults, options);

登录后复制

在 IIFE 构建中，IIFE_ONLY 为 'true'，因此 SlickEvent 和 Utils 将从全局 Slick 对象中获取。而在 ESM 构建中，IIFE_ONLY 为 'false'，因此 SlickEvent 和 Utils 将从 import 语句中获取。

示例

以下是一个完整的示例，展示如何使用 esbuild 插件和 define 特性同时生成 IIFE 和 ESM 格式的包：

// esbuild.config.js
import { build } from 'esbuild';

const removeImportsPlugin= {
    name: 'remove-imports-plugin',
    setup(build) {
      build.onResolve({ filter: /.*/ }, (args) => {
        if (args.kind !== 'entry-point') {
          return { path: args.path + '.js', namespace: 'import-ns' }
        }
      });
      build.onLoad({ filter: /.*/, namespace: 'import-ns' }, () => ({
        contents: `// empty string, do nothing`,
        loader: 'js',
      }));
    }
};

/** build as iife, every file will be bundled separately */
export async function buildIifeFile(file) {
  build({
    entryPoints: [file],
    format: 'iife',
    // add Slick to global only when filename `slick.core.js` is detected
    globalName: /slick.core.js/.test(file) ? 'Slick' : undefined,
    define: { IIFE_ONLY: 'true' },
    outfile: `dist/browser/${file.replace(/.[j|t]s/, '')}.js`,
    plugins: [removeImportsPlugin],
  });
}

// bundle in ESM format into single file index.js
export function buildEsm() {
  build({
    entryPoints: ['index.js'],
    format: 'esm',
    target: 'es2020',
    treeShaking: true,
    define: { IIFE_ONLY: 'false' },
    outdir: `dist/esm`,
  });
}

// index.js
// imports will be auto-dropped in iife by custom plugin
import { SlickEvent as SlickEvent_, Utils as Utils_ } from '../slick.core';

// for (iife) load `Slick` methods from global window object, or use imports for (cjs/esm)
const SlickEvent = IIFE_ONLY ? Slick.Event : SlickEvent_;
const Utils = IIFE_ONLY ? Slick.Utils : Utils_;

// ...

// then use it normally in the code...
const options = Utils.extend(true, {}, defaults, options);

登录后复制