zen-gitsync 2.0.5 → 2.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  # zen-gitsync
3
2
 
4
3
  `zen-gitsync` 是一个简单的命令行工具,用于自动化 Git 提交和推送操作。只需在控制台输入 `g`,并输入提交内容,即可自动执行 `git add`、`git commit` 和 `git push` 操作,极大提升 Git 工作流程的效率。
@@ -94,4 +93,34 @@ $ g log --n=5
94
93
  ### 启动图形界面:
95
94
  ```shell
96
95
  $ g ui
97
- ```
96
+ ```
97
+
98
+ # Zen GitSync 功能说明
99
+
100
+ ## 自动文件监控与状态更新
101
+
102
+ Zen GitSync现在支持自动文件监控和状态更新功能:
103
+
104
+ - 当Git仓库内的文件发生变动时,系统会自动检测并更新Git状态
105
+ - 采用防抖(debounce)技术,避免频繁变动导致的性能问题
106
+ - 用户可以通过界面上的开关随时启用或禁用自动更新功能
107
+ - 设置会自动保存,下次打开应用时仍然生效
108
+
109
+ ### 使用方法
110
+
111
+ 1. 在Git状态面板的顶部有一个开关按钮,用于切换自动更新状态
112
+ 2. 绿色表示自动更新已启用,灰色表示已禁用
113
+ 3. 即使禁用了自动更新,用户仍然可以通过刷新按钮手动更新状态
114
+
115
+ ### 技术说明
116
+
117
+ 该功能使用以下技术实现:
118
+ - 服务端使用chokidar监控文件系统变化
119
+ - 使用Socket.IO实现服务器与客户端的实时通信
120
+ - 采用1000ms防抖延迟,优化性能并避免重复更新
121
+
122
+ ### 注意事项
123
+
124
+ - 自动监控只会监控Git工作目录下的文件变动
125
+ - 监控器会自动过滤.git目录、node_modules目录和隐藏文件
126
+ - 在大型仓库中可能会增加服务器资源消耗
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zen-gitsync",
3
- "version": "2.0.5",
3
+ "version": "2.0.6",
4
4
  "description": "一个 git 自动查看差异并提交的工具",
5
5
  "main": "index.js",
6
6
  "type": "module",
@@ -52,6 +52,7 @@
52
52
  "dependencies": {
53
53
  "boxen": "^8.0.1",
54
54
  "chalk": "^5.4.1",
55
+ "chokidar": "^4.0.3",
55
56
  "cli-table3": "^0.6.5",
56
57
  "date-fns": "^4.1.0",
57
58
  "express": "^5.1.0",
@@ -59,6 +60,7 @@
59
60
  "open": "^10.1.2",
60
61
  "ora": "^8.1.1",
61
62
  "socket.io": "^4.8.1",
63
+ "socket.io-client": "^4.8.1",
62
64
  "string-width": "^7.2.0"
63
65
  }
64
66
  }