@zlskuniapp/zlapp-cli

@zlskuniapp/zlapp-cli

快速创建 uni-app Vue3 项目的脚手架工具。

特性

• 🚀 一行命令创建项目，交互式引导配置
• 📦 基于 degit 从 GitHub 远程拉取模板，无需本地克隆
• 🎨 内置 UniApp Vue3 基础模板，集成 uv-ui 组件库、UnoCSS、Pinia 等
• ⏳ ora 进度动画，模板拉取过程可视化
• ✅ 项目名称 kebab-case 格式校验
• 🛡️ 目录已存在时覆盖确认

快速开始

# 使用 npx（推荐）
npx @zlskuniapp/zlapp-cli create my-app

# 或全局安装后使用
npm install -g @zlskuniapp/zlapp-cli
zlapp-cli create my-app

创建过程会交互式引导你完成以下配置：

1. 项目名称 — kebab-case 格式（如 my-app、uni-vue3）
2. 选择模板 — 当前提供 UniApp 基础版（uni-vue3）

创建成功后：

cd my-app
npm install

命令行选项

zlapp-cli create [name] [options]

示例：

# 指定项目名和模板，跳过交互
npx @zlskuniapp/zlapp-cli create my-app -t uni-vue3

可用模板

项目结构

本项目采用 pnpm monorepo 架构：

zl-uniapp-cli/
├── packages/
│   ├── zlapp-cli/             # CLI 主包
│   │   ├── bin/index.js       # CLI 入口
│   │   └── src/
│   │       ├── commands/      # 命令实现（create）
│   │       ├── prompts/       # 交互式提示
│   │       ├── templates/     # 模板注册表
│   │       └── utils/         # 工具函数（download、install）
│   └── shared/                # 共享工具包
│       └── src/
│           ├── copier.ts      # 模板复制
│           ├── replacer.ts    # 项目名替换
│           ├── logger.ts      # 日志工具
│           └── constants.ts   # 共享常量
├── templates/
│   └── uni-vue3/              # UniApp Vue3 模板项目
├── pnpm-workspace.yaml
└── package.json

开发

环境要求

• Node.js >= 18

本地开发

# 安装依赖
pnpm install

# 开发模式运行 CLI
pnpm dev create my-test-app

# 构建
pnpm build

# 运行测试
pnpm test

工作流程

CLI 创建项目的核心流程：

1. 解析命令行参数（项目名、模板）
2. 交互式补全未提供的选项
3. 使用 degit 从 GitHub 仓库 landon0502/zl-uniapp-cli/templates 拉取指定模板
4. 替换模板 package.json 中的 name 字段为用户指定的项目名
5. 将临时目录移动到目标目录（跨设备时自动回退为复制+删除）
6. 输出后续操作提示

技术栈

License

ISC