@modern-js/main-doc 2.60.6 → 2.61.0

package/docs/zh/guides/topic-detail/generator/plugin/context.md

@@ -1,105 +0,0 @@
----
-sidebar_position: 4
----
-
-# Context
-
-生成器插件默认会导出一个函数，函数参数为 `context`，在执行过程中 `context` 会自动注入到生成器插件中。
-
-```ts title="src/index.ts"
-import { IPluginContext, ForgedAPI } from '@modern-js/generator-plugin';
-
-export default function (context: IPluginContext) {
-  context.onForged(async (_api: ForgedAPI, _input: Record<string, unknown>) => {
-    /**
-     * Todo
-     */
-  });
-}
-```
-
-`context` 提供了两类 API，分别用于自定义 Input 和定义生成器插件声明周期逻辑。
-
-:::info
-下面只对部分 API 做简单示例讲解，完整的 API 请移步 [生成器插件 API](/guides/topic-detail/generator/plugin/api/context.html) 查看。
-:::
-
-## 自定义 Input
-
-Modern.js Framework 和 Modern.js Module 都存在一些默认的 Input 交互，使用这里的 API 可以对这些 Input 进行添加、修改、隐藏、提供默认值等操作。
-
-例如：
-
-- 添加问题
-
-```ts
-context.addInputBefore('packageManager', {
-  type: 'object',
-  properties: {
-    'username': {
-      type: 'string',
-      title: '用户名',
-    },
-  },
-});
-```
-
-- 通过设置 config 隐藏问题
-
-```ts
-context.setDefaultConfig({ langauge: 'ts' });
-```
-
-## 生命周期
-
-生成器插件提供了两个生命周期钩子函数用于定义生成器插件行为：
-
-- onForged：完成文件操作后的生命周期。
-
-- afterForged：onForged 钩子函数执行完成后的生命周期。
-
-## onForged
-
-在 Modern.js 工程方案生成器完成文件操作之后的钩子函数，用于完成生成器插件中的文件操作，比如添加模板文件，覆盖现有文件，删除现有文件等。
-
-对于扩展类型同时执行多个生成器插件时，将会按照声明顺序依次执行对应生成器插件的 `onForged` 操作。
-
-`onForged` 函数参数为一个回调函数，参数为 `api` 和 `input`。
-
-```ts
-context.onForged(async (api: ForgedAPI, input: Record<string, unknown>) => {
-  const { language } = input;
-  api.addFile({
-      type: FileType.Text,
-      file: `src/index.${language as string}`,
-      templateFile: `index.${language as string}.handlebars`,
-      force: true,
-  });
-})
-```
-
-`api` 上会提供生成器插件支持的文件操作相关方法。
-
-`input` 为当前用户输入内容，包含 `--config` 参数定义的，默认工程方案交互的及生成器插件定义的用户输入。
-
-当需要添加新的文件模板时，将模板文件定义到 `templates` 目录，然后通过上述 `api` 上方法进行操作即可，生成器插件默认对 `templates` 目录文件进行操作，无需再声明 `templates` 路径。
-
-## afterForged
-
-`onForged` 钩子函数执行完成后执行，这里主要用于进行安装依赖，Git 操作等。
-
-默认 Modern.js 工程方案在完成文件操作后会默认执行安装依赖及 Git 初始化，Git 初次提交等，该钩子函数可以不使用。
-
-对于自定义的生成器插件还支持 custom 类型，该类型只提供了少量最佳实践的项目配置，则需要在该钩子函数中完成安装依赖和 Git 初始化等操作。
-
-`afterForged` 函数参数也为一个回调函数，参数为 `api` 和 `input`。
-
-```ts
-  context.afterForged(
-    async (api: AfterForgedAPI, input: Record<string, unknown>) => {
-      const { packageManager } = input;
-      console.info('packageManager:', packageManager);
-      await api.install();
-    },
-  );
-```

package/docs/zh/guides/topic-detail/generator/plugin/structure.md

