@wanggangqi/workspace-cli 1.0.0

package/README.md

@@ -0,0 +1,410 @@
+# Workspace CLI
+
+工作空间管理 CLI 工具，用于初始化、扫描和管理工作空间下的多个 Git 项目。
+
+## 安装
+
+```bash
+npm install -g @wanggangqi/workspace-cli
+```
+
+或者使用 npx：
+
+```bash
+npx @wanggangqi/workspace-cli init
+```
+
+## 功能特性
+
+- 🚀 快速初始化工作空间
+- 🔍 自动扫描 Git 项目
+- 📁 分组管理项目
+- 📝 智能项目描述
+- 🔄 批量克隆仓库
+- 🌿 分支信息管理
+- 🌐 一键初始化 Nginx 环境（多空间隔离）
+
+## 命令说明
+
+### `wsc init` 或 `workspace-cli init`
+
+初始化工作空间，创建 `.workspace/config.json` 配置文件。
+
+```bash
+# 在当前目录初始化工作空间
+workspace-cli init
+
+# 创建新目录并初始化为工作空间
+workspace-cli init my-workspace
+
+# 指定 AI 编辑器生成对应的 prompt 文件
+workspace-cli init my-workspace --ai claude-code
+workspace-cli init my-workspace --ai trae
+workspace-cli init my-workspace --ai opencode
+workspace-cli init my-workspace --ai iflow
+```
+
+**参数说明：**
+
+- `directory` (可选): 要创建的工作空间目录名称。如果不指定，则在当前目录初始化；如果指定，则创建该目录并初始化。
+- `--ai <editor>` (可选): 指定 AI 编辑器类型，生成对应的 prompt 文件。支持: `claude-code`, `trae`, `opencode`, `iflow`
+
+**默认配置：**
+初始化时会自动从包自带的 `config.json` 加载默认配置：
+
+- `平台组` - 包含预配置的仓库列表（erdcloud-plat-frontend, erdcloud-plat-plugins-frontend 等）
+- `other` - 未分组（空列表）
+
+**生成的 Prompt 文件：**
+
+| AI 编辑器   | 生成的文件路径        |
+| ----------- | --------------------- |
+| claude-code | `CLAUDE.md`           |
+| trae        | `.trae/prompt.md`     |
+| opencode    | `.opencode/prompt.md` |
+| iflow       | `.iflow/prompt.md`    |
+
+> 注意：工具使用通用的 `prompts/prompt.md` 模板，根据 `--ai` 参数自动复制并重命名为对应编辑器需要的文件名。
+
+**使用示例：**
+
+```bash
+# 创建一个新项目空间（带 Claude Code 支持）
+workspace-cli init plat-workspace --ai claude-code
+cd plat-workspace
+
+# 现在可以用自然语言命令：
+# "将平台组的所有项目克隆下来"
+```
+
+### `wsc scan` 或 `workspace-cli scan`
+
+扫描工作空间下的所有 Git 项目，并更新到配置文件中。
+
+```bash
+# 交互式扫描（默认）
+workspace-cli scan
+
+# 非交互式，自动添加到 other 分组
+workspace-cli scan --no-interactive
+```
+
+**说明：**
+
+- 自动向上查找 `.workspace/config.json`，在工作空间根目录下扫描
+- 对于新发现的项目，会交互式询问分组和描述
+- 对于已存在的项目，会自动更新分支信息
+
+### `wsc list` 或 `workspace-cli list`
+
+列出工作空间中的所有项目。
+
+```bash
+# 列出所有项目
+workspace-cli list
+
+# 只列出指定分组的项目
+workspace-cli list -g 平台组
+```
+
+### `wsc add` 或 `workspace-cli add`
+
+手动添加项目到工作空间。
+
+```bash
+workspace-cli add erdcloud-plat-frontend \
+  --url http://gitlab.example.com/erdcloud-plat-frontend.git \
+  --group 平台组 \
+  --branch develop \
+  --description "平台前端项目"
+```
+
+### `wsc remove` 或 `workspace-cli remove`
+
+从工作空间移除项目。
+
+```bash
+workspace-cli remove test-materials
+```
+
+### `wsc clone-all` 或 `workspace-cli clone-all`
+
+克隆配置文件中所有的仓库到当前目录。
+
+```bash
+# 克隆所有仓库
+workspace-cli clone-all
+
+# 只克隆指定分组的仓库
+workspace-cli clone-all -g 平台组
+```
+
+### `wsc nginx` 或 `workspace-cli nginx`
+
+管理 nginx 配置和启动，用于本地开发环境。支持多空间隔离，每个工作空间拥有独立的 nginx 实例。
+
+#### `wsc nginx init`
+
+初始化当前工作空间的 nginx 环境。自动下载 nginx Windows 绿色版，复制所有配置文件，**解决多空间 nginx 冲突问题**。
+
+```bash
+# 初始化 nginx（默认版本 1.24.0）
+wsc nginx init
+
+# 指定 nginx 版本
+wsc nginx init -v 1.26.0
+
+# 指定代理后端地址（默认 http://192.168.10.189）
+wsc nginx init -p http://192.168.1.100:8080
+
+# 跳过下载，只生成配置文件
+wsc nginx init --skip-download
+```
+
+**功能说明：**
+
+1. **自动分配独立端口**：扫描同一目录下的其他工作空间，自动分配未被使用的端口段（默认从 50000 开始，每个空间间隔 1000）
+2. **下载 nginx**：从 nginx.org 自动下载 Windows 绿色版
+3. **生成配置结构**：
+   - `.workspace/nginx/nginx-{version}/` - nginx 程序目录
+   - `.workspace/nginx/conf.d/` - 项目配置文件目录（自动复制所有 .conf 文件）
+   - `.workspace/nginx/logs/` - 独立日志目录
+4. **复制管理脚本**：复制并修改 `nginx-config/` 下的 PowerShell 脚本
+   - `start-nginx.ps1` - 启动脚本（使用工作空间的 nginx）
+   - `stop-nginx.ps1` - 停止脚本
+   - `reload-nginx.ps1` - 重载配置脚本
+   - `status-nginx.ps1` - 状态检查脚本
+
+5. **生成工作空间域名**：根据目录名自动生成域名（如 `my-project` → `my-project.local`）
+
+6. **替换配置占位符**：自动替换配置文件中的占位符
+   - `<servename>` → 工作空间域名（如 `my-project.local`）
+   - `<workspaceDir>` → 工作空间根目录路径
+   - `<proxyTarget>` → 代理后端接口地址（默认 `http://192.168.10.189`）
+
+**配置文件更新：**
+
+初始化后会在 `.workspace/config.json` 中添加 nginx 配置：
+
+```json
+{
+  "nginx": {
+    "version": "1.24.0",
+    "basePort": 50000,
+    "domain": "my-project.local",
+    "proxyTarget": "http://192.168.10.189",
+    "installed": true,
+    "binDir": "...",
+    "configDir": "...",
+    "logsDir": "...",
+    "configs": [...]
+  }
+}
+```
+
+**域名配置：**
+
+初始化完成后，需要将自动生成的域名添加到 hosts 文件：
+
+```
+# Windows: C:\Windows\System32\drivers\etc\hosts
+127.0.0.1  my-project.local
+```
+
+工具会自动生成辅助脚本 `.workspace/add-to-hosts.ps1`，以管理员身份运行它可以自动添加域名：
+
+```powershell
+# 以管理员身份运行 PowerShell，然后执行
+. .workspace/add-to-hosts.ps1
+```
+
+**nginx 配置示例：**
+
+在 `nginx-config/` 目录下的 `.conf` 文件可以使用以下占位符：
+
+```nginx
+server {
+    listen 5006;
+    server_name <servename>;  # 将替换为 my-project.local
+
+    location / {
+        root <workspaceDir>/dist;  # 将替换为工作空间根目录
+        index index.html;
+    }
+
+    location /api {
+        proxy_pass <proxyTarget>;  # 将替换为 http://192.168.10.189
+    }
+}
+```
+
+配置完成后，即可通过域名访问：
+
+- `http://my-project.local:5006` （具体端口取决于配置）
+
+---
+
+#### `wsc nginx start`
+
+启动当前工作空间的 nginx。
+
+```bash
+wsc nginx start
+```
+
+---
+
+#### `wsc nginx stop`
+
+停止当前工作空间的 nginx。
+
+```bash
+wsc nginx stop
+```
+
+---
+
+#### `wsc nginx reload`
+
+重新加载当前工作空间的 nginx 配置。
+
+```bash
+wsc nginx reload
+```
+
+---
+
+#### `wsc nginx status`
+
+查看当前工作空间的 nginx 状态。
+
+```bash
+wsc nginx status
+```
+
+---
+
+#### `wsc nginx list`
+
+列出所有可用的 nginx 配置模板。
+
+```bash
+wsc nginx list
+```
+
+---
+
+**多空间隔离机制：**
+
+| 空间        | 基础端口 | 进程隔离 |
+| ----------- | -------- | -------- |
+| workspace-a | 50000    | 独立进程 |
+| workspace-b | 51000    | 独立进程 |
+| workspace-c | 52000    | 独立进程 |
+
+**注意事项：**
+
+- 每个工作空间的 nginx 使用独立的 `pid` 文件，避免进程冲突
+- 配置文件通过 `include` 加载 `conf.d/` 下的所有 `.conf` 文件
+- 启动前会自动检查配置是否正确
+- 停止时只停止当前工作空间的 nginx 进程
+
+**完整使用流程：**
+
+```bash
+# 1. 创建工作空间
+wsc init my-project --ai claude-code
+cd my-project
+
+# 2. 初始化 nginx
+wsc nginx init
+
+# 3. 启动当前空间的 nginx
+wsc nginx start
+
+# 4. 查看状态
+wsc nginx status
+
+# 5. 修改配置后重载
+wsc nginx reload
+
+# 6. 停止 nginx
+wsc nginx stop
+```
+
+**或者直接使用 PowerShell 脚本：**
+
+```powershell
+# 使用 PowerShell Core (pwsh) 执行（需要设置执行策略）
+pwsh -ExecutionPolicy Bypass -File .workspace/nginx/start-nginx.ps1
+pwsh -ExecutionPolicy Bypass -File .workspace/nginx/stop-nginx.ps1
+pwsh -ExecutionPolicy Bypass -File .workspace/nginx/reload-nginx.ps1
+pwsh -ExecutionPolicy Bypass -File .workspace/nginx/status-nginx.ps1
+```
+
+## 配置文件结构
+
+`.workspace/config.json`：
+
+```json
+{
+  "version": "1.0",
+  "groups": {
+    "平台组": {
+      "code": "plat",
+      "description": "平台相关仓库集合",
+      "repos": [
+        {
+          "name": "erdcloud-plat-frontend",
+          "url": "http://gitlab.example.com/erdcloud-plat-frontend.git",
+          "descriptions": ["平台前端", "plat前端"],
+          "branch": "develop"
+        }
+      ]
+    }
+  },
+  "nginx": {
+    "version": "1.24.0",
+    "basePort": 50000,
+    "installed": true,
+    "binDir": ".workspace/nginx/nginx-1.24.0",
+    "configDir": ".workspace/nginx/conf.d",
+    "logsDir": ".workspace/nginx/logs",
+    "configs": [{ "name": "5006_plat", "file": "5006_plat.conf", "port": 5006 }]
+  }
+}
+```
+
+## 在 Claude 中使用
+
+将 `prompt.md` 中的内容添加到 Claude Code 的 Agent.md 中，即可使用命令管理工作空间：
+
+```
+ws:scan              # 扫描工作空间
+ws:list              # 列出所有项目
+ws:clone 平台组       # 克隆平台组的所有仓库
+ws:nginx init        # 初始化 nginx 环境
+ws:nginx start       # 启动当前空间的 nginx
+ws:nginx stop        # 停止当前空间的 nginx
+ws:nginx reload      # 重载 nginx 配置
+ws:nginx status      # 查看 nginx 状态
+```
+
+### 可用命令
+
+| 命令                 | 描述                                | 示例                                       |
+| -------------------- | ----------------------------------- | ------------------------------------------ |
+| `ws:scan`            | 扫描当前目录的 Git 项目，同步到配置 | `ws:scan`                                  |
+| `ws:list`            | 列出工作空间中的所有项目            | `ws:list`、 `ws:list -g 平台组`            |
+| `ws:clone [分组名]`  | 克隆指定分组的所有仓库              | `ws:clone`、`ws:clone 平台组`              |
+| `ws:add <项目名>`    | 添加项目到工作空间                  | `ws:add my-project`                        |
+| `ws:remove <项目名>` | 从工作空间移除项目                  | `ws:remove my-project`                     |
+| `ws:nginx init`      | 初始化当前工作空间的 Nginx 环境     | `ws:nginx init`、`ws:nginx init -v 1.26.0` |
+| `ws:nginx start`     | 启动当前空间的 nginx                | `ws:nginx start`                           |
+| `ws:nginx stop`      | 停止当前空间的 nginx                | `ws:nginx stop`                            |
+| `ws:nginx reload`    | 重载当前空间的 nginx 配置           | `ws:nginx reload`                          |
+| `ws:nginx status`    | 查看当前空间的 nginx 状态           | `ws:nginx status`                          |
+
+## License
+
+MIT

