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

package/zh/guides/topic-detail/changesets/commit.md

@@ -16,6 +16,7 @@ Changesets 支持配置 `commit` 为 true 时，在执行 `change` 和 `bump`
 ## 自定义 commit 信息内容
 
 commit 信息分为两种：
+
 - 执行 `change` 命令时自动生成的 commit 信息。
 - 执行 `bump` 命令时自动生成的 commit 信息。
 
@@ -29,15 +30,15 @@ commit 信息分为两种：
 
 当前创建的 chagneset 信息
 
-```typescript
+```ts
 type Release = {
-    name: string;
-    type: VersionType;
+  name: string;
+  type: VersionType;
 };
 
 type Changeset = {
-    summary: string;
-    releases: Array<Release>;
+  summary: string;
+  releases: Array<Release>;
 };
 ```
 
@@ -55,16 +56,16 @@ commit 信息内容。
 
 `@changesets/cli/commit` 默认处理逻辑为以 `docs(changeset):` 开头，commit 信息为 changeset 的 `summary`，并根据传入的 `skipCI` 参数配置添加 [skip ci] 信息。
 
-```typescript
-type SkipCI = boolean | "add" | "version";
+```ts
+type SkipCI = boolean | 'add' | 'version';
 
 const getAddMessage = async (
   changeset: Changeset,
-  options: { skipCI?: SkipCI } | null
+  options: { skipCI?: SkipCI } | null,
 ) => {
-  const skipCI = options?.skipCI === "add" || options?.skipCI === true;
+  const skipCI = options?.skipCI === 'add' || options?.skipCI === true;
   return outdent`docs(changeset): ${changeset.summary}${
-    skipCI ? `\n\n[skip ci]\n` : ""
+    skipCI ? `\n\n[skip ci]\n` : ''
   }`;
 };
 ```
