@modern-js/main-doc 2.51.0 → 2.53.0

package/docs/zh/guides/topic-detail/monorepo/publish.mdx

@@ -1,69 +0,0 @@
----
-sidebar_position: 4
----
-
-# 可复用模块的发布
-
-在 Monorepo 中有时会需要把多个模块项目发布到 [NPM](https://www.npmjs.com/) 上，本章将要介绍如果在 Monorepo 中对子项目进行版本更新以及发布。
-
-## 准备工作
-
-接着 [子项目联调](/guides/topic-detail/monorepo/sub-project-interface) 章节的例子，我们对 `components` 模块进行发布。
-
-## 生成变更记录
-
-在开发阶段，当某个模块的功能开完完成之后，一般需要提交代码（例如提交到 [GitHub](https://github.com/) 上）并需要记录本次修改的内容。在 Modern.js 的 Monorepo 工程中，我们可以在 monorepo 根目录执行命令：
-
-```
-pnpm run change
-```
-
-然后根据提示选择变更或者将要发布的包以及选择包升级的版本，并填写变更信息。变更信息的内容可以包含此次开发的功能、修复的问题等。
-
-那么对于上面的例子，我们选择变更的项目为 `components`，并填写此次变更的内容：
-
-```
-$ modern change
-🦋  Which packages would you like to include? · components
-🦋  Which packages should have a major bump? · No items were selected
-🦋  Which packages should have a minor bump? · components
-🦋  Please enter a summary for this change (this will be in the changelogs). Submit empty line to open external editor
-🦋  Summary · add features
-🦋  === Releasing the following packages ===
-🦋  [Minor]
-🦋    components
-🦋  ╔════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗
-🦋  ║                                                      ========= 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 /Users/demo/modern-js/official/monorepo-pnpm/.changeset/silent-tigers-run.md
-```
-
-该命令完成后，在 `.changeset` 中会有新的 `silent-tigers-run.md` 文件生成，其中包含了刚刚填写的信息，这些新生成的文件将用于后面发布流程中使用。**因此在提交代码的时候，需要将`.changeset` 目录下的文件一并提交**。
-
-## 版本更新
-
-在模块发布之前，还需要将模块的版本进行更新。。在 Modern.js 的 Monorepo 工程中，可以在 Monorepo 项目根目录下执行：
-
-```
-pnpm run bump
-```
-
-该命令会根据之前生成在 `.changeset` 目录下的文件自动更新对应模块的版本号和 CHANGELOG 信息，执行成功后会看到：
-
-```
-🦋  All files have been updated. Review them and commit at your leisure
-```
-
-## 发布
-
-最后执行 `pnpm run prepare --filter {./packages} && pnpm run release`，便可以发布对应的模块了。
-
-:::info 补充信息
-在上面的命令中 --filter \{./packages\} 用于筛选位于 `./packages` 目录下的子项目，可以通过 [PNPM Filtering](https://pnpm.io/filtering) 来了解更多它的使用。
-
-:::

package/docs/zh/guides/topic-detail/monorepo/sub-project-interface.mdx

@@ -1,143 +0,0 @@
----
-sidebar_position: 3
----
-
-# 子项目联调
-
-本章将要介绍如何在 Monorepo 下进行子项目之间的联调使用。
-
-## 准备工作
-
-按照 [「创建子项目」](/guides/topic-detail/monorepo/create-sub-project) 章节的介绍（如果还没有看过，可以先了解一下），我们首先创建以下三个子项目：
-
-- 一个「应用」子项目
-- 一个「模块」子项目
-
-执行 `pnpm run new`，并按照如下进行选择：
-
-**「应用」子项目：**
-
-```
-? 请选择你想创建的工程类型：Web 应用
-? 请填写子项目名称：app
-? 请填写子项目目录名称：app
-? 请选择开发语言：TS
-```
-
-**「模块」子项目：**
-
-```
-? 请选择你想创建的工程类型：Npm 模块
-? 请填写子项目名称：components
-? 请填写子项目目录名称：components
-? 请选择开发语言：TS
-```
-
-创建成功后，会得到以下项目：
-
-- `./apps/app`
-- `./packages/components`
-
-然后修改一下默认的代码和新增文件：
-
-**重命名 `./packages/components/src/index.tsx`**
-
-```tsx
-import './index.css';
-
-export default function ({ text }: { text: string }) {
-  return (
-    <div>
-      This is UI Components Log: <p className="log">{text}</p>
-    </div>
-  );
-}
-```
-
-**新增 `./packages/components/src/index.css`**
-
-```css
-.log {
-  color: gray;
-}
-```
-
-**修改 `./apps/app/src/App.tsx`**
-
-```tsx
-import { Switch, Route } from '@modern-js/runtime/router';
-import Comp from 'components';
-
-import './App.css';
-
-const App = () => (
-  <Switch>
-    <Route exact={true} path="/">
-      <div className="container-box">
-        <Comp text="hello world" />
-        {/* 省略... */}
-      </div>
-    </Route>
-    <Route path="*">
-      <div>404</div>
-    </Route>
-  </Switch>
-);
-
-export default App;
-```
-
-到此为止我们创建了一个可以被发布到外部的组件项目以及一个使用组件的应用项目，如果直接运行应用项目还暂时无法正常使用。接下来将要介绍如何让它们能够互相联调使用，成功的使应用子项目 `apps/app` 正常运行。
-
-:::info
-启动 `apps/app` 项目之前需要先构建（`pnpm run build`） `packages/component`。
-
-:::
-
-由于 Modern.js 支持 pnpm 与 Yarn 的 Monorepo 工程，接下来会从这两个方面分别介绍。
-
-## 在使用 pnpm 的 Monorepo 中进行项目联调
-
-在 pnpm 的 Monorepo 项目中，我们通过在 `apps/app` 子项目下执行以下命令，将 `packages/components` 子项目加入到应用的依赖列表当中。
-
-```
-pnpm add components
-```
-
-执行成功后，在 `apps/app/package.json` 会发生如下变化：
-
-```json
-{
-  "dependencies": {
-++  "components": "workspace:^0.1.0"
-  },
-}
-```
-
-:::info 补充信息
-`workspace:^0.1.0` 是一种 PNPM 提供的 [Workspace 协议](https://pnpm.io/workspaces#workspace-protocol-workspace)。
-
-:::
-
-当依赖安装成功之后，我们还需要将 `packages/components` 进行构建，因为需要使用其构建产物。
-
-到此为止，`app/apps` 应用子项目可以正常的运行了。在修改 `packages/components` 的源码并构建之后，会触发应用子项目的热更新。
-
-## 在使用 Yarn 的 Monorepo 中进行项目联调
-
-在 Yarn 的 Monorepo 项目中，默认情况下可以直接在 `apps/app` 应用项目中直接使用组件项目。
-
-:::info 补充信息
-之所以可以直接在应用中使用组件项目，是因为 Yarn 将这些子项目模块提升到了顶层的 `node_modules`内。
-
-:::
-
-但是考虑到依赖关系的严谨性，建议在 `apps/app/package.json` 中进行显式依赖声明：
-
-```json
-{
-  "dependencies": {
-++  "components": "0.1.0"
-  },
-}
-```