#output

与构建产物相关的选项。

#output.assetPrefix output.assetPrefix

使用该选项设置静态资源的 URL 前缀，比如设置为 CDN 地址。

在 Rslib 中，该选项的默认值由 format 决定：

• 当 format 为 cjs 或 esm 时，默认值为 "auto"。
• 当 format 为 mf 或 umd 时，默认值为 "/"。

当 output.assetPrefix 设置为 "auto" 时，Rslib 会自动将 importMode 设置为 "preserve"，以保留 JavaScript 文件中引用静态资源的 import 或 require 语句。同时，CSS 文件中的静态资源会保留相对引用路径，详情可以查看 静态资源。

当 output.assetPrefix 设置为具体的路径时，JavaScript 文件中引用静态资源的 import 或 require 语句会被替换为包含该前缀的 URL。同时，CSS 文件中的静态资源会被直接替换为带有该前缀的路径。

#output.charset output.charset

指定输出文件的 字符编码，以确保它们在不同的环境中能够正确显示。

#output.cleanDistPath output.cleanDistPath

• 命令行： --clean / --no-clean

是否在构建开始前清理产物目录下的所有文件（产物目录默认为 dist）。

#output.copy output.copy

将指定的文件或目录拷贝到构建输出目录中，基于 rspack.CopyRspackPlugin 实现。

#output.cssModules output.cssModules

用于自定义 CSS Modules 配置。

#output.dataUriLimit output.dataUriLimit

设置图片、字体、媒体等静态资源被自动内联为 base64 的体积阈值。

在 format 为 cjs 或 esm 时，Rslib 默认会将 output.dataUriLimit 设置为 0，不内联任何静态资源，以便于应用侧的构建工具处理和优化。

#output.distPath output.distPath

• 命令行： --dist-path <dir>（例如 --dist-path output）

设置构建产物的输出目录，Rsbuild 会根据产物的类型输出到对应的子目录下。

Rslib 默认将 output.distPath 设置为：

const defaultDistPath = {
  root: 'dist',
  js: './',
  jsAsync: './',
  css: './',
  cssAsync: './',
  svg: 'static/svg',
  font: 'static/font',
  wasm: 'static/wasm',
  image: 'static/image',
  media: 'static/media',
  assets: 'static/assets',
};

wasm 路径适用于 lib.wasm.mode: 'compile' 输出的 WebAssembly。bundleless Preserve 模式会保留每个 .wasm 文件的源码相对路径。

#output.emitCss output.emitCss

是否将 CSS 输出到产物中。

#output.externals output.externals

• 命令行： --externals <pkg>（可重复，例如 --externals react --externals react-dom）

在构建时，防止将代码中某些 import 的依赖包打包到 bundle 中，而是在运行时再去从外部获取这些依赖。

在 bundle 模式下，Rslib 会默认将 package.json 中 dependencies、optionalDependencies 和 peerDependencies 字段下的三方依赖添加到 output.externals 中, 查看 lib.autoExternal 了解更多信息。

#output.filenameHash output.filenameHash

在生产模式构建后，是否在产物的文件名中添加 hash 值。

Rslib 默认将 output.filenameHash 设置为 false。

#output.filename output.filename

设置构建产物的名称。

Rslib 默认会根据 format 设置 output.filename.js 来修改 JavaScript 产物文件的扩展名，详情可查看 autoExtension。

#output.injectStyles output.injectStyles

是否将 CSS 样式插入到 DOM 中。

#output.inlineScripts output.inlineScripts

用来控制是否用 <script> 标签将产物中的 script 文件（.js 文件）inline 到 HTML 中。

#output.inlineStyles output.inlineStyles

用来控制是否用 <style> 标签将产物中的 style 文件（.css 文件）inline 到 HTML 中。

#output.legalComments output.legalComments

配置 legal comment 的处理方式。

#output.manifest output.manifest

是否生成 manifest 文件，该文件包含所有构建产物的信息、以及入口模块与构建产物间的映射关系。

#output.minify output.minify

• 命令行： --minify / --no-minify

用于设置是否开启代码压缩，以及配置压缩工具的选项。

在未指定 output.minify 时，Rslib 会使用一个合理的默认值。

• 当 format 为 esm 或 cjs 时，仅会执行死代码消除和未使用代码消除，默认值为：

export default defineConfig({
  output: {
    minify: {
      js: true,
      css: false,
      jsOptions: {
        minimizerOptions: {
          mangle: false,
          minify: false,
          compress: {
            defaults: false,
            directives: false,
            unused: true,
            dead_code: true,
            toplevel: true,
          },
          format: {
            comments: 'some',
            preserve_annotations: true,
          },
        },
      },
    },
  },
});

• 当 format 为 umd 时，默认值同上，仅会执行死代码消除和未使用代码消除，这通常用于生成开发环境的 UMD 产物。如果需要生成体积尽可能小的生产环境的 UMD 产物，可以将 output.minify 设置为 true：

export default defineConfig({
  output: {
    minify: true,
  },
});

• 当 format 为 mf 时，由于 MF 资源通过网络加载，这意味着它们不会被应用项目压缩。因此，需要在 Rslib 中对它们进行压缩。默认值为：

export default defineConfig({
  output: {
    minify: {
      js: true,
      css: false,
      jsOptions: {
        minimizerOptions: {
          mangle: false,
          // 启用压缩
          minify: true,
          compress: {
            defaults: false,
            directives: false,
            unused: true,
            dead_code: true,
            // 避免 remoteEntry 的全局变量被 tree-shaking
            toplevel: false,
          },
          format: {
            comments: 'some',
            preserve_annotations: true,
          },
        },
      },
    },
  },
});

#output.overrideBrowserslist output.overrideBrowserslist

指定项目兼容的目标浏览器范围。

Rslib 默认会根据 syntax 生成 output.overrideBrowserslist，查看 ESX_TO_BROWSERSLIST 获取映射值。

#output.polyfill output.polyfill

控制 polyfills 的注入方式。

#output.sourceMap output.sourceMap

用于设置是否生成 source map 文件，以及生成哪一种格式的 source map。

#output.target output.target

• 命令行： --target <target>（例如 --target web）

用于设置 Rsbuild 的构建产物类型。

Rslib 默认将 output.target 设置为 node。