@rsdoctor/docs 1.0.0-beta.1 → 1.0.0-beta.3

package/docs/en/blog/release/release-note-0_1.mdx

@@ -16,7 +16,7 @@ Rsdoctor is a one-stop build analysis tool for Rspack and Webpack. It allows for
 
 **Rsdoctor** is a build analysis tool for analyzing projects built with [Rspack](https://www.rspack.dev/) and [Webpack](https://webpack.js.org/). It supports analysis of projects such as [Rsbuild](https://rsbuild.dev/), [Create React App](https://create-react-app.dev/), [Modern.js](https://modernjs.dev/), and more.
 
-![Position](https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rsdoctor-position.png)
+![Position](https://assets.rspack.dev/others/assets/rsdoctor/rsdoctor-position.png)
 
 ## 🔥 Features
 
@@ -35,12 +35,12 @@ Rsdoctor is a one-stop build analysis tool for Rspack and Webpack. It allows for
 
 - The overview page (i.e. the home page) can know **project configuration, diagnostic information, compilation information, and product status**.
 
-![Overall](https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/overall.jpg)
+![Overall](https://assets.rspack.dev/others/assets/rsdoctor/project-overall-1.jpg)
 
 - In addition to the project overview, we also provide diagnostic functions, including compilation diagnostics and duplicate packages diagnostics. If your compilation and products hit the diagnostic rules we defined,
   the corresponding warning alerts will appear on the tool's home page. **where you can see the detailed reference path of duplicate packages**:
 
-![Overall-Alerts](https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/overall-alerts.jpg)
+![Overall-Alerts](https://assets.rspack.dev/others/assets/rsdoctor/overall-alerts.png)
 
 ### ⭐️ Compilation analysis
 
@@ -52,12 +52,12 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
 
 <div style={{ display: 'flex' }}>
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-timeline-overall.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/rsdoctor-loader-timeline.png"
     width="55%"
     style={{ margin: 'auto' }}
   />
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-anlaysis-all.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/loader-analysis-all.png"
     width="45%"
     style={{ margin: 'auto' }}
   />
@@ -70,9 +70,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
 <p>
   <img
     alt="bundle"
-    src={
-      'https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/compile-plugin.jpg'
-    }
+    src={'https://assets.rspack.dev/others/assets/rsdoctor/compile-plugin.jpg'}
     width="600px"
     style={{ margin: 'auto' }}
   />
@@ -85,9 +83,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
 <p>
   <img
     alt="bundle"
-    src={
-      'https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/resolver.jpeg'
-    }
+    src={'https://assets.rspack.dev/others/assets/rsdoctor/resolver.png'}
     width="700px"
     style={{ margin: 'auto' }}
   />
@@ -103,7 +99,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
   <img
     alt="bundle"
     src={
-      'https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/bundle-size.jpg'
+      'https://assets.rspack.dev/others/assets/rsdoctor/bundle-size-overall.png'
     }
     width="700px"
     style={{ margin: 'auto' }}

package/docs/en/blog/release/release-note-0_3.mdx

@@ -13,9 +13,9 @@ The new features of Rsdoctor v0.3 include:
 Considering that users may have their own specific rule definition requirements, Rsdoctor provides an external interface for users to customize their own rule checks in addition to the internal rules already available.
 External extension interfaces need to be configured on the Rsdoctor plugin through the `extends` field, and their configurations are also placed in the `rules` field.
 
-For more details, please refer to: [Custom Extension Rules](/guide/custom/rule-custom)
+For more details, please refer to: [Custom Extension Rules](/guide/rules/rule-custom)
 
-Additionally, the use of custom rules can also be applied for user data collection and reporting. [Data Reporting](/guide/custom/upload-data)
+Additionally, the use of custom rules can also be applied for user data collection and reporting. [Data Reporting](/guide/rules/upload-data)
 
 - Example:
 
@@ -123,14 +123,14 @@ Disabling the Parse Bundle capability only affects the ability to view the final
 
 <div style={{ display: 'flex' }}>
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundled-size.jpeg"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundled-size.jpeg"
     height="300px"
     width="400px"
     style={{ margin: 'auto' }}
   />
 
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundled-code.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundled-code.png"
     height="300px"
     width="500px"
     style={{ margin: 'auto' }}

package/docs/en/blog/release/release-note-0_4.mdx

@@ -36,11 +36,11 @@ The **Bundle Diff** feature helps users compare and analyze changes between two
 
 <div style={{ display: 'flex', justifyContent: 'space-between' }}>
   <img
-    src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/6c20c39a1dd576a513c2a7cb0fb0d2e162f63343/others/assets/rsdoctor/bundle-diff-cards.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-diff-cards.png"
     style={{ width: '48%' }}
   />
   <img
-    src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/632e3087495b569de77a93235196fdacf09627d5/others/assets/rsdoctor/bundle-diff-module-list.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-diff-module-list.png"
     style={{ width: '48%' }}
   />
 </div>
@@ -57,7 +57,7 @@ Plans to support Bundle Diff Action on GitHub to simplify degradation monitoring
 
 Support for loader analysis for Vue projects has been added in Rsdoctor v0.4.
 
-<img src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/d8074588e99dbdcaa278cd1e82f1298663e425db/others/assets/rsdoctor/vue-loader.png" />
+<img src="https://assets.rspack.dev/others/assets/rsdoctor/vue-loader.png" />
 
 ## Other features
 
@@ -67,7 +67,7 @@ Support for loader analysis for Vue projects has been added in Rsdoctor v0.4.
   - Reduced the size of the `@rsdoctor/client` package by 60%, improving page rendering speed.
 
   <img
-    src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/34e6d96d6948a08cade4bd419f50b962e228a4a8/others/assets/rsdoctor/package-size-diff.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/package-size-diff.png"
     style={{ width: '60%', margin: 'auto' }}
   />
 

package/docs/en/blog/topic/duplicate-pkg-problem.mdx

@@ -2,7 +2,7 @@
 
 Rsdoctor will report cases where multiple duplicate dependencies exist in the same builder's artifact.
 
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundle-alerts.png" />
+<img src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-alerts.png" />
 
 ## Hazards of duplicate packages
 

package/docs/en/blog/topic/loader-optimization.mdx

@@ -16,7 +16,7 @@ Regardless of the optimization method used for loaders, we need to obtain data i
 With the Loader Analysis module provided by Rsdoctor, we can see **a tree structure composed of all files that pass through the loaders during the entire compilation process**, as shown in the following figure:
 
 <img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-anlaysis-all.png"
+  src="https://assets.rspack.dev/others/assets/rsdoctor/loader-analysis-all.png"
   width="600px"
   style={{ margin: 'auto' }}
 />
@@ -26,7 +26,7 @@ With the Loader Analysis module provided by Rsdoctor, we can see **a tree struct
 By **clicking on a directory**, you can see the **time-consuming statistics of all loaders** under the currently **selected directory** on the right side of the file tree, such as the number of files processed by a loader and **the estimated time** consumption. The content of the "Statistics of \*\*\*" card is shown in the following figure:
 
 <img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-anlaysis-table.png"
+  src="https://assets.rspack.dev/others/assets/rsdoctor/loader-analysis-table.png"
   width="300px"
   height="400px"
   style={{ margin: 'auto' }}
@@ -43,18 +43,18 @@ Usually, in the directories of third-party libraries inside **`node_modules`**,
 By **clicking on a file**, a mask layer will pop up, showing a list of all loaders that have been executed on the currently clicked file. By **clicking on a loader**, you can see the **input**, **output**, and **parameter data information of the target loader** when it is called.
 
 <img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-analysis-code-change.png"
+  src="https://assets.rspack.dev/others/assets/rsdoctor/loader-analysis-code-change.png"
   width="600px"
   style={{ margin: 'auto' }}
-/>{' '}
+/>
 
 - Parameter Data Information: Click on "**show more**" or the expand button in the upper left corner to view the corresponding parameter information.
 
 <img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-analysis-options.png"
+  src="https://assets.rspack.dev/others/assets/rsdoctor/loader-analysis-options.png"
   width="600px"
   style={{ margin: 'auto' }}
-/>{' '}
+/>
 
 We can use the loader information of individual files here to troubleshoot issues and decide whether to add them to [module.rule.exclude](https://webpack.js.org/configuration/module/#ruleexclude).
 

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

@@ -74,8 +74,36 @@ new RsdoctorWebpackPlugin({
 
 This is the options for the [RsdoctorWebpackPlugin](#rsdoctorwebpackplugin) and [RsdoctorRspackPlugin](#rsdoctorrspackplugin). It contains these properties:
 
+- [brief](#brief)
 - [disableClientServer](#disableclientserver)
+- [experiments](#experiments)
 - [features](#features)
+- [mode](#mode)
+- [output](#output)
+- [port](#port)
+- [supports](#supports)
+
+### brief
+
+<Badge text="Version: 0.4.0" type="warning" />
+
+- **Type:** [BriefType](#brieftype)
+- **Optional:** `true`
+- **Default:** undefined
+
+More configurations for Brief mode are as follows:
+
+- **reportHtmlName:** Configures the name of the HTML report for Brief mode. The default value is `report-rsdoctor.html`.
+- **writeDataJson:** By default, in Brief mode, the analysis data is injected into the HTML file, so no additional build analysis data is generated. If you want to generate additional local data, you need to configure `writeDataJson: true`.
+
+#### briefType
+
+```ts
+interface BriefConfig {
+  reportHtmlName?: string | undefined;
+  writeDataJson: boolean;
+}
+```
 
 ### disableClientServer
 
@@ -85,6 +113,30 @@ This is the options for the [RsdoctorWebpackPlugin](#rsdoctorwebpackplugin) and
 
 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.
 
+### experiments
+
+<Badge text="Version: 1.0.0" type="warning" />
+
+#### enableNativePlugin
+
+- Type: `boolean`
+- Optional: true
+- Default: false
+
+##### Description
+
+By integrating Rsdoctor's native plugin into Rspack, we move Rsdoctor's time-consuming data processing logic to the Rspack build stage. This feature significantly improves the build analysis efficiency of Rsdoctor in Rspack, reducing the overall analysis time.
+
+- enableNativePlugin: Whether to enable the Rspack native plugin, enabling it can significantly reduce the analysis time of Rsdoctor itself.
+
+- Example
+
+```js
+new RsdoctorRspackPlugin({
+  experiments: { enableNativePlugin: true }
+}),
+```
+
 ### features
 
 - **Type:** [RsdoctorWebpackPluginFeatures](#rsdoctorwebpackpluginfeatures) | [Array\<keyof RsdoctorWebpackPluginFeatures\>](#rsdoctorwebpackpluginfeatures) | [RsdoctorRspackPluginFeatures](#rsdoctorrspackpluginfeatures) | [Array\<keyof RsdoctorRspackPluginFeatures\>](#rsdoctorrspackpluginfeatures)
@@ -151,39 +203,27 @@ import ModeIntro from '@en/shared/mode-intro.md';
 
 <ModeIntro />
 
-### reportDir
+### output
 
-<Badge text="Version: 0.4.0" type="warning" />
+<Badge text="Version 1.0.0" type="warning" />
 
-- **Type:** string
-- **Optional:** `true`
-- **Default:** undefined
+#### compressData
 
-The output directory for Rsdoctor reports. By default, it is the build output directory.
+- **Type:** boolean
+- **Optional:** `true`
+- **Default:** true
 
-### brief
+compressData is used to configure whether to compress the analysis data under [outputDir]/.rsdoctor.
 
-<Badge text="Version: 0.4.0" type="warning" />
+#### reportDir
 
-- **Type:** [BriefType](#brieftype)
+- **Type:** string
 - **Optional:** `true`
 - **Default:** undefined
 
-More configurations for Brief mode are as follows:
-
-- **reportHtmlName:** Configures the name of the HTML report for Brief mode. The default value is `report-rsdoctor.html`.
-- **writeDataJson:** By default, in Brief mode, the analysis data is injected into the HTML file, so no additional build analysis data is generated. If you want to generate additional local data, you need to configure `writeDataJson: true`.
-
-#### briefType
-
-```ts
-interface BriefConfig {
-  reportHtmlName?: string | undefined;
-  writeDataJson: boolean;
-}
-```
+The output directory for Rsdoctor reports. By default, it is the build output directory.
 
-### reportCodeType
+#### reportCodeType
 
 - Type: `{ noModuleSource?: boolean; noAssetsAndModuleSource?: boolean }`
 - Optional: true
@@ -206,6 +246,26 @@ new RsdoctorRspackPlugin({
 }),
 ```
 
+### port
+
+- **Type:** `number`
+- **Optional:** `true`
+- **Default:** `random(3000, 8999)`
+
+Configure the port for the Rsdoctor server.
+
+### ~~reportCodeType [**Deprecated**]~~
+
+<Badge text="Deprecated" type="warning" />
+
+Please use [output.reportCodeType](#reportcodetype)
+
+### ~~reportDir [**Deprecated**]~~
+
+<Badge text="Deprecated" type="warning" />
+
+Please use [output.reportDir](#reportDir)
+
 ### supports
 
 - **Type:** [Supports Types](#supports-types)
@@ -235,6 +295,19 @@ When enabling the analysis of BannerPlugin, Rsdoctor should not be used in produ
 
 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)
 
+#### generateTileGraph
+
+- default: true. The default value in rspack is false.
+- type: boolean.
+
+Whether to enable the ability to generate tile graphs, which affects whether the Bundle Size page has a tile graph from `webpack-bundle-analyzer`.
+
+<img
+  src="https://assets.rspack.dev/others/assets/rsdoctor/bundle-size-tile-graph.png"
+  width="500px"
+  style={{ margin: 'auto' }}
+/>
+
 #### parseBundle
 
 - default: true.
@@ -257,36 +330,16 @@ Disabling the Parse Bundle capability will only affect the visibility of the Bun
 
 <div style={{ display: 'flex' }}>
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundled-size.jpeg"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundled-size.jpeg"
     height="300px"
     width="300px"
     style={{ margin: 'auto' }}
   />
 
   <img
-    src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundled-code.png"
+    src="https://assets.rspack.dev/others/assets/rsdoctor/bundled-code.png"
     height="300px"
     width="400px"
     style={{ margin: 'auto' }}
   />
 </div>
-#### generateTileGraph
-
-- default: true. The default value in rspack is false.
-- type: boolean.
-
-Whether to enable the ability to generate tile graphs, which affects whether the Bundle Size page has a tile graph from `webpack-bundle-analyzer`.
-
-<img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/bundle/bundle-size-tile-graph.png"
-  width="500px"
-  style={{ margin: 'auto' }}
-/>
-
-### port
-
-- **Type:** `number`
-- **Optional:** `true`
-- **Default:** `random(3000, 8999)`
-
-Configure the port for the Rsdoctor server.

package/docs/en/guide/_meta.json

@@ -11,8 +11,8 @@
   },
   {
     "type": "dir",
-    "name": "custom",
-    "label": "User Custom"
+    "name": "rules",
+    "label": "Scan Rules"
   },
   {
     "type": "dir",

package/docs/en/guide/more/faq.mdx

@@ -5,9 +5,9 @@
 When we **only need** the [bundle size analysis](../usage/bundle-size) feature of Rsdoctor, we can configure the corresponding [Features](/config/options/options) option when integrating the Rsdoctor plugin. Refer to the code snippet below:
 
 ```ts
-import { RsdoctorWebpackPlugin } from '@rsdoctor/webpack-plugin';
+import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';
 
-new RsdoctorWebpackPlugin({
+new RsdoctorRspackPlugin({
   features: ['bundle'], // Represents enabling only the bundle size analysis feature
 });
 ```
@@ -19,7 +19,7 @@ Additionally, the builder will **parallelize the execution** of multiple non-con
 Furthermore, the asynchronous logic within loader functions cannot be recognized, causing a single loader function to potentially span across the execution of multiple other loaders. As a result, there are three possible cases, as shown in the following diagram:
 
 <img
-  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/loader-cases.jpeg"
+  src="https://assets.rspack.dev/others/assets/rsdoctor/loader-cases.jpeg"
   style={{ width: '250px' }}
 />
 
@@ -44,13 +44,13 @@ You can add the `lite` field to the `features` array to use the lite mode. Addit
 The following example enables the lite mode, build-time analysis, and bundle analysis:
 
 ```js
-const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');
+const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');
 
 // adding the plugin to your configuration
 module.exports = {
   // ...
   plugins: [
-    new RsdoctorWebpackPlugin({
+    new RsdoctorRspackPlugin({
       disableClientServer: false,
       features: ['lite', 'loader', 'plugins', 'bundle'],
     }),
@@ -67,7 +67,7 @@ When using Rsdoctor to analyze the compilation time of Rspack projects, you may
 
 - Reason: The loader in [CssExtractRspackPlugin](https://rspack.dev/plugins/rspack/css-extract-rspack-plugin) asynchronously calls other loaders during the pitch phase and waits for the callback results after these loaders execute. Therefore, the time taken by CssExtractRspackPlugin actually includes the execution time of other loaders and idle time.
 
-<img src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/4ffe579c62f6e8d995b7856d608abdef61219155/rsdoctor/css-extract-loader.png" />
+<img src="https://assets.rspack.dev/rsdoctor/css-extract-loader.png" />
 
 ## Next.js
 

package/docs/en/guide/rules/_meta.json

@@ -0,0 +1 @@
+["rules", "rule-custom", "upload-data"]

package/docs/en/guide/{custom → rules}/rule-custom.mdx

@@ -188,11 +188,7 @@ At the same time, Rsdoctor also has two components that can be used to display r
 
 - Basic Rule Warning Component
 
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rule-1.jpeg" />
-
-- Code Display Component
-
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rule-2.jpeg" />
+<img src="https://assets.rspack.dev/others/assets/rsdoctor/rule-1.jpeg" />
 
 ## Display components
 
@@ -259,7 +255,7 @@ report({
 
 - Display Components
 
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rule-1.jpeg" />
+<img src="https://assets.rspack.dev/others/assets/rsdoctor/rule-1.jpeg" />
 
 - Component Code [Code](https://github.com/web-infra-dev/rsdoctor/blob/main/packages/components/src/components/Alert/link.tsx)
 
@@ -331,9 +327,7 @@ report({
 
 - Component Display
 
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rule-2.jpeg" />
-
-<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/rule-3.jpeg" />
+<img src="https://assets.rspack.dev/others/assets/rsdoctor/rule-3.jpeg" />
 
 - Component Code: [Code](https://github.com/web-infra-dev/rsdoctor/blob/main/packages/components/src/components/Alert/view.tsx)