esbuild基础

esbuild

https://esbuild.bootcss.com/

• ESbuild 是一款基于 Golang 开发的一款打包工具，相比传统的打包工具，主打性能优势，在构建速度上可以快 10~100 倍

安装

npm install esbuild

使用

main.js

console.log("title");

esbuild.js

require("esbuild").buildSync({
  entryPoints: ["main.js"],
  outfile: "out.js",
});

内容类型

• content-types
• 每个内容类型都有一个关联的加载器，它告诉 esbuild 如何解释文件内容。默认情况下，某些文件扩展名已经为它们配置了加载器，尽管可以覆盖默认值

main.js

let title = <h1>hello</h1>;
console.log("title");

esbuild.js

require("esbuild").buildSync({
  entryPoints: ["main.js"],
  bundle: true,
  loader: { ".js": "jsx" },
  outfile: "out.js",
});

plugin

• plugins
• plugins
• 一个 esbuild 插件是一个包含 name 和 setup 函数的对象
• 它们以数组的形式传递给构建 API 调用,setup函数在每次BUILD API调用时都会运行一次

命名空间

• 每个模块都有一个关联的命名空间。默认情况下，esbuild 在 file 命名空间中运行，该命名空间对应于文件系统上的文件
• 但是 esbuild 也可以处理在文件系统上没有对应位置的“虚拟”模块
• 插件可用于创建虚拟模块。虚拟模块通常使用命名空间而不是 file 将它们与文件系统模块区分开来,通常命名空间特定于创建它们的插件

过滤器

• 每个回调都必须提供一个正则表达式作为过滤器。当路径与其过滤器不匹配时，esbuild 使用它来跳过调用回调
• 命名空间也可用于过滤。回调必须提供过滤正则表达式，但也可以选择提供命名空间以进一步限制匹配的路径

Resolve 回调

• 使用添加的回调 onResolve 将在 esbuild 构建的每个模块中的每个导入路径上运行
• 回调可以自定义 esbuild 如何进行路径解析。例如，它可以拦截导入路径并将它们重定向到其他地方。它还可以将路径标记为外部
• 回调可以返回而不提供将路径解析的责任传递给下一个回调的路径。对于给定的导入路径，onResolve 所有插件的所有回调都将按照它们注册的顺序运行，直到有人负责路径解析。如果没有回调返回路径，esbuild 将运行其默认路径解析逻辑

Resolve 参数

• 当 esbuild 调用由 注册的回调时 onResolve，它将为这些参数提供有关导入路径的信息：
• path 这是来自底层模块源代码的逐字未解析路径
• namespace 这是包含要解析的此导入的模块的名称空间

onLoad 回调

• onLoad 将为每个未标记为外部的唯一路径/命名空间对运行添加的回调
• 它的工作是返回模块的内容并告诉 esbuild 如何解释它
• 回调可以在不提供模块内容的情况下返回。在这种情况下，加载模块的责任被传递给下一个注册的回调。对于给定的模块，onLoad 所有插件的所有回调都将按照它们注册的顺序运行，直到有人负责加载模块。如果没有回调返回模块的内容，esbuild 将运行其默认的模块加载逻辑

onLoad 选项

• filter 每个回调都必须提供一个过滤器，它是一个正则表达式。当路径与此过滤器不匹配时，将跳过注册的回调
• namespace 这是可选的。如果提供，回调仅在提供的命名空间中的模块内的路径上运行

load 结果

• contents 将此设置为字符串以指定模块的内容。如果设置了此项，则不会针对此已解析路径运行更多加载回调。如果未设置，esbuild 将继续运行在当前回调之后注册的加载回调。然后，如果内容仍未设置，如果解析的路径在 file 命名空间中，esbuild 将默认从文件系统加载内容
• loader 这告诉 esbuild 如何解释内容。例如，js 加载器将内容解释为 JavaScript，css 加载器将内容解释为 CSS。js 如果未指定，则加载程序默认为。有关所有内置加载程序的完整列表，请参阅内容类型页面。

entry.js

import { Path } from "env";
console.log(`Path is ${Path}`);

envPlugin

let envPlugin = {
  name: "env",
  setup(build) {
    //拦截名为env的导入路径，以便esbuild不会尝试将它们映射到文件系统位置
    //用env-ns名称空间标记它们，以便为该插件保留它们
    build.onResolve({ filter: /^env$/ }, (args) => ({
      path: args.path,
      namespace: "env-ns",
    }));
    //加载带有env-ns名称空间标记的路径，它们的行为就像指向包含环境变量的JSON文件一样
    build.onLoad({ filter: /.*/, namespace: "env-ns" }, () => ({
      contents: JSON.stringify(process.env),
      loader: "json",
    }));
  },
};

require("esbuild")
  .build({
    entryPoints: ["entry.js"],
    bundle: true,
    outfile: "out.js",
    plugins: [envPlugin],
  })
  .catch(() => process.exit(1));