create-branch-cli 1.0.0

package/README.md

@@ -0,0 +1,105 @@
+# create-branch-cli
+
+一个快速创建 Git 分支的命令行工具，支持自动生成规范的分支名称。
+
+## 功能特性
+
+- 🚀 快速创建 Git 分支
+- 📝 自动生成规范的分支名称
+- 👤 首次使用自动保存用户信息（工号、姓名）
+- 🐛 支持 feature 和 hotFix 两种分支类型
+- 📅 自动添加日期后缀
+
+## 分支命名规则
+
+- **Feature 分支**: `feature/工号_姓名_需求标题_年月日`
+- **HotFix 分支**: `hotFix/工号_姓名_需求标题_年月日`
+
+示例：
+- `feature/001_张三_用户登录功能_20251226`
+- `hotFix/001_张三_修复登录bug_20251226`
+
+## 安装
+
+### 本地开发安装
+
+```bash
+npm install -g
+```
+
+或者使用 npm link（在项目目录下）：
+
+```bash
+npm link
+```
+
+### 发布到 npm（发布后其他人可全局安装）
+
+```bash
+npm publish
+```
+
+发布后，其他人可以通过以下命令安装：
+
+```bash
+npm install -g create-branch-cli
+```
+
+## 使用方法
+
+### 首次使用
+
+首次使用时，工具会提示您输入工号和姓名，这些信息会保存在 `~/.create-branch/config.json` 文件中。
+
+### 创建 Feature 分支
+
+```bash
+create-branch 用户登录功能
+# 或使用别名
+cb 用户登录功能
+```
+
+### 创建 HotFix 分支
+
+```bash
+create-branch 修复登录bug -b
+# 或
+create-branch 修复登录bug --bug
+# 或使用别名
+cb 修复登录bug -b
+```
+
+### 查看帮助
+
+```bash
+create-branch
+# 或
+cb
+```
+
+## 配置
+
+用户信息保存在 `~/.create-branch/config.json` 文件中，格式如下：
+
+```json
+{
+  "workId": "001",
+  "name": "张三"
+}
+```
+
+如果需要修改用户信息，可以：
+1. 直接编辑配置文件
+2. 删除配置文件，下次使用时重新录入
+
+## 注意事项
+
+1. 使用前请确保当前目录是一个 Git 仓库
+2. 如果分支已存在，工具会提示是否切换到已存在的分支
+3. 需求标题中的空格会自动替换为下划线
+4. 日期格式为 YYYYMMDD（例如：20251226）
+
+## 许可证
+
+ISC
+

package/index.js

