@rsdoctor/docs 0.2.5 → 0.3.1-beta.0

package/docs/en/config/options/options.mdx

@@ -118,19 +118,13 @@ Therefore, **the default configuration enables bundle analysis capabilities and
 - if the `features` is set as an `Array`, it will **open** the features which you define in this array **only**.
 - if the `features` is set as an `Object`, it will **close** the features which you set the value is `false`.
 
-### reportCodeType 参数
+### reportCodeType
 
 - Type: `{ noModuleSource?: boolean; noAssetsAndModuleSource?: boolean }`
 - Optional: true
 - Default: undefined
 - Description
 
-  - 选择输出的分析数据：
-
-    - undefined 是所有完整数据；
-    - noModuleSource: true 是输出除了 module 代码之外的数据；Module 代码即 Bundle 内拆解出来的一个一个文件的打包模块代码。
-    - noAssetsAndModuleSource: true 是输出除了 module 代码和 Assets 产物代码之外的数据。
-
   - Select the output analysis data:
 
     - undefined is all complete data;
@@ -143,7 +137,7 @@ Therefore, **the default configuration enables bundle analysis capabilities and
 
 ```js
 new WebDoctorWebpackPlugin({
-        disableClientServer: false, // 建议 CI 环境下关闭 server 能力，否则会卡住 pipeline 流程，检测 CI 环境可以使用 `process.env.CI_ACTOR`.
+        disableClientServer: false, // It is recommended to disable the server capability in the CI environment, otherwise it will block the pipeline process. You can check the CI environment using `process.env.CI_ACTOR`.
         features: ['loader', 'bundle', 'plugins'],
         reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
       }),
@@ -156,16 +150,38 @@ new WebDoctorWebpackPlugin({
 - Default: false
 - Description
 
-  开启或关闭需要 tos 上传， true 是关闭 tos 上传，false 是开启 tos 上传。
-
   Turn tos upload on or off. True is to turn off tos upload, and false is tos upload on.
 
 - Example
 
 ```js
 new WebDoctorWebpackPlugin({
-        disableClientServer: false, // 建议 CI 环境下关闭 server 能力，否则会卡住 pipeline 流程，检测 CI 环境可以使用 `process.env.CI_ACTOR`.
+        disableClientServer: false,  // It is recommended to disable the server capability in the CI environment, otherwise it will block the pipeline process. You can check the CI environment using `process.env.CI_ACTOR`.
         features: ['loader', 'bundle', 'plugins'],
         disableTOSUpload: true,
       }),
 ```
+
+### supports
+
+- **Type:** [Supports Types](#supports-types)
+- **Optional:** `true`
+- **Default:** `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.
+
+#### Supports Types
+
+```ts
+type ISupport = {
+  banner: boolean;
+};
+```
+
+#### banner
+
+:::danger
+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](../../guide/usage/bundle-size#supports-bannerplugin)

package/docs/en/guide/usage/bundle-size.mdx

@@ -120,3 +120,29 @@ Click the **"Bundle Analyzer Graph"** button on the **"Bundle Size"** page to vi
   width="500px"
   style={{ margin: 'auto' }}
 />
+
+## Supports BannerPlugin
+
+:::danger
+When enabling the BannerPlugin analysis, do not use Rsdoctor in the production version.
+:::
+
+Both Rspack and Webpack support the [BannerPlugin](https://www.rspack.dev/plugins/webpack/banner-plugin#bannerplugin), which is a built-in plugin that allows you to add specific content at the top or bottom of the generated chunks.
+The added code segment will affect the analysis capability of the bundle.
+
+Rsdoctor is compatible with the logic of adding code using the BannerPlugin, but it is not enabled by default because Rsdoctor needs to add tag code. The Rsdoctor BannerPlugin capability is enabled in the following two cases:
+
+1. The project uses the BannerPlugin in `rspack.config.j|ts` or `webpack.config.j|ts`.
+
+2. Enable Rsdoctor BannerPlugin capability through Rsdoctor options by setting `supports.banner`:
+
+```ts
+new RsdoctorRspackPlugin (
+  supports: {
+    banner: true
+  }
+)
+
+```
+
+- Note: Enabling `drop_console` will affect Rsdoctor's analysis of the BannerPlugin. Therefore, you can disable `drop_console` when `RSDOCTOR = true`.

package/docs/zh/config/options/options.mdx

@@ -136,3 +136,27 @@ import Features from '@zh/shared/features.md';
 import FeaturesRspack from '@zh/shared/features-rspack.md';
 
 <FeaturesRspack />
+
+### supports
+
+- **Type:** [Supports Types](#supports-types)
+- **Optional:** `true`
+- **Default:** `undefined`
+
+该选项是配置 Rsdoctor 是否开启某些细节特性分析能力支持的，例如：是否开启对 BannerPlugin 的兼容能力。
+
+#### Supports Types
+
+```ts
+type ISupport = {
+  banner: boolean;
+};
+```
+
+#### banner
+
+:::danger
+开启 BannerPlugin 分析时，请勿在生产版本中使用 Rsdoctor。
+:::
+
+如果开启 `supports.banner` 则会开启 Rsdoctor 对 BannerPlugin 的兼容逻辑。详细请看：[支持 BannerPlugin](../../guide/usage/bundle-size#%E6%94%AF%E6%8C%81-bannerplugin)

package/docs/zh/guide/usage/bundle-size.mdx

@@ -120,3 +120,29 @@
   width="500px"
   style={{ margin: 'auto' }}
 />
+
+## 支持 BannerPlugin
+
+:::danger
+开启 BannerPlugin 分析时，请勿在生产版本中使用 Rsdoctor。
+:::
+
+由于 Rspack 和 Webpack 都支持 [BannerPlugin](https://www.rspack.dev/plugins/webpack/banner-plugin#bannerplugin)，BannerPlugin 是可在生成的 chunk 顶部或尾部添加一段指定的内容的内置插件。
+添加的代码段将会影响到对 Bundle 的解析能力。
+
+Rsdoctor 兼容了对 BannerPlugin 这种添加代码的逻辑，但因为 Rsdoctor 需要添加标记代码，所以没有默认开启，以下两种情况会开启 Rsdoctor BannerPlugin 能力：
+
+1. 项目在 `rspack.config.j|ts` 或 `webpack.config.j|ts` 中使用了 BannerPlugin；
+
+2. 通过 Rsdoctor options 配置 supports.banner 来开启：
+
+```ts
+new RsdoctorRspackPlugin (
+  supports: {
+    banner: true
+  }
+)
+
+```
+
+- 注：如果开启了 `drop_console` 将会影响 Rsdoctor 对 BannerPlugin 的分析，所以可以在 `RSDOCTOR = true` 时，关闭 `drop_console`。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/docs",
-  "version": "0.2.5",
+  "version": "0.3.1-beta.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -28,7 +28,7 @@
     "rsbuild-plugin-open-graph": "1.0.0",
     "rspress-plugin-font-open-sans": "^1.0.0",
     "typescript": "^5.2.2",
-    "@rsdoctor/types": "0.2.5"
+    "@rsdoctor/types": "0.3.1-beta.0"
   },
   "dependencies": {
     "framer-motion": "^10.17.6",