zen-gitsync 1.3.0 → 1.3.5

package/README.md

@@ -15,10 +15,8 @@ npm install -g zen-gitsync
 
 1. 在终端中，输入 `g` 并按回车。
 2. 输入提交信息，按回车确认提交。
-3. 工具将自动执行以下操作：
-    - `git add .`
-    - `git commit -m "你的提交信息"`
-    - `git push`
+3. 工具将自动查看远程分支并自动提交
+
 
 ### 示例：
 #### 交互式提交：
@@ -30,18 +28,30 @@ $ g
 ```bash
 $ g -y
 ```
+#### 传入message直接提交：
+```bash
+$ g -m <message>
+$ g -m=<message>
+```
+
+#### 查看帮助
+```shell
+$ g -h
+$ g --help
+```
+
 #### 定时执行自动提交，默认间隔1小时
 ```bash
 $ g -y --interval
-$ g -y --interval=秒数 
+$ g -y --interval=<seconds> 
 ```
 #### 指定目录提交
 ```bash
-$ g --path=./
+$ g --path=<path> 
 ```
 或
 ```bash
-$ g --cwd=./
+$ g --cwd=<path> 
 ```
 
 #### 添加项目script
@@ -62,3 +72,9 @@ start /min cmd /k "g -y --path=你要同步的文件夹 --interval"
 ```shell
 $ g --no-diff
 ```
+
+#### 格式化打印git log
+```shell
+$ g log
+$ g log --n=5
+```

package/index.js

@@ -0,0 +1,2 @@
+import config from './src/config.js'
+export default config

package/package.json