@@ -0,0 +1,234 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+// 配置文件路径（存储在用户主目录）
+const CONFIG_DIR = path.join(require('os').homedir(), '.create-branch');
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+// 工具函数
+function log(message) {
+  console.log(`[${new Date().toLocaleTimeString()}] ${message}`);
+}
+
+function error(message) {
+  console.error(`[错误] ${message}`);
+}
+
+function success(message) {
+  console.log(`✅ ${message}`);
+}
+
+// 读取配置文件
+function readConfig() {
+  if (!fs.existsSync(CONFIG_FILE)) {
+    return null;
+  }
+  try {
+    const content = fs.readFileSync(CONFIG_FILE, 'utf-8');
+    return JSON.parse(content);
+  } catch (err) {
+    error(`读取配置文件失败: ${err.message}`);
+    return null;
+  }
+}
+
+// 保存配置文件
+function saveConfig(config) {
+  try {
+    // 确保配置目录存在
+    if (!fs.existsSync(CONFIG_DIR)) {
+      fs.mkdirSync(CONFIG_DIR, { recursive: true });
+    }
+    fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), 'utf-8');
+    return true;
+  } catch (err) {
+    error(`保存配置文件失败: ${err.message}`);
+    return false;
+  }
+}
+
+// 交互式输入
+function question(query) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  return new Promise(resolve => {
+    rl.question(query, answer => {
+      rl.close();
+      resolve(answer);
+    });
+  });
+}
+
+// 首次使用，录入用户信息
+async function initUserInfo() {
+  console.log('\n=== 首次使用，需要录入您的信息 ===\n');
+  
+  const workId = await question('请输入工号: ');
+  if (!workId || !workId.trim()) {
+    error('工号不能为空');
+    process.exit(1);
+  }
+
+  const name = await question('请输入姓名: ');
+  if (!name || !name.trim()) {
+    error('姓名不能为空');
+    process.exit(1);
+  }
+
+  const config = {
+    workId: workId.trim(),
+    name: name.trim()
+  };
+
+  if (saveConfig(config)) {
+    success('用户信息已保存！');
+    return config;
+  } else {
+    error('保存用户信息失败');
+    process.exit(1);
+  }
+}
+
+// 获取当前日期（格式：YYYYMMDD）
+function getCurrentDate() {
+  const now = new Date();
+  const year = now.getFullYear();
+  const month = String(now.getMonth() + 1).padStart(2, '0');
+  const day = String(now.getDate()).padStart(2, '0');
+  return `${year}${month}${day}`;
+}
+
+// 生成分支名
+function generateBranchName(workId, name, title, isBug) {
+  const prefix = isBug ? 'hotFix' : 'feature';
+  const date = getCurrentDate();
+  // 将需求标题中的空格替换为下划线，并移除特殊字符
+  const cleanTitle = title.trim().replace(/\s+/g, '_').replace(/[^\w\u4e00-\u9fa5_-]/g, '');
+  return `${prefix}/${workId}_${name}_${cleanTitle}_${date}`;
+}
+
+// 检查是否在 Git 仓库中
+function isGitRepo() {
+  try {
+    execSync('git rev-parse --git-dir', { stdio: 'ignore' });
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+
+// 检查分支是否已存在
+function branchExists(branchName) {
+  try {
+    const branches = execSync('git branch -a', { encoding: 'utf-8' });
+    const branchList = branches.split('\n').map(b => b.trim().replace(/^\*\s*/, '').replace(/^remotes\/origin\//, ''));
+    return branchList.includes(branchName);
+  } catch (err) {
+    return false;
+  }
+}
+
+// 创建并切换到新分支
+function createBranch(branchName) {
+  try {
+    // 检查分支是否已存在
+    if (branchExists(branchName)) {
+      error(`分支 ${branchName} 已存在！`);
+      const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+      });
+      
+      return new Promise((resolve, reject) => {
+        rl.question('是否切换到已存在的分支？(y/n): ', answer => {
+          rl.close();
+          if (answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes') {
+            try {
+              log(`切换到分支: ${branchName}`);
+              execSync(`git checkout ${branchName}`, { stdio: 'inherit' });
+              success(`已切换到分支: ${branchName}`);
+              resolve(true);
+            } catch (err) {
+              error(`切换分支失败: ${err.message}`);
+              reject(err);
+            }
+          } else {
+            log('已取消操作');
+            reject(new Error('用户取消'));
+          }
+        });
+      });
+    }
+
+    // 创建新分支
+    log(`创建新分支: ${branchName}`);
+    execSync(`git checkout -b ${branchName}`, { stdio: 'inherit' });
+    success(`已创建并切换到分支: ${branchName}`);
+    return Promise.resolve(true);
+  } catch (err) {
+    error(`创建分支失败: ${err.message}`);
+    throw err;
+  }
+}
+
+// 主函数
+async function main() {
+  try {
+    // 解析命令行参数
+    const args = process.argv.slice(2);
+    
+    // 检查是否是 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('\n示例:');
+      console.log('  create-branch 用户登录功能');
+      console.log('  create-branch 修复登录bug -b');
+      console.log('\n别名:');
+      console.log('  cb <需求标题> [-b|--bug]');
+      process.exit(0);
+    }
+
+    const title = titleArgs.join(' ');
+
+    // 检查是否在 Git 仓库中
+    if (!isGitRepo()) {
+      error('当前目录不是 Git 仓库！');
+      process.exit(1);
+    }
+
+    // 读取或初始化用户配置
+    let config = readConfig();
+    if (!config || !config.workId || !config.name) {
+      config = await initUserInfo();
+    }
+
+    // 生成分支名
+    const branchName = generateBranchName(config.workId, config.name, title, isBug);
+
+    // 创建分支
+    await createBranch(branchName);
+
+  } catch (err) {
+    error(err.message);
+    process.exit(1);
+  }
+}
+
+// 运行主函数
+main();
+

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "create-branch-cli",
+  "version": "1.0.0",
+  "description": "快速创建 Git 分支的工具，支持 feature 和 hotFix 分支类型",
+  "main": "index.js",
+  "bin": {
+    "create-branch": "./index.js",
+    "cb": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "git",
+    "branch",
+    "cli",
+    "automation"
+  ],
+  "author": "",
+  "license": "ISC",
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}
+