@rsdoctor/docs 0.0.1 → 0.1.9-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -27,9 +27,9 @@ The meanings of the fields in the data statistics table on the page are as follo
27
27
 
28
28
  ## Usage Instructions
29
29
 
30
- ### View Builder Config
30
+ ### View Bundler Config
31
31
 
32
- If we need to view the Webpack configuration of the project, we can click on `View Builder Config` in the upper right corner of the card. A floating layer will pop up, which contains the serialized **Builder Config**, as shown in the following figure:
32
+ If we need to view the Rspack or Webpack configuration of the project, we can click on `View Bundler Config` in the upper right corner of the card. A floating layer will pop up, which contains the serialized **Bundler Config**, as shown in the following figure:
33
33
 
34
34
  <img
35
35
  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/plugins-analysis-config.png"
@@ -28,9 +28,9 @@ In the main page of **Rsdoctor**, we can see a card named `Project Overall`, whi
28
28
 
29
29
  ## Usage
30
30
 
31
- ### View Builder Config
31
+ ### View Bundler Config
32
32
 
33
- If we need to view the Webpack configuration of the project, we can click on `View Builder Config` in the top right corner of the card. A popup window will appear, containing the serialized [Webpack Config](https://webpack.js.org/configuration/), as shown in the following image:
33
+ If we need to view the Rspack or Webpack configuration of the project, we can click on `View Bundler Config` in the top right corner of the card. A popup window will appear, containing the serialized [Bundler Config](https://webpack.js.org/configuration/), as shown in the following image:
34
34
 
35
35
  <img
36
36
  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/project-overall-config.jpg"
@@ -27,9 +27,9 @@ plugin 耗时中会计算 Rsdoctor 的内部插件耗时。
27
27
 
28
28
  ## 使用说明
29
29
 
30
- ### View Builder Config
30
+ ### View Bundler Config
31
31
 
32
- 如果我们需要查看项目的 Webpack 配置,则可以通过点击卡片右上角的 `View Builder Config`,页面会弹出一个浮层,其中包含被序列化后的 **Builder Config**,如下图所示:
32
+ 如果我们需要查看项目的 Rspack 或 Webpack 配置,则可以通过点击卡片右上角的 `View Bundler Config`,页面会弹出一个浮层,其中包含被序列化后的 **Bundler Config**,如下图所示:
33
33
 
34
34
  <img
35
35
  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/compile/plugins-analysis-config.png"
@@ -28,9 +28,9 @@
28
28
 
29
29
  ## 使用说明
30
30
 
31
- ### View Builder Config
31
+ ### View Bundler Config
32
32
 
33
- 如果我们需要查看项目的 Webpack 配置,则可以通过点击卡片右上角的 `View Builder Config`,页面会弹出一个浮层,其中包含被序列化后的 [Webpack Config](https://webpack.js.org/configuration/),如下图所示:
33
+ 如果我们需要查看项目的 Rspack 或 Webpack 配置,则可以通过点击卡片右上角的 `View Bundler Config`,页面会弹出一个浮层,其中包含被序列化后的 [Bundler Config](https://webpack.js.org/configuration/),如下图所示:
34
34
 
35
35
  <img
36
36
  src="https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/usage/project-overall-config.jpg"
package/package.json CHANGED
@@ -1,11 +1,6 @@
1
1
  {
2
2
  "name": "@rsdoctor/docs",
3
- "version": "0.0.1",
4
- "scripts": {
5
- "dev": "rspress dev",
6
- "build": "rspress build",
7
- "preview": "rspress preview"
8
- },
3
+ "version": "0.1.9-beta.0",
9
4
  "repository": {
10
5
  "type": "git",
11
6
  "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -20,25 +15,30 @@
20
15
  ],
21
16
  "publishConfig": {
22
17
  "access": "public",
23
- "provenance": false,
18
+ "provenance": true,
24
19
  "registry": "https://registry.npmjs.org/"
25
20
  },
26
21
  "devDependencies": {
27
- "@rsdoctor/types": "workspace:*",
28
22
  "@types/node": "^16",
29
23
  "@types/react": "^18",
30
24
  "@types/react-dom": "^18",
31
25
  "react": "18.2.0",
32
26
  "react-dom": "18.2.0",
27
+ "rsbuild-plugin-google-analytics": "^1.0.0",
33
28
  "rspress-plugin-font-open-sans": "^1.0.0",
34
- "ts-node": "^10.9.2",
35
- "typescript": "^5.2.2"
29
+ "typescript": "^5.2.2",
30
+ "@rsdoctor/types": "0.1.9-beta.0"
36
31
  },
37
32
  "dependencies": {
38
33
  "framer-motion": "^10.17.6",
39
34
  "react-markdown": "^9.0.1",
40
35
  "rsfamily-nav-icon": "^1.0.2",
41
- "rspress": "^1.15.1",
36
+ "rspress": "^1.16.1",
42
37
  "tailwindcss": "^3.4.0"
38
+ },
39
+ "scripts": {
40
+ "dev": "rspress dev",
41
+ "build": "rspress build",
42
+ "preview": "rspress preview"
43
43
  }
44
- }
44
+ }