跳转到主文档
应用工程
模块工程
Monorepo工程
项目生成器

介绍

Modern.js 提供了应用(MWA)、模块、Monorepo 三种工程方案类型，并支持通过 @modern-js/create 创建工程方案初始化项目。

使用 @modern-js/create 时会询问用户一些问题来生成符合用户需求的项目，这一章将介绍这里的问题字段便于进行定制化工程方案开发时使用。

info

配置章节将使用同时介绍内容和字段值的方式，括号中内容为对应的字段值

工程方案配置​

Solution​

工程方案类型(solution)，共三个选项：

  • 应用(mwa)

  • 模块(module)

  • Monorepo

info

solution 配置只能在 @modern-js/create 的 --config 参数中使用，不能在生成器插件中通过设置输入默认值的方式使用。

Scenes​

项目场景(scenes)，当使用创建工程方案场景类型的生成器插件时，该值为对应生成器插件的 key 值。

info

scenes 配置只能在 @modern-js/create 的 --config 参数中使用，不能在生成器插件中通过设置输入默认值的方式使用。

通用配置​

Language​

开发语言(language)，共有两个选项：

  • TS(ts)

  • ES6+(js)

Package-Manager​

包管理工具(packageManager)，共有两个选项：

  • pnpm(pnpm)

  • Yarn(yarn)

info

在生成器插件创建工程方案场景的自定义类型(custom)中，默认只提供了 packageManager 配置。

其他配置​

noNeedInstall​

是否跳过依赖安装。

type: Boolean

default: false

noNeedGit​

是否跳过 git 初始化和提交初始 commit。

type: Boolean

default: false

successInfo​

自定义创建项目成功的提示信息。

type: String

default: 不同工程方案的命令操作提示

isMonorepoSubProject​

是否为 Monorepo 子项目。

type: Boolean

default: false

isTest​

作用于 应用(MWA) 项目，标识是否为测试项目。

type: Boolean

  • true: 创建到路径 examples/
  • false: 创建到路径 apps/

default: false

isPublic​

作用于 模块(Module) 项目，标识是否需要对外发布。

type: Boolean

  • true: 创建到路径 packages/
  • false: 创建到路径 features/

default: false