@modern-js/main-doc 0.0.0-nightly-20240605170621 → 0.0.0-nightly-20240606170638

package/docs/en/guides/topic-detail/changesets/add.mdx

@@ -1,125 +0,0 @@
----
-sidebar_position: 2
----
-
-# Add Changesets
-
-When we finish development, we need to add a changeset to declare the current changes for version releases.
-
-## Information
-
-A changeset includes:
-
-- Which packages are affected by this change.
-
-- The type of version for this change, which complies with the [semver](https://semver.org/) specification.
-
-- Changelog information for this change.
-
-## Steps
-
-:::info
-The following example commands are all using pnpm. If you need to use other package managers, please replace them as needed.
-:::
-
-### Modern.js Module
-
-#### Run the change command in the root directory:
-
-```bash
-pnpm run change
-```
-
-#### Select the type of version for this change
-
-![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-select-version.png)
-
-#### Fill in the changelog information
-
-![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-input-changelog.png)
-
-After running, a corresponding changeset file will be created in the `.changeset` directory of the project, and the file content is as follows:
-
-```markdown
----
-'module-changeset': patch
----
-
-feat: test module solution changeset
-```
-
-This file contains all the information of the changeset.
-
-### Monorepo
-
-There are three NPM module packages in the monorepo, `module-1`, `module-2`, and `module-3`.
-
-#### Run the change command in the root directory
-
-```bash
-pnpm run change
-```
-
-#### Select the list of packages to upgrade for this change
-
-Changesets will categorize the packages in the Monorepo into two categories, `changed packages` and `unchanged packages`, based on the current code changes (`git diff Head...baseBranch`), making it easy for users to choose.
-
-Use the space key to select the corresponding package or category, and then press Enter after the selection is completed:
-
-![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-select-packages.png)
-
-#### Select the packages corresponding to different version types
-
-Changesets will ask about the `major` and `minor` types. If there are packages that have not selected these two types, the `patch` type will be used by default.
-
-![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-auto-select-patch.png)
-
-#### Fill in the changelog information
-
-![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-input-changelog-monorepo.png)
-
-After running, a corresponding changeset file will be created in the `.changeset` directory of the project, and the file content is as follows:
-
-```markdown
----
-'module-2': minor
-'module-3': patch
----
-
-feat: test-changeset
-```
-
-This file contains all the information of the changeset, and different packages will be marked according to the selected version type.
-
-## Parameters
-
-The `change` command supports the following parameters:
-
-- `--empty`: Adds an empty changeset.
-
-```bash
-pnpm run change --empty
-```
-
-After running, an empty changeset file will be created in the `.changeset` directory of the project, and the file content is as follows:
-
-```markdown
----
----
-```
-
-- `--open`: When using this parameter, the system default editor will be opened for filling in the changelog.
-
-## Notes
-
-- Not all changes require changesets
-
-If the current change is to modify some infrastructure of the repository, such as CI, testing, etc., there is no need to add changesets, or an empty changeset can be added.
-
-- Multiple changesets can be submitted in one pull request
-
-When a pull request has multiple feature developments or bug fixes, multiple `pnpm run change` commands can be executed to add multiple changeset files. Each file selects the corresponding packages for the feature and adds change information.
-
-- When creating a changeset, all packages related to the feature need to be selected
-
-When creating a changeset in a Monorepo, all related packages to the feature need to be selected to avoid some packages not being published when releasing.

package/docs/en/guides/topic-detail/changesets/changelog.mdx

@@ -1,238 +0,0 @@
----
-sidebar_position: 6
----
-
-# Customizing Changelog
-
-By default, Changesets will use `@changesets/cli/changelog` to generate changelog. If the default changelog cannot meet the requirements, you can customize the generation of changelog.
-
-## Customizing Changelog Content
-
-Changelog mainly includes the following two types of information:
-
-- Changelog written in the changeset.
-
-- Version change information of related packages in this version upgrade.
-
-The custom logic mainly implements two functions, `getReleaseLine` and `getDependencyReleaseLine`, which are used to define the above two types of information, respectively.
-
-### getReleaseLine
-
-#### Params
-
-- changeset
-
-```ts
-export type VersionType = 'major' | 'minor' | 'patch' | 'none';
-
-export type Release = { name: string; type: VersionType };
-
-export type Changeset = {
-  id: string; // changeset id
-  commit?: string; // changeset commit id
-  summary: string; // changeset summary content
-  releases: Array<Release>; // The name and type information of the current computed changeset upgrade package.
-};
-```
-
-- type
-
-The upgraded version type corresponding to the current package, which is of type `VersionType` mentioned above.
-
-#### Returns
-
-Changelog content.
-
-#### Default Implementation
-
-The default processing logic of `@changesets/cli/changelog` is to split the `summary` information according to the newline `\n`, add `-` as the list header before the first line, and organize other content as the supplement of the first line below the list.
-
-```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
-
-All associated changeset information, which is an array of `getReleaseLine` changeset types.
-
-- dependenciesUpdated
-
-```ts
-type ModCompWithPackage = {
-  name: string; // Name of the dependent module
-  type: VersionType; // Upgrade type of the dependent module
-  oldVersion: string; // Current version of the dependent module
-  newVersion: string; // New version of the dependent module
-  changesets: string[]; // List of associated changeset ids
-  packageJson: PackageJSON; // Complete package.json content of the dependent module
-  dir: string; // Path (absolute path) of the dependent module
-};
-
-type DependenciesUpdated = ModCompWithPackage[];
-```
-
-#### Returns
-
-Changelog content.
-
-#### Default Implementation
-
-By default, `@changesets/cli/changelog` will display the corresponding `Updated dependencies + commit id` information of the changesets as a list. Then, based on the `dependenciesUpdated` information, it will display the package name and new version of the corresponding dependency package as a child list item of the list.
-
-```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');
-}
-```
-
-It is displayed as follows:
-
-```markdown
-- Updated dependencies [f0438ab]
-- Updated dependencies [f0438ab]
-  - module-3@2.0.0
-  - module-1@0.2.0
-```
-
-## Configuration
-
-The `changelog` field in the changesets configuration file is used to mark the way to get changelog.
-
-This configuration can be a string, directly declaring the module name or path of the changelog module.
-
-This configuration also supports configuring arrays. The first element in the array is the module name or path of the changelog module, and the second element is the parameter value passed to the corresponding function, which will be passed as the third parameter of the `getReleaseLine` and `getDependencyReleaseLine` functions.
-
-### Configuring Relative Paths
-
-If the changelog configuration is a relative path, it is a relative path under the `.changesets` directory.
-
-For example, create the `.changeset/my-changelog-config.js` file and define the following content:
-
-```ts title=".changeset/my-changelog-config.js"
-async function getReleaseLine(changeset, type) {}
-
-async function getDependencyReleaseLine(changesets, dependenciesUpdated) {}
-
-module.exports = {
-  getReleaseLine,
-  getDependencyReleaseLine,
-};
-```
-
-Configure `changlog` as `./my-changelog-config.js`:
-
-```json title=".changesets/config.json"
-{
-  "changelog": "./my-changelog-config.js",
-   ...
-}
-```
-
-### Using Modern.js Module
-
-Customizing changelog can also be managed using the Modern.js Module to provide a common solution.
-
-#### Use `npx @modern-js/create@latest` to create a Modern.js Module.
-
-```md
-? Please select the type of project you want to create: Npm Module
-? Please fill in the project name: custom-changelog
-? Please select the programming language: TS
-? Please select the package manager: pnpm
-```
-
-#### Implement Custom Content
-
-```ts title="src/index.ts"
-export async function getReleaseLine() {}
-
-export async function getDependencyReleaseLine() {}
-```
-
-#### Publish the module to NPM
-
-#### Install the module in the root directory of the target repository, such as `custom-changelog`.
-
-#### Configure the changelog configuration of changesets as the package name.
-
-```json title=".changesets/config.json"
-{
-  "changelog": "custom-changelog",
-   ...
-}
-```
-
-### Using Monorepo Sub-Project
-
-If your current repository is Monorepo, you can directly manage it using NPM module sub-projects.
-
-#### Run `pnpm run new` to create a NPM module sub-project
-
-```bash
-? Please select the type of project you want to create: Npm Module
-? Please fill in the sub-project name: custom-changelog
-? Please fill in the sub-project directory name: custom-changelog
-? Please select the programming language: TS
-```
-
-#### Implement Custom Content
-
-```ts title="src/index.ts"
-export async function getReleaseLine() {}
-
-export async function getDependencyReleaseLine() {}
-```
-
-#### Add the sub-project module dependency, such as `custom-changelog`, to the Monorepo root directory
-
-```json title="package.json"
-{
-  "devDependencies": {
-    "custom-changelog": "workspace:*",
-    ...
-  }
-}
-```
-
-#### Configure the changelog configuration of Changesets as the package name
-
-```json title=".changesets/config.json"
-{
-  "changelog": "custom-changelog",
-   ...
-}
-```
-
-After the module is published to NPM, it can still be used like a module type for other repositories.

package/docs/en/guides/topic-detail/changesets/commit.mdx

@@ -1,269 +0,0 @@
----
-sidebar_position: 7
----
-
-# Customizing Commit Messages
-
-Changesets supports configuring `commit` to automatically submit the current changes when running the `change` and `bump` commands.
-
-The default `commit` information is provided by `@changesets/cli/commit`, and the default information format is:
-
-![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)
-
-When the default commit information cannot meet the requirements, custom commit information is supported.
-
-## Customizing Commit Message Content
-
-Commit information is divided into two types:
-
-- Commit information automatically generated when running the `change` command.
-- Commit information automatically generated when running the `bump` command.
-
-The custom logic mainly implements two functions, `getAddMessage` and `getVersionMessage`, which are used to define the above two types of information, respectively.
-
-### getAddMessage
-
-#### Params
-
-- changeset
-
-The current changeset information created.
-
-```ts
-type Release = {
-  name: string;
-  type: VersionType;
-};
-
-type Changeset = {
-  summary: string;
-  releases: Array<Release>;
-};
-```
-
-- options
-
-Configuration information when committing.
-
-> When the commit configuration is an array, the second parameter supports passing in default configuration information, which will be used to pass this parameter.
-
-#### Returns
-
-Commit message content.
-
-#### Default Implementation
-
-The default processing logic of `@changesets/cli/commit` is to start with `docs(changeset):`, and the commit information is the `summary` of the changeset, and [skip ci] information is added according to the `skipCI` parameter configuration passed in.
-
-```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) is used to remove the leading whitespace content of the template string to make the commit information more compliant with the specification.
-
-### 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'; // Current state of pre mode
-  tag: string; // Type of pre
-  initialVersions: {
-    [pkgName: string]: string; // Package name and version information before version upgrade
-  };
-  changesets: string[]; // List of changeset ids for this upgrade
-};
-
-type ReleasePlan = {
-  changesets: Changeset[]; // List of changesets for this upgrade
-  releases: ComprehensiveRelease[]; // Information of the current upgrade, including package name, current version, upgraded version, and upgrade type
-  preState: PreState | undefined; // If it is a pre-release, provide relevant state information
-};
-```
-
-- options
-
-Configuration information when committing.
-
-> When the commit configuration is an array, the second parameter supports passing in default configuration information, which will be used to pass this parameter.
-
-#### Returns
-
-Commit message content.
-
-#### Default Implementation
-
-The default processing logic of `@changesets/cli/commit` is to first display the number of packages that need to be released, then display the names and new version of the released packages, and [skip ci] information is added according to the `skipCI` parameter configuration passed in.
-
-```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` : ''}
-`;
-};
-```
-
-## Configuration
-
-The `commit` field in the changesets configuration file is used to mark whether to submit commit information when running the `change` and `bump` commands, and the way to obtain commit information.
-
-This configuration can be a `boolean`. When it is `true`, the default `@changesets/cli/commit` formatting commit information will be used.
-
-This configuration can be a string, directly declaring the module name or path of the commit information acquisition module.
-
-This configuration also supports configuring arrays. The first element in the array is the module name or path of the commit information acquisition module, and the second element is the parameter value passed to the corresponding function, which will be passed as the second parameter of the `getAddMessage` and `getVersionMessage` functions.
-
-### Configuring Relative Paths
-
-If the commit configuration is a relative path, it is a relative path under the `.changesets` directory.
-
-For example, create the `.changeset/my-commit-config.js` file and define the following content:
-
-```js title=".changeset/my-commit-config.js"
-async function getAddMessage(changeset, options) {}
-
-async function getVersionMessage(releasePlan, options) {}
-
-module.exports = {
-  getAddMessage,
-  getVersionMessage,
-};
-```
-
-Configure `commit` as `./my-commit-config.js`:
-
-```json title=".changesets/config.json"
-{
-  "changelog": "./my-commit-config.js",
-   ...
-}
-```
-
-### Using Modern.js Module
-
-Customizing commit can also be managed using the Modern.js Module to provide a common solution.
-
-#### Use `npx @modern-js/create@latest` to create a mModern.js Module
-
-```md
-? Please select the type of project you want to create: Npm Module
-? Please fill in the project name: custom-commit
-? Please select the programming language: TS
-? Please select the package manager: pnpm
-```
-
-#### Implement Custom Content
-
-```ts title="src/index.ts"
-export async function getAddMessage() {}
-
-export async function getVersionMessage() {}
-```
-
-#### Publish the module to NPM
-
-#### Install the corresponding module in the root directory of the target repository, such as `custom-commit`
-
-#### Configure the commit configuration of changesets as the package name
-
-```json title="package.json"
-{
-  "commit": "custom-commit",
-   ...
-}
-```
-
-### Using Monorepo Sub-Project
-
-If your current repository is Monorepo, you can directly manage it using NPM module sub-projects.
-
-#### Run `pnpm run new` to create a module sub-project
-
-```bash
-? Please select the type of project you want to create: Npm Module
-? Please fill in the sub-project name: custom-commit
-? Please fill in the sub-project directory name: custom-commit
-? Please select the programming language: TS
-```
-
-#### Implement Custom Content
-
-```ts title="src/index.ts"
-export async function getAddMessage() {}
-
-export async function getVersionMessage() {}
-```
-
-#### Add the sub-project module dependency, such as `custom-commit`, to the Monorepo root directory
-
-```json title="package.json"
-{
-  "devDependencies": {
-    "custom-commit": "workspace:*",
-    ...
-  }
-}
-```
-
-#### Configure the commit configuration of Changesets as the package name
-
-```json title=".changesets/config.json"
-{
-  "commit": "custom-commit",
-   ...
-}
-```
-
-After the module is published to NPM, it can still be used like a module type for other repositories.