CLI 命令
Modern.js Module 项目可以使用的 CLI 命令如下:
modern build
Usage: modern build [options]
构建生产环境产物
Options:
-w, --watch 使用监听模式构建代码
--tsconfig [tsconfig] 指定 tsconfig.json 文件的路径 (default:
"./tsconfig.json")
--platform [platform] 构建所有或者指定平台的产物
--no-dts 关闭 DTS 类型文件生成和类型检查
--no-clear 关闭自动清除产物输出目录的行为
-c, --config <config> 指定配置文件(default: "modern.config.j(t)s")
-h, --help 展示当前命令的信息
Modern.js Module 支持 platform
构建模式,可以用于执行其他工具的构建任务,目前官方支持的有 Rspress。例如,可以通过执行 modern build --platform
命令启动 doc 构建任务生成 doc 产物。
modern new
Usage: modern new [options]
启用可选功能
Options:
-d, --debug 开启 Debug 模式,打印调试日志信息 (default: false)
-c, --config <config> 生成器运行默认配置(JSON 字符串)
--dist-tag <tag> 生成器使用特殊的 npm Tag 版本
--registry 生成器运行过程中定制 npm Registry
-h, --help display help for command
modern new
命令用于启动微生成器功能,它可以为项目启用默认没有提供的功能。
目前可以开启的功能有:
- Storybook V7
- Tailwind CSS 支持
关于这些功能,可以通过「使用微生成器」 章节了解更多。
modern dev
Usage: modern dev [options]
运行和调试模块
Options:
-h, --help display help for command
Commands:
[dev-tools-subCommand]
Modern.js Module 提供了使用调试工具的能力,可以通过 modern dev
命令来启动。不过要注意的是,默认情况下是没有提供调试相关的插件,因此此时执行 modern dev
会提示: "No dev tools found available"。
目前官方支持的调试工具有 Rspress,因此在你执行 modern new
命令开启它后,就可以执行 modern dev
或者 modern dev doc
执行它。
modern change
Usage: modern change [options]
创建变更集
Options:
--empty 创建空变更集 (default: false)
--open 使用编辑器中打开创建的变更集 (default: false)
-h, --help display help for command
modern change
命令用于生成 changesets 需要的 Markdown 文件。
modern pre
Usage: modern pre [options] <enter|exit> [tag]
进入和退出预发布模式
Options:
-h, --help display help for command
可以使用 modern pre
命令在正式发布前预发布一个版本。
modern bump
Usage: modern bump [options]
使用变更集自动更新发布版本和变更日志
Options:
--canary 创建一个预发布版本进行测试 (default: false)
--preid <tag> 在对预发布版本进行版本控制时指定标识符 (default: "next")
--snapshot 创建一个特殊版本进行测试 (default: false)
-h, --help display help for command
按照 changesets 生成的变更记录的 Markdown 文件修改 package.json
中的版本号, 同时生成 CHANGELOG.md
文件。
modern release
Usage: modern release [options]
发布 npm 包
Options:
--tag <tag> 发布 npm 包使用特定的 tag (default: "")
--ignore-scripts 发布时忽略 package.json 中的 scripts 命令,仅支持在 pnpm monorepo
中使用 (default: "")
-h, --help display help for command
modern release
命令可以将模块发布到 npm Registry 上。
modern gen-release-note
Usage: modern gen-release-note [options]
根据当前仓库 changeset 信息生成 Release Note
Options:
--repo <repo> 仓库名称,用于生成 Pull Request 链接, 例如: web-infra-dev/modern.js
--custom <cumtom> 自定义 Release Note 生成函数
-h, --help display help for command
根据当前仓库的 changeset 信息自动生成 Release Note。
modern upgrade
Usage: modern upgrade [options]
升级 Modern.js 到最新版本
Options:
--registry <registry> 定制 npm registry (default: "")
-d,--debug 开启 Debug 模式,打印调试日志信息 (default: false)
--cwd <cwd> 项目路径 (default: "")
-h, --help display help for command
modern upgrade
命令,用于升级项目 Modern.js 相关依赖至最新版本。
在项目根目录下执行命令 npx modern upgrade
,会默认将当前执行命令项目的 package.json
中的 Modern.js 相关依赖更新至最新版本。