gsd-trae 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.1.0] - 2026-03-16
+
+### Added
+- 新增 `uninstall.sh` 卸载脚本，支持完整清理 GSD 安装
+- CLI 支持 `uninstall` / `--uninstall` / `-u` 命令
+- 安装时自动创建 `~/.gsdc` 符号链接，统一命令访问路径，减少 token 消耗
+- 安装时自动备份已存在的 `project_rules.md`（带时间戳）
+- 添加端到端测试（vitest），覆盖安装/卸载完整流程
+- 新增 `gsd-agents.md` 和 `gsd-references.md` 文档
+
+### Changed
+- `project_rules.md` 改为渐进式披露结构，核心指令优先展示
+- 改进 `install.sh` 目录处理，使用子 shell 避免副作用
+- 修复 CLI 工作目录问题，确保在正确目录执行脚本
+- `uninstall.sh` 包含在 npm 包中
+
+### Fixed
+- 修复 `cli.js` 未正确传递 `cwd` 导致安装到错误目录的问题
+
 ## [1.0.2] - 2026-02-26
 
 ### Changed

package/README.md

@@ -34,34 +34,19 @@ GSD 通过流程约束解决了**上下文衰减（Context Rot）**问题——
 在项目根目录运行：
 
 ```bash
-npx gsd-trae
+npx -y gsd-trae@latest
 ```
 
-### 方式二：使用 curl
-
-在项目根目录运行：
-
-```bash
-bash <(curl -s https://raw.githubusercontent.com/Lionad-Morotar/get-shit-done-trae/main/install.sh)
-```
-
-### 方式三：手动安装
-
-1. 克隆本仓库到固定位置：
+### 卸载
 
 ```bash
-git clone https://github.com/Lionad-Morotar/get-shit-done-trae.git ~/.config/gsd-trae
+npx -y gsd-trae@latest uninstall
 ```
 
-2. 运行安装脚本：
-
-```bash
-bash ~/.config/gsd-trae/install.sh
-```
 
 ### 开始工作
 
-安装完成后，在 Trae 的 AI 对话中输入：
+安装完成后，在 Trae 的 AI 对话中输入 GSD 指令即可开始。以下是一个示例：
 
 ```
 /gsd:new-project
@@ -69,19 +54,15 @@ bash ~/.config/gsd-trae/install.sh
 
 ![](./assets/screenshot.png)
 
-## 核心命令
+## 工作流程
 
-| 命令                   | 用途                                      |
-| ---------------------- | ----------------------------------------- |
-| `/gsd:new-project`     | 初始化新项目：提问 → 研究 → 需求 → 路线图 |
-| `/gsd:discuss-phase N` | 收集第 N 阶段的上下文                     |
-| `/gsd:plan-phase N`    | 为第 N 阶段创建详细计划                   |
-| `/gsd:execute-phase N` | 执行第 N 阶段的所有计划                   |
-| `/gsd:verify-work`     | 验证交付物是否符合要求                    |
-| `/gsd:progress`        | 检查项目进度                              |
-| `/gsd:map-codebase`    | 分析现有代码库                            |
+### 从已有代码开始（Brownfield）
 
-## 工作流程
+```
+/gsd:map-codebase      # 先分析现有代码
+   ↓
+/gsd:new-project       # 基于现有上下文规划新功能
+```
 
 ### 新项目（Greenfield）
 
@@ -97,27 +78,22 @@ bash ~/.config/gsd-trae/install.sh
 进入 Phase 2...
 ```
 