@@ -1,21 +1,27 @@
 {
   "name": "zen-gitsync",
-  "version": "1.3.0",
+  "version": "1.3.5",
   "description": "一个 git 自动查看差异并提交的工具",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "g": "node ./src/gitCommit.js",
+    "g:m": "node ./src/gitCommit.js -m='test'",
+    "g:m2": "node ./src/gitCommit.js -m testmsg",
     "g:y": "node ./src/gitCommit.js -y",
     "g:y:interval": "node ./src/gitCommit.js -y --interval",
     "g:y:interval10": "node ./src/gitCommit.js -y --interval=10",
     "g:cwd": "node ./src/gitCommit.js --path=./",
-    "g:no-diff": "node ./src/gitCommit.js --no-diff"
+    "g:cwd2": "node ./src/gitCommit.js --path=../",
+    "g:no-diff": "node ./src/gitCommit.js --no-diff",
+    "g:log": "node ./src/gitCommit.js log",
+    "g:log5": "node ./src/gitCommit.js log --n=5",
+    "g:h": "node ./src/gitCommit.js -h"
   },
   "files": [
-    "src/gitCommit.js",
-    "src/utils/index.js",
-    "package.json"
+    "src/*",
+    "package.json",
+    "index.js"
   ],
   "bin": {
     "g": "./src/gitCommit.js"

package/src/config.js

@@ -0,0 +1,3 @@
+export default {
+  "defaultCommitMessage": "submit"
+}

package/src/gitCommit.js

@@ -2,13 +2,53 @@
 
 import {exec, execSync} from 'child_process'
 import os from 'os'
-import {coloredLog} from './utils/index.js';
+import {coloredLog, errorLog} from './utils/index.js';
 import readline from 'readline'
 import ora from 'ora';
 import chalk from 'chalk';
 import boxen from 'boxen';
+import config from './config.js'
+
+const {defaultCommitMessage} = config
 
 let timer = null
+const showHelp = () => {
+  const helpMessage = `
+Usage: g [options]
+
+Options:
+  -h, --help              Show this help message
+  -y                      Auto commit with default message
+  -m <message>            Commit message (use quotes if message contains spaces)
+  -m=<message>            Commit message (use this form without spaces around '=')
+  --path=<path>           Set custom working directory
+  --cwd=<path>            Set custom working directory
+  --interval=<seconds>    Set interval time for automatic commits (in seconds)
+  log                     Show git commit logs
+    --n=<number>          Number of commits to show with --log
+  --no-diff               Skip displaying git diff
+
+Example:
+  g -m "Initial commit"      Commit with a custom message
+  g -m=Fix-bug               Commit with a custom message (no spaces around '=')
+  g -y                       Auto commit with the default message
+  g -y --interval=600        Commit every 10 minutes (600 seconds)
+  g --path=/path/to/repo     Specify a custom working directory
+  g log                      Show recent commit logs
+  g log --n=5                Show the last 5 commits with --log
+
+Add auto submit in package.json:
+  "scripts": {
+    "g:y": "g -y"
+  }
+
+Start a background process for automatic commits:
+  start /min cmd /k "g -y --path=your-folder --interval"
+  `;
+
+  console.log(helpMessage);
+  process.exit();
+};
 
 const judgePlatform = () => {
   // 判断是否是 Windows 系统
@@ -51,7 +91,7 @@ class GitCommit {
   constructor(options) {
     this.statusOutput = null
     this.exit = options.exit
-    this.commitMessage = `提交`
+    this.commitMessage = defaultCommitMessage
     this.init()
   }
 
@@ -60,53 +100,193 @@ class GitCommit {
       process.exit()
     }
   }
-
-  async init() {
-    try {
-      judgePlatform()
-
-      this.statusOutput = this.execSyncGitCommand('git status')
-      if (this.statusOutput.includes('nothing to commit, working tree clean')) {
-        if (this.statusOutput.includes('use "git push')) {
-          this.exec_push()
-        } else {
-          this.exec_exit();
+  judgeLog() {
+    const logArg = process.argv.find(arg => arg === 'log');
+    if (logArg) {
+      this.printGitLog(); // 如果有 log 参数，打印 Git 提交记录
+      return true;
+    }
+  }
+  judgeHelp() {
+    if (process.argv.includes('-h') || process.argv.includes('--help')) {
+      showHelp();
+      return true;
+    }
+  }
+  execDiff() {
+    const no_diff = process.argv.find(arg => arg.startsWith('--no-diff'))
+    if (!no_diff) {
+      this.execSyncGitCommand('git diff --color=always', {
+        head: `git diff`
+      })
+    }
+  }
+  async execAddAndCommit() {
+    // 检查 -m 参数（提交信息）
+    const commitMessageArg = process.argv.find(arg => arg.startsWith('-m'));
+    if (commitMessageArg) {
+      if (commitMessageArg.includes('=')) {
+        // 处理 -m=<message> 的情况
+        this.commitMessage = commitMessageArg.split('=')[1]?.replace(/^['"]|['"]$/g, '') || defaultCommitMessage;
+      } else {
+        // 处理 -m <message> 的情况
+        const index = process.argv.indexOf(commitMessageArg);
+        if (index !== -1 && process.argv[index + 1]) {
+          this.commitMessage = process.argv[index + 1]?.replace(/^['"]|['"]$/g, '') || defaultCommitMessage;
         }
-        return
       }
+    }
 
-      const no_diff = process.argv.find(arg => arg.startsWith('--no-diff'))
-      if(!no_diff){
-        this.execSyncGitCommand('git diff')
-      }
+    // 检查命令行参数，判断是否有 -y 参数
+    const autoCommit = process.argv.includes('-y');
+
+    if (!autoCommit && !commitMessageArg) {
+      // 如果没有 -y 参数，则等待用户输入提交信息
+      this.commitMessage = await question('请输入提交信息：');
+    }
 
-      // 检查命令行参数，判断是否有 -y 参数
-      const autoCommit = process.argv.includes('-y');
+    this.statusOutput.includes('(use "git add') && this.execSyncGitCommand('git add .')
 
-      if (!autoCommit) {
-        // 如果没有 -y 参数，则等待用户输入提交信息
-        this.commitMessage = await question('请输入提交信息：');
+    // 执行 git commit
+    if (this.statusOutput.includes('Untracked files:') || this.statusOutput.includes('Changes not staged for commit') || this.statusOutput.includes('Changes to be committed')) {
+      this.execSyncGitCommand(`git commit -m "${this.commitMessage || defaultCommitMessage}"`)
+    }
+  }
+  async judgeRemote() {
+    try{
+      const spinner = ora('正在检查远程更新...').start();
+      // 检查是否有远程更新
+      // 先获取远程最新状态
+      await this.execGitCommand('git remote update', {
+        head: 'Fetching remote updates',
+        log: false
+      });
+      // 检查是否需要 pull
+      const res = await this.execGitCommand('git rev-list HEAD..@{u} --count', {
+        head: 'Checking if behind remote',
+        log: false
+      });
+      const behindCount = res.stdout.trim()
+      // 如果本地落后于远程
+      if (parseInt(behindCount) > 0) {
+        try {
+          spinner.stop();
+          // const spinner_pull = ora('发现远程更新，正在拉取...').start();
+          await this.execPull()
+
+          // // 尝试使用 --ff-only 拉取更新
+          // const res = await this.execGitCommand('git pull --ff-only', {
+          //   spinner: spinner_pull,
+          //   head: 'Pulling updates'
+          // });
+          console.log(chalk.green('✓ 已成功同步远程更新'));
+        } catch (pullError) {
+          // // 如果 --ff-only 拉取失败，尝试普通的 git pull
+          // console.log(chalk.yellow('⚠️ 无法快进合并，尝试普通合并...'));
+          // await this.execPull()
+          throw new Error(pullError)
+        }
+      } else {
+        spinner.stop();
+        console.log(chalk.green('✓ 本地已是最新'));
       }
+    }catch (e) {
+      // console.log(`e ==> `, e)
+      spinner.stop();
+      throw new Error(e)
+    }
+  }
+  async execPull(){
+    try{
+      // 检查是否需要拉取更新
+      const spinner = ora('正在拉取代码...').start();
+      await this.execGitCommand('git pull', {
+        spinner
+      })
+    }catch (e) {
+      console.log(chalk.yellow('⚠️ 拉取远程更新合并失败，可能存在冲突，请手动处理'));
+      throw Error(e)
+    }
+  }
+
+  async init() {
+    try {
+      judgePlatform()
+
+      // 检查是否有 log 参数
+      if(this.judgeLog()) return
 
-      // 执行 git add .
-      this.statusOutput.includes('(use "git add') && this.execSyncGitCommand('git add .')
+      // 检查帮助参数
+      if(this.judgeHelp()) return
 
-      // 执行 git commit
-      if (this.statusOutput.includes('Untracked files:') || this.statusOutput.includes('Changes not staged for commit') || this.statusOutput.includes('Changes to be committed')) {
-        this.execSyncGitCommand(`git commit -m "${this.commitMessage || '提交'}"`)
+      this.statusOutput = this.execSyncGitCommand('git status')
+      const hasUnmerged = this.statusOutput.includes('You have unmerged paths');
+      if(hasUnmerged){
+        errorLog('错误', '存在未合并的文件，请先解决冲突')
+        process.exit(1);
       }
+      // 先检查本地是否有未提交的更改
+      const hasLocalChanges = !this.statusOutput.includes('nothing to commit, working tree clean');
+      if (hasLocalChanges) {
+        // 检查是否有 --no-diff 参数
+        this.execDiff()
 
-      // 检查是否需要拉取更新
-      this.statusOutput.includes('use "git pull') && this.execSyncGitCommand('git pull')
+        await this.execAddAndCommit()
 
-      this.exec_push()
+        this.statusOutput.includes('use "git pull') && await this.execPull()
 
+        // 检查是否有远程更新
+        await this.judgeRemote()  // 等待 judgeRemote 完成
 
+        this.exec_push()
+      }else{
+        if (this.statusOutput.includes('use "git push')) {
+          this.exec_push()
+        } else if (this.statusOutput.includes('use "git pull')) {
+          await this.execPull()
+        } else {
+          await this.judgeRemote()  // 等待 judgeRemote 完成
+          this.exec_exit();
+        }
+      }
     } catch (e) {
-      console.log(`e ==> `, e)
+      // console.log(`e.message ==> `, e.message)
+      // 应该提供更具体的错误信息
+      // console.error('Git operation failed:', e.message);
+      // 考虑不同错误类型的处理
+      if (e.message.includes('not a git repository')) {
+        errorLog('错误', '当前目录不是git仓库')
+      } else if (e.message.includes('Permission denied')) {
+        errorLog('错误', '权限不足，请检查git配置')
+      }
+      process.exit(1);
     }
   }
 
+  async printGitLog() {
+    let n = 20;
+    let logArg = process.argv.find(arg => arg.startsWith('--n='));
+    if (logArg) {
+      n = parseInt(logArg.split('=')[1], 10);
+    }
+    const logCommand = `git log -n ${n} --pretty=format:"%C(green)%h%C(reset) | %C(cyan)%an%C(reset) | %C(yellow)%ad%C(reset) | %C(blue)%D%C(reset) | %C(magenta)%s%C(reset)" --date=format:"%Y-%m-%d %H:%M" --graph --decorate --color`
+    try {
+      const logOutput = this.execSyncGitCommand(logCommand, {
+        head: `git log`
+      });
+      // // 格式化输出 Git 提交记录
+      // const box = boxen(chalk.green.bold(logOutput), {
+      //   borderStyle: 'round',
+      //   borderColor: 'cyan',
+      //   backgroundColor: 'black',
+      // });
+      // console.log(box); // 打印优雅的 Git 提交记录
+    } catch (error) {
+      console.error('无法获取 Git 提交记录:', error.message);
+    }
+    this.exec_exit(); // 打印完成后退出
+  }
+
   exec_push() {
     // 执行 git push
     // this.execSyncGitCommand(`git push`);
@@ -117,7 +297,7 @@ class GitCommit {
 
       // 使用 boxen 绘制带边框的消息
       let msg = ` SUCCESS: 提交完成 
- message: ${this.commitMessage || '提交'} 
+ message: ${this.commitMessage || defaultCommitMessage} 
  time: ${new Date().toLocaleString()} `
       const message = chalk.green.bold(msg);
       const box = boxen(message, {
@@ -134,39 +314,47 @@ class GitCommit {
 
   execSyncGitCommand(command, options = {}) {
     try {
-      let {encoding = 'utf-8', maxBuffer = 30 * 1024 * 1024} = options
+      let {encoding = 'utf-8', maxBuffer = 30 * 1024 * 1024, head = command, log = true} = options
       let cwd = getCwd()
       const output = execSync(command, {encoding, maxBuffer, cwd})
-      if(options.spinner){
+      if (options.spinner) {
         options.spinner.stop();
       }
       let result = output.trim()
-      coloredLog(command, result)
+      log && coloredLog(head, result)
       return result
     } catch (e) {
-      console.log(`执行命令出错 ==> `, command, e)
+      // console.log(`执行命令出错 ==> `, command, e)
+      log && coloredLog(command, e, 'error')
       throw new Error(e)
     }
   }
 
   execGitCommand(command, options = {}, callback) {
-    let {encoding = 'utf-8', maxBuffer = 30 * 1024 * 1024} = options
-    let cwd = getCwd()
-    exec(command, {encoding, maxBuffer, cwd}, (error, stdout, stderr) => {
-      if(options.spinner){
-        options.spinner.stop();
-      }
-      if (error) {
-        coloredLog(command, error, 'error')
-        return
-      }
-      if (stdout) {
-        coloredLog(command, stdout)
-      }
-      if (stderr) {
-        coloredLog(command, stderr)
-      }
-      callback && callback(error, stdout, stderr)
+    return new Promise((resolve, reject) => {
+      let {encoding = 'utf-8', maxBuffer = 30 * 1024 * 1024, head = command, log = true} = options
+      let cwd = getCwd()
+      exec(command, {encoding, maxBuffer, cwd}, (error, stdout, stderr) => {
+        if (options.spinner) {
+          options.spinner.stop();
+        }
+        if (error) {
+          log && coloredLog(head, error, 'error')
+          reject(error)
+          return
+        }
+        if (stdout) {
+          log && coloredLog(head, stdout)
+        }
+        if (stderr) {
+          log && coloredLog(head, stderr)
+        }
+        resolve({
+          stdout,
+          stderr
+        })
+        callback && callback(error, stdout, stderr)
+      })
     })
   }
 }

package/src/utils/index.js

@@ -17,6 +17,7 @@
 import stringWidth from 'string-width';
 import Table from 'cli-table3';
 import chalk from 'chalk';
+import boxen from "boxen";
 
 const printTableWithHeaderUnderline = (head, content, style) => {
   // 获取终端的列数（宽度）
@@ -31,7 +32,7 @@ const printTableWithHeaderUnderline = (head, content, style) => {
   if (!style) {
     style = {
       // head: ['cyan'], // 表头文字颜色为cyan
-      // border: ['white'],         // 边框颜色
+      border: [chalk.reset()],         // 边框颜色
       compact: true,              // 启用紧凑模式，去掉不必要的空白
     }
   }
@@ -41,6 +42,23 @@ const printTableWithHeaderUnderline = (head, content, style) => {
     colWidths,       // 使用动态计算的列宽
     style: style,
     wordWrap: true,  // 启用自动换行
+    // chars: {
+    //   'top': '═',       // 顶部边框使用长横线
+    //   'top-mid': '╤',   // 顶部连接符
+    //   'top-left': '╔',   // 左上角
+    //   'top-right': '╗',  // 右上角
+    //   'bottom': '═',    // 底部边框
+    //   'bottom-mid': '╧', // 底部连接符
+    //   'bottom-left': '╚',// 左下角
+    //   'bottom-right': '╝',// 右下角
+    //   'left': '║',      // 左边框
+    //   'left-mid': '╟',  // 左连接符
+    //   'mid': '═',       // 中间分隔符
+    //   'mid-mid': '╪',   // 中间连接符
+    //   'right': '║',     // 右边框
+    //   'right-mid': '╢', // 右连接符
+    //   'middle': '│'     // 中间内容的边界
+    // }
   });
 
   // 向表格中添加不同颜色的行
@@ -94,15 +112,15 @@ const calcColor = (commandLine, str) => {
       }
       break;
     case 'git diff':
-      if (str.startsWith('-')) {
-        color = 'red'
-      }
-      if (str.startsWith('+')) {
-        color = 'green'
-      }
-      if (str.startsWith('@@ ')) {
-        color = 'cyan'
-      }
+      // if (str.startsWith('---')) {
+      //   color = 'red'
+      // }
+      // if (str.startsWith('+++')) {
+      //   color = 'green'
+      // }
+      // if (str.startsWith('@@ ')) {
+      //   color = 'cyan'
+      // }
       break;
   }
   return color
@@ -112,7 +130,7 @@ const tableLog = (commandLine, content, type) => {
   let head = chalk.bold.blue(handle_commandLine)
   let style = {
     // head: ['cyan'], // 表头文字颜色为cyan
-    // border: ['whiteBright'],         // 边框颜色
+    border: [chalk.reset()],         // 边框颜色
     compact: true,              // 启用紧凑模式，去掉不必要的空白
   }
   switch (type) {
@@ -121,7 +139,7 @@ const tableLog = (commandLine, content, type) => {
       content = content.toString().split('\n')
       head = chalk.bold.red(handle_commandLine)
       break;
-    case 'log':
+    case 'common':
       style.head = ['blue'];
       content = content.split('\n')
       break;
@@ -140,12 +158,15 @@ const coloredLog = (...args) => {
   // 获取参数内容
   const commandLine = args[0];
   const content = args[1];
-  const type = args[2] || 'log';
-
-
+  const type = args[2] || 'common';
   tableLog(commandLine, content, type);
-
-  // console.log(`args ==> `, args)
-
 }
-export {coloredLog};
+const errorLog = (commandLine, content) => {
+  // 使用 boxen 绘制带边框的消息
+  let msg = ` FAIL ${commandLine}
+ content: ${content} `
+  const message = chalk.red.bold(msg);
+  const box = boxen(message);
+  console.log(box); // 打印带有边框的消息
+}
+export {coloredLog, errorLog};