@modern-js/main-doc 2.21.0 → 2.22.0

package/docs/zh/guides/topic-detail/generator/config/module.mdx

@@ -1,42 +0,0 @@
----
-sidebar_position: 3
----
-
-# 模块
-
-## 项目创建
-
-创建项目时配置，`@modern-js/create` 使用 `--config` 参数时使用的配置，也是在生成器插件中修改和添加 input 时使用的配置。
-
-模块项目默认包含通用配置，通用配置可查看[通用配置](/guides/topic-detail/generator/config/common)。
-
-### packageName
-
-包名(packageName)，字符串类型，为输入值。
-
-## New 命令
-
-模块项目中 new 命令配置， 可以在执行 new 命令时通过 `--config` 参数配置，也可在生成器插件中创建元素和启用功能时使用。
-
-### actionType
-
-New 命令的操作类型(actionType)，类型支持一种：
-
-- function 启用功能
-
-:::info
-在生成器插件中使用启用功能和创建元素时不需要该参数，生成器插件中自动添加该参数。
-
-:::
-
-### function
-
-可选功能名称(function)，支持如下选项:
-
-- Tailwind CSS(tailwindcss)
-
-- Storybook(storybook)
-
-- Runtime API(runtimeApi)
-
-- 测试(test)

package/docs/zh/guides/topic-detail/generator/config/monorepo.mdx

@@ -1,28 +0,0 @@
----
-sidebar_position: 4
----
-
-# Monorepo
-
-Monorepo 项目默认只需要 [PackageManager 配置](/guides/topic-detail/generator/config/common#packagemanager)。
-
-## 创建子项目
-
-Monorepo 项目支持通过使用 new 命令创建子项目，子项目类型支持应用、测试应用、模块、内部模块，除了应用和模块各自的配置外，这里还需要一些通用的子项目配置。
-
-### solution
-
-子项目类型(solution)，不同子项目类型字段为:
-
-- 应用(mwa)
-- 应用（测试）(mwa_test)
-- 模块(module)
-- 模块（内部）(inner_module)
-
-### packageName
-
-子项目名称(packageName)，字符串类型。
-
-### packagePath
-
-子项目路径(packagePath)，字符串类型。

package/docs/zh/guides/topic-detail/generator/plugin/abstract.mdx

@@ -1,23 +0,0 @@
----
-sidebar_position: 1
----
-
-# 为什么需要生成器插件
-
-Modern.js 提供了应用、模块和 Monorepo 三种工程方案，并通过使用 `@modern-js/create` 工具可以创建三种工程方案的初始项目模板，初始项目模板会提供基本的代码开发环境、简单的示例代码及配置等。
-
-Modern.js 提供的初始化模板具有通用性，能满足一些通用的项目开发需求。
-
-当你深度使用 Modern.js 时，必然会发现每次创建的项目都会进行一些针对自身项目的特定的相似改动，比如修改示例代码、增加一些配置、开启某些功能等。
-
-生成器插件可以帮你将这些针对个人或团队特定的改动沉淀下来，在执行 `npx @modern-js/create@latest` 只需简单的带上 `--plugin` 参数即可避免每次创建完项目都需重复性修改项目的工作。
-
-生成器插件是在 Modern.js 提供的初始化模板项目的基础上，提供对模板进行增加、删除、修改的方法，并通过快捷的方式修改 `package.json`、`modernConfig` 配置和开启功能等操作。
-
-生成器插件提供了两种定制化方式：
-
-1. 扩展工程方案：直接对默认提供的三大工程方案进行定制化
-
-2. 创建工程方案场景：基于默认的三大工程方案创建对应的工程方案场景
-
-接下来将会逐步介绍如何使用和开发生成器插件。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "文件操作 API",
-  "position": 6
-}

package/docs/zh/guides/topic-detail/generator/plugin/api/file/addFile.mdx

