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 上编辑此页
上一页dev.writeToDisk
下一页resolve.alias

#resolve.aliasStrategy

  • 类型: 'prefer-tsconfig' | 'prefer-alias'
  • 默认值: 'prefer-tsconfig'
  • 版本: >=1.1.7

设置路径别名解析的策略,用于控制 tsconfig.json 中的 paths 选项与 Rsbuild 的 resolve.alias 选项之间的优先级关系。

TIP

参考 路径别名 了解 tsconfig.json 的 paths 选项与 resolve.alias 选项的区别。

#prefer-tsconfig

resolve.aliasStrategy 默认为 'prefer-tsconfig',此时 tsconfig.json 中的 paths 选项和打包工具的 alias 选项都会生效,但 tsconfig paths 选项的优先级更高。

比如同时配置以下内容:

  • tsconfig paths:
tsconfig.json
{
  "compilerOptions": {
    "paths": {
      "@common/*": ["./src/common-1/*"]
    }
  }
}
  • resolve.alias:
export default {
  resolve: {
    alias: {
      '@common': './src/common-2',
      '@utils': './src/utils',
    },
  },
};

由于 tsconfig paths 的优先级更高,所以:

  • @common 会使用 tsconfig paths 定义的值,指向 ./src/common-1
  • @utils 会使用 resolve.alias 定义的值,指向 ./src/utils

#prefer-alias

当 resolve.aliasStrategy 的值为 prefer-alias 时,tsconfig.json 中的 paths 选项只用于提供 TypeScript 类型定义,而不会对打包结果产生任何影响。此时,构建工具只会读取 alias 选项作为路径别名。

export default {
  resolve: {
    aliasStrategy: 'prefer-alias',
  },
};

比如同时配置以下内容:

  • tsconfig paths:
tsconfig.json
{
  "compilerOptions": {
    "paths": {
      "@common/*": ["./src/common-1/*"],
      "@utils/*": ["./src/utils/*"]
    }
  }
}
  • resolve.alias:
export default {
  resolve: {
    alias: {
      '@common': './src/common-2',
    },
  },
};

由于 tsconfig paths 只用于提供类型,所以最终只有 @common 别名生效,并指向 ./src/common-2 目录。

大部分情况下你不需要使用 prefer-alias,但当你需要动态生成一些别名配置时,可以考虑使用它。比如,基于环境变量来生成 alias 选项:

export default {
  resolve: {
    alias: {
      '@common':
        process.env.NODE_ENV === 'production'
          ? './src/common-prod'
          : './src/common-dev',
    },
  },
};