index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/rspack.mdx | ---
sidebar_label: rspack
---
# tools.rspack
import Main from '@modern-js/builder-doc/docs/zh/config/tools/rspack.md';
<Main />
| 7,700 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/sass.mdx | ---
sidebar_label: sass
---
# tools.sass
import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md';
<Main />
| 7,701 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/style-loader.mdx | ---
sidebar_label: styleLoader
---
# tools.styleLoader
import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md';
<Main />
| 7,702 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/styled-components.mdx | ---
sidebar_label: styledComponents
---
# tools.styledComponents
import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md';
<Main />
| 7,703 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/swc.mdx | ---
sidebar_label: swc
---
# tools.swc
- **类型：** `Object | Function`
- **默认值：** `undefined`
## 介绍
import SWC from '@modern-js/builder-doc/docs/zh/shared/swc.md';
<SWC />
:::tip
在使用 Rspack 作为打包工具时，默认会使用 SWC 进行转译和压缩，因此你不需要再安装和配置 SWC 插件。
如果你使用 Rspack 时配置了当前的 SWC 插件，它将不会产生任何效果。
:::
## 安装
import EnableSWC from '@mo... | 7,704 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/tailwindcss.mdx | ---
sidebar_label: tailwindcss
---
# tools.tailwindcss
- **类型：** `Object | Function`
- **默认值：**
```js
const tailwind = {
content: [
'./src/**/*.{js,jsx,ts,tsx}',
'./config/html/**/*.{html,ejs,hbs}',
'./storybook/**/*',
],
};
```
用于修改 [Tailwind CSS](https://tailwindcss.com/docs/configuration) 的配置项。
... | 7,705 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/terser.mdx | ---
sidebar_label: terser
---
# tools.terser
import Main from '@modern-js/builder-doc/docs/zh/config/tools/terser.md';
<Main />
| 7,706 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/ts-checker.mdx | ---
sidebar_label: tsChecker
---
# tools.tsChecker
import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsChecker.md';
<Main />
| 7,707 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/ts-loader.mdx | ---
sidebar_label: tsLoader
---
# tools.tsLoader
import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsLoader.md';
<Main />
| 7,708 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/webpack-chain.mdx | ---
sidebar_label: webpackChain
---
# tools.webpackChain
import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpackChain.md';
<Main />
| 7,709 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/configure/app/tools/webpack.mdx | ---
sidebar_label: webpack
---
# tools.webpack
import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpack.md';
<Main />
| 7,710 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/_category_.json | {
"label": "进阶功能",
"position": 6,
"collapsed": false
}
| 7,711 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/code-split.mdx | ---
sidebar_position: 3
---
# 代码分割
代码分割是优化前端资源加载的一种常用手段，本文将介绍 Modern.js 支持的三种代码分割方式：
:::info
使用 Modern.js [约定式路由](/guides/basic-features/routes#约定式路由)时，默认会根据路由组件做代码分割，无需自行进行代码分割。
:::
- `import`
- `React.lazy`
- `loadable`
## import
使用动态 `import()` 语法，传入的 JS 模块将会被被打包到单独的 JS 文件中。例如：
```ts
import('./math').then(mat... | 7,712 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/compatibility.mdx | ---
sidebar_position: 6
---
# 浏览器兼容性
## Browserslist 配置
Modern.js 支持设置 Web 应用需要兼容的浏览器范围，你可以在 `.browserslistrc` 文件里设置 [Browserslist](https://browsersl.ist/) 的值。
当你创建一个新的 Modern.js 项目时，默认会包含一份 `.browserslistrc` 配置，这表示 JavaScript 代码会被编译至 ES6 格式。
```yaml title=".browserslistrc"
chrome >= 51
edge >= 15
firefox >= 54
sa... | 7,713 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/eslint.mdx | ---
sidebar_position: 8
---
# ESLint 规则集
{/* 参考 [实战教程 - 确认编程环境](../handbook/c03-ide/3.1-setting-up) 确保本地 IDE 环境正常。 */}
**Modern.js ESLint 规则集**是全量的 **ESLint** 规则集合，包含 `@modern-js` （对于 Node.js 项目的 Lint 规则）和 `@modern-js-app`（对于前端项目的 Lint 规则）。
下面以具体问题介绍更多 ESLint 用法。
## Q: 如何处理 Lint
### 实时自动修复
多数问题会被 ESLint 规则的自动修复... | 7,714 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/low-level.mdx | ---
sidebar_position: 10
---
# 配置底层工具
## 使用方式
Modern.js 内部默认集成了 [Babel](https://babeljs.io/)、[TypeScript](https://www.typescriptlang.org/)、[Webpack](https://webpack.js.org/)、[PostCSS](https://postcss.org/)、[Tailwind CSS](https://tailwindcss.com/) 等工具。通常情况下，默认配置能够满足大多业务开发需求。当有特殊需求时，可以通过底层配置来实现。
以配置 Webpack 为例，只需要在 `... | 7,715 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/rspack-start.mdx | ---
sidebar_position: 1
---
# 使用 Rspack
import Rspack from '@modern-js/builder-doc/docs/zh/shared/rspackTip.mdx';
<Rspack />
**Modern.js 提供开箱即用的 Rspack 支持**，你可以在成熟的 Webpack 和更快的 Rspack 之间进行切换。
这篇文档会向你介绍如何在 Modern.js 中开启 Rspack 构建模式。
## 初始化 Rspack 项目
Modern.js 生成器会提供一个可交互的问答界面，只需将构建工具选择为 **Rspack**，即可创建一个 Rspack ... | 7,716 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/ssg.mdx | ---
sidebar_position: 5
---
# 静态站点生成
SSG（Static Site Generation）是一种基于数据与模板，在构建时渲染完整静态网页的技术解决方案。
我们首先需要执行 `pnpm run new` 启用 SSG 功能：
```bash
? 请选择你想要的操作 启用可选功能
? 请选择功能名称 启用「SSG」功能
```
执行命令后，在 `modern.config.ts` 中注册 SSG 插件：
```ts title="modern.config.ts"
import { ssgPlugin } from '@modern-js/plugin-ssg';
export def... | 7,717 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/ssr.mdx | ---
sidebar_position: 4
---
# 服务端渲染
在 Modern.js 中，SSR 也是开箱即用的。开发者无需为 SSR 编写复杂的服务端逻辑，也无需关心 SSR 的运维，或是创建单独的服务。Modern.js 拥有完备的 SSR 降级策略，保证页面能够安全运行。
启用 SSR 非常简单，只需要设置 [`server.ssr`](/configure/app/server/ssr) 为 `true` 即可：
```ts title="modern.config.ts"
import { defineConfig } from '@modern-js/app-tools';
export defaul... | 7,718 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/testing.mdx | ---
sidebar_position: 11
---
# 使用 Jest 测试
Modern.js 默认集成了 [Jest](https://jestjs.io/) 的测试能力。
我们首先需要执行 `pnpm run new` 启用「单元测试 / 集成测试」功能：
```bash
? 请选择你想要的操作 启用可选功能
? 请选择功能名称 启用「单元测试 / 集成测试」功能
```
执行上述命令后，`package.json` 中将会自动添加 `"test": "modern test"` 命令。
在 `modern.config.ts` 中注册 `@modern-js/plugin-testing` 插件后即可使用测... | 7,719 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/using-storybook.mdx | ---
sidebar_position: 12
---
# 使用 StorybookV6
:::warning
该教程是用于老版本 StorybookV6 用户，并且会在以后弃用，想要从旧版本插件升级或新用户想要尝试请查看[新文档](https://modernjs.dev/builder/guide/advanced/storybook.html)
:::
[Storybook](https://storybook.js.org/) 是一个专门用于组件调试的工具，它围绕着组件开发提供了：
- 丰富多样的调试能力
- 可与一些测试工具结合使用
- 可重复使用的文档内容
- 可分享能力
- 工作流程自动化
## 开启 S... | 7,720 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/web-server.mdx | ---
sidebar_position: 13
---
# 自定义 Web Server
Modern.js 作为以客户端为中心的开发框架，对服务端的定制能力较弱。而在有些开发场景下，需要定制特殊的服务端逻辑，例如用户鉴权、请求预处理、添加页面渲染骨架等。
一些开发者可能会有疑惑，Modern.js 已经提供了 [BFF 能力](/guides/advanced-features/bff/function.html)，为什么还需要**自定义 Web Server**。
因为在默认情况下，页面路由并不会经过 BFF，它没有办法为页面访问提供服务端的定制逻辑。之所以这样设计，是因为我们不希望控制页面的服务与 BFF 服务绑定在... | 7,721 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/_category_.json | {
"label": "使用 BFF",
"position": 2,
"link": {
"type": "doc",
"id": "guides/advanced-features/bff/index"
}
}
| 7,722 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/bff-proxy.mdx | ---
sidebar_position: 5
title: 使用 BFF 代理
---
# 使用 BFF 代理
通过配置 BFF 代理，无需手动写码，即可对 API 请求进行转发。
:::caution
使用 BFF 代理需确保请求能进入 BFF handler。（例如请求路径必须包含 bff prefix）
:::
在 `modern.server-runtime.config.js` 文件中编写以下 BFF 代理配置，会将发送到 `http://localhost:8080/api/v1/topics` 的请求代理到 `https://cnodejs.org/api/v1/topics`。
```js title="... | 7,723 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/frameworks.mdx | ---
sidebar_position: 3
title: 运行时框架
---
# 运行时框架
Modern.js 的 BFF 支持不同的运行时框架，当前 Modern.js 的 BFF 支持两种运行时框架 [Express.js](https://expressjs.com/) 和 [Koa.js](https://koajs.com/)。
## 函数写法
在函数写法下，各类运行时框架仅中间件写法存在差异，其他实现基本相同。这里以 Express 为例，介绍如何在 `api/_app.ts` 中，手写一个中间件，添加权限校验：
```ts
import { hook } from '@modern-js/runtime/... | 7,724 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/function.mdx | ---
sidebar_position: 1
title: 基础用法
---
# 基础用法
通过 Modern.js 开发的应用，可以在 `api/` 目录下定义接口函数，前端可以调用这些接口函数，即可发起请求，无需写前后端胶水层代码，同时保证前后端类型安全。
## 启用 BFF
import EnableBFF from "@site-docs/components/enable-bff"
<EnableBFF/>
## BFF 函数
允许通过一体化调用的函数，称为 **BFF 函数**。这里写一个最简单的 BFF 函数，创建 `api/hello.ts` 文件：
:::caution
如果是框架模式（有 `api... | 7,725 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/index.mdx | ---
title: BFF
---
# BFF
在**前后端分离**概念出现后一段时间发展中，前端部分能够做的事越来越多，前端需要一些面向 UI 的数据接口，因此业界引入了 BFF（Backends for Frontends）这一概念。
它主要为了解决的问题包括：
- 根据自身业务需求，对更底层 API 的聚合、映射、裁剪、代理。
- 对一些特定场景的数据进行缓存，提高性能，进而提升用户体验。
- 根据已有接口快速开发新产品。
- 与第三方系统对接，例如登陆鉴权。
Modern.js 官方支持了 BFF，并提供了**一体化 BFF 方案**来进一步强化 BFF 能力，主要包括以下能力：
- 快速开发调试上线，在同一项目... | 7,726 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/sdk.mdx | ---
sidebar_position: 4
title: 自定义请求 SDK
---
# 自定义请求 SDK
Modern.js 的 BFF 在 CSR 和 SSR 是同构的。在浏览器端依赖了[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch)，在服务端依赖了 [node-fetch](https://www.npmjs.com/package/node-fetch)。但在很多业务场景下我们需要对请求或响应做一些额外的处理，例如：
- 在请求头中写入鉴权信息
- 对响应的数据或错误进行统一的处理
- 特定平台无法... | 7,727 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/advanced-features/bff/type.mdx | ---
sidebar_position: 2
title: 函数写法 & 框架写法
---
# 函数写法 & 框架写法
运行时框架支持也是 **BFF** 中重要的一环。Modern.js 支持通过插件扩展 BFF 的运行时框架，并提供了一系列内置插件，开发者可以直接使用对应框架的约定和生态。
插件中兼容了这些框架大部分的规范，每一种框架都需要提供两类扩展写法 BFF 函数的方式，分别是**函数写法**和**框架写法**。
:::note
当前 `api/` 目录结构是否为框架写法由对应的插件决定，Modern.js 并不关心。
:::
## 函数写法
当插件认为当前为函数写法时，必须支持在 `api/_app.ts`... | 7,728 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/_category_.json | {
"label": "基础功能",
"position": 3,
"collapsed": false
}
| 7,729 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/alias.mdx | ---
sidebar_position: 4
---
# 路径别名
import Alias from '@modern-js/builder-doc/docs/zh/shared/alias';
<Alias />
## 默认别名
Modern.js 框架内置了以下别名:
```json
{
"@": "./src",
"@shared": "./shared"
}
```
此外，在启用框架的 BFF 插件时，默认会添加 `@api` 别名。
```json
{
"@api": "./api"
}
```
| 7,730 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/css.mdx | ---
sidebar_position: 1
---
# 样式开发
Modern.js 内置多种常用的 CSS 开发方案，包括 Less / Sass / Stylus 预处理器、PostCSS、CSS Modules、CSS-in-JS 和 Tailwind CSS。
## 使用 Less、Sass 和 Stylus
Modern.js 内置了社区流行的 CSS 预处理器，包括 Less 和 Sass。
默认情况下，你不需要对 Less 和 Sass 进行任何配置。如果你有自定义 loader 配置的需求，可以通过配置 [tools.less](/configure/app/tools/less)、[tools.sas... | 7,731 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/env-vars.mdx | ---
sidebar_position: 7
---
# 环境变量
Modern.js 提供了对环境变量的支持，包含内置的环境变量和自定义的环境变量。
## 内置的环境变量
### ASSET_PREFIX
表示当前资源文件的路径前缀，是**只读的**的环境变量。
### NODE_ENV
表示当前的执行环境，是**只读的**的环境变量，其值在不同的执行命令下具有不同的值：
- `production`：执行 `modern build`、`modern serve` 命令时的默认值。
- `test`：执行 `modern test` 命令时的默认值。
- `development`：执行 `modern dev... | 7,732 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/html.mdx | ---
title: HTML 模板
sidebar_position: 9
---
# HTML 模板
Modern.js 提供了 **JSX 语法**和 **HTML(EJS) 语法**两种方式用于自定义 HTML 模板。
## JSX 语法
Modern.js 约定，在 `src/` 或入口目录下，可以创建 `Document.[jt]sx` 文件并默认导出组件，该组件的渲染结果可以作为入口的 HTML 模板。
例如以下目录结构：
```bash
.
└── src
├── Document.tsx
├── entry-a
│ ├── Document.tsx
│ └── r... | 7,733 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/mock.mdx | ---
sidebar_position: 5
---
# 数据模拟
Modern.js 提供了快速生成 Mock 数据的功能，能够让前端独立自主开发，不被后端接口阻塞。
## 启用 Mock
约定当 `config/mock` 目录下存在 `index.[jt]s` 时，会自动开启 Mock 功能，如下：
```bash
.
├── config
│ └── mock
│ └── index.ts
├── src
│ └── App.tsx
└── modern.config.ts
```
## 编写 Mock 文件
`config/mock/index.ts` 文件只需要导出一个包含所有 Moc... | 7,734 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/proxy.mdx | ---
sidebar_position: 6
---
# 网络代理
## 本地代理
Modern.js 在 [`tools.devServer`](/configure/app/tools/dev-server) 中提供了配置开发环境代理的方式。例如，将本地开发接口，代理到线上某个地址：
```ts title="modern.config.ts"
import { defineConfig } from '@modern-js/app-tools';
export default defineConfig({
tools: {
devServer: {
proxy: {
'/go... | 7,735 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/routes.mdx | ---
sidebar_position: 2
---
# 路由方案
Modern.js 的路由基于 [React Router 6](https://reactrouter.com/en/main)，并提供了多种类型的路由模式。根据不同 [入口](/guides/concept/entries) 类型，将路由分为三种模式，分别是**约定式路由**，**自控式路由**和**其他路由方案**。
:::note
本小节提到的路由，都是客户端路由，即 SPA 路由。
:::
## 约定式路由
以 `routes/` 为约定的入口，Modern.js 会自动基于文件系统，生成对应的路由结构。
Modern.js 支持了业界流行... | 7,736 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/data/_category_.json | {
"label": "数据管理",
"position": 3
}
| 7,737 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/data/data-fetch.mdx | ---
title: 数据获取
sidebar_position: 3
---
# 数据获取
Modern.js 中提供了开箱即用的数据获取能力，开发者可以通过这些 API，在项目中获取数据。
需要注意的是，这些 API 并不帮助应用发起请求，而是帮助开发者更好地管理数据，提升项目的性能。
## Data Loader(推荐)
Modern.js 推荐使用约定式路由做路由的管理，通过 Modern.js 的[约定式（嵌套）路由](/guides/basic-features/routes#约定式路由)，每个路由组件(`layout.ts` 或 `page.ts`)可以有一个同名的 `data` 文件，该 `data` 文件... | 7,738 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/basic-features/data/data-write.mdx | ---
title: 数据写入
sidebar_position: 4
---
# 数据写入
在 Data Loader 章节中，介绍了 Modern.js 获取数据的方式，你可能会遇到两个问题：
1. 如何更新 Data Loader 中的数据？
2. 如何将新的数据传递到服务器?
EdenX 对此的解决方案是 DataAction。
## 基本示例
Data Action 和 Data Loader 一样，也是基于约定式路由的，通过 Modern.js 的[约定式（嵌套）路由](/guides/basic-features/routes#约定式路由)，每个路由组件(`layout.ts`，`page.ts` 或 `$.... | 7,739 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/concept/_category_.json | {
"label": "核心概念",
"position": 2,
"collapsed": false
}
| 7,740 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/concept/builder.mdx | ---
sidebar_position: 2
---
# 构建工具
**Modern.js 的构建能力由 [Modern.js Builder](https://modernjs.dev/builder) 提供。**
Modern.js Builder 是 Modern.js 体系的核心组件之一，它是一个基于 Rspack 的 Web 构建工具，可以脱离 Modern.js 被独立使用。Modern.js Builder 同时支持 webpack 和 Rspack 等多种打包工具，默认情况下使用最成熟的 webpack 进行打包。
## 构建架构
从构建的角度看，Modern.js 分为三层架构，从上到下依次是：
- ... | 7,741 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/concept/entries.mdx | ---
sidebar_position: 1
---
# 页面入口
通过本章节，你可以了解到 Modern.js 中的入口约定，以及如何自定义入口。
## 什么是入口
**入口（Entry）指的是一个页面的起始模块。**
在 Modern.js 项目中，每一个入口对应一个独立的页面，也对应一条服务端路由。默认情况下，Modern.js 会基于目录约定来自动确定页面的入口，同时也支持通过配置项来自定义入口。
Modern.js 提供的很多配置项都是以入口为维度进行划分的，比如页面标题、HTML 模板、页面 Meta 信息、是否开启 SSR/SSG、服务端路由规则等。
## 单入口与多入口
Modern.js 初始化的... | 7,742 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/_category_.json | {
"label": "开始",
"position": 1,
"collapsed": false
}
| 7,743 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/glossary.mdx | ---
sidebar_position: 4
---
# 名词解释
## BFF
BFF 是 "Backend For Frontend"（前端的后端） 的缩写。它是一种架构模式，表示为前端应用程序创建一个专门的后台服务。
BFF 服务作为前端应用程序和服务端 API 之间的中介，可以为前端提供定制的 API 供其使用。这允许前端开发者对需要的数据和功能有更多的控制，而不必依赖后端服务提供相应的能力。
## Bundler
import Bundler from '@modern-js/builder-doc/docs/zh/shared/bundler.md';
<Bundler />
## Builder
i... | 7,744 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/introduction.mdx | ---
title: 介绍
sidebar_position: 1
---
# Modern.js 介绍
**Modern.js 是字节跳动 Web 工程体系的开源版本**，它提供多个解决方案，来帮助开发者解决不同研发场景下的问题。
目前 Modern.js 包含两个解决方案，分别面向 Web 应用开发场景 和 npm 包开发场景：
import { SolutionCards } from '@site/src/components/SolutionCards';
<SolutionCards
cards={[
{
title: 'Modern.js Framework',
descr... | 7,745 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/quick-start.mdx | ---
title: 快速上手
sidebar_position: 2
---
# 快速上手
## 环境准备
import Prerequisites from '@site-docs/components/prerequisites';
<Prerequisites />
## 安装
Modern.js 提供了 `@modern-js/create` 工具来创建项目，不需要全局安装，直接使用 `npx` 按需运行即可。
你可以在已有的空目录来创建项目：
```bash
mkdir myapp && cd myapp
npx @modern-js/create@latest
```
也可以直接用新目录创建项目：
... | 7,746 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/tech-stack.mdx | ---
sidebar_position: 4
---
# 技术栈
Modern.js 框架默认集成了一些社区中流行的库和开发工具。
在这篇文档中，你可以了解到 Modern.js 框架涉及的主要技术栈，以及一些可选的库和工具。
---
## UI 库
Modern.js 使用 [React 18](https://react.dev/) 来构建用户界面，同时也兼容 React 17。
Modern.js 底层的 Builder 也支持构建 Vue 应用，如果你需要使用 Vue，可以参考[「构建 Vue 应用」](https://modernjs.dev/builder/guide/framework/vue3.htm... | 7,747 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/get-started/upgrade.mdx | ---
sidebar_position: 3
---
# 版本升级
## 通过命令行升级
Modern.js 提供了 `upgrade` 命令支持项目升级到最新的 Modern.js 版本。
在项目中执行 `upgrade` 命令：
import { PackageManagerTabs } from '@theme';
<PackageManagerTabs command="run upgrade" />
```bash
> modern upgrade
[INFO] [项目类型]: Web 应用
[INFO] [Modern.js 最新版本]: 2.0.0
[INFO] 已更新 Modern.js 依赖至最新... | 7,748 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/_category_.json | {
"label": "专题详解",
"position": 8,
"collapsed": false
}
| 7,749 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/_category_.json | {
"label": "包版本管理",
"position": 5
}
| 7,750 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/add.mdx | ---
sidebar_position: 2
---
# 添加 Changesets
当我们开发完成时，需要添加一个 changeset 声明当前变更，用于后续版本发布。
## 信息
一个 changeset 包含的内容包括：
- 本次变更涉及哪些包的变更。
- 本次变更需要升级的版本号类型，类型符合 [semver](https://semver.org/) 规范。
- 本次变更的 changelog 信息。
## 步骤
:::info
以下示例命令都以 pnpm 作为包管理工具进行，如果需要使用其他包管理工具，请按需求进行替换。
:::
### Modern.js Module
#### 在根目录执行 ... | 7,751 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/changelog.mdx | ---
sidebar_position: 6
---
# 自定义 changelog 生成
Changesets 默认会使用 `@changesets/cli/changelog` 生成 Changelog 信息，如果默认的 changelog 信息不能满足需求，可以自定义 changelog 的生成。
## 自定义 changelog 内容
changelog 信息主要包含以下两种信息：
- changeset 中写入的 changelog 信息。
- 本次版本升级关联包的版本变更信息。
自定义逻辑主要实现两个函数，`getReleaseLine` 和 `getDependencyReleaseLine`，分别用来... | 7,752 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/commit.mdx | ---
sidebar_position: 7
---
# 自定义提交 commit 信息
Changesets 支持配置 `commit` 为 true 时，在执行 `change` 和 `bump` 命令时自动提交当前变更。
默认的 `commit` 信息由 `@changesets/cli/commit` 提供，默认信息格式为：
，右上角选择安装，确认即可安装成功。
 用于模块和 Monorepo 工程方案的包版本管理。
## 特点
Changesets 具有以下几个特点：
- 在开发时，需要开发者提供本次变更涉及的包名称、升级版本类型(`pathch`、`minor`、`major`)及变更信息，即 changeset。
- 在发布版本时，会根据 changeset 内容自动升级对应包的版本号，并在对应的包中生成 changelog 信息。
- 在 Mon... | 7,756 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/release-note.mdx | ---
sidebar_position: 8
---
# 自定义 Release Note 格式
Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在的 changeset 和 git commit 信息自动生成 Release Note 信息，在发布命令执行之前，可以通过执行该命令生成本次发布的 Release Note。
默认生成的 Release Note 格式为：
```markdown
- fix: add missing type definitions by @zllkjc in https://github.com/web-infra-dev/modern.... | 7,757 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/release-pre.mdx | ---
sidebar_position: 4
---
# 发布预发布版本
在发布正式版本之前，我们也需要发布预发布版本供内部测试和用户使用，changesets 也支持发布预发布版本。
## 步骤
:::info
以下示例命令都以 pnpm 作为包管理工具进行，如果需要使用其他包管理工具，请按需求进行替换。
:::
#### 执行 bump 命令升级预发布版本版本号
```bash
pnpm run bump --canary --preid <preid>
```
`preid` 为预发布版本标记，例如 `alpha`、`beta` 等，默认值为 `next`。
使用 `--canary` 参数后，`bump`... | 7,758 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/changesets/release.mdx | ---
sidebar_position: 3
---
# 发布正式版本
发版正式版本时，我们需要根据开发过程中生成的 changesets 进行相关包版本号升级，并执行 publish 命令发布到 NPM 上。
## 步骤
:::info
以下示例命令都以 pnpm 作为包管理工具进行，如果需要使用其他包管理工具，请按需求进行替换。
:::
### Modern.js Module
#### 在根目录执行 bump 命令
```bash
pnpm run bump
```
![执行 bump 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/l... | 7,759 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/_category_.json | {
"label": "自定义插件",
"position": 6
}
| 7,760 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/extend.mdx | ---
sidebar_position: 5
---
# 扩展插件 Hook
本小节介绍如何通过动态注册 [Hook 模型](/guides/topic-detail/framework-plugin/hook) 的方式来扩展插件 Hook。
## 示例
这里我们用一个简单的例子演示一下。假设我们要添加一些管理控制台输出信息的 Hook。
首先我们初始化一个空的项目文件，并添加基础依赖：
```bash
$ npx @modern-js/create@latest modern-js-demo
```
### 创建 Hook
我们先创建一个 Hook 模型：
```ts title=config/plugin/m... | 7,761 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/hook-list.mdx | ---
sidebar_position: 8
---
# Hook 列表
Modern.js 工程体系中包含三类插件：CLI、Runtime、Server，每一类插件可以使用不同的 Hooks。
在本章节中，罗列了所有可用的 Hooks，你可以根据自己的需求来使用对应的 Hook。
## CLI Common Hooks
以下是通用的 CLI Hooks，可以在 Modern.js Framework 以及 Modern.js Module 中使用。
### `beforeConfig`
- 功能：运行收集配置前的任务
- 执行阶段：收集配置前
- Hook 模型：`AsyncWorkflow`
- 类型：`Asyn... | 7,762 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/hook.mdx | ---
sidebar_position: 2
---
# Hook 模型
首先介绍一下 Modern.js 的基础的插件系统中的一些内容，包括 Hook 模型的工作方式、各个 Hook 模型的运行模式、Manager 的工作模式。
每种 Hook 模型都是独立的，可以独立管理运行函数。
## 基础工作方式
先以 Pipeline 为例，简单介绍一下 Hook 模型的工作方式。先看一个简单的例子：
```ts
import { createPipeline } from '@modern-js/plugin';
// 1. 创建
const pipeline = createPipeline<number, numbe... | 7,763 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/implement.mdx | ---
sidebar_position: 3
---
# 如何编写插件
上一小节介绍了 Modern.js 插件的 Hook 模型，这一小节介绍如何编写插件。
## 实现插件
Modern.js 插件是一个对象，对象包含以下属性：
- `name`: 插件的名称，唯一标识符。
- `setup`: 插件初始化函数，只会执行一次。setup 函数可以返回一个 Hooks 对象，Modern.js 会在特定的时机执行这些 Hooks。
```ts
const myPlugin = {
name: 'my-plugin',
setup() {
// 执行一些初始化逻辑
const foo = '1'... | 7,764 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/introduction.mdx | ---
sidebar_position: 1
---
# 介绍
## Modern.js 插件系统
Modern.js 用于扩展项目运行、请求、渲染等不同阶段功能的系统，主要分为三个部分：Hook 模型、管理器，上下文共享机制。
Hook 模型用于确定当前 Hook 的执行方式，不同 Hook 模型的函数拥有不同的执行逻辑。管理器用于控制 Hook 的执行与调度。上下文共享机制用于在不同 Hook 间传递信息。
目前 Modern.js 提供几种不同的 Hook 模型：
- Pipeline
- Sync
- Async
- Waterfall
- Sync
- Async
- Workflow
-... | 7,765 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/lifecycle.mdx | ---
sidebar_position: 1
---
# 生命周期
Modern.js 应用具有完整的生命周期，包括 CLI、Server Side 和 Runtime 三个阶段。
目前 Modern.js 大致的生命周期如下：
:::note
其中粉色框的矩形代表 Modern.js 提供的插件钩子，淡黄色底色椭圆代表与下一个阶段的连接点。
:::
| 7,766 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/plugin-api.mdx | ---
sidebar_position: 6
---
# 插件 API
插件的 `setup` 函数会接收一个 `api` 入参，你可以调用 api 上提供的一些方法来获取到配置、应用上下文等信息。
```ts
import type { CliPlugin } from '@modern-js/core';
export const myPlugin = (): CliPlugin => ({
name: 'my-plugin',
setup(api) {
// 获取应用原始配置
const config = api.useConfigContext();
// 获取应用运行上下文
... | 7,767 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/framework-plugin/relationship.mdx | ---
sidebar_position: 4
---
# 插件之间的关系
Modern.js 的插件配置对象提供了一系列的字段，用于控制插件顺序、互斥等能力，可用的字段如下：
- `name`: `string`，设置当前插件的名称。
- `pre`: `string[]`，这些插件最终会调整到当前插件前面。
- `post`: `string[]`，这些插件最终会调整到当前插件后面。
- `rivals`: `string[]`，互斥插件，遇到这些插件时会报错。
- `required`: `string[]`，必需插件，插件列表中没有对应的插件时会报错。
- `usePlugin`: `CliPlugin[]`，注册其他... | 7,768 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/_category_.json | {
"label": "项目生成器",
"position": 5
}
| 7,769 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/create/_category_.json | {
"label": "@modern-js/create",
"position": 1
}
| 7,770 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/create/config.mdx | ---
sidebar_position: 3
---
# 配置参数
`@modern-js/create` 提供了 [--config](/guides/topic-detail/generator/create/option.html#-c,---config-<config>) 参数，用于提前指定执行过程中交互问题的答案。
这里将介绍不同情况下，可以在 `config` 中配置的字段及字段值。
## 通用配置
### solution
问题：请选择你想创建的工程类型
选项：
- Web 应用 -- mwa
- Npm 模块 -- module
- 文档站 -- doc
- Monorepo -- mon... | 7,771 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/create/option.md | ---
sidebar_position: 2
---
# CLI 参数
`@modern-js/create` 提供了很多配置参数用于配置其执行过程中的行为，可以通过 `--help` 参数进行查看：
```bash
npx @modern-js/create@latest --help
Usage: npx @modern-js/create@latest [projectDir]
创建 Modern.js 工程方案
Options:
--version 当前 create 工具版本号
--lang <lang> 设置 create 工具语言(zh 或者 e... | 7,772 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/create/use.mdx | ---
sidebar_position: 1
---
# 使用
Modern.js 提供了 `@modern-js/create` 工具用于创建 Modern.js 提供的工程方案项目，例如 [Web 应用](https://modernjs.dev/)、[Npm 模块](https://modernjs.dev/module-tools)、[Monorepo](/guides/topic-detail/monorepo/intro.html) 等。
下面将介绍 `@modern-js/create` 的使用姿势。
## 环境准备
import Prerequisites from "@site-docs/compone... | 7,773 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/new/_category_.json | {
"label": "new 命令",
"position": 2
}
| 7,774 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/new/config.md | ---
sidebar_position: 3
---
# 配置参数
`new` 命令提供了 [--config](/guides/topic-detail/generator/new/option.html#-c,---config-<config>) 参数，用于提前指定执行过程中交互问题的答案。
这里将介绍不同情况下，可以在 `config` 中配置的字段及字段值。
## 通用配置
### actionType
问题：请选择你想要的操作
选项：
- 创建工程元素 -- element
- 启用可选功能 -- function
- 自动重构 -- refactor
## Web 应用
### element... | 7,775 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/new/option.md | ---
sidebar_position: 2
---
# CLI 参数
`new` 命令提供了很多配置参数用于配置其执行过程中的行为，可以通过 `--help` 参数进行查看：
```bash
npm run new --help
Usage: modern new [options]
启用可选功能
Options:
--lang <lang> 设置 new 命令执行语言(zh 或者 en)
-c, --config <config> 生成器运行默认配置(JSON 字符串)
-d, --debug 开启 Debug 模式，打印调试日志信息 (default: fal... | 7,776 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/new/use.md | ---
sidebar_position: 1
---
# 使用
在 Web 应用、 Npm 模块和 Monorepo 项目中，我们提供了 `new` 命令用于创建项目元素、开启功能和创建子项目。
## Web 应用
Web 应用项目通过 `@modern-js/app-tools` 提供 `new` 命令。
new 命令提供了三种操作类型：
- 创建工程元素
- 启用可选功能
- 自动重构
每种操作类型都提供了对应支持的列表，可根据项目情况进行选择。
例如：
创建新的应用入口：
```bash
npm run new
? 请选择你想要的操作 创建工程元素
? 请选择创建元素类型 新建「应用入口」
? 请填写... | 7,777 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/_category_.json | {
"label": "生成器插件",
"position": 2
}
| 7,778 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/category.md | ---
sidebar_position: 2
---
# 类型
## 介绍
生成器插件分为两类：
- 扩展：Web 应用( Npm 模块) = Web 应用( Npm 模块) + 生成器插件
- 自定义：新应用(模块) = Web 应用(模块) + 生成器插件
简单理解就是扩展还是使用 Modern.js 原本的工程方案名称，自定义会创建一个新的名称。
## 标识
生成器插件的类型通过 `package.json` 中的 meta 字段来提供：
### 扩展
```json title="package.json"
{
"meta": {
"extend": "mwa" // module
}
}... | 7,779 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/context.md | ---
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... | 7,780 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/structure.md | ---
sidebar_position: 1
---
# 介绍及创建项目
## 介绍
Modern.js 提供了 Web 应用、Npm 模块等工程方案，并通过使用 `@modern-js/create` 工具可以创建工程方案的初始项目模板，初始项目模板会提供基本的代码开发环境、简单的示例代码及配置等。
Modern.js 提供的初始化模板具有通用性，能满足一些通用的项目开发需求。
当你深度使用 Modern.js 时，必然会发现每次创建的项目都会进行一些针对自身项目的特定的相似改动，比如修改示例代码、增加一些配置、开启某些功能等。
生成器插件可以帮你将这些针对个人或团队特定的改动沉淀下来，在执行 `npx @moder... | 7,781 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/use.md | ---
sidebar_position: 3
---
# 使用
`@modern-js/create` 提供了 `--plugin` 参数用于运行生成器插件项目。
`--plugin` 支持三种格式：
## 绝对路径
适用于本地开发调试，开发完成后，在生成器插件执行 `npm run build` 构建项目，然后使用下面命令即可进行测试。
```bash
npx @modern-js/create@latest --plugin <pluginPath>
```
## 相对路径
适用于本地开发调试或者生成器插件项目和目标创建项目在同一个 Monorepo，无需发布 NPM 包，构建项目后，执行下面命令即可。
``... | 7,782 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/api/_category_.json | {
"label": "API",
"position": 5
}
| 7,783 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/api/afterForged.md | ---
sidebar_position: 3
---
# afterForged
`afterForged` 为生成器插件中用于文件操作后其他步骤操作的生命周期函数。
## 类型
```ts
export type AfterForgedAPI = {
isInGitRepo: () => Promise<boolean>;
initGitRepo: () => Promise<void>;
gitAddAndCommit: (commitMessage: string) => Promise<void>;
install: () => Promise<void>;
};
export type Plug... | 7,784 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/api/context.md | ---
sidebar_position: 1
---
# context
生成器插件在 `main` 文件中默认导出了一个函数，函数参数为 `context`，生成器插件提供的所有 API 都是由这个 `context` 提供的。
## 类型
我们先大概了解一下 `context` 的类型定义：
```ts
export interface IPluginContext {
locale?: string;
addInputBefore: (key: string, input: Schema) => void;
addInputAfter: (key: string, input: Schema) => v... | 7,785 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/api/input.md | ---
sidebar_position: 4
---
# Input
生成器插件提供了 Input 的方式完成与用户的问题交互，使用 JSON Schema 的方式进行定义：
例如：
```js
const schema = {
type: 'object',
properties: {
language: {
type: 'string',
title: '开发语言',
enum: [
{ label: 'TS', value: 'ts' },
{ label: 'ES6+', value: 'js' },
],
},... | 7,786 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/generator/plugin/api/onForged.md | ---
sidebar_position: 2
---
# onForged
`onForged` 为生成器插件中用于文件操作的生命周期函数。
## 类型
```ts
export type ForgedAPI = {
addFile: (params: AddFileParams) => Promise<void>;
addManyFiles: (params: AddManyFilesParams) => Promise<void>;
updateJSONFile: (fileName: string, updateInfo: Record<string, unknown>) => Promise<void>... | 7,787 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/_category_.json | {
"label": "微前端",
"position": 2
}
| 7,788 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/c01-introduction.mdx | ---
sidebar_position: 1
---
# 微前端介绍
import MicroFrontend from '@modern-js/builder-doc/docs/zh/shared/micro-frontend.md';
<MicroFrontend />
## 微前端关键词
在微前端研发模式中，应用会被分成 **主应用**、和 **子应用**。
- 主应用：微前端项目的基座工程，所有子应用都会由它来加载。
- 子应用：独立开发、独立部署的应用，最终会被主应用加载。
## 功能简介
- 基于 [Garfish](https://www.garfishjs.org/guide)
- 生成器支持微前端... | 7,789 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/c02-development.mdx | ---
sidebar_position: 2
title: 体验微前端
---
# 体验微前端
通过本章你可以了解到：
- 如何创建微前端项目的主应用、子应用。
- 微前端项目开发的基本流程。
## 创建应用
目前支持两种路由模式
- 自控式路由
- 约定式路由
首先明确主应用的路由模式 [创建约定式路由主应用](#创建约定式路由主应用) 或 [创建自控式路由主应用](#创建自控式路由主应用)
在本次体验中我们会为主应用创建两个子应用 Table 和 Dashboard (Table 为约定式路由，Dashboard 为自控式路由)
### 创建约定式路由主应用
通过命令行工具初始化项目：
```bash
m... | 7,790 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/c03-main-app.mdx | ---
sidebar_position: 3
title: 开发主应用
---
# 开发主应用
在上一章 [体验微前端](/guides/topic-detail/micro-frontend/c02-development) 通过一个示例演示了如何创建和配置微前端子应用，通过本章你可以进一步了解如何开发主应用，以及它的常见配置。
在通过 `@modern-js/create` 命令创建 Modern.js 工程后，可以在项目中执行 `pnpm run new`（实际执行了 `modern new` 命令），在选择了「微前端」模式后，会安装微前端依赖依赖，只需手动注册插件即可。
import EnableMicroFron... | 7,791 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/c04-communicate.mdx | ---
sidebar_position: 4
title: 主子应用通信
---
# 主子应用通信
## props 通信
Modern.js 中，会将子应用包裹成一个 React 组件，直接通过给 React 组件传递 `props` 即可实现主应用和子应用通信的目的。
```tsx title=主应用：App.tsx
function App() {
const { MApp } = useModuleApps();
return (
<div>
<MApp count={100} />
</div>
);
}
```
```tsx title=子应用：App.tsx
fun... | 7,792 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/micro-frontend/c05-mixed-stack.mdx | ---
sidebar_position: 5
title: 混合技术栈
---
# 混合技术栈
Modern.js 微前端方案是基于 [Garfish](https://garfishjs.org/) 封装的，提供了一些更开箱即用的使用方式。
当你的主应用和子应用不全是 Modern.js 应用的时候，可以参考这篇文档。
1. 子应用是 **Modern.js**，主应用使用的原生 Garfish 微前端。
2. 主应用是 **Modern.js**，子应用有的是其它技术栈。
## 子应用是 Modern.js
**Modern.js** 子应用编译后会生成标准的 [Garfish 子应用导出](https://www... | 7,793 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/_category_.json | {
"label": "Reduck 状态管理",
"position": 1
}
| 7,794 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/auto-actions.mdx | ---
sidebar_position: 6
title: 自动生成 Actions
---
# 自动生成 Actions
在 [快速上手](/guides/topic-detail/model/quick-start) 中，我们实现最简单的计数器 Model 也需要 10 行代码。
实际上，Modern.js 支持根据声明的 `state` 类型，自动生成常用的 Actions，从而简化模板代码量。当前支持的类型有：
- 原始数据类型
- 数组类型
- 简单对象类型（Plain Object）
## 原始数据类型
```ts
const countModel = model('count').define({ state... | 7,795 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/computed-state.mdx | ---
sidebar_position: 4
title: 衍生状态
---
# 衍生状态
一些场景中，组件需要对 Model 中的 State 进行进一步计算，才能在组件中使用，这部分逻辑可以直接写在组件内部，也可以通过 Model 的衍生状态实现。
衍生状态定义在 Model 中的 `computed` 字段下。根据依赖的 Model 的不同、返回类型的不同，衍生状态的定义方法可以分为以下 3 种。
## 只依赖自身的 State
衍生状态只依赖当前 Model 的 State，State 会作为第一个参数，传入衍生状态的定义函数中。
例如， todo 应用的 State 有 `items` 和 `filter`，`f... | 7,796 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/define-model.mdx | ---
sidebar_position: 2
title: 创建 Model
---
# 创建 Model
上一节的计数器应用中，我们简单演示了如何创建一个 Model。本节我们将详细介绍 Model 的创建方法。
通过 `model` API 创建 Model，例如，`model('foo')` 表示要创建一个名为 `foo` 的 Model，通过调用 `model('foo')` 返回的 `define` 函数，定义 Model 包含的 State、Actions 等：
```js
import { model, useModel } from '@modern-js/runtime/model';
const foo... | 7,797 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/faq.mdx | ---
sidebar_position: 13
title: 常见问题
---
# 常见问题
## 浏览器兼容性
Reduck 的编译构建产物默认使用 ES6 语法，如果你需要支持更低版本的浏览器，请将 `@modern-js-reduck` 命名空间下的所有包加入到应用的编译过程。
:::info 补充信息
Reduck 使用的 [`@babel/preset-env`](https://babeljs.io/docs/en/babel-preset-env) 的详细[配置](https://github.com/web-infra-dev/reduck/blob/main/common/config.js#L10~L1... | 7,798 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/zh/guides/topic-detail/model/manage-effects.mdx | ---
sidebar_position: 5
title: 副作用管理
---
# 副作用管理
Model 中的 Action 必须是一个纯函数，执行过程中不会产生任何副作用。但在真实的业务中，我们会遇到很多副作用场景，如：请求 HTTP 接口获取状态数据，或者在更新状态的同时修改 localStorage、发送事件等。在 Reduck 中，是通过 Model 的 Effects 函数管理副作用的。
## 副作用对 State 修改
副作用修改 State，最常见的场景就是请求 HTTP 接口，更新状态数据。
我们以一个简单的 `todoModel` 为例。其有一个 `load` 的副作用函数，请求远端的 TODO 列表，... | 7,799 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.