@zjex/git-workflow 0.2.24 → 0.3.0
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/.github/workflows/deploy-docs.yml +68 -0
- package/.github/workflows/test.yml +24 -4
- package/.husky/pre-commit +14 -0
- package/README.md +72 -1066
- package/dist/index.js +103 -13
- package/docs/.vitepress/cache/deps/_metadata.json +52 -0
- package/docs/.vitepress/cache/deps/chunk-2CLQ7TTZ.js +9719 -0
- package/docs/.vitepress/cache/deps/chunk-2CLQ7TTZ.js.map +7 -0
- package/docs/.vitepress/cache/deps/chunk-LE5NDSFD.js +12824 -0
- package/docs/.vitepress/cache/deps/chunk-LE5NDSFD.js.map +7 -0
- package/docs/.vitepress/cache/deps/package.json +3 -0
- package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4505 -0
- package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +583 -0
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js +1352 -0
- package/docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js.map +7 -0
- package/docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js +1665 -0
- package/docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js.map +7 -0
- package/docs/.vitepress/cache/deps/vitepress___minisearch.js +1813 -0
- package/docs/.vitepress/cache/deps/vitepress___minisearch.js.map +7 -0
- package/docs/.vitepress/cache/deps/vue.js +347 -0
- package/docs/.vitepress/cache/deps/vue.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/chunk-2CLQ7TTZ.js +9719 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/chunk-2CLQ7TTZ.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/chunk-LE5NDSFD.js +12824 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/chunk-LE5NDSFD.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/package.json +3 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vue_devtools-api.js +4505 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vue_devtools-api.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vueuse_core.js +583 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vueuse_core.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vueuse_integrations_useFocusTrap.js +1352 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___@vueuse_integrations_useFocusTrap.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___mark__js_src_vanilla__js.js +1665 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___mark__js_src_vanilla__js.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___minisearch.js +1813 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vitepress___minisearch.js.map +7 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vue.js +347 -0
- package/docs/.vitepress/cache/deps_temp_44e2fb0f/vue.js.map +7 -0
- package/docs/.vitepress/config.ts +167 -0
- package/docs/.vitepress/theme/custom.css +39 -0
- package/docs/.vitepress/theme/index.ts +4 -0
- package/docs/README.md +82 -0
- package/docs/commands/branch.md +468 -0
- package/docs/commands/commit.md +554 -0
- package/docs/commands/config.md +346 -0
- package/docs/commands/index.md +312 -0
- package/docs/commands/interactive.md +384 -0
- package/docs/commands/release.md +300 -0
- package/docs/commands/stash.md +309 -0
- package/docs/commands/tag.md +278 -0
- package/docs/commands/update.md +347 -0
- package/docs/config/ai-config.md +160 -0
- package/docs/config/branch-config.md +133 -0
- package/docs/config/commit-config.md +185 -0
- package/docs/config/config-file.md +776 -0
- package/docs/config/examples.md +279 -0
- package/docs/config/index.md +478 -0
- package/docs/guide/ai-commit.md +576 -0
- package/docs/guide/basic-usage.md +522 -0
- package/docs/guide/best-practices.md +426 -0
- package/docs/guide/branch-management.md +712 -0
- package/docs/guide/getting-started.md +294 -0
- package/docs/guide/index.md +168 -0
- package/docs/guide/installation.md +449 -0
- package/docs/guide/release-management.md +744 -0
- package/docs/guide/stash-management.md +608 -0
- package/docs/guide/tag-management.md +614 -0
- package/docs/index.md +205 -0
- package/docs/public/favicon.svg +21 -0
- package/docs/public/hero-logo.svg +43 -0
- package/docs/public/logo.svg +20 -0
- package/package.json +11 -2
- package/scripts/publish.js +55 -8
- package/scripts/publish.sh +20 -2
- package/scripts/release.sh +20 -2
- package/scripts/update-test-count.js +55 -0
- package/src/ai-service.ts +101 -15
- package/src/commands/init.ts +18 -0
- package/src/config.ts +1 -0
- package/tests/ai-service.test.ts +237 -2
- package/tests/help.test.ts +134 -0
- package/tests/init.test.ts +582 -0
- package/tests/release.test.ts +333 -0
- package/tests/setup.ts +21 -0
- package/tests/stash.test.ts +376 -0
- package/tests/update.test.ts +402 -0
- package/vitest.config.ts +3 -0
- package/zjex-logo.svg +22 -0
- package/zjex-optimized.svg +34 -0
- package/zjex.svg +1 -0
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# 提交配置
|
|
2
|
+
|
|
3
|
+
commit 相关的配置选项。
|
|
4
|
+
|
|
5
|
+
## 📝 自动暂存
|
|
6
|
+
|
|
7
|
+
控制提交时是否自动暂存所有更改。
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"autoStage": true
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**行为对比：**
|
|
16
|
+
|
|
17
|
+
`autoStage: true`（默认）：
|
|
18
|
+
```bash
|
|
19
|
+
gw c
|
|
20
|
+
# 自动暂存所有更改，直接进入提交流程
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
`autoStage: false`：
|
|
24
|
+
```bash
|
|
25
|
+
gw c
|
|
26
|
+
# 显示文件选择界面，手动选择要暂存的文件
|
|
27
|
+
? 选择要暂存的文件:
|
|
28
|
+
◉ M src/index.ts
|
|
29
|
+
◉ M src/utils.ts
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 😀 Emoji 配置
|
|
33
|
+
|
|
34
|
+
控制是否在 commit message 中使用 emoji。
|
|
35
|
+
|
|
36
|
+
```json
|
|
37
|
+
{
|
|
38
|
+
"useEmoji": true
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**效果对比：**
|
|
43
|
+
|
|
44
|
+
启用 emoji：
|
|
45
|
+
```
|
|
46
|
+
✨ feat(auth): 添加用户登录功能
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
禁用 emoji：
|
|
50
|
+
```
|
|
51
|
+
feat(auth): 添加用户登录功能
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 🎨 自定义 Emoji
|
|
55
|
+
|
|
56
|
+
自定义各类型 commit 的 emoji。
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"commitEmojis": {
|
|
61
|
+
"feat": "🎉",
|
|
62
|
+
"fix": "🔧",
|
|
63
|
+
"docs": "📚",
|
|
64
|
+
"style": "🎨",
|
|
65
|
+
"refactor": "🔨",
|
|
66
|
+
"perf": "🚀",
|
|
67
|
+
"test": "🧪",
|
|
68
|
+
"build": "📦",
|
|
69
|
+
"ci": "👷",
|
|
70
|
+
"chore": "🔧",
|
|
71
|
+
"revert": "⏪"
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## 🤖 AI Commit 配置
|
|
77
|
+
|
|
78
|
+
详细的 AI commit 配置请参考 [AI 配置](./ai-config.md)。
|
|
79
|
+
|
|
80
|
+
基础配置：
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"aiCommit": {
|
|
85
|
+
"enabled": true,
|
|
86
|
+
"provider": "github",
|
|
87
|
+
"language": "zh-CN",
|
|
88
|
+
"detailedDescription": true
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## 📋 使用场景
|
|
94
|
+
|
|
95
|
+
### 严格的 CI/CD 环境
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"useEmoji": false,
|
|
100
|
+
"autoStage": false,
|
|
101
|
+
"aiCommit": {
|
|
102
|
+
"enabled": true,
|
|
103
|
+
"detailedDescription": true
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 个人项目
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"useEmoji": true,
|
|
113
|
+
"autoStage": true,
|
|
114
|
+
"aiCommit": {
|
|
115
|
+
"enabled": true,
|
|
116
|
+
"provider": "github",
|
|
117
|
+
"language": "zh-CN"
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### 团队协作
|
|
123
|
+
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"useEmoji": true,
|
|
127
|
+
"autoStage": true,
|
|
128
|
+
"aiCommit": {
|
|
129
|
+
"enabled": true,
|
|
130
|
+
"provider": "github",
|
|
131
|
+
"detailedDescription": true,
|
|
132
|
+
"language": "zh-CN"
|
|
133
|
+
},
|
|
134
|
+
"commitEmojis": {
|
|
135
|
+
"feat": "✨",
|
|
136
|
+
"fix": "🐛"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## 🔧 最佳实践
|
|
142
|
+
|
|
143
|
+
### Commit Message 规范
|
|
144
|
+
|
|
145
|
+
遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/) 规范：
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
<type>(<scope>): <subject>
|
|
149
|
+
|
|
150
|
+
<body>
|
|
151
|
+
|
|
152
|
+
<footer>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### 类型说明
|
|
156
|
+
|
|
157
|
+
| 类型 | 说明 | 示例 |
|
|
158
|
+
|------|------|------|
|
|
159
|
+
| `feat` | 新功能 | `feat(auth): 添加用户登录` |
|
|
160
|
+
| `fix` | Bug 修复 | `fix(api): 修复数据获取失败` |
|
|
161
|
+
| `docs` | 文档更新 | `docs(readme): 更新安装说明` |
|
|
162
|
+
| `style` | 代码格式 | `style: 修复代码缩进` |
|
|
163
|
+
| `refactor` | 重构 | `refactor(utils): 优化工具函数` |
|
|
164
|
+
| `perf` | 性能优化 | `perf(query): 优化数据库查询` |
|
|
165
|
+
| `test` | 测试相关 | `test(auth): 添加登录测试` |
|
|
166
|
+
| `build` | 构建相关 | `build: 更新依赖版本` |
|
|
167
|
+
| `ci` | CI/CD | `ci: 添加自动部署` |
|
|
168
|
+
| `chore` | 其他杂项 | `chore: 更新配置文件` |
|
|
169
|
+
| `revert` | 回退提交 | `revert: 回退登录功能` |
|
|
170
|
+
|
|
171
|
+
### Scope 建议
|
|
172
|
+
|
|
173
|
+
- 使用模块名：`auth`, `api`, `ui`, `utils`
|
|
174
|
+
- 使用功能名：`login`, `payment`, `search`
|
|
175
|
+
- 保持简洁：避免过长的 scope
|
|
176
|
+
|
|
177
|
+
### 破坏性变更
|
|
178
|
+
|
|
179
|
+
对于包含破坏性变更的提交，添加 `BREAKING CHANGE` 标记：
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
feat(api): 重构用户 API
|
|
183
|
+
|
|
184
|
+
BREAKING CHANGE: 用户 API 响应格式已更改
|
|
185
|
+
```
|