close
logologo
指南
配置
插件
API
社区
版本
更新日志
Rsbuild 0.x 文档
English
简体中文
指南
配置
插件
API
社区
更新日志
Rsbuild 0.x 文档
English
简体中文
logologo
Overview
root
mode
plugins
logLevel
environments

dev

dev.assetPrefix
dev.browserLogs
dev.cliShortcuts
dev.client
dev.hmr
dev.lazyCompilation
dev.liveReload
dev.progressBar
dev.setupMiddlewares
dev.watchFiles
dev.writeToDisk

resolve

resolve.aliasStrategy
resolve.alias
resolve.conditionNames
resolve.dedupe
resolve.extensions
resolve.mainFields

source

source.assetsInclude
source.decorators
source.define
source.entry
source.exclude
source.include
source.preEntry
source.transformImport
source.tsconfigPath

output

output.assetPrefix
output.charset
output.cleanDistPath
output.copy
output.cssModules
output.dataUriLimit
output.distPath
output.emitAssets
output.emitCss
output.externals
output.filenameHash
output.filename
output.injectStyles
output.inlineScripts
output.inlineStyles
output.legalComments
output.manifest
output.minify
output.module
output.overrideBrowserslist
output.polyfill
output.sourceMap
output.target

html

html.appIcon
html.crossorigin
html.favicon
html.inject
html.meta
html.mountId
html.outputStructure
html.scriptLoading
html.tags
html.templateParameters
html.template
html.title

server

server.base
server.compress
server.cors
server.headers
server.historyApiFallback
server.host
server.htmlFallback
server.https
server.middlewareMode
server.open
server.port
server.printUrls
server.proxy
server.publicDir
server.strictPort

security

security.nonce
security.sri

tools

tools.bundlerChain
tools.cssExtract
tools.cssLoader
tools.htmlPlugin
tools.lightningcssLoader
tools.postcss
tools.rspack
tools.styleLoader
tools.swc

performance

performance.buildCache
performance.bundleAnalyze
performance.chunkSplit
performance.dnsPrefetch
performance.preconnect
performance.prefetch
performance.preload
performance.printFileSize
performance.profile
performance.removeConsole
performance.removeMomentLocale

moduleFederation

moduleFederation.options
📝 在 GitHub 上编辑此页
上一页output.dataUriLimit
下一页output.emitAssets

#output.distPath

  • 类型:
type DistPathConfig = {
  root?: string;
  html?: string;
  favicon?: string;
  js?: string;
  jsAsync?: string;
  css?: string;
  cssAsync?: string;
  svg?: string;
  font?: string;
  wasm?: string;
  image?: string;
  media?: string;
  assets?: string;
};
  • 默认值:
const defaultDistPath = {
  root: 'dist',
  html: './',
  favicon: './',
  js: output.target === 'node' ? '' : 'static/js',
  jsAsync: output.target === 'node' ? '' : 'static/js/async',
  css: 'static/css',
  cssAsync: 'static/css/async',
  svg: 'static/svg',
  font: 'static/font',
  wasm: 'static/wasm',
  image: 'static/image',
  media: 'static/media',
  assets: 'static/assets';
};

设置构建产物的输出目录,Rsbuild 会根据产物的类型将其输出到相应的子目录中。

查看 构建产物目录 了解更多。

#文件类型

output.distPath 可以为不同类型的文件设置不同的输出目录。

下面是 output.distPath 中各个选项的说明:

  • root: 所有构建产物输出的根目录。
  • html:HTML 文件的输出目录。
  • favicon:favicon 文件的输出目录。
  • js:JavaScript 文件的输出目录。
  • jsAsync:异步 JavaScript 文件的输出目录,默认会输出到 distPath.js 的 async 子目录。
  • css:CSS 文件的输出目录。
  • cssAsync:异步 CSS 文件的输出目录,默认会输出到 distPath.css 的 async 子目录。
  • svg:SVG 图片的输出目录。
  • font:字体文件的输出目录。
  • wasm:WebAssembly 文件的输出目录。
  • image:非 SVG 图片的输出目录。
  • media:视频等媒体资源的输出目录。
  • assets:其他静态资源的输出目录。例如 扩展静态资源类型 中定义的资源。

#根目录

root 是构建产物的根目录,可以为相对路径或绝对路径。如果 root 的值为相对路径,则会基于当前项目的根目录拼接为绝对路径。

其他目录只能为相对路径,并且会相对于 root 进行输出。

#示例

以 JavaScript 文件为例,会输出到 distPath.root + distPath.js 目录,即为 dist/static/js。

如果需要将 JavaScript 文件输出到 build/resource/js 目录,可以这样设置:

rsbuild.config.ts
export default {
  output: {
    distPath: {
      root: 'build',
      js: 'resource/js',
    },
  },
};

以上配置会生成如下的目录结构:

build
├── resource
│   └── js
│       └── index.js
└── index.html