@@ -1,106 +0,0 @@
----
-sidebar_position: 1
----
-
-# 介绍及创建项目
-
-## 介绍
-
-Modern.js 提供了 Web 应用、Npm 模块等工程方案，并通过使用 `@modern-js/create` 工具可以创建工程方案的初始项目模板，初始项目模板会提供基本的代码开发环境、简单的示例代码及配置等。
-
-Modern.js 提供的初始化模板具有通用性，能满足一些通用的项目开发需求。
-
-当你深度使用 Modern.js 时，必然会发现每次创建的项目都会进行一些针对自身项目的特定的相似改动，比如修改示例代码、增加一些配置、开启某些功能等。
-
-生成器插件可以帮你将这些针对个人或团队特定的改动沉淀下来，在执行 `npx @modern-js/create@latest` 只需简单的带上 `--plugin` 参数即可避免每次创建完项目都需重复性修改项目的工作。
-
-生成器插件是在 Modern.js 提供的初始化模板项目的基础上，提供对模板进行增加、删除、修改的方法，并通过快捷的方式修改 `package.json`、`modernConfig` 配置和开启功能等操作。
-
-## 创建项目
-
-使用 `@modern-js/create` 可直接创建生成器插件项目：
-
-```bash
-npx @modern-js/create@latest plugin --plugin @modern-js/generator-plugin-plugin
-? 请选择你想创建的工程类型 Npm 模块
-? 请选择项目场景 生成器插件
-? 请输入生成器插件插件包名 plugin
-? 请选择开发语言 TS
-? 请选择包管理工具 pnpm
-? 请选择插件类型 extend
-? 请选择插件基础类型 Web 应用
-```
-
-创建完成后，我们可以看一下这个项目的目录结构：
-
-```bash
-.
-├── .changeset
-│   └── config.json
-├── .eslintrc.js
-├── .gitignore
-├── .npmrc
-├── .nvmrc
-├── .prettierrc
-├── README.md
-├── modern.config.ts
-├── package.json
-├── src
-│   ├── modern-app-env.d.ts
-│   └── index.ts
-├── templates
-│   └── .gitkeep
-└── tsconfig.json
-```
-
-项目是基于 Npm 模块项目创建的，核心是下面几个文件：
-
-```bash
-*
-├── package.json
-├── src
-│   └── index.ts
-├── templates
-│   └── .gitkeep
-```
-
-## package.json
-
-`package.json` 中除了正常的模块项目的字段外，提供了 meta 字段，用于描述生成器插件的信息。
-
-生成器插件分为两类：扩展和自定义，具体分类定义可查看[类型](/guides/topic-detail/generator/plugin/category)。
-
-```json title="package.json"
-{
-  ...,
-  "meta": {
-    "extend": "mwa"
-  }
-}
-```
-
-## src/index.ts
-
-该文件用于完成生成器插件的内容开发。
-
-```js
-import { IPluginContext, ForgedAPI } from '@modern-js/generator-plugin';
-
-export default function (context: IPluginContext) {
-  context.onForged(async (_api: ForgedAPI, _input: Record<string, unknown>) => {
-    /**
-     * todo
-     */
-  });
-}
-```
-
-该文件默认导出一个函数，函数参数为 `context`，`context` 上提供了生成器插件支持的 API 方法，可用于实现生成器插件的逻辑。`context` 提供的能力可以参考 [context](/guides/topic-detail/generator/plugin/context)。
-
-## templates
-
-`templates` 目录存在当前定制化方式的模板文件，支持 [Handlebars](https://handlebarsjs.com/) 和 [EJS](https://ejs.co/) 格式，将根据模板文件后缀使用不同的渲染引擎执行渲染，如果无后缀，将会直接复制模板文件到目标目录。
-
-如果模板文件为 `js`、`ts` 或者 `json` 文件，推荐直接使用 `.handlebars` 或者 `.ejs` 后缀，可避免项目 eslint 报错和在 Monorepo 中项目识别问题。
-
-模板中 `.gitignore` 文件和 `.npmrc` 文件在发布 npm 包时会自动删除，需要使用 `.handlebars` 或者 `.ejs` 后缀将其保留。

package/docs/zh/guides/topic-detail/generator/plugin/use.md

@@ -1,33 +0,0 @@
----
-sidebar_position: 3
----
-
-# 使用
-
-`@modern-js/create` 提供了 `--plugin` 参数用于运行生成器插件项目。
-
-`--plugin` 支持三种格式：
-
-## 绝对路径
-
-适用于本地开发调试，开发完成后，在生成器插件执行 `npm run build` 构建项目，然后使用下面命令即可进行测试。
-
-```bash
-npx @modern-js/create@latest --plugin <pluginPath>
-```
-
-## 相对路径
-
-适用于本地开发调试或者生成器插件项目和目标创建项目在同一个 Monorepo，无需发布 NPM 包，构建项目后，执行下面命令即可。
-
-```bash
-npx @modern-js/create@latest --plugin file:../<pluginPath>
-```
-
-## npm 包
-
-适用于生成器插件发布于 npm 上，共享生成器插件场景。
-
-```bash
-npx @modern-js/create@latest --plugin <pluginPackage>
-```