@@ -1,52 +0,0 @@
----
-sidebar_position: 4
----
-
-# addFile
-
-添加单个文件。用于添加 `templates` 目录的单个模板文件或者直接使用模板添加到模板文件。
-
-该方法可用于任何文件类型，对于二进制以外的文件类型，添加文件时会进行 Handlebars 渲染。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export interface AddFileParams {
-  type: FileType;
-  file: string;
-  template?: string;
-  templateFile?: string;
-  force?: boolean;
-  data?: Record<string, string>;
-}
-export type ForgedAPI = {
-  addFile: (params: AddFileParams) => Promise<void>;
-  ...
-};
-```
-
-## type
-
-文件类型，具体可查看[文件类型](/guides/topic-detail/generator/plugin/api/file/introduce#文件类型)。
-
-## file
-
-创建的目标文件路径。
-
-## template
-
-文件模板，配置该字段值可直接用于模板渲染文件。优先级低于 templateFile。
-
-## templateFile
-
-模板文件，用于渲染的模板文件路径，其值为 `templates` 的相对路径即可。
-
-## force
-
-是否强制覆盖，当添加的文件已存在时，默认会冲突报错，设置该值为 true 时，可强制覆盖。
-
-## data
-
-Handlebars 渲染数据。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/addHelper.mdx

@@ -1,26 +0,0 @@
----
-sidebar_position: 2
----
-
-# addHelper
-
-针对于文本类型文件，增加 Handlebars 的自定义 Help 函数，具体可查看文档[Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  addHelper: (name: string, fn: Handlebars.HelperDelegate) => void;
-  ...
-};
-```
-
-## name
-
-help 函数名称。
-
-## fn
-
-help 函数实现。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/addManyFile.mdx

