Rsbuild 0.x 文档

简体中文

source.define

类型： Record<string, unknown>
默认值： {}

构建时将代码中的变量替换成其它值或者表达式，可以用于在代码逻辑中区分开发模式与生产模式等场景。

传入的配置对象的键名是需要替换变量的名称，或者是用 . 连接的多个标识符，配置项的值则根据类型进行不同的处理：

字符串会被当作代码片段。
包括函数在内的其他类型会被转换成字符串。
嵌套对象的父子键名之间会用 . 连接作为需要替换的变量名。
以 typeof 开头的键名会用来替换 typeof 调用。

更多用法请参考使用 define 和 Rspack - DefinePlugin。

示例

export default {
  source: {
    define: {
      PRODUCTION: JSON.stringify(true),
      VERSION: JSON.stringify('5fa3b9'),
      BROWSER_SUPPORTS_HTML5: true,
      TWO: '1 + 1',
      'typeof window': JSON.stringify('object'),
      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
      'import.meta.test': JSON.stringify('foo'),
    },
  },
};

表达式会被替换为对应的代码段：

const foo = TWO;

// ⬇️ Turns into
const foo = 1 + 1;