@modern-js/main-doc 0.0.0-next-20230113074650 → 0.0.0-next-20230113142853

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @modern-js/main-doc@2.1.0 build /github/workspace/packages/toolkit/main-doc
+> @modern-js/main-doc@2.1.0 build /tmp/repo/modern.js/packages/toolkit/main-doc
 > npx ts-node ./scripts/sync.ts
 

package/CHANGELOG.md

@@ -1,10 +1,10 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-20230113074650
+## 0.0.0-next-20230113142853
 
 ### Patch Changes
 
-- 8a51f073d5: docs: modify data loader usage in the guide
+- 8a51f073d: docs: modify data loader usage in the guide
   docs: 修改指南中 data loader 的用法
-- Updated dependencies [9da67a2c1e]
-  - @modern-js/builder-doc@0.0.0-next-20230113074650
+- Updated dependencies [9da67a2c1]
+  - @modern-js/builder-doc@0.0.0-next-20230113142853

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Commands",
-  "position": 3,
+  "position": 0,
   "link": {
     "type": "doc",
     "id": "apis/app/commands/index"

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/build.md

@@ -36,9 +36,3 @@ Open the above HTML file in the browser, you can see the tile diagram of the pac
 <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/mwa-build-analyze-8784f762c1ab0cb20935829d5f912c4c.png" />
 
 > this features based on [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer).
-
-## Command Arguments
-
-import CommandTip from '@site-docs-en/components/command-tip.md'
-
-<CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/dev.md

@@ -31,6 +31,31 @@ info    App running at:
   > Network:  http://192.168.0.1:8080/
 ```
 
-import CommandTip from '@site-docs-en/components/command-tip.md'
+## Compile Partial Pages
 
-<CommandTip />
+In multi-page (MPA) projects, the `--entry` option can be added to specify one or more pages to compile. In this way, only part of the code in the project will be compiled, and the dev startup speed will be faster.
+
+For example, execute `modern dev --entry`, the entry selector will be displayed in the command line interface:
+
+```bash
+$ modern dev --entry
+
+? Please select the entry that needs to be built
+❯ ◯ foo
+  ◯ bar
+  ◯ baz
+```
+
+For example, if you select the `foo` entry, only the code related to the `foo` entry will be compiled, and the code of other pages will not be compiled.
+
+### Specify the page by parameter
+
+You can also specify the page name through parameters after `--entry`, and the names of multiple pages can be separated by commas.
+
+```bash
+# Compile foo page
+modern dev --entry foo
+
+# Compile foo and bar pages
+modern dev --entry foo,bar
+```

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/lint.md

@@ -16,7 +16,3 @@ Options:
 Run ESLint to check the syntax of the code. Normally, only the part of the code modified by this commit needs to be checked by `lint-staged` during the `git commit` phase.
 
 - `--no-fix` close auto fix by lint.
-
-import CommandTip from '@site-docs-en/components/command-tip.md'
-
-<CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/new.md

@@ -19,10 +19,6 @@ The `modern new` command is used to enable features to an existing project.
 
 For example, add application entry, enable some optional features such as Tailwind CSS, micro frontend, etc.
 
-import CommandTip from '@site-docs-en/components/command-tip.md'
-
-<CommandTip />
-
 ### Add Entry
 
 In the project, execute the `new` command to add entries as follows:

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/serve.md

@@ -24,7 +24,3 @@ export default defineConfig({
   },
 });
 ```
-
-import CommandTip from '@site-docs-en/components/command-tip.md'
-
-<CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/test.md

@@ -30,7 +30,3 @@ Time:        0.994 s, estimated 1 s
 :::info
 files match `*.test.(js|ts)` in `api/` or `src/` will be recognized as test cases by default。
 :::
-
-import CommandTip from '@site-docs-en/components/command-tip.md'
-
-<CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/upgrade.md

@@ -15,7 +15,3 @@ Options:
 ```
 
 Execute the command `npx modern upgrade` in the project, by default, dependencies in the `package.json` are updated to the latest version.
-
-:::info
-the command is available in `@modern-js/app-tools` version >= 1.17.0, previous versions can be upgraded with `npx @modern-js/upgrade`.
-:::

package/en/docusaurus-plugin-content-docs/current/guides/troubleshooting/_category_.json

@@ -0,0 +1,5 @@
+{
+  "label": "FAQ",
+  "position": 6,
+  "collapsed": true
+}

package/en/docusaurus-plugin-content-docs/current/{components/command-tip.md → guides/troubleshooting/cli.md}

@@ -1,4 +1,11 @@
-:::tip 提示
+---
+sidebar_position: 2
+---
+
+# CLI FAQ
+
+### Can't pass command line arguments correctly when using pnpm?
+
 The pnpm v6 and pnpm v7 versions do not use the same posture when executing commands. The following should be noted:
 
 pnpm v7：
@@ -54,4 +61,3 @@ Summary:
 ** When using pnpm v7, if you pass arguments to pnpm, you need to put the arguments before the command **
 
 ** When using pnpm v6, if the parameter passed to pnpm, you do not need to add `--`; if the parameter passed is for script use, you need to add `--` character string **.
-:::

package/package.json

@@ -11,20 +11,20 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-20230113074650",
+  "version": "0.0.0-next-20230113142853",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "^0.0.0-next-20230113074650"
+    "@modern-js/builder-doc": "0.0.0-next-20230113142853"
   },
   "devDependencies": {
     "ts-node": "^10",
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-20230113074650"
+    "@modern-js/builder-doc": "0.0.0-next-20230113142853"
   },
   "scripts": {
     "build": "npx ts-node ./scripts/sync.ts"

package/zh/apis/app/commands/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "命令",
-  "position": 3,
+  "position": 0,
   "link": {
     "type": "doc",
     "id": "apis/app/commands/index"

package/zh/apis/app/commands/build.md

@@ -36,9 +36,3 @@ File sizes after production build:
 <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/mwa-build-analyze-8784f762c1ab0cb20935829d5f912c4c.png" />
 
 > 该功能基于 [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) 实现。
-
-## 命令行参数
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/app/commands/dev.md

@@ -10,7 +10,7 @@ Usage: modern dev / modern start [options]
 本地开发命令
 
 Options:
-  -e --entry <entry>    指定入口，编译特定的页面
+  -e --entry <entry>    指定入口，只编译特定的页面
   -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
   -h, --help            显示命令帮助
   --analyze             分析构建产物体积，查看各个模块打包后的大小
@@ -31,6 +31,31 @@ info    App running at:
   > Network:  http://192.168.0.1:8080/
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
+## 编译部分页面
 
-<CommandTip />
+在多页面（MPA）项目中，可以添加 `--entry` 参数来指定编译其中的一个或多个页面。这样可以只编译项目中的部分代码，从而提升 dev 启动速度。
+
+比如执行 `modern dev --entry`，在命令行界面中会展示入口选择框：
+
+```bash
+$ modern dev --entry
+
+? 请选择需要构建的入口
+❯ ◯ foo
+  ◯ bar
+  ◯ baz
+```
+
+比如选择 `foo` 入口，那么只有 `foo` 入口相关的代码会进行编译，其他页面的代码将不会参与构建。
+
+### 通过参数指定页面
+
+你也可以在 `--entry` 后面通过参数来指定页面名称，多个页面的名称使用逗号分隔。
+
+```bash
+# 编译 foo 页面
+modern dev --entry foo
+
+# 编译 foo 和 bar 页面
+modern dev --entry foo,bar
+```

package/zh/apis/app/commands/lint.md

@@ -16,7 +16,3 @@ Options:
 运行 `ESLint` 检查代码语法情况。通常情况下，我们只需要在 `git commit` 阶段通过 `lint-staged` 检查本次提交修改的部分代码。
 
 - `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/app/commands/new.md

@@ -19,10 +19,6 @@ Options:
 
 比如添加应用入口、启用启用一些可选功能如 Tailwind CSS、微前端开发模式等。
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 ### 添加入口
 
 在应用工程中，执行 `new` 命令添加入口如下：

package/zh/apis/app/commands/serve.md

@@ -24,7 +24,3 @@ export default defineConfig({
   },
 });
 ```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/app/commands/test.md

@@ -30,7 +30,3 @@ Time:        0.994 s, estimated 1 s
 :::info 注
 `src` 和 `api` 目录下面 `*.test.(js|ts)` 都会默认识别为测试用例。
 :::
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/app/commands/upgrade.md

@@ -15,7 +15,3 @@ Options:
 ```
 
 在项目根目录下执行命令 `npx modern upgrade`，会默认将当前执行命令项目的 `package.json` 中的 Modern.js 相关依赖更新至最新版本。