@@ -77,41 +78,41 @@ const getAddMessage = async (
 
 - releasePlan
 
-```typescript
-type VersionType = "major" | "minor" | "patch" | "none";
+```ts
+type VersionType = 'major' | 'minor' | 'patch' | 'none';
 
 type Release = {
-    name: string;
-    type: VersionType;
+  name: string;
+  type: VersionType;
 };
 
 type Changeset = {
-    id: string;
-    summary: string;
-    releases: Array<Release>;
+  id: string;
+  summary: string;
+  releases: Array<Release>;
 };
 
 type ComprehensiveRelease = {
-    name: string;
-    type: VersionType;
-    oldVersion: string;
-    newVersion: string;
-    changesets: string[];
+  name: string;
+  type: VersionType;
+  oldVersion: string;
+  newVersion: string;
+  changesets: string[];
 };
 
 type PreState = {
-    mode: "pre" | "exit"; // pre 模式当前状态
-    tag: string; // pre 的类型
-    initialVersions: {
-        [pkgName: string]: string; // 版本升级前包名及版本号信息，Map 格式
-    };
-    changesets: string[]; // 本次升级的 changeset id 列表
+  mode: 'pre' | 'exit'; // pre 模式当前状态
+  tag: string; // pre 的类型
+  initialVersions: {
+    [pkgName: string]: string; // 版本升级前包名及版本号信息，Map 格式
+  };
+  changesets: string[]; // 本次升级的 changeset id 列表
 };
 
 type ReleasePlan = {
-    changesets: Changeset[]; // 本次升级的 changeset 列表
-    releases: ComprehensiveRelease[]; // 当前升级的包信息，包含包名称、当前版本、升级后版本、升级类型等
-    preState: PreState | undefined; // 当前如果为 pre 发布，提供相关状态信息
+  changesets: Changeset[]; // 本次升级的 changeset 列表
+  releases: ComprehensiveRelease[]; // 当前升级的包信息，包含包名称、当前版本、升级后版本、升级类型等
+  preState: PreState | undefined; // 当前如果为 pre 发布，提供相关状态信息
 };
 ```
 
@@ -129,27 +130,27 @@ commit 信息内容。
 
 `@changesets/cli/commit` 默认处理逻辑为：先展示当前需要 release 的包数量，再展示 release 包的名称及新版本号，并根据传入的 `skipCI` 参数配置添加 [skip ci] 信息。
 
-```typescript
+```ts
 const getVersionMessage = async (
   releasePlan: ReleasePlan,
-  options: { skipCI?: SkipCI } | null
+  options: { skipCI?: SkipCI } | null,
 ) => {
-  const skipCI = options?.skipCI === "version" || options?.skipCI === true;
+  const skipCI = options?.skipCI === 'version' || options?.skipCI === true;
   const publishableReleases = releasePlan.releases.filter(
-    release => release.type !== "none"
+    release => release.type !== 'none',
   );
   const numPackagesReleased = publishableReleases.length;
 
   const releasesLines = publishableReleases
     .map(release => `  ${release.name}@${release.newVersion}`)
-    .join("\n");
+    .join('\n');
 
   return outdent`
     RELEASING: Releasing ${numPackagesReleased} package(s)
 
     Releases:
     ${releasesLines}
-    ${skipCI ? `\n[skip ci]\n` : ""}
+    ${skipCI ? `\n[skip ci]\n` : ''}
 `;
 };
 ```
@@ -164,14 +165,13 @@ Changesets 配置文件中 `commit` 字段，该字段用于标记是否需要
 
 该配置还支持配置数组，数组中第一个元素为获取 commit 信息模块的模块名称或者路径，第二个元素为传入对应函数的参数值，会作为 `getAddMessage` 和 `getVersionMessage` 函数的第二个参数传入。
 
-
 ### 配置相对路径
 
 commit 配置如果为相对路径为 `.changesets` 目录下的相对路径。
 
 例如创建 .changeset/my-commit-config.js 文件，定义如下内容：
 
-```javascript title=".changeset/my-commit-config.js"
+```js title=".changeset/my-commit-config.js"
 async function getAddMessage(changeset, options) {}
 
 async function getVersionMessage(releasePlan, options) {}
@@ -199,7 +199,7 @@ commit 配置为 ./my-commit-config.js 即可:
 
 #### 使用 `npx @modern-js/create` 创建模块工程方案。
 
-``` md
+```md
 ? 请选择你想创建的工程类型 模块
 ? 请填写项目名称 custom-commit
 ? 请选择开发语言 TS
@@ -208,16 +208,16 @@ commit 配置为 ./my-commit-config.js 即可:
 
 #### 实现自定义内容。
 
-```typescript title="src/index.ts"
+```ts title="src/index.ts"
 export async function getAddMessage() {}
 
 export async function getVersionMessage() {}
-
 ```
 
 #### 将模块发布到 NPM。
 
 #### 在目标仓库根目录安装对应模块，例如 custom-commit。
+
 #### 配置 changeset 的 commit 配置为包名称。
 
 ```json title="package.json"
@@ -233,7 +233,7 @@ export async function getVersionMessage() {}
 
 #### 执行 `pnpm run new` 创建模块子项目。
 
-``` md
+```md
 ? 请选择你想创建的工程类型 模块
 ? 请填写子项目名称 custom-commit
 ? 请填写子项目目录名称 custom-commit
@@ -242,11 +242,10 @@ export async function getVersionMessage() {}
 
 #### 实现自定义内容。
 
-```typescript title="src/index.ts"
+```ts title="src/index.ts"
 export async function getAddMessage() {}
 
 export async function getVersionMessage() {}
-
 ```
 
 #### 在 Monorepo 根目录添加子项目模块依赖，例如 custom-commit。

package/zh/guides/topic-detail/changesets/config.md

@@ -89,6 +89,7 @@ sidebar_position: 5
 当执行 `bump` 命令升级版本号时，默认会自动更新仓库中使用该包的依赖声明。配置该字段为 `minor` 后，如果升级版本号为 `patch` 类型，将不会自动更新引用依赖声明。
 
 例如：
+
 ```
 pkg-a @ version 1.0.0
 pkg-b @ version 1.0.0
@@ -115,7 +116,7 @@ pkg-b @ version 1.0.0
 
 配置为数组时，第一个参数为自定义 NPM 包或者路径，第二个参数为需要传入的默认参数配置，自定义格式我们将在后续[自定义 Changelog](/docs/guides/topic-detail/changesets/changelog) 章节讲解。
 
-### ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
+### \_\_\_experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
 
 一些实验性配置。
 

package/zh/guides/topic-detail/changesets/github.md

@@ -24,7 +24,6 @@ sidebar_position: 9
 
 配置完成后，该机器人将会自动 check 每个 Pull Request 是否添加了 changeset，并通过回复的方式给到提示信息。
 
-
 #### 未添加 changeset
 
 ![未添加 changeset 状态](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-bot-no-changeset.png)
@@ -69,7 +68,7 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@master
         with:
-        # This makes Actions fetch only one branch to release
+          # This makes Actions fetch only one branch to release
           fetch-depth: 100
 
       - name: Create Release Pull Request
@@ -82,7 +81,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           REPOSITORY: ${{ github.repository }}
           REF: ${{ github.ref }}
-
 ```
 
 将 Workflow 合并到主分支后，进入 Github 仓库对应的 Action 页面，选择 Release Pull Request：
@@ -101,7 +99,6 @@ workflow 运行完成后将自动创建 `Release-${version}` 的 Pull Request，
 
 Modern.js 提供了自动创建发版 Pull Request 的 Github Action，提供基于选择的分支自动执行 release 操作，将包发布到 NPM 上。
 
-
 #### 使用
 
 在仓库中创建 `.github/workflows/release.yml` 文件，填入以下内容：
@@ -118,10 +115,10 @@ on:
         required: true
         default: 'canary'
         options:
-        - canary
-        - alpha
-        - pre
-        - latest
+          - canary
+          - alpha
+          - pre
+          - latest
       branch:
         description: 'Release Branch(confirm release branch)'
         required: true
@@ -135,7 +132,7 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@master
         with:
-        # This makes Actions fetch only one branch to release
+          # This makes Actions fetch only one branch to release
           fetch-depth: 1
 
       - name: Release
@@ -150,7 +147,6 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           REPOSITORY: ${{ github.repository }}
           REF: ${{ github.ref }}
-
 ```
 
 配置仓库的 NPM_TOKEN:

package/zh/guides/topic-detail/changesets/introduce.md

@@ -22,7 +22,6 @@ Modern.js 默认创建的模块和 Monorepo 工程方案项目已经初始化完
 
 并且，Modern.js 在其对应的工程方案工具 `@modern-js/module-tools` 和 `@modern-js/monorepo-tools` 提供了 Changesets 相应的命令，无需再手动安装 Changesets 相关依赖。
 
-
 Changesets 默认配置如下：
 
 ```json title=".changeset/config.json"

package/zh/guides/topic-detail/changesets/release-note.md

@@ -40,7 +40,7 @@ Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在
 
 初步解析 commit 获取基本信息。
 
-```typescript
+```ts
 interface Commit {
   id: string; // commit id
   type: 'feature' | 'fix'; // commit 类型，默认通过开头字符串如果为 fix，类型为 fix，其他为 feature
@@ -61,7 +61,7 @@ commitObj， 补充后完整的 commit 对象。
 
 Modern.js 的默认实现为：根据 commit 信息拆分出 Pull Request ID 和作者，加入到 commitObj 中。
 
-```typescript
+```ts
 function getReleaseInfo(commit: string, commitObj: Commit) {
   const commitRegex = /(.*)\(#(\d*)\)/;
 
@@ -103,7 +103,7 @@ function getReleaseInfo(commit: string, commitObj: Commit) {
 
 Modern.js 的默认实现为：
 
-```typescript
+```ts
 function formatSummary(summary: string, pullRequestId?: string) {
   const [firstLine, ...futureLines] = summary
     .split('\n')
@@ -157,7 +157,7 @@ custom 参数值如果为相对路径为**项目跟目录**。
 
 例如创建 `scripts/my-release-note-config.js` 文件，定义如下内容：
 
-```typescript title="scripts/my-release-note-config.js"
+```ts title="scripts/my-release-note-config.js"
 function getReleaseInfo(commit, commitObj) {
   return commitObj;
 }
@@ -168,7 +168,6 @@ module.exports = {
   getReleaseInfo,
   getReleaseNoteLine,
 };
-
 ```
 
 执行下面命令：
@@ -197,7 +196,7 @@ custom 参数值还可以使用模块工程方案进行管理，提供通用方
 
 1. 使用 npx @modern-js/create 创建模块工程方案。
 
-``` md
+```md
 ? 请选择你想创建的工程类型 模块
 ? 请填写项目名称 custom-release-note
 ? 请选择开发语言 TS
@@ -206,11 +205,10 @@ custom 参数值还可以使用模块工程方案进行管理，提供通用方
 
 2. 实现自定义内容。
 
-```typescript title="src/index.ts"
+```ts title="src/index.ts"
 export function getReleaseInfo() {}
 
 export function getReleaseNoteLine() {}
-
 ```
 
 3. 将模块发布到 NPM。
@@ -221,13 +219,13 @@ export function getReleaseNoteLine() {}
 pnpm run gen-release-note -- --custom custom-release-note
 ```
 
-### 使用Monorepo 工程方案
+### 使用 Monorepo 工程方案
 
 如果你当前仓库为 Monorepo 工程方案，可以直接使用模块子项目进行管理。
 
 1. 执行 `pnpm run new` 创建模块子项目
 
-``` md
+```md
 ? 请选择你想创建的工程类型 模块
 ? 请填写子项目名称 custom-release-note
 ? 请填写子项目目录名称 custom-release-note
@@ -236,11 +234,10 @@ pnpm run gen-release-note -- --custom custom-release-note
 
 2. 实现自定义内容。
 
-```typescript title="src/index.ts"
+```ts title="src/index.ts"
 export function getReleaseInfo() {}
 
 export function getReleaseNoteLine() {}
-
 ```
 
 3. 在 Monorepo 根目录添加子项目模块依赖，例如 `custom-release-note`。

package/zh/guides/topic-detail/changesets/release-pre.md

@@ -12,7 +12,6 @@ sidebar_position: 4
 以下示例命令都以 pnpm 作为包管理工具进行，如果需要使用其他包管理工具，请按需求进行替换。
 :::
 
-
 #### 执行以下命令升级预发布版本版本号：
 
 ```bash
@@ -22,6 +21,7 @@ pnpm run bump -- --canary --preid <preid>
 `preid` 为预发布版本标记，例如 `alpha`、`beta` 等，默认值为 `next`。
 
 使用 `--canary` 参数后，`bump` 命令由以下三个步骤完成：
+
 - `changeset pre enter <preid>` 进入预发布模式
 
 - `changeset version` 升级版本号

package/zh/guides/topic-detail/framework-plugin/extend.md

@@ -19,7 +19,7 @@ $ npx @modern-js/create modern-js-demo
 
 我们先创建一个 Hook 模型：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 import { createWaterfall } from '@modern-js/plugin';
 
 const message = createWaterfall<string[]>();
@@ -27,7 +27,7 @@ const message = createWaterfall<string[]>();
 
 然后注册它：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 import type { CliPlugin } from '@modern-js/core';
 
 export default (): CliPlugin => ({
@@ -41,7 +41,7 @@ export default (): CliPlugin => ({
 
 添加 Hook 类型：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 declare module '@modern-js/core' {
   export interface Hooks {
     message: typeof message;
@@ -53,7 +53,7 @@ declare module '@modern-js/core' {
 
 创建插件，通过 `commands` Hook 函数，添加命令处理逻辑：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 import type { CliPlugin } from '@modern-js/core';
 
 export default (): CliPlugin => ({
@@ -73,9 +73,9 @@ export default (): CliPlugin => ({
 });
 ```
 
-最后 `config/plugin/MyPlugin.ts` 的状态是：
+最后 `config/plugin/myPlugin.ts` 的状态是：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 import { createWaterfall } from '@modern-js/plugin';
 import type { CliPlugin } from '@modern-js/core';
 
@@ -112,10 +112,10 @@ declare module '@modern-js/core' {
 
 ```ts title="modern.config.ts"
 import { defineConfig } from '@modern-js/app-tools';
-import MyPlugin from './config/plugin/MyPlugin';
+import myPlugin from './config/plugin/myPlugin';
 
 export default defineConfig({
-  plugins: [MyPlugin()],
+  plugins: [myPlugin()],
 });
 ```
 
@@ -123,11 +123,11 @@ export default defineConfig({
 
 那这里我们添加一个：
 
-```ts title=config/plugin/OtherPlugin.ts
+```ts title=config/plugin/otherPlugin.ts
 import type { CliPlugin } from '@modern-js/core';
 
 export default (): CliPlugin => ({
-  name: 'my-plugin',
+  name: 'other-plugin',
 
   setup(api) {
     return {
@@ -143,11 +143,11 @@ export default (): CliPlugin => ({
 
 ```ts title="modern.config.ts"
 import { defineConfig } from '@modern-js/app-tools';
-import MyPlugin from './config/plugin/MyPlugin';
-import OtherPlugin from './config/plugin/OtherPlugin';
+import myPlugin from './config/plugin/myPlugin';
+import otherPlugin from './config/plugin/otherPlugin';
 
 export default defineConfig({
-  plugins: [MyPlugin(), OtherPlugin()],
+  plugins: [myPlugin(), otherPlugin()],
 });
 ```
 

package/zh/guides/topic-detail/framework-plugin/hook-list.md

@@ -149,10 +149,10 @@ export default (): CliPlugin => ({
 将上面这个插件添加到 `modern.config.ts` 中：
 
 ```ts title="modern.config.ts"
-import MyPlugin from './config/plugin/MyPlugin';
+import myPlugin from './config/plugin/myPlugin';
 
 export default defineConfig({
-  plugins: [MyPlugin()],
+  plugins: [myPlugin()],
 });
 ```