close
指南
配置
插件
API
社区
版本
指南
配置
插件
API
社区
简体中文

tools.bundlerChain

  • 类型：
type BundlerChainFn = (
  chain: RspackChain,
  utils: ModifyBundlerChainUtils,
) => Promise<void> | void;
  • 默认值： undefined

rspack-chain 是一个用于配置 Rspack 的工具库。它提供了链式 API，使得配置 Rspack 变得更加灵活。通过使用 rspack-chain，你可以更方便地修改和扩展 Rspack 配置，而不需要直接操作复杂的配置对象。

你可以通过 tools.bundlerChain 来调用 rspack-chain 以修改默认的 Rspack 配置，它的值是一个函数，接收两个参数：

  • 第一个参数为 rspack-chain 实例，你可以通过它来修改 Rspack 配置。
  • 第二个参数为一个工具对象，包括 env、isProd、CHAIN_ID 等。

tools.bundlerChain 会早于 tools.rspack 被执行，因此会被 tools.rspack 覆盖。

TIP

Rsbuild 内置的 Rspack 配置会随着迭代而发生变化，这些变化不会反映在 semver 中，因此在升级 Rsbuild 时，你的自定义配置可能会失效。

示例

参考：RspackChain 示例。

工具对象

env

  • 类型： 'development' | 'production' | 'test'

通过 env 参数可以判断当前环境为 development、production 还是 test，比如：

export default {
  tools: {
    bundlerChain: (chain, { env }) => {
      if (env === 'development') {
        chain.devtool('cheap-module-eval-source-map');
      }
    },
  },
};

isDev

  • 类型： boolean

用于判断当前是否为开发模式构建，比如：

export default {
  tools: {
    bundlerChain: (config, { isDev }) => {
      if (isDev) {
        config.devtool = 'eval-cheap-source-map';
      }
      return config;
    },
  },
};

isProd

  • 类型： boolean

用于判断当前是否为生产模式构建，比如：

export default {
  tools: {
    bundlerChain: (chain, { isProd }) => {
      if (isProd) {
        chain.devtool('source-map');
      }
    },
  },
};

target

  • 类型： 'web' | 'node' | 'web-worker'

通过 target 参数可以判断构建的目标运行时环境。比如：

export default {
  tools: {
    bundlerChain: (chain, { target }) => {
      if (target === 'node') {
        // ...
      }
    },
  },
};

isServer

  • 类型： boolean

判断当前构建的目标运行时环境是否为 node，等价于 target === 'node'。

export default {
  tools: {
    bundlerChain: (chain, { isServer }) => {
      if (isServer) {
        // ...
      }
    },
  },
};

isWebWorker

  • 类型： boolean

判断当前构建的目标运行时环境是否为 web-worker，等价于 target === 'web-worker'。

export default {
  tools: {
    bundlerChain: (chain, { isWebWorker }) => {
      if (isWebWorker) {
        // ...
      }
    },
  },
};

rspack

  • 类型： Rspack

通过这个参数你可以拿到 Rspack 实例。比如：

export default {
  tools: {
    bundlerChain: (chain, { rspack }) => {
      chain.plugin('extra-define').use(rspack.DefinePlugin, [
        {
          'process.env': {
            NODE_ENV: JSON.stringify(process.env.NODE_ENV),
          },
        },
      ]);
    },
  },
};

HtmlPlugin

  • 类型： typeof import('html-rspack-plugin')

对应 html-rspack-plugin 插件的默认导出。

export default {
  tools: {
    bundlerChain: (chain, { HtmlPlugin }) => {
      console.log(HtmlPlugin);
    },
  },
};

CHAIN_ID

Rsbuild 中预先定义了一些常用的 Chain ID，你可以通过这些 ID 来定位到内置的 Rule 或 Plugin。

TIP

请留意，下列的一部分 Rule 或 Plugin 并不是默认存在的，当你开启特定配置项、或是注册某些插件后，它们才会被包含在 Rspack 或 webpack 配置中。

比如，RULE.STYLUS 仅在注册了 Stylus 插件后才会存在。

CHAIN_ID.RULE

ID描述
RULE.JS处理 js 和 ts 的规则
RULE.SVG处理 svg 的规则
RULE.CSS处理 css 的规则
RULE.LESS处理 less 的规则
RULE.SASS处理 sass 的规则
RULE.WASM处理 wasm 的规则
RULE.FONT处理 font 的规则
RULE.IMAGE处理 image 的规则
RULE.MEDIA处理 media 的规则
RULE.VUE处理 vue 的规则（依赖 Vue 插件）
RULE.SVELTE处理 svelte 的规则（依赖 Svelte 插件）
RULE.STYLUS处理 stylus 的规则（依赖 Stylus 插件）

CHAIN_ID.ONE_OF

通过 ONE_OF.[ID] 可以匹配到规则数组中的某一类规则。

ID描述
ONE_OF.SVG_URL处理 SVG 的规则，输出为单独文件
ONE_OF.SVG_INLINE处理 SVG 的规则，作为 data URI 内联到 bundle 中
ONE_OF.SVG_ASSETS处理 SVG 的规则，在 data URI 和单独文件之间自动选择

CHAIN_ID.USE

通过 USE.[ID] 可以匹配到对应的 loader。

ID描述
USE.SWC对应 builtin:swc-loader
USE.POSTCSS对应 postcss-loader
USE.STYLE对应 style-loader
USE.LESS对应 less-loader（依赖 Less 插件）
USE.SASS对应 sass-loader（依赖 Sass 插件）
USE.RESOLVE_URL对应 resolve-url-loader（依赖 Sass 插件）
USE.VUE对应 vue-loader（依赖 Vue 插件）
USE.SVGR对应 svgr-loader（依赖 Svgr 插件）
USE.BABEL对应 babel-loader（依赖 Babel 插件）
USE.SVELTE对应 svelte-loader（依赖 Svelte 插件）
USE.STYLUS对应 stylus-loader（依赖 Stylus 插件）

CHAIN_ID.PLUGIN

通过 PLUGIN.[ID] 可以匹配到特定的 Rspack 或 webpack plugin。

ID描述
PLUGIN.HTML对应 HtmlRspackPlugin，使用时需要拼接 entry 名称：${PLUGIN.HTML}-${entryName}
PLUGIN.SUBRESOURCE_INTEGRITY对应 SubresourceIntegrityPlugin
PLUGIN.BUNDLE_ANALYZER对应 BundleAnalyzerPlugin

CHAIN_ID.MINIMIZER

通过 MINIMIZER.[ID] 可以匹配到对应的压缩工具。

ID描述
MINIMIZER.JS对应 SwcJsMinimizerRspackPlugin
MINIMIZER.CSS对应 LightningCssMinimizerRspackPlugin
目录