RsdoctorRspackPlugin
class are exported by @rsdoctor/rspack-plugin
, and the option is RsdoctorRspackPluginOptions.
RsdoctorWebpackPlugin
class are exported by @rsdoctor/webpack-plugin
, and the option is RsdoctorWebpackPluginOptions.
Type: Object
This is the options for the RsdoctorWebpackPlugin and RsdoctorRspackPlugin. It contains these properties:
boolean
true
false
Whether to automatically open the Rsdoctor report page. If you do not need to view the analysis report provided by Rsdoctor in the browser, you can enable this configuration item.
true
['loader', 'plugins', 'bundle']
The features
attribute is used to analyze the function switches, and the specific functional items are as follows:
Therefore, the default configuration enables bundle analysis capabilities and Loader and Plugin build-time analysis. The Resolver analysis capability is not enabled, and Rspack does not currently support Resolver analysis capabilities.
If an "out of memory" error occurs, you can try the following:
features
is set as an Array
, it will open the features which you define in this array only.features
is set as an Object
, it will close the features which you set the value is false
.features
type:
features
type:
normal | brief | lite
true
normal
Choose the Rsdoctor build report mode to use, which includes the following options:
normal mode: Generates a .rsdoctor
folder in the build output directory, which contains various data files and displays code in the report page. The output directory can be configured via reportDir.
brief mode: Generates an HTML report file in the .rsdoctor
folder within the build output directory. All build analysis data will be consolidated into this HTML file, which can be viewed by opening it in a browser. Brief mode also has additional configuration options, detailed at: brief.
lite mode: Based on the normal mode, this mode does not display source code and product code, only showing the information of the bundled code.
true
The output directory for Rsdoctor reports. By default, it is the build output directory.
true
More configurations for Brief mode are as follows:
report-rsdoctor.html
.writeDataJson: true
.Type: { noModuleSource?: boolean; noAssetsAndModuleSource?: boolean }
Optional: true
Default: undefined
Description
Select the output analysis data:
default is all complete data;
noModuleSource: true is the output of data other than module code; Module code is the packaged module code of a file disassembled in the Bundle.
noAssetsAndModuleSource: true is the output of data other than module code and Assets product code.
Example
true
undefined
This option is used to configure whether Rsdoctor enables support for certain detailed feature analysis capabilities, such as whether to enable compatibility with BannerPlugin.
When enabling the analysis of BannerPlugin, Rsdoctor should not be used in production versions.
If supports.banner
is enabled, Rsdoctor will enable compatibility logic for BannerPlugin. For more details, please refer to: Supports BannerPlugin
In some large repositories, the execution time of parsing the bundle is too long. Since the Parse Bundle analysis utilizes AST parsing and processing, it can be time-consuming when there are a large number of output files. If this capability is not necessary, it can be selectively disabled using the supports.parseBundle configuration. An example is shown below:
Disabling the Parse Bundle capability will only affect the visibility of the Bundled Size and Bundled Code of the modules in the bundle:
Whether to enable the ability to generate tile graphs, which affects whether the Bundle Size page has a tile graph from webpack-bundle-analyzer
.
number
true
random(3000, 8999)
Configure the port for the Rsdoctor server.