本节内容派生于以下链接指向的内容 ,并遵守 CC BY 4.0 许可证的规定。
以下内容如果没有特殊声明,可以认为都是基于原内容的修改和删减后的结果。
输出:该选项用于指示 Rspack 如何以及在哪里输出生成的文件内容。
Object
string
'[hash][ext][query]'
Asset module 输出的文件名称。这个值可以被 Rule.generator.filename 覆盖。
'asset'
且 asset 为满足 Rule.parser.dataUrlCondition
设定值'asset/resource'
string
'[name].js'
这个选项决定了输出的 JavaScript bundle 文件名称。这些 bundle 将会被写入 output.path
指定的目录下。
对于单个 Entry 来说,你可以使用一个静态名称,如:
而对于多个 Entry,或其他可以导致拆分出多个 bundle 的情况,你需要使用下面这种方式来动态生成 bundle 的文件名。
Rspack 会对用户输入的代码进行代码拆分优化,这些优化可能包括但不限于:code splitting、bundle splitting,或通过其他插件实现的代码拆分等。 这些代码拆分的行为会导致生成多个 bundle,因此 bundle 的文件名需要动态生成。
使用 Entry 名称:
使用内部生成的 chunk id:
使用根据文件内容生成的 hash:
当然你也可以组合使用:
更多可以参考 Template String。
string
output.filename
推断此选项决定了非初始(non-initial)JavaScript chunk 文件的名称。
false | 'array-push' | 'commonjs' | 'module'
chunk 产物的格式,默认值会根据 target
和 output.module
的配置而决定,一般来说,target 为 web 或 webworker 时会使用 'array-push'
格式;为 ESM 时会使用 'module'
格式;为 node.js 时会使用 'commonjs'
格式
false | 'jsonp' | 'import-scripts' | 'require' | 'async-node' | 'import'
加载 chunk 的方式,默认值会根据 target
和 chunkFormat
的配置而决定,一般来说,target 为 web 时会使用 'jsonp'
来加载 chunk;为 ESM 时会使用 'import'
来加载 chunk;为 webworker 时会使用 'import-scripts'
来加载 chunk;为 node.js 时会使用 'require'
来加载 chunk;为 async node.js 时会使用 'async-node'
(fs.readFile
+ vm.runInThisContext
)来加载 chunk
string
output.uniqueName
推断
webpackChunk${output.uniqueName}
此选项决定了 Rspack 用于加载 chunk 的全局变量。
string
| function (info)
当模板字符串或函数产生重复时使用的备用内容。
详见 output.devtoolModuleFilenameTemplate
.
string = 'webpack://[namespace]/[resource-path]?[loaders]'
| function (info) => string
此选项仅在 devtool
使用了需要模块名称的选项时使用。
自定义每个 source map 的 sources
数组中使用的名称。可以通过传递模板字符串或者函数来完成。例如,当使用 devtool: 'eval'
,默认值是:
模板字符串支持以下模式:
模板 | 描述 |
---|---|
[absolute-resource-path] | 绝对路径文件名 |
[all-loaders] | 自动和显式的 loader,并且参数取决于第一个 loader 名称 |
[hash] | 模块标识符的 hash |
[id] | 模块标识符 |
[loaders] | 显式的 loader,并且参数取决于第一个 loader 名称 |
[resource] | 用于解析文件的路径和用于第一个 loader 的任意查询参数 |
[resource-path] | 不带任何查询参数,用于解析文件的路径 |
[namespace] | 模块命名空间。在构建成为一个 library 之后,通常也是 library 名称,否则为空 |
当使用一个函数,同样的选项要通过 info
参数并使用驼峰式:
如果多个模块产生相同的名称,使用 output.devtoolFallbackModuleFilenameTemplate
来代替这些模块。
此选项确定 output.devtoolModuleFilenameTemplate
使用的模块名称空间。未指定时的默认值为:output.uniqueName
。在加载多个通过 Rspack 构建的 library 时,用于防止 source map 中源文件路径冲突。
例如,如果你有两个 library
,分别使用命名空间 library1
和 library2
,并且都有一个文件 ./src/index.js
(可能具有不同内容),它们会将这些文件暴露为 webpack://library1/./src/index.js
和 webpack://library2/./src/index.js
。
string[]
开启可用的 chunkLoading 类型的运行时模块打包。
string
output.filename
推断此选项决定了 CSS 文件的名称。
string
output.chunkFilename
推断此选项决定了非初始(non-initial)CSS chunk 文件的名称。
false | 'anonymous' | 'use-credentials'
false
通过 crossOriginLoading
配置项,你可以为动态加载的 chunks 设置 crossorigin 属性。
当 target
为 'web'
时,Rspack 会动态创建 <script>
和 <link>
标签来加载异步的 JavaScript 和 CSS 资源。如果这些资源的 URL 在其他域名下,且 crossOriginLoading
不为 false
,那么 Rspack 会为 <script>
和 <link>
标签添加 crossorigin
属性。
crossOriginLoading
有以下可选值:
false
: 不设置 crossorigin 属性。'anonymous'
:将 crossorigin
设置为 'anonymous'
,不包含用户凭据来跨域加载资源。'use-credentials'
:将 crossorigin
设置为 'use-credentials'
,包含用户凭据来跨域加载资源。比如将 output.publicPath
设置为 https://example.com/
,并将 output.crossOriginLoading
设置为 'anonymous'
:
当 Rspack 在加载异步的 JavaScript 资源时,会生成如下的 HTML:
string
path.resolve(process.cwd(), 'dist')
输出文件目录的绝对路径。
string
'web'
或 'webworker'
时为 'auto'
此选项决定了引用的资源的 URL 前缀,如: 图片、文件等等。
例如,给定一个配置文件:
对于某一个非初始(non-initial) chunk 文件,它的请求 URL 看起来像是这样: /assets/1.chunk.js
。
对于一个图片的引用,它的请求 URL 看起来像是这样:/assets/logo.png
。
同时,当你使用 CDN 对产物进行部署时则非常有用:
对于所有 asset 资源,它们的请求 URL 看起来像是这样:https://cdn.example.com/assets/logo.png
。
在运行时代码中,你可以通过 __webpack_public_path__
来动态设置 publicPath
,__webpack_public_path__
会覆盖 Rspack 配置中的 publicPath
,但只能对异步加载的资源生效。
首先创建一个 publicPath.js
:
然后在入口文件的第一行引入它即可:
boolean
false
按照 ES Module 规范处理 module 加载时的错误,会有性能损失。
可以用下方的模板字符串来替换对应文件名。不同的 context 对应了不同的可替换内容,如 output.assetModuleFilename
支持使用 file context 和 module context。
可在 compilation 层面替换的内容
模板 | 描述 |
---|---|
[fullhash] | compilation 的完整 hash |
可在 chunk 层面替换的内容:
模板 | 描述 |
---|---|
[id] | 当前 chunk id |
[name] | 当 chunk name 存在则使用名称,否则使用 chunk id |
[chunkhash] | chunk 的 hash 值,通过当前 chunk 中所有类型的元素计算所得 |
[contenthash] | chunk 的 hash 值,通过只包含该类型内容的元素计算所得。如:生成 JavaScript 类型的文件则只会使用当前 chunk 中所有 JavaScript 模块计算所得的 hash |
可在 module 层面替换的内容:
模板 | 描述 |
---|---|
[id] | 模块的 id |
[hash] | 模块的 hash |
[contenthash] | 模块内容的 hash |
可在 file 层面替换的内容:
模板 | 描述 |
---|---|
[query] | 文件 query,包含 ? |
[path] | 文件路径,不包含文件名 |
[name] | 文件名,不包含扩展名和文件路径 |
[ext] | 扩展名,包含 . (仅支持在 output.assetModuleFilename 里使用) |
最好使用 output.library.auxiliaryComment
。
string | object
在和 output.library
和 output.libraryTarget
一起使用时,此选项允许用户向导出容器(export wrapper)中插入注释。要为 libraryTarget
每种类型都插入相同的注释,将 auxiliaryComment
设置为一个字符串:
rspack.config.js
将会生成如下:
someLibName.js
对于 libraryTarget
每种类型的注释进行更细粒度地控制,请传入一个对象:
rspack.config.js
output.enabledLibraryTypes
string[]
入口点可用的 library 类型列表。
string
'self'
当输出为 library 时,尤其是当 libraryTarget
为 'umd'
时,此选项将决定使用哪个全局对象来挂载 library。为了使 UMD 构建在浏览器和 Node.js 上均可用,应将 output.globalObject
选项设置为 'this'
。对于类似 web 的目标,默认为 self
。
入口点的返回值将会使用 output.library.name
赋值给全局对象。依赖于 target
配置项,全局对象将会发生对应的改变,例如:self
, global
或者 globalThis
。
示例:
string
'import'
内部 import()
函数的名称. 可用于 polyfilling, 例如 通过 dynamic-import-polyfill
.
rspack.config.js
输出一个库,为你的入口做导出。
string | string[] | object
一起来看一个简单的示例。
rspack.config.js
假设你在 src/index.js
的入口中导出了如下函数:
此时,变量 MyLibrary
将与你的入口文件所导出的文件进行绑定,下面是如何使用 rspack 构建的库的实现:
在上面的例子中,我们为 entry
设置了一个入口文件,然而 rspack 可以接受 多个入口,例如一个 array
或者一个 object
。
如果你将 entry
设置为一个 array
,那么只有数组中的最后一个会被暴露。
如果你将 entry
设置为一个 object
,所以入口都可以通过 library
的 array
语法暴露:
假设 a.js
与 b.js
导出名为 hello
的函数,这就是如何使用这些库的方法:
查看 示例 获取更多内容。
指定库的名称。
类型:
配置将库暴露的方式。
类型: string
类型默认包括 'var'
、 'module'
、'system'
、 'assign'
、 'assign-properties'
、 'this'
、 'window'
、 'self'
、 'global'
、 'commonjs'
、 'commonjs2'
、 'commonjs-module'
、 'commonjs-static'
、 'amd'
、 'amd-require'
、 'umd'
、 'umd2'
,除此之外也可以通过插件添加。
对于接下来的示例,我们将会使用 _entry_return_
表示被入口点返回的值。
These options assign the return value of the entry point (e.g. whatever the entry point exported) to the name provided by output.library.name
at whatever scope the bundle was included at.
让你的库加载之后,入口起点的返回值 将会被赋值给一个变量:
这将生成一个隐含的全局变量,它有可能重新分配一个现有的值(请谨慎使用):
请注意,如果 MyLibrary
没有在你的库之前定义,那么它将会被设置在全局作用域。
与 type: 'assign'
相似但是更安全,因为如果 MyLibrary
已经存在的话,它将被重用:
这些配置项分配入口点的返回值(例如:无论入口点导出的什么内容)到一个名为 output.library.name
的对象中。
入口起点的返回值 将会被赋值给 this 对象下的 output.library.name
属性。this
的含义取决于你:
入口起点的返回值 将会被赋值给 window
对象下的 output.library.name
。
入口起点的返回值 将会被复制给全局对象下的 output.library.name
。取决于 target
值,全局对象可以分别改变,例如,self
、global
或者 globalThis
。
入口起点的返回值 将使用 output.library.name
赋值给 exports
对象。顾名思义,这是在 CommonJS 环境中使用。
注意,不设置 output.library.name
将导致入口起点返回的所有属性都被赋值给给定的对象;不检查现有的属性名。
这些配置项将生成一个带有完整 header 的 bundle,以确保与各种模块系统兼容。output.library.name
配置项在不同的 output.library.type
中有不同的含义。
入口起点的返回值 将会被赋值给 module.exports
。顾名思义,这是在 Node.js(CommonJS)环境中使用的:
如果我们指定 output.library.name
为 type: commmonjs2
,你的入口起点的返回值将会被赋值给 module.exports.[output.library.name]
。
在考虑 CommonJS 与 CommonJS2 之间的区别?虽然它们很相似,但是它们之间有一些细微的差别,这些差别在 rspack 的上下文中通常是不相关的。(要获取更多详细内容,请 阅读这个 issue。)
单个导出将被设置为 module.exports
中的属性。名称中的“static”是指输出是静态可分析的,因此具名导出可以通过 Node.js 导入到 ESM 中:
输入:
输出:
Consumption (CommonJS):
Consumption (ESM):
当源代码是用 ESM 编写的,并且输出应该兼容 CJS 和 ESM 时,这是很有用的。获取更多详情,请阅读该 issue 或者 这篇文档(尤其是 这个章节)。
这将在所有模块定义下暴露你的库, 允许它与 CommonJS、AMD 和作为全局变量工作。可以查看 UMD Repository 获取更多内容。
在这种情况下,你需要使用 library.name
属性命名你的模块:
最终的输出为:
请注意,根据对象赋值部分,省略 library.name
将导致入口起点返回的所有属性直接赋值给根对象。示例:
输出将会是:
你可以为 library.name
指定一个对象,每个目标的名称不同:
这将会把你的库暴露为一个 System.register
模块。
System 模块要求当 bundle 执行时,全局变量 System
出现在浏览器中。编译的 System.register
格式允许你在没有额外配置的情况下使用 System.import('/bundle.js')
,并将你的 bundle 加载到系统模块注册表中。
输出:
除了设置 output.library.type
为 system
,还要将 output.library.name
添加到配置中,输出的 bundle 将以库名作为 System.register
的参数:
输出 ES 模块。
然而该特性仍然是实验性的,并且没有完全支持,所以请确保事先启用 experiments.outputModule。
在 UMD 包装器中添加注释。
string | { amd?: string, commonjs?: string, commonjs2?: string, root?: string }
为每个 umd
类型插入相同的注释,将 auxiliaryComment
设置为 string。
这将产生以下结果:
对于细粒度控制,可以传递一个对象:
boolean
当使用 output.library.type: "umd"
时,将 output.library.umdNamedDefine
设置为 true
将会把 AMD 模块命名为 UMD 构建。否则使用匿名 define
。
AMD module 将会是这样:
我们可能会停止对此的支持,所以最好使用 output.library.export,其作用与 libraryExport
一致。
string
| string[]
通过配置 libraryTarget
决定暴露哪些模块。默认情况下为 undefined
,如果你将 libraryTarget
设置为空字符串,则与默认情况具有相同的行为。例如,如果设置为 ''
,将导出整个(命名空间)对象。下述 demo 演示了当设置 libraryTarget: 'var'
时的效果。
支持以下配置:
libraryExport: 'default'
——入口的默认导出将分配给 library target:
libraryExport: 'MyModule'
- 这个 确定的模块 将被分配给 library target:
libraryExport: ['MyModule', 'MySubModule']
- 数组将被解析为要分配给 library target 的 模块路径:
使用上述指定的 libraryExport
配置时,library 的结果可以这样使用:
output.libraryTarget
string
var
请使用 output.library.type
代理,因为我们可能在未来放弃对 output.libraryTarget
的支持。
最好使用 output.library.umdNamedDefine
。
boolean
当使用 libraryTarget: "umd"
时,设置 output.umdNamedDefine
为 true
将命名由 UMD 构建的 AMD 模块。否则将使用一个匿名的 define
。
string
output.library
名称或者上下文中的 package.json 的 包名称(package name), 如果两者都不存在,值为 ''。此选项决定了在全局环境下为防止多个 rspack 运行时 冲突所使用的唯一名称。
output.uniqueName
将用于生成唯一全局变量:
boolean
false
在生成产物前,删除输出目录下的所有文件。
boolean
false
以 ESM 模块的形式输出 JavaScript 文件。由于此功能还处于实验阶段,默认关闭,想要使用的话必须将 experiments.outputModule
设置为 true
false | 'fetch', 'async-node'
'fetch'
用于设置加载 WebAssembly 模块的方式。默认方式包括 'fetch'
(web/webworker)、'async-node'
(Node.js)
默认值会受不同 target
的影响:
'web'
、'webworker'
、'electron-renderer'
或 'node-webkit'
,默认值为 'fetch'
。'node'
、'async-node'
、'electron-main'
或 'electron-preload'
,则默认为 'async-node'
。开启可用的 wasmLoading 类型的运行时模块打包。
false | 'fetch', 'async-node'
boolean
true
是否创建按需加载的异步 chunk。
string
"[id].[fullhash].hot-update.js"
自定义热更新文件的文件名。只有 [fullhash]
和 [id]
可用作占位符。
string
"[runtime].[fullhash].hot-update.json"
自定义热更新清单文件的文件名。只有 [fullhash]
和 [runtime]
可用作占位符。
string
"webpackHotUpdate" + output.uniqueName
只在 chunkLoading 为 "jsonp"
或 "import-scripts"
时会被使用。该全局变量会用来请求并加载热更新文件。