-### 已有代码（Brownfield）
-
-```
-/gsd:map-codebase      # 先分析现有代码
-   ↓
-/gsd:new-project       # 基于现有上下文规划新功能
-```
-
-## 参考
-
-- [GSD 原项目](https://github.com/glittercowboy/get-shit-done) - 官方仓库
-
 ## 工作原理
 
 安装脚本 `install.sh` 会执行以下操作：
 
 1. 将 GSD 源文件克隆到 `~/.gsd-source`
-2. 在当前项目创建 `.trae/rules/project_rules.md`
-3. `project_rules.md` 中的链接指向 `~/.gsd-source` 下的实际文件
+2. 创建符号链接 `~/.gsdc` → `~/.gsd-source/commands/gsd`
+3. 在当前项目创建 `.trae/rules/project_rules.md`
 
-这样多个项目可以共享同一份 GSD 源文件，同时每个项目有自己的 Trae 规则配置。
+这样：
+- 多个项目共享同一份 GSD 源文件
+- 通过 `~/.gsdc/{command}.md` 统一访问命令文档
+- 每个项目有自己的 Trae 规则配置
+
+## Reference
+
+- [GSD 原项目](https://github.com/glittercowboy/get-shit-done) - 官方仓库
 
 ## 许可证
 

package/bin/cli.js

@@ -3,11 +3,27 @@
 const { execSync } = require('child_process');
 const path = require('path');
 
-const installScript = path.join(__dirname, '..', 'install.sh');
+const args = process.argv.slice(2);
+const command = args[0];
 
-try {
-  execSync(`bash "${installScript}"`, { stdio: 'inherit' });
-} catch (error) {
-  console.error('安装失败:', error.message);
-  process.exit(1);
+const scriptDir = path.join(__dirname, '..');
+
+const userCwd = process.cwd();
+
+if (command === 'uninstall' || command === '--uninstall' || command === '-u') {
+  const uninstallScript = path.join(scriptDir, 'uninstall.sh');
+  try {
+    execSync(`bash "${uninstallScript}"`, { stdio: 'inherit', cwd: userCwd });
+  } catch (error) {
+    console.error('卸载失败:', error.message);
+    process.exit(1);
+  }
+} else {
+  const installScript = path.join(scriptDir, 'install.sh');
+  try {
+    execSync(`bash "${installScript}"`, { stdio: 'inherit', cwd: userCwd });
+  } catch (error) {
+    console.error('安装失败:', error.message);
+    process.exit(1);
+  }
 }

package/install.sh

@@ -18,52 +18,63 @@ if [ ! -d "$GSD_SOURCE/.git" ]; then
     git clone --depth 1 "$GSD_REPO" "$GSD_SOURCE" >/dev/null 2>&1
 else
     echo "📥 更新 GSD 源文件..."
-    cd "$GSD_SOURCE" && git pull >/dev/null 2>&1
+    (cd "$GSD_SOURCE" && git pull >/dev/null 2>&1)
 fi
 
-# 2. 检查是否已存在 project_rules.md
+# 2. 创建 ~/.gsdc 符号链接（指向 ~/.gsd-source/commands/gsd）
+GSDC_PATH="$HOME/.gsdc"
+if [ -L "$GSDC_PATH" ]; then
+    rm "$GSDC_PATH"
+elif [ -e "$GSDC_PATH" ]; then
+    rm -rf "$GSDC_PATH"
+fi
+ln -s "$GSD_SOURCE/commands/gsd" "$GSDC_PATH"
+echo "🔗 创建符号链接: ~/.gsdc → $GSD_SOURCE/commands/gsd"
+
+# 3. 检查是否已存在 project_rules.md
 if [ -f ".trae/rules/project_rules.md" ]; then
-    echo "❌ 错误: .trae/rules/project_rules.md 已存在"
-    echo ""
-    echo "如需重新安装，请先删除现有文件："
-    echo "   rm .trae/rules/project_rules.md"
-    echo ""
-    echo "或手动备份后重命名："
-    echo "   mv .trae/rules/project_rules.md .trae/rules/project_rules.md.backup"
-    exit 1
+    BACKUP_FILE=".trae/rules/project_rules.md.backup.$(date +%Y%m%d%H%M%S)"
+    echo "⚠️  检测到已存在 .trae/rules/project_rules.md"
+    echo "📝 自动备份到: $BACKUP_FILE"
+    cp ".trae/rules/project_rules.md" "$BACKUP_FILE"
 fi
 
-# 3. 创建 .trae/rules 目录
+# 4. 创建 .trae/rules 目录
 if [ ! -d ".trae/rules" ]; then
     echo "📁 创建 .trae/rules 目录..."
     mkdir -p ".trae/rules"
 fi
 
-# 4. 复制 project_rules.md
-PROJECT_RULES_SOURCE=""
+# 5. 复制项目规则文档
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+RULES_SOURCE_DIR=""
 
 # 优先从脚本所在目录查找
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-if [ -f "$SCRIPT_DIR/.trae/rules/project_rules.md" ]; then
-    PROJECT_RULES_SOURCE="$SCRIPT_DIR/.trae/rules/project_rules.md"
-elif [ -f "$SCRIPT_DIR/project_rules.md" ]; then
-    PROJECT_RULES_SOURCE="$SCRIPT_DIR/project_rules.md"
+if [ -d "$SCRIPT_DIR/.trae/rules" ]; then
+    RULES_SOURCE_DIR="$SCRIPT_DIR/.trae/rules"
+elif [ -d "$SCRIPT_DIR/.trae" ]; then
+    RULES_SOURCE_DIR="$SCRIPT_DIR/.trae"
 fi
 
-# 如果没找到，从远程仓库下载
-if [ -z "$PROJECT_RULES_SOURCE" ]; then
-    echo "📥 从远程仓库下载 project_rules.md..."
-    curl -fsSL "$REPO_URL/raw/main/.trae/rules/project_rules.md" -o ".trae/rules/project_rules.md" 2>/dev/null || \
-    curl -fsSL "$REPO_URL/raw/main/.trae/project_rules.md" -o ".trae/rules/project_rules.md" 2>/dev/null
-    if [ $? -eq 0 ]; then
-        echo "✅ project_rules.md 下载成功"
-    else
-        echo "❌ 无法下载 project_rules.md，请检查网络连接"
-        exit 1
-    fi
+# 定义需要复制的文件
+RULES_FILES=("project_rules.md" "gsd-agents.md" "gsd-references.md")
+
+if [ -n "$RULES_SOURCE_DIR" ]; then
+    # 从本地目录复制
+    for file in "${RULES_FILES[@]}"; do
+        if [ -f "$RULES_SOURCE_DIR/$file" ]; then
+            echo "📝 复制 $file..."
+            cp "$RULES_SOURCE_DIR/$file" ".trae/rules/$file"
+        fi
+    done
 else
-    echo "📝 复制 project_rules.md..."
-    cp "$PROJECT_RULES_SOURCE" ".trae/rules/project_rules.md"
+    # 从远程仓库下载
+    echo "📥 从远程仓库下载文档..."
+    for file in "${RULES_FILES[@]}"; do
+        curl -fsSL "$REPO_URL/raw/main/.trae/rules/$file" -o ".trae/rules/$file" 2>/dev/null && \
+            echo "   ✅ $file 下载成功" || \
+            echo "   ⚠️  $file 下载失败"
+    done
 fi
 
 echo ""
@@ -71,7 +82,11 @@ echo "✅ 安装完成！"
 echo ""
 echo "📍 文件位置:"
 echo "   GSD 源文件: $GSD_SOURCE"
-echo "   项目规则: $(pwd)/.trae/rules/project_rules.md"
+echo "   命令目录: ~/.gsdc (符号链接)"
+echo "   项目规则: $(pwd)/.trae/rules/"
+echo "     - project_rules.md"
+echo "     - gsd-agents.md"
+echo "     - gsd-references.md"
 echo ""
 echo "🚀 开始使用:"
 echo "   在 Trae 中输入 /gsd:new-project"

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "gsd-trae",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "GSD (Get Shit Done) framework adapter for Trae IDE",
   "main": "bin/cli.js",
   "bin": {
     "gsd-trae": "bin/cli.js"
   },
   "scripts": {
-    "lint": "npx prettier --write README.md"
+    "lint": "npx prettier --write README.md",
+    "test": "vitest run tests/e2e/"
   },
   "keywords": [
     "gsd",
@@ -32,7 +33,11 @@
     "bin/",
     "assets/",
     "install.sh",
+    "uninstall.sh",
     "README.md",
     "CHANGELOG.md"
-  ]
+  ],
+  "devDependencies": {
+    "vitest": "^4.1.0"
+  }
 }

package/uninstall.sh

@@ -0,0 +1,83 @@
+#!/bin/bash
+
+# GSD for Trae - 卸载脚本
+# 用法: bash uninstall.sh
+
+set -e
+
+GSD_SOURCE="$HOME/.gsd-source"
+GSDC_PATH="$HOME/.gsdc"
+
+echo "🗑️  卸载 GSD for Trae..."
+echo ""
+
+# 1. 删除 GSD 源文件
+if [ -d "$GSD_SOURCE" ]; then
+    echo "📁 删除 GSD 源文件: $GSD_SOURCE"
+    rm -rf "$GSD_SOURCE"
+    echo "   ✅ 已删除"
+else
+    echo "   ℹ️  GSD 源文件不存在，跳过"
+fi
+
+# 2. 删除符号链接
+if [ -L "$GSDC_PATH" ]; then
+    echo "🔗 删除符号链接: ~/.gsdc"
+    rm "$GSDC_PATH"
+    echo "   ✅ 已删除"
+else
+    echo "   ℹ️  符号链接不存在，跳过"
+fi
+
+# 3. 删除当前项目的 GSD 规则文档
+RULES_FILES=("project_rules.md" "gsd-agents.md" "gsd-references.md")
+RULES_DELETED=0
+
+for file in "${RULES_FILES[@]}"; do
+    if [ -f ".trae/rules/$file" ]; then
+        echo "📝 删除项目规则: .trae/rules/$file"
+        rm ".trae/rules/$file"
+        echo "   ✅ 已删除"
+        RULES_DELETED=$((RULES_DELETED + 1))
+    fi
+done
+
+if [ $RULES_DELETED -eq 0 ]; then
+    echo "   ℹ️  项目规则文件不存在，跳过"
+fi
+
+# 如果目录为空，询问是否删除
+if [ -d ".trae/rules" ] && [ -z "$(ls -A .trae/rules 2>/dev/null)" ]; then
+    echo ""
+    read -p "🤔 .trae/rules 目录为空，是否删除？(y/N) " -n 1 -r
+    echo ""
+    if [[ $REPLY =~ ^[Yy]$ ]]; then
+        rmdir ".trae/rules"
+        echo "   ✅ 已删除 .trae/rules"
+
+        # 检查 .trae 是否为空
+        if [ -d ".trae" ] && [ -z "$(ls -A .trae 2>/dev/null)" ]; then
+            read -p "🤔 .trae 目录为空，是否删除？(y/N) " -n 1 -r
+            echo ""
+            if [[ $REPLY =~ ^[Yy]$ ]]; then
+                rmdir ".trae"
+                echo "   ✅ 已删除 .trae"
+            fi
+        fi
+    fi
+fi
+
+# 4. 检查是否有 .planning 目录
+if [ -d ".planning" ]; then
+    echo ""
+    echo "⚠️  检测到项目规划目录: .planning/"
+    echo "   包含项目计划和历史记录，建议保留或手动备份后删除"
+fi
+
+echo ""
+echo "✅ 卸载完成！"
+echo ""
+echo "如需重新安装，请运行:"
+echo "   npx gsd-trae"
+echo ""
+echo "感谢使用 GSD for Trae 👋"