@itbox/cli 1.0.0

package/README.md

@@ -0,0 +1,208 @@
+# @itbox/cli
+
+前端项目模板生成工具，支持Vue、Vue+TypeScript、Nuxt、Nest等多种模板，可从Gitee动态拉取模板分支。
+
+## 功能特性
+
+- ✅ 支持从Gitee仓库动态获取模板分支
+- ✅ 支持npm/pnpm包管理器选择
+- ✅ 交互式终端操作（方向键切换，空格选择）
+- ✅ 配置管理功能（支持设置模板仓库地址）
+- ✅ 列出所有可用模板功能
+- ✅ ES模块模式开发
+- ✅ 支持 `pnpm create itbox` 调用方式
+
+## 安装
+
+### 全局安装
+
+```bash
+# 使用 npm
+npm install -g @itbox/cli
+
+# 使用 pnpm
+pnpm add -g @itbox/cli
+```
+
+### 直接使用
+
+```bash
+# 使用 npm create
+npm create itbox <项目名>
+
+# 使用 pnpm create
+pnpm create itbox <项目名>
+```
+
+## 使用方法
+
+### 创建项目
+
+```bash
+# 使用命令创建项目
+itbox create <项目名>
+
+# 示例
+itbox create my-vue3-app
+```
+
+执行后会进入交互式选择界面：
+1. 选择项目模板（从Gitee仓库动态获取的分支）
+2. 选择包管理器（npm或pnpm）
+
+### 列出所有可用模板
+
+```bash
+itbox list
+```
+
+### 配置管理
+
+```bash
+# 设置模板仓库地址
+itbox config set templateRepo <仓库地址>
+
+# 获取当前模板仓库地址
+itbox config get templateRepo
+
+# 删除模板仓库配置
+itbox config delete templateRepo
+
+# 查看配置帮助
+itbox config help
+```
+
+## 命令详解
+
+### `itbox create <projectName>`
+
+创建新的前端项目，从指定Gitee仓库拉取模板。
+
+**参数：**
+- `projectName`: 项目名称，将作为新创建的项目目录名
+
+**功能流程：**
+1. 检查Git是否安装
+2. 获取远程仓库分支列表作为模板选项
+3. 交互式选择模板和包管理器
+4. 检查包管理器是否安装
+5. 使用git clone命令下载模板
+6. 安装项目依赖
+
+### `itbox list`
+
+列出所有可用的项目模板（即远程仓库的分支列表）。
+
+**功能流程：**
+1. 检查Git是否安装
+2. 获取远程仓库分支列表
+3. 格式化输出模板列表
+
+### `itbox config`
+
+管理CLI工具的配置项。
+
+**子命令：**
+- `set <key> <value>`: 设置配置项
+- `get <key>`: 获取配置项值
+- `delete <key>`: 删除配置项
+- `help`: 显示配置命令帮助
+
+**配置文件位置：**
+`~/.fe-cli/config.json`
+
+**可配置项：**
+- `templateRepo`: 模板仓库地址（默认：https://gitee.com/jianlidmeng/template.git）
+
+## 实现逻辑
+
+### 技术栈
+
+- **Node.js**: 运行环境
+- **Commander.js**: 命令行界面构建
+- **Inquirer.js**: 交互式终端实现
+- **Git**: 模板下载和分支获取
+- **fs-extra**: 文件系统操作
+- **ora**: 终端加载动画
+
+### 核心实现
+
+1. **动态模板获取**
+   - 使用 `git ls-remote --heads` 命令获取远程仓库分支列表
+   - 分支名称作为模板选项供用户选择
+
+2. **模板下载**
+   - 使用 `git clone -b <branch> <repo> <projectName>` 命令直接克隆指定分支
+   - 替代了传统的 `download-git-repo` 库，解决了Gitee兼容性问题
+
+3. **交互式选择**
+   - 使用 Inquirer.js 的 checkbox 类型实现单选限制
+   - 通过 validate 函数确保只能选择一个模板和一个包管理器
+   - 支持方向键切换、空格选择、回车确认
+
+4. **配置管理**
+   - 配置文件存储在用户主目录下的 `.fe-cli/config.json`
+   - 实现了完整的配置读写功能
+   - 支持多个配置项的管理
+
+5. **模块化设计**
+   - 使用 ES 模块模式开发（package.json 中设置 `"type": "module"`）
+   - 功能模块化，便于维护和扩展
+
+### 项目结构
+
+```
+@itbox/cli/
+├── bin/
+│   └── index.js          # CLI入口文件
+├── package.json          # 项目配置文件
+└── README.md             # 项目文档
+```
+
+## 注意事项
+
+1. **Git安装**：使用前请确保已安装Git
+2. **包管理器**：根据选择的包管理器确保已安装
+3. **网络连接**：需要网络连接以获取模板列表和下载模板
+4. **仓库权限**：确保Gitee仓库是公开的，或已登录Git账号
+
+## 故障排除
+
+### 1. Git命令失败
+
+**错误信息**：`git clone failed with status 128`
+
+**解决方案**：
+- 检查Git是否正确安装：`git --version`
+- 检查网络连接是否正常
+- 确保Gitee仓库是公开的或已正确配置Git凭证
+
+### 2. 模板列表获取失败
+
+**错误信息**：`403 Forbidden`
+
+**解决方案**：
+- 检查Git是否已登录Gitee账号
+- 确保仓库具有公开访问权限
+- 尝试重新配置模板仓库地址
+
+### 3. 包管理器命令失败
+
+**错误信息**：`Command not found`
+
+**解决方案**：
+- 安装选择的包管理器：`npm install -g npm` 或 `npm install -g pnpm`
+- 检查包管理器是否在系统PATH中
+
+## 更新日志
+
+### v1.0.0
+- 初始版本发布
+- 支持从Gitee动态获取模板分支
+- 支持npm/pnpm包管理器选择
+- 实现配置管理功能
+- 支持 `pnpm create itbox` 调用方式
+
+## License
+
+MIT

