@modern-js/main-doc 2.0.3-alpha.0 → 2.2.0

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

@@ -1,42 +0,0 @@
----
-sidebar_position: 4
----
-
-```bash
-Usage: modern bump [options]
-
-使用变更集自动更新发布版本和变更日志
-
-Options:
-  --canary       创建一个预发布版本进行测试 (default: false)
-  --preid <tag>  在对预发布版本进行版本控制时指定标识符 (default: "next")
-  --snapshot     创建一个特殊版本进行测试 (default: false)
-  -h, --help     display help for command
-```
-
-:::info 注
-`bump` 命令执行之前需要提前执行 [`change`](/docs/apis/monorepo/commands/change) 命令添加 changeset。
-:::
-
-按 changeset 记录修改 `package.json` 中的版本号， 同时生成 `CHANGELOG.md`：
-
-```bash
-npx modern bump
-🦋  All files have been updated. Review them and commit at your leisure
-```
-
-`CHANGELOG.md` 示例内容如下：
-
-```md
-# package-a
-
-## 0.1.1
-### Patch Changes
-
-- test publish
-
-```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

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

@@ -1,58 +0,0 @@
----
-sidebar_position: 2
----
-
-```bash
-Usage: modern change [options]
-
-创建变更集
-
-Options:
-  --empty     创建空变更集 (default: false)
-  --open      使用编辑器中打开创建的变更集 (default: false)
-  -h, --help  display help for command
-```
-
-:::info 注
-[`change`](/docs/apis/monorepo/commands/change)、[`pre`](/docs/apis/monorepo/commands/pre)、[`bump`](/docs/apis/monorepo/commands/bump)、[`release`](/docs/apis/monorepo/commands/release) 命令集成了工具 [`changesets`](https://github.com/atlassian/changesets) 管理版本变更和 Changelog。
-:::
-
-`modern change` 命令添加 changeset：
-
-```bash
-$ npx modern change
-🦋  Which packages would you like to include? · package-a, package-b
-🦋  Which packages should have a major bump? · No items were selected
-🦋  Which packages should have a minor bump? · No items were selected
-🦋  The following packages will be patch bumped:
-🦋  package-a@0.1.0
-🦋  package-b@0.1.0
-🦋  Please enter a summary for this change (this will be in the changelogs). Submit empty line to open external editor
-🦋  Summary · test publish
-🦋  === Releasing the following packages ===
-🦋  [Patch]
-🦋    package-a, package-b
-🦋  ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
-🦋  ║                                                      ========= NOTE ========                                                       ║
-🦋  ║All dependents of these packages that will be incompatible with the new version will be patch bumped when this changeset is applied.║
-🦋  ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
-🦋  Is this your desired changeset? (Y/n) · true
-🦋  Changeset added! - you can now commit it
-🦋
-🦋  If you want to modify or expand on the changeset summary, you can find it here
-🦋  info /xxxx/monorepo/.changeset/long-lizards-talk.md
-```
-上面我们给 `package-a` 和 `package-b` 都选择了 `patch` 变更，具体的变更信息在 monorepo 根目录下的 `.changeset/long-lizards-talk.md` 中:
-
-```md
----
-"package-a": patch
-"package-b": patch
----
-
-test publish
-```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

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

@@ -1,27 +0,0 @@
----
-sidebar_position: 8
----
-
-```bash
-Usage: modern clear [options]
-
-clear project dirs
-
-Options:
-  --remove-dirs [dirs...]  remove dirs, default is node_modules
-  -h, --help               display help for command
-```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
-默认对 Monorepo 以及 Monorepo 子项目的 `node_modules` 进行清理。
-
-可以通过参数 `--remove-dirs` 来指定要删除的目录，例如执行：
-
-```bash
-$ npx modern clear --remove-dirs dist
-```
-
-则会清理所有 Monorepo 子项目的 `dist` 目录。

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

@@ -1,39 +0,0 @@
----
-sidebar_position: 7
----
-
-```bash
-Usage: modern deploy [options]
-
-deploy project
-
-Options:
-  -p, --path [path]  Specify the path of the product output (default: "output")
-  -h, --help         display help for command
-```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
-对指定的项目进行部署，会通过指定项目分析其依赖的 Monorepo 下的子项目。
-
-在执行命令之后，会首先生成 `output` 目录，在目录当中包含了指定部署的项目以及其依赖的子项目，形成一个最小集合的 Monorepo。
-
-:::info 补充信息
-`output` 目录是默认目录，可以通过 `-p` 参数进行自定义。
-:::
-
-然后会在 `output` 目录下进行依赖的安装以及必要文件的复制。
-
-最后当依赖安装完成后，便完成了对指定项目的部署任务。
-
-例如部署项目名称为 `app` 的应用，则可以执行：
-
-```
-pnpm deploy app
-```
-
-:::info 补充信息
-其中 `app` 为项目的 `package.json` 的 `name` 值。
-:::

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

@@ -1,35 +0,0 @@
----
-sidebar_position: 9
----
-
-```bash
-Usage: modern gen-release-note [options]
-
-根据当前仓库 changeset 文件生成 Release Note
-
-Options:
-  --repo <repo>      仓库名称，用于生成 Pull Request 链接， 例如： modern-js-dev/modern.js
-  --custom <cumtom>  自定义 Release Note 生成函数
-  -h, --help         display help for command
-```
-
-根据当前仓库的 changeset 信息自动生成 Release Note。
-
-:::warning 注意
-需要在 bump 命令之前执行。
-:::
-
-``` markdown
-## Features:
-
-[[#1160](https://github.com/modern-js-dev/modern.js/pull/1160)] export ExecaError type
-
-## Bug Fix:
-
-[[#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/index.md

@@ -1,12 +0,0 @@
----
-type: ref
----
-
-# 命令
-
-本节涵盖了使用Monorepo工程的所有命令。
-
-
-
-
-

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

@@ -1,21 +0,0 @@
----
-sidebar_position: 6
----
-
-```bash
-Usage: modern lint [options] [...files]
-
-lint and fix source files
-
-Options:
-  --no-fix    disable auto fix source file
-  -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

@@ -1,41 +0,0 @@
----
-sidebar_position: 1
----
-
-```bash
-Usage: modern new [options]
-
-Monorepo 创建子项目
-
-Options:
-  -d, --debug            开启 Debug 模式，打印调试日志信息 (default: false)
-  -c, --config <config>  生成器运行默认配置(JSON 字符串)
-  --dist-tag <tag>       生成器使用特殊的 npm Tag 版本
-  --registry             生成器运行过程中定制 npm Registry
-  -h, --help             display help for command
-```
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />
-
-`modern new` 命令在 monorepo 中可以用来添加应用工程和可复用的模块：
-
-```bash
-$ modern new
-? 请选择你想创建的工程类型 (Use arrow keys)
-❯ 应用
-  应用（测试）
-  模块
-  模块（内部）
-```
-
-应用工程默认会添加到 `apps` 目录， 测试应用会添加到 `examples` 目录，公共模块默认会添加到 `packages` 目录， 内部模块默认会添加到 `features` 目录。
-
-内部模块在 monorepo 的应用里面使用时，可以无需构建直接使用源码。
-
-:::caution 注意
-`--config` 参数对应参数值需要使用 JSON 字符串。
-
-pnpm 暂不支持使用 JSON 字符串作为参数值，可使用 `npm new` 开启相关功能。【[相关 Issue](https://github.com/pnpm/pnpm/issues/3876)】
-:::

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

@@ -1,68 +0,0 @@
----
-sidebar_position: 3
----
-
-```bash
-Usage: modern pre [options] <enter|exit> [tag]
-
-进入和退出预发布模式
-
-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>` 进入预发布模式:
-
-```bash
-$ npx modern pre enter next
-🦋  success Entered pre mode with tag next
-🦋  info Run `changeset version` to version packages with prerelease versions
-```
-
-之后通过 `modern change` 命令添加 changeset:
-
-```bash
-$ npx modern change
-🦋  Which packages would you like to include? · package-a, package-b
-🦋  Which packages should have a major bump? · No items were selected
-🦋  Which packages should have a minor bump? · No items were selected
-🦋  The following packages will be patch bumped:
-🦋  package-a@0.1.1
-🦋  package-b@0.1.1
-🦋  Please enter a summary for this change (this will be in the changelogs). Submit empty line to open external editor
-🦋  Summary · test pre publish
-🦋  === Releasing the following packages ===
-🦋  [Patch]
-🦋    package-a, package-b
-🦋  ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
-🦋  ║                                                      ========= NOTE ========                                                       ║
-🦋  ║All dependents of these packages that will be incompatible with the new version will be patch bumped when this changeset is applied.║
-🦋  ╚════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╝
-🦋  Is this your desired changeset? (Y/n) · true
-🦋  Changeset added! - you can now commit it
-🦋
-🦋  If you want to modify or expand on the changeset summary, you can find it here
-🦋  info /xxxxxx/monorepo/.changeset/beige-paws-rule.md
-```
-
-接着可以使用 `modern bump` 命令更新具体的版本号：
-
-```bash
-$ npx modern bump
-🦋  warn ===============================IMPORTANT!===============================
-🦋  warn You are in prerelease mode
-🦋  warn If you meant to do a normal release you should revert these changes and run `changeset pre exit`
-🦋  warn You can then run `changeset version` again to do a normal release
-🦋  warn ----------------------------------------------------------------------
-🦋  All files have been updated. Review them and commit at your leisure
-```
-
-可以看到 `package-a` 和 `package-b` 的 `package.json` 中版本号均已更新到 `0.1.2-next.0`。
-
-提交完变更之后，我们可以通过 `modern pre exit` 命令退出预发布模式。

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

@@ -1,20 +0,0 @@
----
-sidebar_position: 5
----
-
-
-```bash
-Usage: modern release [options]
-
-publish changes to npm
-
-Options:
-  --tag <tag>  publish use special tag (default: "")
-  -h, --help   display help for command
-```
-
-发布当前仓库的 Packages 至 NPM。
-
-import CommandTip from '@site-docs/components/command-tip.md'
-
-<CommandTip />

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

@@ -1,23 +0,0 @@
----
-sidebar_position: 11
----
-
-```
-Usage: modern upgrade [options]
-
-升级 Modern.js 到最新版本
-
-Options:
-  --registry <registry>  定制 npm registry (default: "")
-  -d,--debug             开启 Debug 模式，打印调试日志信息 (default: false)
-  --cwd <cwd>            项目路径 (default: "")
-  -h, --help             display help for command
-```
-
-`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/apis/monorepo/hooks/apps.md

@@ -1,12 +0,0 @@
----
-title: apps/*
-sidebar_position: 1
----
-
-Monorepo 工程方案应用类型项目目录。
-
-Modern.js Monorepo 工程方案约定将应用类型子项目放置在 `apps` 目录下进行统一管理，`apps` 目录下每一个文件夹都是一个完整的应用项目。
-
-:::info 注
-可直接在项目下执行 new 命令创建应用类型子项目。
-:::

package/zh/apis/monorepo/hooks/code-workspace.md

@@ -1,10 +0,0 @@
----
-title: monorepo.code-workspace
-sidebar_position: 7
----
-
-Monorepo 工程方案 VS Code 配置文件。
-
-Monorepo 工程方案支持 VS Code Workspace 配置，可以通过该配置文件打开的一个或多个文件夹的集合。
-
-VS Code workspace 协议详情可查看: [VS Code Workspace](https://code.visualstudio.com/docs/editor/workspaces)

package/zh/apis/monorepo/hooks/examples.md

@@ -1,14 +0,0 @@
----
-title: examples/*
-sidebar_position: 2
----
-
-Monorepo 工程方案测试应用类型项目目录。
-
-Modern.js Monorepo 工程方案约定将测试的应用类型子项目放置在 `examples` 目录下进行统一管理，`examples` 目录下每一个文件夹都是一个完整的应用项目。
-
-测试类型的应用项目不包含部署相关的 scripts 命令，用于开发过程中进行测试项目、测试案例的编写。
-
-:::info 注
-可直接在项目下执行 new 命令创建测试应用类型子项目。
-:::

package/zh/apis/monorepo/hooks/features.md

@@ -1,14 +0,0 @@
----
-title: features/
-sidebar_position: 3
----
-
-Monorepo 工程方案内部模块类型项目目录。
-
-Modern.js Monorepo 工程方案约定将内部模块类型子项目放置在 `features` 目录下进行统一管理，`features` 目录下每一个文件夹都是一个完整的模块项目。
-
-内部模块项目用于一些不需要编译的公共的组件和工具的编写，这类型的项目不包含编译、发布命令，在应用类型项目中引用时，应用类型项目会默认对其进行编译。
-
-:::info 注
-可直接在项目下执行 new 命令内部模块类型子项目。
-:::

package/zh/apis/monorepo/hooks/index.md

@@ -1,12 +0,0 @@
----
-type: ref
----
-
-# 命令
-
-本节涵盖了使用Monorepo工程所有的文件约定
-
-
-
-
-

package/zh/apis/monorepo/hooks/packages.md

@@ -1,14 +0,0 @@
----
-title: packages/
-sidebar_position: 4
----
-
-Monorepo 工程方案公共模块类型项目目录。
-
-Modern.js Monorepo 工程方案约定将公共模块类型子项目放置在 `packages` 目录下进行统一管理，`packages` 目录下每一个文件夹都是一个完整的模块项目。
-
-公共模块项目用户一些公共的组件和工具的编写，这些公共包可自行进行编译和发布，也可在应用类型项目中引用。
-
-:::info 注
-可直接在项目下执行 new 命令创建模块类型子项目。
-:::

package/zh/apis/monorepo/hooks/pnpm-workspace.md

@@ -1,10 +0,0 @@
----
-title: pnpm-workspace.yaml
-sidebar_position: 5
----
-
-Monorepo 工程方案 pnpm workspace 配置文件。
-
-Monorepo 工程方案支持使用 pnpm 作为包管理工具对项目进行管理，支持 pnpm 的 workspace 协议。
-
-pnpm workspace 配置详情可查看: [pnpm workspace](https://pnpm.io/workspaces)

package/zh/apis/monorepo/hooks/pnpmfile.md

@@ -1,10 +0,0 @@
----
-title: .pnpmfile.cjs
-sidebar_position: 6
----
-
-Monorepo 工程方案 pnpm 钩子文件。
-
-Monorepo 工程方案支持使用 pnpm 作为包管理工具对项目进行管理，支持使用 pnpm 的钩子文件对安装过程进行自定义。
-
-pnpm .pnpmfile.cjs 使用详情可查看: [pnpmfile](https://pnpm.io/pnpmfile)

package/zh/components/command-tip.md

@@ -1,57 +0,0 @@
-:::tip 提示
-pnpm v6 和 pnpm v7 版本在执行命令时使用姿势不完全一致，需要注意以下事项：
-
-pnpm v7：
-
-在使用 pnpm 调用 `package.json` 中的命令时，如果需要传递参数至 pnpm，需要将参数放到命令前。
-
-例如使用 pnpm `--filter` 参数执行 prepare 命令：
-
-```bash
-pnpm run --filter "./packages/**" prepare
-```
-
-如果需要传递参数至命令，需要将参数放到命令后。
-
-例如，在如下 `package.json` 配置中：
-
-``` json
-{
-  "scripts": {
-    "command": "modern command"
-  }
-}
-```
-
-执行 command 命令时携带参数方式为：
-```bash
-pnpm run command --options
-```
-
-pnpm v6:
-
-在如下 `package.json` 配置中：
-
-``` json
-{
-  "scripts": {
-    "command": "modern command"
-  }
-}
-```
-
-当需要执行 `modern command --option`：
-
-使用 pnpm 时，需要执行 `pnpm run command -- --option`。
-
-这是因为 pnpm 对于命令参数的处理与 Yarn 并不相同，但是与 npm 类似：在不加 `--` 字符串的时候，传递的是 pnpm 的参数；在使用 `--` 字符串的时候，传递的是执行脚本的参数。
-
-在上述例子里参数 `--option` 传递给了 `modern command`。如果执行 `pnpm run command --option`，则参数 `--option` 将传递给 pnpm。
-
-总结来说：
-
-**在使用 pnpm v7 时，如果传递参数给 pnpm，需要将参数放置到命令前**
-
-**在使用 pnpm v6 时，如果传递的参数给 pnpm，不需要加 `--`；如果传递的参数是给脚本使用，需要增加 `--` 字符串**。
-
-:::

package/zh/components/enable-bff.md

@@ -1,36 +0,0 @@
-1. 执行 `pnpm new`，选择启用 BFF
-2. 根据选择的运行时框架，将下面的代码添加到 `modern.config.[tj]s` 中：
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs>
-  <TabItem value="express" label="Express.js" default>
-
-```ts title="modern.config.ts"
-import ExpressPlugin from '@modern-js/plugin-express';
-import BffPlugin from '@modern-js/plugin-bff';
-
-export default defineConfig({
-  plugins: [
-    ExpressPlugin(),
-    BffPlugin()
-  ]
-})
-```
-  </TabItem>
-  <TabItem value="koa" label="Koa.js">
-
-```ts title="modern.config.ts"
-import KoaPlugin from '@modern-js/plugin-koa';
-import BffPlugin from '@modern-js/plugin-bff';
-
-export default defineConfig({
-  plugins: [
-    KoaPlugin(),
-    BffPlugin()
-  ]
-})
-```
-  </TabItem>
-</Tabs>

package/zh/components/enable-micro-frontend.md

@@ -1,13 +0,0 @@
-```javascript title="modern.config.ts"
-import AppToolPlugin, { defineConfig } from '@modern-js/app-tools';
-import GarfishPlugin from '@modern-js/plugin-garfish';
-
-export default defineConfig({
-  runtime: {
-    router: true,
-    state: true,
-    masterApp: true,
-  },
-  plugins: [AppToolPlugin(), GarfishPlugin()],
-});
-```