rerumaccusamus
Version:
The meta-framework suite designed from scratch for frontend-focused modern web development.
190 lines (97 loc) • 3.44 kB
Markdown
---
sidebar_position: 2
---
# 应用
应用项目默认包含通用配置,通用配置可查看[通用配置](/docs/apis/generator/config/introduce#通用配置)。
## 创建项目
创建项目时配置,`@modern-js/create` 使用 config 参数时使用的配置,也是在生成器插件中修改和添加 input 时使用的配置。
### Run-Way
运行方式(runWay),共有两个选项:
- No(no),使用标准运行模式
- Electron(electron),启用 Electron 模式
### Need-Modify-MWA-Config
是否需要修改应用默认配置(needModifyMWAConfig),该值为 `yes` 时,后续配置才会展示给用户,在使用 `config` 参数和生成器插件中,后续配置才会生效。
该字段共有两个选项:
- 是(yes)
- 否(no)
### Client-Route
客户端路由配置(clientRoute),默认为自控路由,共有三个选项:
- 启用自控路由(selfControlRoute)
- 启用约定式路由(conventionalRoute)
- 不启用(no)
### Disable-State-Management
是否关闭应用状态管理功能(disableStateManagement),默认为不关闭,共有两个选项:
- 是(yes)
- 否(no)
### Enable-Less
是否启用 Less 支持(enableLess),默认为不启用,共有两个选项:
- 是(yes)
- 否(no)
### Enable-Sass
是否启用 Sass 支持(enableSass), 默认为不启用,共有两个选项:
- 是(yes)
- 否(no)
## New 命令
应用项目中 new 命令配置, new 命令中使用 config 参数时使用的配置,也是在生成器插件中创建元素和启用功能时使用。
### Action-Type
New 命令的操作类型(actionType),类型支持两种:
- element 创建工程元素
- function 启用功能
:::info
在生成器插件中使用启用功能和创建元素时不需要该参数,生成器插件中自动添加该参数。
:::
### Element
元素名称(element),支持两个选项:
- 创建应用入口(entry)
- 新建 Server 自定义源码目(server)
这两个选项还需要配置具体的配合使用,介绍如下:
#### Name
入口名称(name), 字符串类型。
创建入口除了`name`之外,还需要 `needModifyMWAConfig`、`clientRoute` 和 `disableStateManagement` 字段。
#### Framework
自定义 Server 运行时框架(framework),支持四个选项:
- Egg(egg)
- Express(express)
- Koa(koa)
- Nest(nest)
### Function
可选功能名称(function),支持 11 个选项:
- Unbundled(unbundle)
- Tailwind CSS(tailwindcss)
- Less(less)
- Sass(sass)
- BFF(bff)
- SSG(ssg)
- 微前端(micro_frontend)
- Electron(electron)
- 单元测试(test)
- Storybook(mwa_storybook)
- 部署(deploy)
`bff` 和 `deploy` 和还需要配置具体的配合使用,介绍如下:
#### BFF 相关参数
##### BFF-Type
BFF 类型(bffType),支持两个选项:
- 函数模式(function)
- 框架模式(framework)
##### Framework
自定义 Server 运行时框架(framework),支持四个选项:
- Egg(egg)
- Express(express)
- Koa(koa)
- Nest(nest)
#### Deploy 相关参数
##### Disable-Modern-Server
是否禁用框架内置的产品级 Web 服务器(disableModernServer)。
该字段共有两个选项:
- 是(yes)
- 否(no)
##### CDN-Type
CDN 平台(cdnType),支持三个选项:
- 阿里云 OSS(oss)
- 腾讯云 COS(cos)
- 不使用 CDN(no)
##### Lambda-Type
云函数平台(lambdaType),支持三个选项:
- 阿里云 FC(fc)
- 腾讯云 SCF(scf)
- 不使用云函数部署(no)