npm - @modern-js/main-doc - Versions diffs - 2.52.0 → 2.54.0 - Mend

@modern-js/main-doc 2.52.0 → 2.54.0

Files changed (77) hide show

package/docs/zh/guides/topic-detail/changesets/add.mdx DELETED Viewed

@@ -1,126 +0,0 @@
----
-sidebar_position: 2
----
-# 添加 Changesets
-当我们开发完成时，需要添加一个 changeset 声明当前变更，用于后续版本发布。
-## 信息
-一个 changeset 包含的内容包括：
-- 本次变更涉及哪些包的变更。
-- 本次变更需要升级的版本号类型，类型符合 [semver](https://semver.org/) 规范。
-- 本次变更的 changelog 信息。
-## 步骤
-:::info
-以下示例命令都以 pnpm 作为包管理工具进行，如果需要使用其他包管理工具，请按需求进行替换。
-:::
-### Modern.js Module
-#### 在根目录执行 change 命令
-```bash
-pnpm run change
-```
-#### 选择本次变更需要升级的版本号类型
-![选择版本类型](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-select-version.png)
-#### 填入 changelog 信息，并点击两次回车：
-![写入变更信息](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-input-changelog.png)
-执行完成后，将在项目的 `.changeset` 目录创建对应的 changeset 文件，文件内容如下：
-```markdown
----
-'module-changeset': patch
----
-feat: test module solution changeset
-```
-该文件中包含了 changeset 的所有信息。
-### Monorepo 工程方案
-我们假设 monorepo 中存在三个模块包，分别为 `module-1`，`module-2`，`module-3`。
-#### 在根目录执行 change 命令
-```bash
-pnpm run change
-```
-#### 选择本次需要升级的包列表
-Changesets 会根据当前代码变更(`git diff Head...baseBranch`)，将 Monorepo 中的 package 分为两类，`changed packages` 和 `unchanged packages`，方便用户进行选择。
-使用空格键选择对应的包或者分类即可，选择完成后点击回车：
-![选择升级包](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-select-packages.png)
-#### 分别选择不同版本类型对应的包
-changeset 会询问 `major` 和 `minor` 类型，如果存在包未选择这两种类型，将会默认使用 `patch` 类型。
-![选择升级包版本类型](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-auto-select-patch.png)
-#### 填入 changelog 信息
-![写入变更信息](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-input-changelog-monorepo.png)
-执行完成后，将在项目的 `.changeset` 目录创建对应的 changeset 文件，文件内容如下：
-```markdown
----
-'module-2': minor
-'module-3': patch
----
-feat: test-changeset
-```
-该文件中包含了 changeset 的所有信息，不同的包也会根据选择的版本类型进行标记。
-## 参数
-change 命令支持以下参数：
-- `--empty`： 添加一个空的 changeset。
-```bash
-pnpm run change --empty
-```
-执行完成后，将在项目的 `.changeset` 目录创建空的 changeset 文件，文件内容如下：
-```markdown
----
----
-```
-- `--open`： 使用该参数时，在填写 changelog 步骤会打开系统默认编辑器进行填写。
-## 注意事项
-- 不是所有的变更都需要 changeset
-如果当前变更是修改仓库的一些基础设施，比如 CI、测试等，就不需要添加 changeset 或者可以添加一个空的 changeset。
-- 一个 pull reuqest 可以提交多个 changeset
-当一个 pull request 存在多个功能开发或者问题修复时，可以多次执行 `pnpm run change` 添加多个 changeset 文件，每个文件选择对应功能的包和添加变更信息即可。
-- 创建 changeset 时，需要选择该功能相关的所有包
-在 Monorepo 中创建 changeset 时，需要选中和该功能相关的所有变更包，避免出现发版时部分包未发布的情况。

package/docs/zh/guides/topic-detail/changesets/changelog.mdx DELETED Viewed

@@ -1,238 +0,0 @@
----
-sidebar_position: 6
----
-# 自定义 changelog 生成
-Changesets 默认会使用 `@changesets/cli/changelog` 生成 Changelog 信息，如果默认的 changelog 信息不能满足需求，可以自定义 changelog 的生成。
-## 自定义 changelog 内容
-changelog 信息主要包含以下两种信息：
-- changeset 中写入的 changelog 信息。
-- 本次版本升级关联包的版本变更信息。
-自定义逻辑主要实现两个函数，`getReleaseLine` 和 `getDependencyReleaseLine`，分别用来定义上述这两种信息。
-### getReleaseLine
-#### Params
-- changeset
-```ts
-export type VersionType = 'major' | 'minor' | 'patch' | 'none';
-export type Release = { name: string; type: VersionType };
-export type Changeset = {
-  id: string; // changeset 的文件名称
-  commit?: string; // changeset 提交时的 commit id 信息
-  summary: string; // changeset 内容信息
-  releases: Array<Release>; // 当前计算出的 changeset 升级包名称及类型信息
-};
-```
-- type
-当前包对应的升级版本类型，类型为上述 `VersionType`。
-#### 返回值
-changelog 内容。
-#### 默认实现
-`@changesets/cli/changelog` 默认处理逻辑为将 `summary` 信息按照换行符 `\n` 分割，第一样前面增加 `-` 作为列表开头，其他内容作为第一行内容的补充整理在列表下方。
-```ts
-async function getReleaseLine(changeset, type) {
-  const [firstLine, ...futureLines] = changeset.summary
-    .split('\n')
-    .map(l => l.trimRight());
-  let returnVal = `- ${
-    changeset.commit ? `${changeset.commit}: ` : ''
-  }${firstLine}`;
-  if (futureLines.length > 0) {
-    returnVal += `\n${futureLines.map(l => `  ${l}`).join('\n')}`;
-  }
-  return returnVal;
-}
-```
-### getDependencyReleaseLine
-#### Params
-- changesets
-当前关联的所有 changeset 信息，类型为 `getReleaseLine` changeset 类型数组。
-- dependenciesUpdated
-```ts
-type ModCompWithPackage = {
-  name: string; // 依赖模块名称
-  type: VersionType; // 依赖模块的升级类型
-  oldVersion: string; // 依赖模块当前版本号
-  newVersion: string; // 依赖模块新版本号
-  changesets: string[]; // 关联的 changeset id 列表
-  packageJson: PackageJSON; // 依赖模块完整的 package.json 内容
-  dir: string; // 依赖模块的路径(绝对路径)
-};
-type DependenciesUpdated = ModCompWithPackage[];
-```
-#### 返回值
-changelog 内容。
-#### 默认实现
-`@changesets/cli/changelog` 默认会使用 changesets 信息展示对应的 `Updated dependencies + commit id`，以列表形式展示。然后根据 `dependenciesUpdated` 信息展示对应的依赖包包名和新版本号，作为列表的子列表项。
-```ts
-async function getDependencyReleaseLine(changesets, dependenciesUpdated) {
-  console.log('getDependencyReleaseLine', changesets, dependenciesUpdated);
-  if (dependenciesUpdated.length === 0) return '';
-  const changesetLinks = changesets.map(
-    changeset =>
-      `- Updated dependencies${
-        changeset.commit ? ` [${changeset.commit}]` : ''
-      }`,
-  );
-  const updatedDepenenciesList = dependenciesUpdated.map(
-    dependency => `  - ${dependency.name}@${dependency.newVersion}`,
-  );
-  return [...changesetLinks, ...updatedDepenenciesList].join('\n');
-}
-```
-展示效果为：
-```markdown
-- Updated dependencies [f0438ab]
-- Updated dependencies [f0438ab]
-  - module-3@2.0.0
-  - module-1@0.2.0
-```
-## 配置
-Changesets 配置文件中 `changelog` 字段用于标记 changelog 信息的获取途径。
-该配置可以为字符串，直接声明获取 changelog 信息模块的模块名称或者路径。
-该配置还支持配置数组，数组中第一个元素为获取 changelog 信息模块的模块名称或者路径，第二个元素为传入对应函数的参数值，会作为 `getReleaseLine` 和 `getDependencyReleaseLine` 函数的第三个参数传入。
-### 配置相对路径
-changelog 配置如果为相对路径为 `.changesets` 目录下的相对路径。
-例如创建 `.changeset/my-changelog-config.js` 文件，定义如下内容：
-```ts title=".changeset/my-changelog-config.js"
-async function getReleaseLine(changeset, type) {}
-async function getDependencyReleaseLine(changesets, dependenciesUpdated) {}
-module.exports = {
-  getReleaseLine,
-  getDependencyReleaseLine,
-};
-```
-`changlog` 配置为 `./my-changelog-config.js` 即可:
-```json title=".changesets/config.json"
-{
-  "changelog": "./my-changelog-config.js",
-   ...
-}
-```
-### 使用 Modern.js Module
-自定义 changelog 还可以使用 Modern.js Module 方案进行管理，提供通用方案。
-#### 使用 `npx @modern-js/create@latest` 创建 Modern.js Module
-```md
-? 请选择你想创建的工程类型：Npm 模块
-? 请填写项目名称：custom-changelog
-? 请选择开发语言：TS
-? 请选择包管理工具：pnpm
-```
-#### 实现自定义内容
-```ts title="src/index.ts"
-export async function getReleaseLine() {}
-export async function getDependencyReleaseLine() {}
-```
-#### 将模块发布到 NPM
-#### 在目标仓库根目录安装对应模块，例如 `custom-changelog`
-#### 配置 changeset 的 changelog 配置为包名称
-```json title=".changesets/config.json"
-{
-  "changelog": "custom-changelog",
-   ...
-}
-```
-### 使用 Monorepo 工程方案
-如果你当前仓库为 Monorepo 工程方案，可以直接使用模块子项目进行管理。
-#### 执行 `pnpm run new` 创建模块子项目
-```md
-? 请选择你想创建的工程类型：Npm 模块
-? 请填写子项目名称：custom-changelog
-? 请填写子项目目录名称：custom-changelog
-? 请选择开发语言：TS
-```
-#### 实现自定义内容
-```ts title="src/index.ts"
-export async function getReleaseLine() {}
-export async function getDependencyReleaseLine() {}
-```
-#### 在 Monorepo 根目录添加子项目模块依赖，例如 `custom-changelog`
-```json title="package.json"
-{
-  "devDependencies": {
-    "custom-changelog": "workspace:*",
-    ...
-  }
-}
-```
-#### 配置 changeset 的 changelog 配置为包名称
-```json title=".changesets/config.json"
-{
-  "changelog": "custom-changelog",
-   ...
-}
-```
-该模块发布到 NPM 后，依然可以和模块类型一样供其他仓库使用。

package/docs/zh/guides/topic-detail/changesets/commit.mdx DELETED Viewed

@@ -1,269 +0,0 @@
----
-sidebar_position: 7
----
-# 自定义提交 commit 信息
-Changesets 支持配置 `commit` 为 true 时，在执行 `change` 和 `bump` 命令时自动提交当前变更。
-默认的 `commit` 信息由 `@changesets/cli/commit` 提供，默认信息格式为：
-![change commit](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-change-commit-info.png)
-![bump commit](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-bump-commit-info.png)
-当默认的 commit 信息不能满足需求时，支持自定义 commit 信息。
-## 自定义 commit 信息内容
-commit 信息分为两种：
-- 执行 `change` 命令时自动生成的 commit 信息。
-- 执行 `bump` 命令时自动生成的 commit 信息。
-自定义逻辑主要实现两个函数，`getAddMessage` 和 `getVersionMessage`，分别用来定义上述这两种信息。
-### getAddMessage
-#### Params
-- changeset
-当前创建的 chagneset 信息
-```ts
-type Release = {
-  name: string;
-  type: VersionType;
-};
-type Changeset = {
-  summary: string;
-  releases: Array<Release>;
-};
-```
-- options
-配置 commit 时的配置信息。
-> commit 配置为数组时，第二个参数支持传入默认的配置信息，会对应的使用该参数传递。
-#### 返回值
-commit 信息内容。
-#### 默认实现
-`@changesets/cli/commit` 默认处理逻辑为以 `docs(changeset):` 开头，commit 信息为 changeset 的 `summary`，并根据传入的 `skipCI` 参数配置添加 [skip ci] 信息。
-```ts
-type SkipCI = boolean | 'add' | 'version';
-const getAddMessage = async (
-  changeset: Changeset,
-  options: { skipCI?: SkipCI } | null,
-) => {
-  const skipCI = options?.skipCI === 'add' || options?.skipCI === true;
-  return outdent`docs(changeset): ${changeset.summary}${
-    skipCI ? `\n\n[skip ci]\n` : ''
-  }`;
-};
-```
-> [outdent](https://www.npmjs.com/package/outdent) 目的是删除模板字符串开头的空格内容，使 commit 信息更符合规范。
-### getVersionMessage
-#### Params
-- releasePlan
-```ts
-type VersionType = 'major' | 'minor' | 'patch' | 'none';
-type Release = {
-  name: string;
-  type: VersionType;
-};
-type Changeset = {
-  id: string;
-  summary: string;
-  releases: Array<Release>;
-};
-type ComprehensiveRelease = {
-  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 列表
-};
-type ReleasePlan = {
-  changesets: Changeset[]; // 本次升级的 changeset 列表
-  releases: ComprehensiveRelease[]; // 当前升级的包信息，包含包名称、当前版本、升级后版本、升级类型等
-  preState: PreState | undefined; // 当前如果为 pre 发布，提供相关状态信息
-};
-```
-- options
-配置 commit 时的其他参数。
-> commit 配置为数组时，第二个参数支持传入默认的配置信息，会对应的使用该参数传递。
-#### 返回值
-commit 信息内容。
-#### 默认实现
-`@changesets/cli/commit` 默认处理逻辑为：先展示当前需要 release 的包数量，再展示 release 包的名称及新版本号，并根据传入的 `skipCI` 参数配置添加 [skip ci] 信息。
-```ts
-const getVersionMessage = async (
-  releasePlan: ReleasePlan,
-  options: { skipCI?: SkipCI } | null,
-) => {
-  const skipCI = options?.skipCI === 'version' || options?.skipCI === true;
-  const publishableReleases = releasePlan.releases.filter(
-    release => release.type !== 'none',
-  );
-  const numPackagesReleased = publishableReleases.length;
-  const releasesLines = publishableReleases
-    .map(release => `  ${release.name}@${release.newVersion}`)
-    .join('\n');
-  return outdent`
-    RELEASING: Releasing ${numPackagesReleased} package(s)
-    Releases:
-    ${releasesLines}
-    ${skipCI ? `\n[skip ci]\n` : ''}
-`;
-};
-```
-## 配置
-Changesets 配置文件中 `commit` 字段，该字段用于标记是否需要在 `change` 和 `bump` 命令是提交 commit 信息及 commit 信息的获取途径。
-该配置可以为 `boolean`，为 true 时使用默认 `@changesets/cli/commit` 格式化 commit 信息。
-该配置可以为字符串，直接声明获取 commit 信息模块的模块名称或者路径。
-该配置还支持配置数组，数组中第一个元素为获取 commit 信息模块的模块名称或者路径，第二个元素为传入对应函数的参数值，会作为 `getAddMessage` 和 `getVersionMessage` 函数的第二个参数传入。
-### 配置相对路径
-commit 配置如果为相对路径为 `.changesets` 目录下的相对路径。
-例如创建 `.changeset/my-commit-config.js` 文件，定义如下内容：
-```js title=".changeset/my-commit-config.js"
-async function getAddMessage(changeset, options) {}
-async function getVersionMessage(releasePlan, options) {}
-module.exports = {
-  getAddMessage,
-  getVersionMessage,
-};
-```
-commit 配置为 ./my-commit-config.js 即可:
-```json title=".changesets/config.json"
-{
-  "changelog": "./my-commit-config.js",
-   ...
-}
-```
-### 使用 Modern.js Module
-自定义 commit 还可以使用 Modern.js Module 进行管理，提供通用方案。
-#### 使用 `npx @modern-js/create@latest` 创建 Modern.js Module
-```md
-? 请选择你想创建的工程类型：Npm 模块
-? 请填写项目名称：custom-commit
-? 请选择开发语言：TS
-? 请选择包管理工具：pnpm
-```
-#### 实现自定义内容
-```ts title="src/index.ts"
-export async function getAddMessage() {}
-export async function getVersionMessage() {}
-```
-#### 将模块发布到 NPM
-#### 在目标仓库根目录安装对应模块，例如 `custom-commit`
-#### 配置 changeset 的 commit 配置为包名称
-```json title="package.json"
-{
-  "commit": "custom-commit",
-   ...
-}
-```
-### 使用 Monorepo 工程方案
-如果你当前仓库为 Monorepo 工程方案，可以直接使用模块子项目进行管理。
-#### 执行 `pnpm run new` 创建模块子项目
-```md
-? 请选择你想创建的工程类型：Npm 模块
-? 请填写子项目名称：custom-commit
-? 请填写子项目目录名称：custom-commit
-? 请选择开发语言：TS
-```
-#### 实现自定义内容
-```ts title="src/index.ts"
-export async function getAddMessage() {}
-export async function getVersionMessage() {}
-```
-#### 在 Monorepo 根目录添加子项目模块依赖，例如 `custom-commit`
-```json title="package.json"
-{
-  "devDependencies": {
-    "custom-commit": "workspace:*",
-    ...
-  }
-}
-```
-#### 配置 changeset 的 commit 配置为包名称
-```json title=".changesets/config.json"
-{
-  "commit": "custom-commit",
-   ...
-}
-```
-该模块发布到 NPM 后，依然可以和模块类型一样供其他仓库使用。