-
-:::info
-命令在 `@modern-js/app-tools` 版本 >= 1.17.0 提供，之前版本可使用 `npx @modern-js/upgrade` 进行升级。
-:::

package/zh/apis/monorepo/commands/bump.md

@@ -36,7 +36,3 @@ npx modern bump
 
 - test publish
 ```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/monorepo/commands/change.md

@@ -53,7 +53,3 @@ $ npx modern change
 
 test publish
 ```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/monorepo/commands/clear.md

@@ -12,10 +12,6 @@ Options:
   -h, --help               display help for command
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 默认对 Monorepo 以及 Monorepo 子项目的 `node_modules` 进行清理。
 
 可以通过参数 `--remove-dirs` 来指定要删除的目录，例如执行：

package/zh/apis/monorepo/commands/deploy.md

@@ -12,10 +12,6 @@ Options:
   -h, --help         display help for command
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 对指定的项目进行部署，会通过指定项目分析其依赖的 Monorepo 下的子项目。
 
 在执行命令之后，会首先生成 `output` 目录，在目录当中包含了指定部署的项目以及其依赖的子项目，形成一个最小集合的 Monorepo。

package/zh/apis/monorepo/commands/gen-release-note.md

@@ -28,7 +28,3 @@ Options:
 
 [[#1264](https://github.com/modern-js-dev/modern.js/pull/1264)] fix: conventional router app use App.init not work
 ```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/monorepo/commands/lint.md

@@ -12,10 +12,6 @@ Options:
   -h, --help  display help for command
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 运行 `ESLint` 检查 monorepo 中代码语法情况， 通长情况下，我们只需要在 `git commit` 阶段通过 `lint-staged` 检查本次提交修改的部分代码。
 
 - `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。

package/zh/apis/monorepo/commands/new.md

@@ -15,10 +15,6 @@ Options:
   -h, --help             display help for command
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 `modern new` 命令在 monorepo 中可以用来添加应用工程和可复用的模块：
 
 ```bash

package/zh/apis/monorepo/commands/pre.md

@@ -11,10 +11,6 @@ Options:
   -h, --help  display help for command
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
 可以使用 `modern pre` 命令在正式发布前[预发布](https://github.com/atlassian/changesets/blob/main/docs/prereleases.md)一个版本。
 
 首先 `modern pre enter <tag>` 进入预发布模式:

package/zh/apis/monorepo/commands/release.md

@@ -13,7 +13,3 @@ Options:
 ```
 
 发布当前仓库的 Packages 至 NPM。
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

package/zh/apis/monorepo/commands/upgrade.md

@@ -17,7 +17,3 @@ Options:
 `modern upgrade` 命令，用于升级项目 Modern.js 相关依赖至最新版本。
 
 在项目根目录下执行命令 `npx modern upgrade`，会默认将当前执行命令项目的 `package.json` 中的 Modern.js 相关依赖更新至最新版本。
-
-:::info
-命令在 `@modern-js/monorepo-tools` 版本 >= 1.17.0 提供，之前版本可使用 `npx @modern-js/upgrade` 进行升级。
-:::

package/zh/{components/command-tip.md → guides/troubleshooting/cli.md}

@@ -1,4 +1,11 @@
-:::tip 提示
+---
+sidebar_position: 2
+---
+
+# 命令行问题
+
+### 使用 pnpm 时无法正确传递命令行参数？
+
 pnpm v6 和 pnpm v7 版本在执行命令时使用姿势不完全一致，需要注意以下事项：
 
 pnpm v7：
@@ -54,5 +61,3 @@ pnpm v6:
 **在使用 pnpm v7 时，如果传递参数给 pnpm，需要将参数放置到命令前**
 
 **在使用 pnpm v6 时，如果传递的参数给 pnpm，不需要加 `--`；如果传递的参数是给脚本使用，需要增加 `--` 字符串**。
-
-:::