zen-gitsync 2.11.19 → 2.11.21

package/README.md

@@ -1,17 +1,134 @@
 # zen-gitsync
 
-`zen-gitsync` 是一个工作平台工具，集成部分 git 功能，可自定义命令，编排命令，设置自启动
+[English](#zen-gitsync) | [中文](#zen-gitsync-1)
+
+A Git automation platform with interactive commits, scheduled sync, custom command orchestration, file locking, and a visual GUI.
+
+## Installation
+
+Install globally via npm:
+
+```bash
+npm install -g zen-gitsync
+```
+
+## v2.x.x
+- Added graphical user interface (GUI) mode
+- Support for standardized commit message format
+
+### Launch GUI:
+```shell
+$ g ui
+```
+![ui](https://home.flowdash.cn/upload/VditorFiles/2026-1/image_zbQZpiL6.png)
+
+### Command Orchestration
+
+![Command Orchestration](https://home.flowdash.cn/upload/VditorFiles/2026-1/zen-gitsync_SBAJdlvm.png)
+
+### Commands
+
+#### Interactive commit:
+```bash
+$ g
+Enter your commit message: fix login page style
+```
+
+#### Commit directly (skip prompt):
+```bash
+$ g -y
+```
+
+#### Set default commit message:
+```bash
+$ g --set-default-message="update"
+```
+
+#### Get current config:
+```bash
+$ g get-config
+```
+
+#### Commit with inline message:
+```bash
+$ g -m <message>
+$ g -m=<message>
+```
+
+#### Show help:
+```shell
+$ g -h
+$ g --help
+```
+
+#### Scheduled auto-commit (default interval: 1 hour):
+```bash
+$ g -y --interval
+$ g -y --interval=<seconds>
+```
+
+#### Specify working directory:
+```bash
+$ g --path=<path>
+$ g --cwd=<path>
+```
+
+#### Sync a folder in background (Windows cmd):
+```shell
+start /min cmd /k "g -y --path=<your-folder> --interval"
+```
+
+#### Scheduled command execution (Windows cmd):
+```shell
+start /min cmd /k "g --cmd=\"echo hello\" --cmd-interval=5"     # run every 5 seconds
+start /min cmd /k "g --cmd=\"echo at-time\" --at=23:59"         # run once at 23:59
+start /min cmd /k "g --cmd=\"echo daily\" --at=23:59 --daily"   # run daily at 23:59
+```
+
+#### Suppress git diff output:
+```shell
+$ g --no-diff
+```
+
+#### Print formatted git log:
+```shell
+$ g log
+$ g log --n=5
+```
+
+#### File locking (only effective within the tool):
+```shell
+# Lock a file (locked files are excluded from commits)
+$ g --lock-file=config.json
+
+# Unlock a file
+$ g --unlock-file=config.json
+
+# List all locked files
+$ g --list-locked
+
+# Check if a file is locked
+$ g --check-lock=config.json
+```
+
+---
+
+# zen-gitsync
+
+[English](#zen-gitsync) | [中文](#zen-gitsync-1)
+
+`zen-gitsync` 是一个 Git 自动化工作平台，支持交互式提交、定时同步、自定义命令编排、文件锁定与可视化 GUI 界面。
 
 ## 安装
 
-通过 npm 安装 `zen-gitsync`，并进行全局安装：
+通过 npm 全局安装：
 
 ```bash
 npm install -g zen-gitsync
 ```
 
 ## v2.x.x
-- 新增图形用户界面(GUI)模式
+- 新增图形用户界面（GUI）模式
 - 支持标准化的提交信息格式
 
 ### 启动图形界面：
@@ -19,78 +136,82 @@ npm install -g zen-gitsync
 $ g ui
 ```
 ![ui](https://home.flowdash.cn/upload/VditorFiles/2026-1/image_zbQZpiL6.png)
+
 ### 命令编排
 
 ![命令编排](https://home.flowdash.cn/upload/VditorFiles/2026-1/zen-gitsync_SBAJdlvm.png)
 
-### 其他命令：
+### 命令列表
+
 #### 交互式提交：
 ```bash
 $ g
 请输入你的提交信息: 修复了登录页样式问题
 ```
-#### 直接提交：
+
+#### 直接提交（跳过输入）：
 ```bash
 $ g -y
 ```
+
 #### 设置默认提交信息：
 ```bash
 $ g --set-default-message="提交"
 ```
-#### 获取默认提交信息：
+
+#### 获取当前配置：
 ```bash
 $ g get-config
 ```
-#### 传入message直接提交：
+
+#### 传入 message 直接提交：
 ```bash
 $ g -m <message>
 $ g -m=<message>
 ```
 
-#### 查看帮助
+#### 查看帮助：
 ```shell
 $ g -h
 $ g --help
 ```
 
-#### 定时执行自动提交，默认间隔1小时
+#### 定时执行自动提交（默认间隔 1 小时）：
 ```bash
 $ g -y --interval
-$ g -y --interval=<seconds> 
+$ g -y --interval=<seconds>
 ```
-#### 指定目录提交
-```bash
-$ g --path=<path> 
-```
-或
+
+#### 指定目录提交：
 ```bash
-$ g --cwd=<path> 
+$ g --path=<path>
+$ g --cwd=<path>
 ```
 
-#### cmd同步文件夹
+#### 后台同步文件夹（Windows cmd）：
 ```shell
 start /min cmd /k "g -y --path=你要同步的文件夹 --interval"
 ```
 
-#### cmd 定时执行命令
+#### 定时执行命令（Windows cmd）：
 ```shell
-start /min cmd /k "g --cmd=\"echo hello\" --cmd-interval=5"     # 每5秒执行一次echo hello
-start /min cmd /k "g --cmd=\"echo at-time\" --at=23:59" # 在23:59执行一次echo at-time
-start /min cmd /k "g --cmd=\"echo daily\" --at=23:59 --daily" # 每天23:59执行一次echo daily
+start /min cmd /k "g --cmd=\"echo hello\" --cmd-interval=5"     # 每5秒执行一次
+start /min cmd /k "g --cmd=\"echo at-time\" --at=23:59"         # 在23:59执行一次
+start /min cmd /k "g --cmd=\"echo daily\" --at=23:59 --daily"   # 每天23:59执行一次
 ```
 
-#### 不显示git diff内容
+#### 不显示 git diff 内容：
 ```shell
 $ g --no-diff
 ```
 
-#### 格式化打印git log
+#### 格式化打印 git log：
 ```shell
 $ g log
 $ g log --n=5
 ```
-#### 文件锁定功能(仅在工具中有效)
 
+#### 文件锁定功能（仅在工具中有效）：
 ```shell
 # 锁定文件（锁定后的文件不会被包含在提交中）
 $ g --lock-file=config.json

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zen-gitsync",
-  "version": "2.11.19",
-  "description": "一个 git 提交的工具",
+  "version": "2.11.21",
+  "description": "A Git automation platform with interactive commits, scheduled sync, command orchestration, file locking, and a visual GUI.",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/scripts/release.js

@@ -257,6 +257,26 @@ async function checkEnvironment() {
   }
 }
 
+// TSC 类型检查
+async function runTypeCheck() {
+  console.log(chalk.blue('\n=== TypeScript 类型检查 ==='));
+
+  const frontendDir = path.join(rootDir, 'src', 'ui', 'client');
+  if (!fs.existsSync(frontendDir)) {
+    console.log(chalk.yellow('前端项目目录不存在，跳过 TSC 检查'));
+    return;
+  }
+
+  try {
+    console.log(chalk.gray('执行 tsc --noEmit...'));
+    execSync('npx tsc --noEmit', { cwd: frontendDir, stdio: 'inherit' });
+    console.log(chalk.green('TSC 类型检查通过'));
+  } catch (error) {
+    console.error(chalk.red('TSC 类型检查失败，请修复以上错误后重新发布'));
+    process.exit(1);
+  }
+}
+
 // 更新版本号
 function updateVersion() {
   console.log(chalk.blue('=== 更新版本号 ==='));
@@ -535,17 +555,20 @@ async function main() {
   try {
     // 1. 检查环境
     await checkEnvironment();
-    
-    // 2. 更新版本号
+
+    // 2. TSC 类型检查
+    await runTypeCheck();
+
+    // 3. 更新版本号
     const newVersion = updateVersion();
-    
-    // 3. 构建前端项目
+
+    // 4. 构建前端项目
     await buildFrontend();
-    
-    // 4. 提交更改到Git
+
+    // 5. 提交更改到Git
     await commitChanges(newVersion);
-    
-    // 5. 发布到NPM
+
+    // 6. 发布到NPM
     await publishToNpm();
     
     console.log(chalk.green('\n🎉 发布完成！'));