package/bin/index.js

@@ -0,0 +1,316 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import inquirer from 'inquirer';
+import fs from 'fs-extra';
+import path from 'path';
+import ora from 'ora';
+import { execSync } from 'child_process';
+import os from 'os';
+
+const { prompt } = inquirer;
+
+// 配置文件相关
+const CONFIG_DIR = path.join(os.homedir(), '.fe-cli');
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+// 读取配置
+function readConfig() {
+    if (fs.existsSync(CONFIG_FILE)) {
+        try {
+            return fs.readJSONSync(CONFIG_FILE);
+        } catch (error) {
+            console.error('❌ 读取配置文件失败:', error.message);
+            return {};
+        }
+    }
+    return {};
+}
+
+// 写入配置
+function writeConfig(config) {
+    try {
+        // 确保配置目录存在
+        fs.ensureDirSync(CONFIG_DIR);
+        fs.writeJSONSync(CONFIG_FILE, config, { spaces: 2 });
+        return true;
+    } catch (error) {
+        console.error('❌ 写入配置文件失败:', error.message);
+        return false;
+    }
+}
+
+// 获取配置项
+function getConfig(key) {
+    const config = readConfig();
+    return config[key];
+}
+
+// 设置配置项
+function setConfig(key, value) {
+    const config = readConfig();
+    config[key] = value;
+    return writeConfig(config);
+}
+
+// 创建命令行程序实例
+const program = new Command();
+
+// 检查git是否安装
+function checkGit() {
+    try {
+        execSync('git --version', { stdio: 'ignore' });
+        return true;
+    } catch (error) {
+        return false;
+    }
+}
+
+// 检查包管理器是否安装
+function checkPackageManager(pm) {
+    try {
+        execSync(`${pm} --version`, { stdio: 'ignore' });
+        return true;
+    } catch (error) {
+        return false;
+    }
+}
+
+// 获取远程仓库分支
+function getRemoteBranches(repoUrl) {
+    try {
+        const output = execSync(`git ls-remote --heads ${repoUrl}`, { stdio: 'pipe' });
+        const branches = output.toString().split('\n').filter(line => line.trim()).map(line => {
+            const [, ref] = line.split('\t');
+            return ref.replace('refs/heads/', '');
+        });
+        return branches;
+    } catch (error) {
+        if (error.message.includes('403')) {
+            console.error('❌ 仓库访问受限 (403)');
+            console.error('请检查：');
+            console.error('1. 是否已登录Gitee');
+            console.error('2. 是否有权限访问该仓库');
+            console.error('3. 仓库是否处于公开状态');
+        } else {
+            console.error('❌ 获取远程分支失败:', error.message);
+        }
+        process.exit(1);
+    }
+}
+
+
+
+// 指定的gitee仓库（优先从配置文件读取，否则使用默认值）
+const DEFAULT_TEMPLATE_REPO = 'https://gitee.com/jianlidmeng/template.git';
+let TEMPLATE_REPO = getConfig('templateRepo') || DEFAULT_TEMPLATE_REPO;
+
+// 从package.json获取项目信息
+const packagePath = path.resolve(path.dirname(import.meta.url.replace('file:///', '')), '../package.json');
+const packageInfo = fs.readJSONSync(packagePath);
+
+// 命令行配置
+program
+    .name(packageInfo.name.split('/')[1]) // 使用包名的第二部分作为命令名（如@itbox/cli -> itbox）
+    .description(packageInfo.description)
+    .version(packageInfo.version);
+
+// 列出所有可用模板
+program
+    .command('list')
+    .description('列出所有可用的项目模板')
+    .action(() => {
+        // 检查git是否安装
+        if (!checkGit()) {
+            console.error('❌ 请先安装Git');
+            process.exit(1);
+        }
+
+        // 获取远程仓库分支（模板）
+        const spinner = ora('正在获取可用模板列表...').start();
+        const branches = getRemoteBranches(TEMPLATE_REPO);
+        spinner.succeed('✅ 模板列表获取完成');
+
+        // 显示模板列表
+        if (branches.length === 0) {
+            console.log('❌ 当前仓库没有可用的模板');
+        } else {
+            console.log('\n🚀 可用模板列表:');
+            console.log('================');
+            branches.forEach((branch, index) => {
+                console.log(`${index + 1}. ${branch}`);
+            });
+            console.log('================');
+            console.log(`\n共 ${branches.length} 个可用模板`);
+            console.log('\n使用命令创建项目: itbox create <项目名>');
+            console.log('或使用: pnpm create itbox <项目名>');
+        }
+    });
+
+program
+    .command('create <projectName>')
+    .description('创建新的项目')
+    .action((projectName) => {
+        // 检查git是否安装
+        if (!checkGit()) {
+            console.error('❌ 请先安装Git');
+            process.exit(1);
+        }
+
+        // 检查项目名是否已存在
+        if (fs.existsSync(projectName)) {
+            console.error('❌ 项目已存在');
+            process.exit(1);
+        }
+
+        // 获取远程仓库分支
+        const spinner = ora('正在获取模板列表...').start();
+        const branches = getRemoteBranches(TEMPLATE_REPO);
+        spinner.succeed('✅ 模板列表获取完成');
+
+        // 如果没有分支
+        if (branches.length === 0) {
+            console.error('❌ 仓库没有可用的分支');
+            process.exit(1);
+        }
+
+        // 选择模板（分支）
+    prompt([
+      {
+        type: 'checkbox',
+        name: 'branch',
+        message: '请选择项目模板 (空格选择，回车确认):',
+        choices: branches.map(branch => ({
+          name: branch,
+          value: branch
+        })),
+        validate: function(answer) {
+          if (answer.length !== 1) {
+            return '请选择一个模板';
+          }
+          return true;
+        }
+      },
+      { type: 'checkbox',
+        name: 'packageManager',
+        message: '请选择包管理器 (空格选择，回车确认):',
+        choices: ['npm', 'pnpm'],
+        validate: function(answer) {
+          if (answer.length !== 1) {
+            return '请选择一个包管理器';
+          }
+          return true;
+        }
+      }
+    ]).then(answers => {
+      // 检查包管理器是否安装
+      if (!checkPackageManager(answers.packageManager[0])) {
+        console.error(`❌ 请先安装 ${answers.packageManager[0]}`);
+        process.exit(1);
+      }
+
+      // 获取选中的分支（checkbox返回数组，取第一个元素）
+      const selectedBranch = answers.branch[0];
+      const branchSpinner = ora(`正在下载模板 (${selectedBranch})...`).start();
+
+            // 使用git命令直接克隆模板
+            try {
+                execSync(`git clone -b ${selectedBranch} ${TEMPLATE_REPO} ${projectName}`, {
+                    stdio: 'inherit'
+                });
+                branchSpinner.succeed('✅ 模板下载完成');
+
+                // 安装依赖
+                const installSpinner = ora('正在安装依赖...').start();
+                try {
+                    execSync(`${answers.packageManager[0]} install`, {
+                        cwd: path.resolve(process.cwd(), projectName),
+                        stdio: 'inherit'
+                    });
+                    installSpinner.succeed('✅ 依赖安装完成');
+
+                    console.log('\n🎉 项目创建成功!');
+                    console.log(`📁 项目目录: ${projectName}`);
+                    console.log(`📦 包管理器: ${answers.packageManager[0]}`);
+                    console.log(`\n接下来可以执行:`);
+                    console.log(`  cd ${projectName}`);
+                    console.log(`  ${answers.packageManager[0]} run dev\n`);
+                } catch (error) {
+                    installSpinner.fail('❌ 依赖安装失败');
+                    console.error('\n请尝试手动安装依赖:');
+                    console.error(`  cd ${projectName}`);
+                    console.error(`  ${answers.packageManager[0]} install\n`);
+                    process.exit(1);
+                }
+            } catch (err) {
+                branchSpinner.fail('❌ 模板下载失败');
+                console.error('\n错误信息:', err.message);
+                console.error('\n请检查以下几点:');
+                console.error('1. 网络连接是否正常');
+                console.error('2. Git是否已正确安装');
+                console.error('3. 是否有权限访问该仓库');
+                process.exit(1);
+            }
+        });
+    });
+
+// 配置命令
+const configCommand = program.command('config');
+
+// 设置配置
+configCommand
+    .command('set <key> <value>')
+    .description('设置配置项')
+    .action((key, value) => {
+        if (setConfig(key, value)) {
+            console.log('✅ 配置设置成功');
+        }
+    });
+
+// 获取配置
+configCommand
+    .command('get <key>')
+    .description('获取配置项')
+    .action((key) => {
+        const value = getConfig(key);
+        if (value !== undefined) {
+            console.log(value);
+        } else {
+            console.log(`❌ 配置项 ${key} 不存在`);
+        }
+    });
+
+// 删除配置
+configCommand
+    .command('delete <key>')
+    .description('删除配置项')
+    .action((key) => {
+        const config = readConfig();
+        if (config[key] !== undefined) {
+            delete config[key];
+            if (writeConfig(config)) {
+                console.log('✅ 配置删除成功');
+            }
+        } else {
+            console.log(`❌ 配置项 ${key} 不存在`);
+        }
+    });
+
+// 配置命令帮助
+configCommand
+    .command('help')
+    .description('显示配置命令帮助')
+    .action(() => {
+        console.log('配置命令用法:');
+        console.log('  itbox config set <key> <value>  设置配置项');
+        console.log('  itbox config get <key>          获取配置项');
+        console.log('  itbox config delete <key>       删除配置项');
+        console.log('  itbox config help               显示帮助信息');
+    });
+
+// 解析命令行参数
+program.parse(process.argv);
+
+// 如果没有传入命令，显示帮助信息
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@itbox/cli",
+  "version": "1.0.0",
+  "description": "前端项目模板生成工具，支持Vue、Vue+TypeScript、Nuxt、Nest等模板",
+  "type": "module",
+  "main": "bin/index.js",
+  "bin": {
+    "itbox": "bin/index.js",
+    "create-itbox": "bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "vue",
+    "nuxt",
+    "nest",
+    "template"
+  ],
+  "author": "jianlidmeng",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "bin/",
+    "package.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "^14.0.2",
+    "fs-extra": "^11.3.3",
+    "inquirer": "^13.1.0",
+    "ora": "^9.0.0"
+  }
+}