使用

Modern.js 提供了 @modern-js/create 工具用于创建 Modern.js 提供的工程方案项目,例如 Web 应用Npm 模块

下面将介绍 @modern-js/create 的使用姿势。

环境准备

Node.js

在开始使用前,你需要安装 Node.js,并保证 Node.js 版本不低于 16.2.0,我们推荐使用 Node.js 18 的 LTS 版本

你可以通过以下命令检查当前使用的 Node.js 版本:

node -v

如果你当前的环境中尚未安装 Node.js,或是安装的版本低于 16,可以通过 nvmfnm 安装需要的版本。

下面是通过 nvm 安装 Node.js 18 LTS 版本的例子:

# 安装 Node.js 18 的长期支持版本
nvm install 18 --lts

# 将刚安装的 Node.js 18 设置为默认版本
nvm alias default 18

# 切换到刚安装的 Node.js 18
nvm use 18
nvm 和 fnm

nvm 和 fnm 都是 Node.js 版本管理工具。相对来说,nvm 较为成熟和稳定,而 fnm 是使用 Rust 实现的,比 nvm 提供了更好的性能。

此外,在安装 nvm 或 fnm 后,然后只要仓库根目录下有内容为 lts/hydrogen.nvmrc 文件,进入这个仓库时就会自动安装或切换到正确的 Node.js 版本。

pnpm

推荐使用 pnpm 来管理依赖:

npm install -g pnpm@8
NOTE

Modern.js 同样支持使用 yarnnpm 进行依赖管理。

使用 @modern-js/create 创建项目

不需要全局安装 @modern-js/create,直接使用 npx 执行即可:

npx @modern-js/create@latest [projectDir]
INFO

[projectDir] 为项目目录名称,不填写将会在当前目录创建项目。

执行过程中需要根据提示完成交互,创建符合需求的项目。

创建 Web 应用项目

npx @modern-js/create@latest web-app
? 请选择你想创建的工程类型 Web 应用
? 请选择开发语言 TS
? 请选择包管理工具 pnpm

创建 Npm 模块项目

npx @modern-js/create@latest npm-module
? 请选择你想创建的工程类型 Npm 模块
? 请填写项目名称 npm-module
? 请选择开发语言 TS
? 请选择包管理工具 pnpm