Modern.js 项目生成器(new命令)使用指南

Modern.js 提供了强大的项目生成器功能，通过 new 命令可以帮助开发者快速创建项目元素、启用功能模块和进行自动重构。本文将详细介绍如何在 Web 应用和 Npm 模块项目中使用这一功能。

Web 应用中的 new 命令

在基于 @modern-js/app-tools 的 Web 应用项目中，new 命令提供了三种主要操作类型：

1. 创建工程元素：快速生成项目中的各类元素
2. 启用可选功能：为项目添加额外功能支持
3. 自动重构：自动化调整项目结构

创建工程元素示例

创建新的应用入口是常见的需求，执行流程如下：

npm run new
? 请选择你想要的操作 创建工程元素
? 请选择创建元素类型 新建「应用入口」
? 请填写入口名称 entry

执行后，Modern.js 会：

• 在 src 目录下创建指定名称的文件夹
• 生成默认入口文件
• 自动整理现有入口文件到正确位置

启用功能模块示例

以启用 BFF(Backend For Frontend)功能为例：

npm run new
? 请选择你想要的操作 启用可选功能
? 请选择功能名称 启用「BFF」功能
? 请选择 BFF 类型 函数模式
? 请选择运行时框架 Express

执行后，系统会：

1. 安装必要的 BFF 相关依赖
2. 创建 api 目录用于 BFF 开发
3. 提供详细的插件注册指南

技术说明：Modern.js 选择让开发者手动注册插件而非自动完成，主要是考虑到配置文件的复杂性。不同模块间可能存在相互引用关系，手动操作能确保配置修改的正确性。这种设计理念也适用于其他需要定制化配置的场景。

Npm 模块中的 new 命令

对于基于 @modern-js/module-tools 的 Npm 模块项目，new 命令专注于启用可选功能。

启用 Storybook 示例

npm run new
? 请选择你想要的操作 启用可选功能
? 请选择功能名称 启用「Storybook」

执行后，项目会：

• 安装 Storybook 相关依赖
• 添加 storybook 命令
• 创建 stories 目录
• 提供插件注册指南

常见问题与注意事项

1. 功能未显示：如果需要的功能不在列表中，请检查：

   • 是否已安装对应功能插件
   • 如要使用 new 命令启用，需先手动移除相关插件依赖

2. 配置修改：对于需要修改配置文件的功能，Modern.js 会提供明确的操作指南而非自动修改，这确保了项目配置的稳定性和可控性。

3. 项目结构：使用 new 命令创建元素时，Modern.js 会自动维护项目结构的合理性，开发者无需手动调整文件位置。

Modern.js 的 new 命令通过交互式命令行界面，为开发者提供了便捷的项目扩展能力，既保证了开发效率，又维护了项目的规范性。无论是添加新功能还是创建项目元素，都能通过简单的命令完成，大幅提升了开发体验。