Modern.js 项目创建工具 @modern-js/create 使用指南

Modern.js 是一个现代化的前端开发框架，提供了多种工程方案来满足不同场景的开发需求。本文将详细介绍如何使用 Modern.js 提供的 @modern-js/create 工具快速创建不同类型的项目。

环境准备

在使用 @modern-js/create 创建项目前，请确保你的开发环境满足以下要求：

1. Node.js 版本 14 或更高版本
2. 包管理工具（npm、yarn 或 pnpm）
3. 稳定的网络连接

安装与使用

@modern-js/create 工具设计为无需全局安装，可以直接通过 npx 命令运行：

npx @modern-js/create@latest [项目目录]

如果不指定项目目录，工具将在当前目录创建项目。

创建项目流程

运行命令后，工具会启动交互式命令行界面，引导你完成项目创建过程。下面分别介绍创建不同类型项目的具体步骤。

创建 Web 应用项目

Web 应用项目是 Modern.js 最常用的项目类型，适合构建单页应用(SPA)或多页应用(MPA)。创建过程如下：

npx @modern-js/create@latest web-app

交互式命令行会询问以下配置选项：

1. 工程类型：选择"Web 应用"
2. 开发语言：可选择 TypeScript 或 JavaScript
3. 包管理工具：支持 npm、yarn 或 pnpm
4. 构建工具：可选择 webpack 或其他支持的构建工具

创建 Npm 模块项目

如果你需要开发可复用的 npm 包，可以选择创建 Npm 模块项目：

npx @modern-js/create@latest npm-module

交互式命令行会询问以下配置选项：

1. 工程类型：选择"Npm 模块"
2. 项目名称：输入你的模块名称
3. 开发语言：可选择 TypeScript 或 JavaScript
4. 包管理工具：支持 npm、yarn 或 pnpm

项目创建后的操作

项目创建完成后，工具会自动安装依赖包。你可以：

1. 进入项目目录：cd [项目目录]
2. 启动开发服务器（Web 应用）：npm run dev
3. 构建生产版本：npm run build

高级选项

@modern-js/create 还支持一些高级选项：

• 使用 --no-need-install 跳过自动安装依赖
• 使用 --template 指定特定模板
• 使用 --config 提供预设配置

常见问题

1. 网络问题导致依赖安装失败：可以尝试切换 npm 镜像源或使用 --no-need-install 选项手动安装
2. Node.js 版本不兼容：请确保使用支持的 Node.js 版本
3. 权限问题：在 Linux/macOS 系统上可能需要使用 sudo

通过 @modern-js/create 工具，开发者可以快速初始化符合 Modern.js 最佳实践的项目结构，专注于业务开发而不是项目配置。