@@ -1,55 +0,0 @@
----
-sidebar_position: 5
----
-
-# addManyFile
-
-批量添加文件。用于添加 `templates` 目录的多个文件。
-
-该方法可用于任何文件类型，对于二进制以外的文件类型，添加文件时会进行 Handlebars 渲染。
-
-该方法可在 `onForged` 生命周期的 `api` 参数上获取。
-
-其类型定义为：
-
-```ts
-export interface AddManyFilesParams {
-  type: FileType;
-  destination: string;
-  templateFiles: string[] | (() => string[]);
-  templateBase?: string;
-  fileNameFunc?: (name: string) => string;
-  data?: Record<string, string>; // template data
-}
-export type ForgedAPI = {
-  addManyFiles: (params: AddManyFilesParams) => Promise<void>;
-  ...
-};
-```
-
-## type
-
-文件类型，具体可查看[文件类型](/guides/topic-detail/generator/plugin/api/file/introduce#文件类型)。
-
-## destination
-
-创建的目标文件夹路径。由于是批量添加文件，这里填写需要写入的文件夹路径即可。
-
-## templateFiles
-
-模板文件列表。
-该参数支持函数参数，也支持 [globby 正则](https://www.npmjs.com/package/globby)。
-
-## templateBase
-
-模板基础路径。
-模板路径通常为同一个目录下的模板文件，如果渲染结果需要去除掉模板文件前缀目录，可使用该字段。
-模板渲染文件内容将等于 `templateFiles - templateBase`
-
-## fileNameFunc
-
-重命名文件函数，在该函数中将一次传入渲染的文件名称，可在该函数中进行重命名。
-
-## data
-
-Handlebars 渲染数据。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/addPartial.mdx

@@ -1,26 +0,0 @@
----
-sidebar_position: 3
----
-
-# addPartial
-
-针对于文本类型文件，增加 Handlebars 的自定义 Partial 片段，具体可查看文档[Partials](https://handlebarsjs.com/guide/#partials)。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  addPartial: (name: string, str: Handlebars.Template) => void;
-  ...
-};
-```
-
-## name
-
-partial 名称。
-
-## str
-
-partial 模板字符串。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/introduce.mdx

@@ -1,39 +0,0 @@
----
-sidebar_position: 1
----
-
-# 介绍
-
-文件操作 API 可在 `onForged` 生命周期函数中使用，可对当前项目文件进行增、删、改的操作。
-
-文件操作 API 相关路径填写项目相对路径即可，生成器插件会自动添加当前项目路径前缀。
-
-## 文件类型
-
-生成器插件将文件类型分为一下几类：
-
-- 文本文件：纯文本内容文件，可使用 handlebars 进行模板处理的文件。
-
-- 二进制文件：图片、音频、视频等文件
-
-:::warning
-使用变量的 jsx 或 tsx 文件为二进制文件，其语法与 handlebars 渲染冲突，会造成模板文件创建失败。
-
-:::
-
-- JSON 文件：JSON 格式的文件，例如 `package.json`、 `tsconfig.json`。
-
-- 文本列表文件：文件由行文本组成的文件，例如 `.gitignore`, `.editorconfig`, `.npmrc`。
-
-生成器插件的文件操作 API 将是针对这四种文件类型进行操作。
-
-其类型定义为：
-
-```ts
-export enum FileType {
-  Text = 'text',
-  Binary = 'binary',
-  Json = 'json',
-  TextRaw = 'textRaw',
-}
-```

package/docs/zh/guides/topic-detail/generator/plugin/api/file/rmDir.mdx

@@ -1,24 +0,0 @@
----
-sidebar_position: 10
----
-
-# rmDir
-
-删除文件夹。该方法会递归的删除文件夹下的所有文件。
-
-该方法可用于任何文件类型。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  rmDir: (dirName: string) => Promise<void>;
-  ...
-};
-```
-
-## dirName
-
-需删除的文件夹名称或文件夹路径。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/rmFile.mdx

@@ -1,24 +0,0 @@
----
-sidebar_position: 9
----
-
-# rmFile
-
-删除文件。
-
-该方法可用于任何文件类型。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  rmFile: (fileName: string) => Promise<void>;
-  ...
-};
-```
-
-## fileName
-
-需删除的文件名称或文件路径。

package/docs/zh/guides/topic-detail/generator/plugin/api/file/updateJSONFile.mdx

@@ -1,54 +0,0 @@
----
-sidebar_position: 6
----
-
-# updateJSONFile
-
-更新 JSON 文件字段。
-
-该方法适用于 JSON 文件类型，可批量更新 JSON 文件中字段值。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  updateJSONFile: (
-    fileName: string,
-    updateInfo: Record<string, unknown>,
-  ) => Promise<void>;
-  ...
-};
-```
-
-## fileName
-
-JSON 文件的文件名或者文件路径。
-
-## updateInfo
-
-字段更新信息。
-
-该信息使用 `Record` 形式表示。
-
-例如需要更新 name 字段：
-
-```ts
-api.updateJSONFile(file, {
-  name: '新名称',
-});
-```
-
-需更新嵌套字段：
-
-```ts
-api.updateJSONFile(file, {
-  'dependencies.name': '新名称',
-});
-```
-
-:::warning
-更新嵌套字段时注意字段名，如果不是全量更新，需将嵌套的 key 也写入字段名中。
-
-:::

package/docs/zh/guides/topic-detail/generator/plugin/api/file/updateModernConfig.mdx

@@ -1,27 +0,0 @@
----
-sidebar_position: 8
----
-
-# updateModernConfig
-
-更新 `package.json` 中 `modernConfig` 字段。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-  updateModernConfig: (updateInfo: Record<string, any>) => Promise<void>;
-  ...
-};
-```
-
-## updateInfo
-
-字段更新信息。
-
-:::info
-该函数为 updateJSONFile 的封装，将自动更新 `package.json` 的 `modernConfig` 字段 `updateInfo` 中只需填写相对于 `modernConfig` 的更新信息即可。
-
-:::

package/docs/zh/guides/topic-detail/generator/plugin/api/file/updateTextRawFile.mdx

@@ -1,33 +0,0 @@
----
-sidebar_position: 7
----
-
-# updateTextRawFile
-
-更新文本列表文件内容。
-
-该方法适用与文本列表文件类型。
-
-该方法可在 `onForged` 生命周期的 api 参数上获取。
-
-其类型定义为：
-
-```ts
-export type ForgedAPI = {
-updateTextRawFile: (
-    fileName: string,
-    update: (content: string[]) => string[],
-  ) => Promise<void>;
-  ...
-};
-```
-
-## fileName
-
-文本列表文件的文件名或者文件路径。
-
-## update
-
-更新函数。
-
-该函数参数为当前文件内容，内容将以 '\n' 分割，以数组的形式传入函数，函数的返回值也是数组，内部将自动以 '\n' 合并，写入源文件。

package/docs/zh/guides/topic-detail/generator/plugin/api/git/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "GIT API",
-  "position": 8
-}

package/docs/zh/guides/topic-detail/generator/plugin/api/git/gitAddAndCommit.mdx

@@ -1,20 +0,0 @@
----
-sidebar_position: 3
----
-
-# gitAddAndCommit
-
-提交当前仓库变更。
-
-其类型定义为：
-
-```ts
-export type AfterForgedAPI = {
-  gitAddAndCommit: (commitMessage: string) => Promise<void>;
-  ...
-};
-```
-
-## commitMessage
-
-提交信息。

package/docs/zh/guides/topic-detail/generator/plugin/api/git/initGitRepo.mdx

@@ -1,16 +0,0 @@
----
-sidebar_position: 2
----
-
-# initGitRepo
-
-初始化当前目录为 Git 仓库。
-
-其类型定义为：
-
-```ts
-export type AfterForgedAPI = {
-  initGitRepo: () => Promise<void>;
-  ...
-};
-```

package/docs/zh/guides/topic-detail/generator/plugin/api/git/isInGitRepo.mdx

@@ -1,16 +0,0 @@
----
-sidebar_position: 1
----
-
-# isInGitRepo
-
-判断当前项目是否为一个 Git 仓库。
-
-其类型定义为：
-
-```ts
-export type AfterForgedAPI = {
-  isInGitRepo: () => Promise<boolean>;
-  ...
-};
-```

package/docs/zh/guides/topic-detail/generator/plugin/api/hook/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Hook 函数 API",
-  "position": 5
-}

package/docs/zh/guides/topic-detail/generator/plugin/api/hook/afterForged.mdx

@@ -1,35 +0,0 @@
----
-sidebar_position: 2
----
-
-# AfterForged
-
-`afterForged` 函数为生成器插件生命周期函数，其通常用于定义安装依赖、Git 等操作，这些操作将会在 `onForged` 函数执行完成后进行。
-
-该方法可直接在 context 上获取。
-
-其类型定义为：
-
-```ts
-export type PluginAfterForgedFunc = (
-  api: AfterForgedAPI,
-  inputData: Record<string, unknown>,
-) => Promise<void>;
-
-export interface IPluginContext {
-  afterForged: (func: PluginAfterForgedFunc) => void;
-  ...
-}
-```
-
-## func
-
-`afterForged` 参数是一个回调函数，函数参数为 `api` 和 `inputData。`
-
-### api
-
-在 `afterForged` 生命周期中支持的函数列表，具体可查看 [Git API](/guides/topic-detail/generator/plugin/api/git/isInGitRepo) 和 [NPM API](/guides/topic-detail/generator/plugin/api/npm/install)。
-
-### inputData
-
-当前用户输入，可用于获取用户当前的输入信息及配置信息。

package/docs/zh/guides/topic-detail/generator/plugin/api/hook/onForged.mdx

@@ -1,35 +0,0 @@
----
-sidebar_position: 1
----
-
-# OnForged
-
-`onForged` 函数为生成器插件生命周期函数，其通常用于定义文件类型操作，这些操作将在 base 的工程方案文件操作完成后进行。
-
-该方法可直接在 context 上获取。
-
-其类型定义为：
-
-```ts
-export type PluginForgedFunc = (
-  api: ForgedAPI,
-  inputData: Record<string, unknown>,
-) => void | Promise<void>;
-
-export interface IPluginContext {
-  onForged: (func: PluginForgedFunc) => void;
-  ...
-}
-```
-
-## func
-
-`onForged` 参数是一个回调函数，函数参数为 api 和 inputData。
-
-### api
-
-在 `onForged` 生命周期中支持的函数列表，具体可查看[文件操作 API](/guides/topic-detail/generator/plugin/api/file/introduce) 和[启用功能 API](/guides/topic-detail/generator/plugin/api/new/introduce)。
-
-### inputData
-
-当前用户输入，可用于获取用户当前的输入信息及配置信息。

package/docs/zh/guides/topic-detail/generator/plugin/api/info/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "获取信息 API",
-  "position": 4
-}

package/docs/zh/guides/topic-detail/generator/plugin/api/info/isFileExit.mdx

@@ -1,22 +0,0 @@
----
-sidebar_position: 2
----
-
-# isFileExist
-
-判断文件是否存在。
-
-该方法可直接在 context 上获取。
-
-其类型定义为：
-
-```ts
-export interface IPluginContext {
-  isFileExist: (fileName: string) => Promise<boolean>;
-  ...
-}
-```
-
-## fileName
-
-需要判断的文件名或者文件路径，基于创建的项目的相对路径即可。

package/docs/zh/guides/topic-detail/generator/plugin/api/info/locale.mdx

@@ -1,17 +0,0 @@
----
-sidebar_position: 1
----
-
-# locale
-
-当前语言。
-
-该变量可直接在 context 上获取。
-
-该字段存在两个值：
-
-- zh: 中文
-
-- en: 英文
-
-生成器插件中可根据该字段调整相关展示字段的值。

package/docs/zh/guides/topic-detail/generator/plugin/api/info/readDir.mdx

@@ -1,22 +0,0 @@
----
-sidebar_position: 3
----
-
-# readDir
-
-读取文件夹，获取文件列表。
-
-该方法可直接在 context 上获取。
-
-其类型定义为：
-
-```ts
-export interface IPluginContext {
-  readDir: (dir: string) => Promise<string[]>;
-  ...
-}
-```
-
-## dir
-
-文件夹名称或路径，基于创建的项目的相对路径即可。

package/docs/zh/guides/topic-detail/generator/plugin/api/input/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "自定义输入 API",
-  "position": 3
-}