create-branch-cli 1.0.0 → 1.0.1

package/README.md

@@ -9,6 +9,7 @@
 - 👤 首次使用自动保存用户信息（工号、姓名）
 - 🐛 支持 feature 和 hotFix 两种分支类型
 - 📅 自动添加日期后缀
+- 💾 支持保存需求唯一标识，快速提交和推送
 
 ## 分支命名规则
 
@@ -54,21 +55,67 @@ npm install -g create-branch-cli
 ### 创建 Feature 分支
 
 ```bash
+# 仅创建分支
 create-branch 用户登录功能
 # 或使用别名
 cb 用户登录功能
+
+# 创建分支并保存需求唯一标识（用于后续快速提交）
+create-branch 用户登录功能 PROJ-123
+# 或使用别名
+cb 用户登录功能 PROJ-123
 ```
 
 ### 创建 HotFix 分支
 
 ```bash
+# 仅创建分支
 create-branch 修复登录bug -b
 # 或
 create-branch 修复登录bug --bug
 # 或使用别名
 cb 修复登录bug -b
+
+# 创建分支并保存需求唯一标识
+create-branch 修复登录bug PROJ-124 -b
+# 或使用别名
+cb 修复登录bug PROJ-124 -b
 ```
 
+### 快速提交和推送
+
+如果创建分支时输入了需求唯一标识，可以使用以下命令快速提交和推送：
+
+```bash
+create-branch push
+# 或使用别名
+cb push
+```
+
+**说明**：
+- 会自动添加所有更改到暂存区
+- 提交信息格式：`需求唯一标识:需求标题`（例如：`PROJ-123:用户登录功能`）
+- 自动推送到远程仓库的当前分支
+
+### 重置用户信息
+
+如果需要修改工号或姓名，可以使用以下命令：
+
+```bash
+create-branch reset
+# 或
+create-branch config
+# 或使用别名
+cb reset
+# 或
+cb config
+```
+
+**说明**：
+- 会提示输入新的工号和姓名
+- 重置后，之前保存的需求信息会保留
+- 新创建的分支将使用新的工号和姓名
+
 ### 查看帮助
 
 ```bash
@@ -79,18 +126,31 @@ cb
 
 ## 配置
 
-用户信息保存在 `~/.create-branch/config.json` 文件中，格式如下：
+用户信息和需求信息保存在 `~/.create-branch/config.json` 文件中，格式如下：
 
 ```json
 {
   "workId": "001",
-  "name": "张三"
+  "name": "张三",
+  "requirements": {
+    "feature/001_张三_用户登录功能_20251226": {
+      "id": "PROJ-123",
+      "title": "用户登录功能",
+      "branchName": "feature/001_张三_用户登录功能_20251226"
+    }
+  }
 }
 ```
 
+**配置说明**：
+- `workId`: 工号
+- `name`: 姓名
+- `requirements`: 需求信息（以分支名为 key，自动保存）
+
 如果需要修改用户信息，可以：
-1. 直接编辑配置文件
-2. 删除配置文件，下次使用时重新录入
+1. 使用 `cb reset` 或 `cb config` 命令（推荐）
+2. 直接编辑配置文件
+3. 删除配置文件，下次使用时重新录入
 
 ## 注意事项
 
@@ -98,6 +158,8 @@ cb
 2. 如果分支已存在，工具会提示是否切换到已存在的分支
 3. 需求标题中的空格会自动替换为下划线
 4. 日期格式为 YYYYMMDD（例如：20251226）
+5. 使用 `cb push` 前，请确保创建分支时输入了需求唯一标识
+6. `cb push` 会自动添加所有更改并提交，提交信息格式：`需求唯一标识:需求标题`
 
 ## 许可证
 

package/index.js

@@ -135,6 +135,30 @@ function branchExists(branchName) {
   }
 }
 
+// 获取当前分支名
+function getCurrentBranch() {
+  try {
+    const branch = execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
+    return branch;
+  } catch (err) {
+    error('无法获取当前分支');
+    throw err;
+  }
+}
+
+// 保存需求信息到配置
+function saveRequirementInfo(config, branchName, requirementId, title) {
+  if (!config.requirements) {
+    config.requirements = {};
+  }
+  config.requirements[branchName] = {
+    id: requirementId,
+    title: title,
+    branchName: branchName
+  };
+  saveConfig(config);
+}
+
 // 创建并切换到新分支
 function createBranch(branchName) {
   try {
@@ -178,33 +202,149 @@ function createBranch(branchName) {
   }
 }
 
+// 重置用户信息
+async function resetUserInfo() {
+  try {
+    console.log('\n=== 重置用户信息 ===\n');
+    
+    const workId = await question('请输入新的工号: ');
+    if (!workId || !workId.trim()) {
+      error('工号不能为空');
+      return false;
+    }
+
+    const name = await question('请输入新的姓名: ');
+    if (!name || !name.trim()) {
+      error('姓名不能为空');
+      return false;
+    }
+
+    // 读取现有配置（保留需求信息）
+    let config = readConfig() || {};
+    
+    // 更新用户信息
+    config.workId = workId.trim();
+    config.name = name.trim();
+
+    if (saveConfig(config)) {
+      success('用户信息已更新！');
+      console.log(`工号: ${config.workId}`);
+      console.log(`姓名: ${config.name}`);
+      return true;
+    } else {
+      error('保存用户信息失败');
+      return false;
+    }
+  } catch (err) {
+    error(`重置用户信息失败: ${err.message}`);
+    return false;
+  }
+}
+
+// 提交并推送代码
+function commitAndPush() {
+  try {
+    // 检查是否在 Git 仓库中
+    if (!isGitRepo()) {
+      error('当前目录不是 Git 仓库！');
+      return false;
+    }
+
+    // 获取当前分支
+    const currentBranch = getCurrentBranch();
+    log(`当前分支: ${currentBranch}`);
+
+    // 读取配置，获取需求信息
+    const config = readConfig();
+    if (!config || !config.requirements || !config.requirements[currentBranch]) {
+      error('当前分支没有保存需求信息！');
+      error('请使用以下格式创建分支：cb <需求标题> <需求唯一标识>');
+      return false;
+    }
+
+    const requirement = config.requirements[currentBranch];
+    const commitMessage = `${requirement.id}:${requirement.title}`;
+
+    // 检查是否有变更
+    try {
+      const status = execSync('git status --porcelain', { encoding: 'utf-8' });
+      if (!status.trim()) {
+        log('没有文件变更，无需提交');
+        return true;
+      }
+    } catch (err) {
+      error('无法获取 Git 状态');
+      return false;
+    }
+
+    // 添加所有更改
+    log('添加所有更改到暂存区...');
+    execSync('git add .', { stdio: 'inherit' });
+
+    // 提交
+    log(`提交更改: ${commitMessage}`);
+    execSync(`git commit -m "${commitMessage}"`, { stdio: 'inherit' });
+
+    // 推送
+    log('推送到远程仓库...');
+    execSync(`git push origin ${currentBranch}`, { stdio: 'inherit' });
+
+    success(`已提交并推送到分支: ${currentBranch}`);
+    return true;
+  } catch (err) {
+    error(`提交或推送失败: ${err.message}`);
+    return false;
+  }
+}
+
 // 主函数
 async function main() {
   try {
     // 解析命令行参数
     const args = process.argv.slice(2);
     
+    // 检查是否是 push 命令
+    if (args.length > 0 && args[0].toLowerCase() === 'push') {
+      const success = commitAndPush();
+      process.exit(success ? 0 : 1);
+      return;
+    }
+    
+    // 检查是否是 reset 命令
+    if (args.length > 0 && (args[0].toLowerCase() === 'reset' || args[0].toLowerCase() === 'config')) {
+      const success = await resetUserInfo();
+      process.exit(success ? 0 : 1);
+      return;
+    }
+    
     // 检查是否是 bug 类型
     const isBug = args.includes('-b') || args.includes('--bug');
     
-    // 移除标志参数，获取需求标题
+    // 移除标志参数，获取需求标题和需求唯一标识
     const titleArgs = args.filter(arg => arg !== '-b' && arg !== '--bug');
     
     if (titleArgs.length === 0) {
       console.log('\n用法:');
-      console.log('  create-branch <需求标题>        # 创建 feature 分支');
-      console.log('  create-branch <需求标题> -b     # 创建 hotFix 分支');
-      console.log('  create-branch <需求标题> --bug  # 创建 hotFix 分支');
+      console.log('  create-branch <需求标题>                    # 创建 feature 分支');
+      console.log('  create-branch <需求标题> <需求唯一标识>      # 创建 feature 分支并保存需求信息');
+      console.log('  create-branch <需求标题> -b                 # 创建 hotFix 分支');
+      console.log('  create-branch <需求标题> <需求唯一标识> -b   # 创建 hotFix 分支并保存需求信息');
+      console.log('  create-branch push                          # 提交并推送代码（使用保存的需求信息）');
+      console.log('  create-branch reset                         # 重置工号和姓名');
       console.log('\n示例:');
       console.log('  create-branch 用户登录功能');
+      console.log('  create-branch 用户登录功能 PROJ-123');
       console.log('  create-branch 修复登录bug -b');
+      console.log('  create-branch 修复登录bug PROJ-124 -b');
+      console.log('  create-branch push');
+      console.log('  create-branch reset');
       console.log('\n别名:');
-      console.log('  cb <需求标题> [-b|--bug]');
+      console.log('  cb <需求标题> [需求唯一标识] [-b|--bug]');
+      console.log('  cb push');
+      console.log('  cb reset 或 cb config');
       process.exit(0);
     }
 
-    const title = titleArgs.join(' ');
-
     // 检查是否在 Git 仓库中
     if (!isGitRepo()) {
       error('当前目录不是 Git 仓库！');
@@ -217,12 +357,34 @@ async function main() {
       config = await initUserInfo();
     }
 
+    // 解析需求标题和需求唯一标识
+    // titleArgs 已经过滤掉了 -b 和 --bug
+    // 如果参数数量 >= 2，则最后一个参数是需求唯一标识
+    let title, requirementId;
+    if (titleArgs.length >= 2) {
+      // 最后一个参数是需求唯一标识
+      requirementId = titleArgs[titleArgs.length - 1];
+      title = titleArgs.slice(0, -1).join(' ');
+    } else {
+      // 只有需求标题
+      title = titleArgs.join(' ');
+      requirementId = null;
+    }
+
     // 生成分支名
     const branchName = generateBranchName(config.workId, config.name, title, isBug);
+    log(`生成的分支名: ${branchName}`);
 
     // 创建分支
     await createBranch(branchName);
 
+    // 如果提供了需求唯一标识，保存到配置
+    if (requirementId) {
+      saveRequirementInfo(config, branchName, requirementId.trim(), title);
+      success(`已保存需求信息: ${requirementId}:${title}`);
+      log('可以使用 "cb push" 快速提交和推送代码');
+    }
+
   } catch (err) {
     error(err.message);
     process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-branch-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "快速创建 Git 分支的工具，支持 feature 和 hotFix 分支类型",
   "main": "index.js",
   "bin": {
@@ -22,4 +22,3 @@
     "node": ">=12.0.0"
   }
 }
-