package/bin/cli.js

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+
+const { Command } = require('commander');
+const chalk = require('chalk');
+const WorkspaceManager = require('../lib/workspace');
+
+const program = new Command();
+const workspace = new WorkspaceManager();
+
+program
+  .name('workspace-cli')
+  .description('工作空间管理 CLI 工具')
+  .version('1.0.0');
+
+program
+  .command('init [directory]')
+  .description('初始化工作空间，创建 .workspace/config.json。如果指定目录，则创建该目录并初始化。')
+  .option('--ai <editor>', '指定 AI 编辑器类型，生成对应的 prompt 文件 (claude-code|trae|opencode|iflow)')
+  .action(async (directory, options) => {
+    try {
+      await workspace.init(directory, options.ai);
+    } catch (error) {
+      console.error(chalk.red('初始化失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('scan')
+  .description('扫描当前目录下的 Git 项目，更新配置文件')
+  .option('-i, --interactive', '交互式模式，询问项目描述', true)
+  .action(async (options) => {
+    try {
+      await workspace.scan(options.interactive);
+    } catch (error) {
+      console.error(chalk.red('扫描失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('list')
+  .alias('ls')
+  .description('列出工作空间中的所有项目')
+  .option('-g, --group <group>', '按分组筛选')
+  .action(async (options) => {
+    try {
+      await workspace.list(options.group);
+    } catch (error) {
+      console.error(chalk.red('列表获取失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('add <name>')
+  .description('添加项目到工作空间')
+  .requiredOption('-u, --url <url>', 'Git 仓库地址')
+  .option('-g, --group <group>', '所属分组', 'other')
+  .option('-b, --branch <branch>', '默认分支', 'main')
+  .option('-d, --description <description>', '项目描述')
+  .action(async (name, options) => {
+    try {
+      await workspace.add(name, options);
+    } catch (error) {
+      console.error(chalk.red('添加失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('remove <name>')
+  .alias('rm')
+  .description('从工作空间移除项目')
+  .action(async (name) => {
+    try {
+      await workspace.remove(name);
+    } catch (error) {
+      console.error(chalk.red('移除失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('clone-all')
+  .description('克隆所有配置的仓库到当前目录')
+  .option('-g, --group <group>', '只克隆指定分组的仓库')
+  .action(async (options) => {
+    try {
+      await workspace.cloneAll(options.group);
+    } catch (error) {
+      console.error(chalk.red('克隆失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+// nginx 命令组
+const nginxCmd = program
+  .command('nginx')
+  .description('管理 nginx 配置和启动');
+
+nginxCmd
+  .command('init')
+  .description('初始化当前工作空间的 nginx 环境')
+  .option('-v, --version <version>', '指定 nginx 版本', '1.24.0')
+  .option('-p, --proxy-target <url>', '代理后端接口地址', 'http://192.168.10.189')
+  .option('--skip-download', '跳过下载，只生成配置文件')
+  .action(async (options) => {
+    try {
+      await workspace.initNginx(options);
+    } catch (error) {
+      console.error(chalk.red('nginx 初始化失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+nginxCmd
+  .command('start')
+  .description('启动当前工作空间的 nginx')
+  .action(async () => {
+    try {
+      await workspace.manageSpaceNginx({ start: true });
+    } catch (error) {
+      console.error(chalk.red('nginx 启动失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+nginxCmd
+  .command('stop')
+  .description('停止当前工作空间的 nginx')
+  .action(async () => {
+    try {
+      await workspace.manageSpaceNginx({ stop: true });
+    } catch (error) {
+      console.error(chalk.red('nginx 停止失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+nginxCmd
+  .command('reload')
+  .description('重新加载当前工作空间的 nginx 配置')
+  .action(async () => {
+    try {
+      await workspace.manageSpaceNginx({ reload: true });
+    } catch (error) {
+      console.error(chalk.red('nginx 重载失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+nginxCmd
+  .command('status')
+  .description('查看当前工作空间的 nginx 状态')
+  .action(async () => {
+    try {
+      await workspace.manageSpaceNginx({ status: true });
+    } catch (error) {
+      console.error(chalk.red('nginx 状态检查失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+nginxCmd
+  .command('list')
+  .description('列出可用的 nginx 配置')
+  .action(async () => {
+    try {
+      await workspace.listNginxConfigs();
+    } catch (error) {
+      console.error(chalk.red('列出配置失败:'), error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/config.json

@@ -0,0 +1,41 @@
+{
+  "version": "1.0",
+  "groups": {
+    "平台组": {
+      "code": "plat",
+      "description": "易立德(公司)平台的仓库集合",
+      "repos": [
+        {
+          "name": "erdcloud-plat-frontend",
+          "url": "http://gitlab.ddns.e-lead.cn/erdcloud-plm/erdcloud-plat/erdcloud-plat-frontend.git",
+          "descriptions": [
+            "平台前端",
+            "平台仓库",
+            "plat前端"
+          ],
+          "branch": "develop"
+        },
+        {
+          "name": "erdcloud-plat-plugins-frontend",
+          "url": "http://gitlab.ddns.e-lead.cn/erdcloud-plm/erdcloud-plat/erdcloud-plat-plugins-frontend.git",
+          "descriptions": [
+            "插件前端",
+            "平台仓库",
+            "plat插件前端"
+          ],
+          "branch": "develop"
+        }
+      ]
+    },
+	"other": {
+		"code": "other",
+		"description": "未分组",
+		"repos": [{
+      "name": "test-materials",
+      "url": "http://gitlab.ddns.e-lead.cn/erdcloud-plm/erdcloud-plat/erdcloud-plat-test/test-materials.git",
+      "descriptions": ["测试仓库"],
+      "branch": "master"
+    }]
+	}
+  }
+}