zco-claude 0.0.8__py3-none-any.whl
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.
- ClaudeSettings/DOT.claudeignore +7 -0
- ClaudeSettings/README.md +100 -0
- ClaudeSettings/commands/generate_changelog.sh +49 -0
- ClaudeSettings/commands/show_env +92 -0
- ClaudeSettings/commands/zco-clean +164 -0
- ClaudeSettings/commands/zco-git-summary +15 -0
- ClaudeSettings/commands/zco-git-tag +42 -0
- ClaudeSettings/hooks/CHANGELOG.md +157 -0
- ClaudeSettings/hooks/README.md +254 -0
- ClaudeSettings/hooks/save_chat_plain.py +148 -0
- ClaudeSettings/hooks/save_chat_spec.py +398 -0
- ClaudeSettings/rules/README.md +270 -0
- ClaudeSettings/rules/go/.golangci.yml.template +170 -0
- ClaudeSettings/rules/go/GoBuildAutoVersion.v250425.md +95 -0
- ClaudeSettings/rules/go/check-standards.sh +128 -0
- ClaudeSettings/rules/go/coding-standards.md +973 -0
- ClaudeSettings/rules/go/example.go +207 -0
- ClaudeSettings/rules/go/go-testing.md +691 -0
- ClaudeSettings/rules/go/list-comments.sh +85 -0
- ClaudeSettings/settings.sample.json +71 -0
- ClaudeSettings/skills/README.md +225 -0
- ClaudeSettings/skills/zco-docs-update/SKILL.md +381 -0
- ClaudeSettings/skills/zco-help/SKILL.md +601 -0
- ClaudeSettings/skills/zco-plan/SKILL.md +661 -0
- ClaudeSettings/skills/zco-plan-new/SKILL.md +585 -0
- ClaudeSettings/zco-scripts/co-docs-update.sh +150 -0
- ClaudeSettings/zco-scripts/test_update_plan_metadata.py +328 -0
- ClaudeSettings/zco-scripts/update-plan-metadata.py +324 -0
- zco_claude-0.0.8.dist-info/METADATA +190 -0
- zco_claude-0.0.8.dist-info/RECORD +34 -0
- zco_claude-0.0.8.dist-info/WHEEL +5 -0
- zco_claude-0.0.8.dist-info/entry_points.txt +3 -0
- zco_claude-0.0.8.dist-info/top_level.txt +1 -0
- zco_claude_init.py +1732 -0
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
|
|
3
|
+
# 列出所有非代码注释的脚本
|
|
4
|
+
|
|
5
|
+
# 颜色定义
|
|
6
|
+
CYAN='\033[0;36m'
|
|
7
|
+
YELLOW='\033[1;33m'
|
|
8
|
+
RED='\033[0;31m'
|
|
9
|
+
GREEN='\033[0;32m'
|
|
10
|
+
NC='\033[0m'
|
|
11
|
+
|
|
12
|
+
echo "💬 Go 项目非代码注释列表"
|
|
13
|
+
echo "======================================"
|
|
14
|
+
echo ""
|
|
15
|
+
|
|
16
|
+
# 检查是否在 Go 项目中
|
|
17
|
+
if ! ls *.go > /dev/null 2>&1 && ! find . -name "*.go" -type f | grep -q .; then
|
|
18
|
+
echo -e "${RED}错误: 当前目录不是 Go 项目${NC}"
|
|
19
|
+
exit 1
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
# 1. TODO 列表
|
|
23
|
+
echo -e "${CYAN}📋 TODO 列表:${NC}"
|
|
24
|
+
if grep -rn "//;@TODO:" . --include="*.go" --color=always 2>/dev/null; then
|
|
25
|
+
echo ""
|
|
26
|
+
else
|
|
27
|
+
echo " (无)"
|
|
28
|
+
echo ""
|
|
29
|
+
fi
|
|
30
|
+
|
|
31
|
+
# 2. FIXME 列表
|
|
32
|
+
echo -e "${RED}🔧 FIXME 列表:${NC}"
|
|
33
|
+
if grep -rn "//;@FIXME:" . --include="*.go" --color=always 2>/dev/null; then
|
|
34
|
+
echo ""
|
|
35
|
+
else
|
|
36
|
+
echo " (无)"
|
|
37
|
+
echo ""
|
|
38
|
+
fi
|
|
39
|
+
|
|
40
|
+
# 3. HACK 列表
|
|
41
|
+
echo -e "${YELLOW}⚠️ HACK 列表:${NC}"
|
|
42
|
+
if grep -rn "//;@HACK:" . --include="*.go" --color=always 2>/dev/null; then
|
|
43
|
+
echo ""
|
|
44
|
+
else
|
|
45
|
+
echo " (无)"
|
|
46
|
+
echo ""
|
|
47
|
+
fi
|
|
48
|
+
|
|
49
|
+
# 4. OPTIMIZE 列表
|
|
50
|
+
echo -e "${GREEN}⚡ OPTIMIZE 列表:${NC}"
|
|
51
|
+
if grep -rn "//;@OPTIMIZE:" . --include="*.go" --color=always 2>/dev/null; then
|
|
52
|
+
echo ""
|
|
53
|
+
else
|
|
54
|
+
echo " (无)"
|
|
55
|
+
echo ""
|
|
56
|
+
fi
|
|
57
|
+
|
|
58
|
+
# 5. DEPRECATED 列表
|
|
59
|
+
echo -e "${RED}🗑️ DEPRECATED 列表:${NC}"
|
|
60
|
+
if grep -rn "//;@DEPRECATED:" . --include="*.go" --color=always 2>/dev/null; then
|
|
61
|
+
echo ""
|
|
62
|
+
else
|
|
63
|
+
echo " (无)"
|
|
64
|
+
echo ""
|
|
65
|
+
fi
|
|
66
|
+
|
|
67
|
+
# 6. NOTE 列表
|
|
68
|
+
echo -e "${CYAN}📝 NOTE 列表:${NC}"
|
|
69
|
+
if grep -rn "//;@NOTE:" . --include="*.go" --color=always 2>/dev/null; then
|
|
70
|
+
echo ""
|
|
71
|
+
else
|
|
72
|
+
echo " (无)"
|
|
73
|
+
echo ""
|
|
74
|
+
fi
|
|
75
|
+
|
|
76
|
+
# 7. 统计
|
|
77
|
+
echo "======================================"
|
|
78
|
+
echo -e "${CYAN}📊 统计信息:${NC}, comment with //@NOTE:"
|
|
79
|
+
echo " TODO: $(grep -r "TODO:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
80
|
+
echo " FIXME: $(grep -r "FIXME:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
81
|
+
echo " HACK: $(grep -r "HACK:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
82
|
+
echo " OPTIMIZE: $(grep -r "OPTIMIZE:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
83
|
+
echo " DEPRECATED: $(grep -r "DEPRECATED:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
84
|
+
echo " NOTE: $(grep -r "NOTE:" . --include="*.go" 2>/dev/null | wc -l) 项"
|
|
85
|
+
echo ""
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
{
|
|
2
|
+
"env": {
|
|
3
|
+
"ZCO_TPL_VERSION": "v2",
|
|
4
|
+
"YJ_CLAUDE_CHAT_SAVE_SPEC": "1",
|
|
5
|
+
"YJ_CLAUDE_CHAT_SAVE_PLAIN": "1",
|
|
6
|
+
"CLAUDE_CODE_MAX_OUTPUT_TOKENS": "6000"
|
|
7
|
+
},
|
|
8
|
+
"permissions": {
|
|
9
|
+
"allow": [
|
|
10
|
+
"Bash(chmod:*)",
|
|
11
|
+
"Bash(python3:*)",
|
|
12
|
+
"Bash(echo:*)",
|
|
13
|
+
"Bash(go build:*)",
|
|
14
|
+
"Bash(ls:*)",
|
|
15
|
+
"Bash(tree:*)",
|
|
16
|
+
"Bash(git add:*)",
|
|
17
|
+
"Bash(git check-ignore:*)",
|
|
18
|
+
"Bash(cat:*)",
|
|
19
|
+
"Bash(zsh:*)",
|
|
20
|
+
"Bash(test:*)",
|
|
21
|
+
"Skill(zco-plan)",
|
|
22
|
+
"Bash(git commit:*)",
|
|
23
|
+
"Bash(./.claude/commands/show_env:*)",
|
|
24
|
+
"Skill(zco-plan-new)"
|
|
25
|
+
],
|
|
26
|
+
"deny": [
|
|
27
|
+
"Read(~/.ssh/**)",
|
|
28
|
+
"Read(~/.aws/**)",
|
|
29
|
+
"Read(**/Library/Application Support/Google/Chrome/**)",
|
|
30
|
+
"Read(./.DS_Store)",
|
|
31
|
+
"Read(**/.DS_Store)",
|
|
32
|
+
"Read(**/__pycache__)",
|
|
33
|
+
"Read(**/__pycache__/**)",
|
|
34
|
+
"Read(*._.*)",
|
|
35
|
+
"Read(*.bak.*)",
|
|
36
|
+
"Read(*.tmp.*)",
|
|
37
|
+
"Read(_.*/**)",
|
|
38
|
+
"Read(*._/**)"
|
|
39
|
+
],
|
|
40
|
+
"ask": [
|
|
41
|
+
"Read(**/.git/**)",
|
|
42
|
+
"Read(**/app.local.conf)",
|
|
43
|
+
"Read(**/*.local.conf)",
|
|
44
|
+
"Read(**/config.local.yaml)",
|
|
45
|
+
"Read(**/.env*)",
|
|
46
|
+
"Write(**/*.conf)",
|
|
47
|
+
"Write(**/*.yaml)",
|
|
48
|
+
"Read(**/.zshrc)",
|
|
49
|
+
"Read(**/.bashrc)",
|
|
50
|
+
"Read(**/.bash_profile)",
|
|
51
|
+
"Read(**/*.secret.*)",
|
|
52
|
+
"Write(**/docs/manual/**)"
|
|
53
|
+
]
|
|
54
|
+
},
|
|
55
|
+
"hooks": {
|
|
56
|
+
"Stop": [
|
|
57
|
+
{
|
|
58
|
+
"hooks": [
|
|
59
|
+
{
|
|
60
|
+
"type": "command",
|
|
61
|
+
"command": "python3 \"$CLAUDE_PROJECT_DIR\"/.claude/hooks/save_chat_plain.py"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"type": "command",
|
|
65
|
+
"command": "python3 \"$CLAUDE_PROJECT_DIR\"/.claude/hooks/save_chat_spec.py"
|
|
66
|
+
}
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Custom Skills 目录
|
|
2
|
+
|
|
3
|
+
## 命名规范
|
|
4
|
+
|
|
5
|
+
**所有自定义 skills 必须使用 `zco-` 前缀**(Zhicheng Custom Operations)
|
|
6
|
+
|
|
7
|
+
### 示例
|
|
8
|
+
|
|
9
|
+
✅ **正确命名**:
|
|
10
|
+
- `zco-docs-update/` - 更新文档元信息
|
|
11
|
+
- `zco-plan/` - 执行开发计划
|
|
12
|
+
- `zco-deploy/` - 部署脚本(如果创建)
|
|
13
|
+
- `zco-backup/` - 备份工具(如果创建)
|
|
14
|
+
|
|
15
|
+
❌ **错误命名**:
|
|
16
|
+
- `docs-update/` - 缺少前缀
|
|
17
|
+
- `my-skill/` - 不符合规范
|
|
18
|
+
- `common/` - 不是有效 skill
|
|
19
|
+
- `utils/` - 不符合规范
|
|
20
|
+
|
|
21
|
+
## Skill 结构
|
|
22
|
+
|
|
23
|
+
每个 skill 必须遵循以下结构:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
.claude/skills/
|
|
27
|
+
└── zco-{skill-name}/
|
|
28
|
+
└── SKILL.md # 必需:Skill 定义文件
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### SKILL.md 格式
|
|
32
|
+
|
|
33
|
+
```markdown
|
|
34
|
+
---
|
|
35
|
+
name: zco-{skill-name}
|
|
36
|
+
description: Skill 的简短描述
|
|
37
|
+
allowed-tools: Bash, Read, Glob, Write, Edit
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
# Skill 标题
|
|
41
|
+
|
|
42
|
+
## 🎯 Skill 用途
|
|
43
|
+
简要说明这个 skill 的用途
|
|
44
|
+
|
|
45
|
+
## 📋 何时使用此 Skill
|
|
46
|
+
列出使用场景
|
|
47
|
+
|
|
48
|
+
## 🚀 使用步骤
|
|
49
|
+
详细的执行步骤
|
|
50
|
+
|
|
51
|
+
## 📝 示例
|
|
52
|
+
使用示例
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 当前可用 Skills
|
|
56
|
+
|
|
57
|
+
| Skill | 描述 | 版本 |
|
|
58
|
+
|-------|------|------|
|
|
59
|
+
| [zco-docs-update](zco-docs-update/SKILL.md) | 更新 CLAUDE.md 的 Git 元信息 | 1.0.0 |
|
|
60
|
+
| [zco-plan](zco-plan/SKILL.md) | 读取并执行 docs/plans/ 下的开发计划 | 1.0.0 |
|
|
61
|
+
|
|
62
|
+
## 创建新 Skill
|
|
63
|
+
|
|
64
|
+
### 步骤 1:创建目录结构
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# 使用 zco- 前缀
|
|
68
|
+
mkdir -p .claude/skills/zco-{your-skill-name}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 步骤 2:创建 SKILL.md
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# 复制模板(可选)
|
|
75
|
+
cp .claude/skills/zco-plan/SKILL.md .claude/skills/zco-{your-skill-name}/SKILL.md
|
|
76
|
+
|
|
77
|
+
# 编辑文件
|
|
78
|
+
vim .claude/skills/zco-{your-skill-name}/SKILL.md
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 步骤 3:定义 YAML Front Matter
|
|
82
|
+
|
|
83
|
+
必需字段:
|
|
84
|
+
- `name` - Skill 名称(必须以 `zco-` 开头)
|
|
85
|
+
- `description` - 简短描述
|
|
86
|
+
- `allowed-tools` - 允许使用的工具列表
|
|
87
|
+
|
|
88
|
+
可选字段:
|
|
89
|
+
- `version` - 版本号
|
|
90
|
+
- `author` - 作者
|
|
91
|
+
- `tags` - 标签
|
|
92
|
+
|
|
93
|
+
### 步骤 4:编写 Skill 内容
|
|
94
|
+
|
|
95
|
+
参考现有 skills 的格式:
|
|
96
|
+
- 使用清晰的标题层次
|
|
97
|
+
- 包含使用示例
|
|
98
|
+
- 说明错误处理
|
|
99
|
+
- 提供故障排查指南
|
|
100
|
+
|
|
101
|
+
### 步骤 5:测试 Skill
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# 在 Claude CLI 中测试
|
|
105
|
+
zco-{your-skill-name}
|
|
106
|
+
|
|
107
|
+
# 或在对话中测试
|
|
108
|
+
"运行 zco-{your-skill-name}"
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## 最佳实践
|
|
112
|
+
|
|
113
|
+
### 命名
|
|
114
|
+
|
|
115
|
+
1. **使用清晰的名称**:`zco-plan` 优于 `zco-p`
|
|
116
|
+
2. **使用连字符**:`zco-docs-update` 优于 `zco_docs_update`
|
|
117
|
+
3. **避免缩写**:除非是众所周知的缩写
|
|
118
|
+
4. **保持简洁**:2-3 个单词最佳
|
|
119
|
+
|
|
120
|
+
### 功能设计
|
|
121
|
+
|
|
122
|
+
1. **单一职责**:每个 skill 只做一件事
|
|
123
|
+
2. **幂等性**:多次运行产生相同结果
|
|
124
|
+
3. **错误处理**:提供清晰的错误信息
|
|
125
|
+
4. **文档完整**:包含使用示例和故障排查
|
|
126
|
+
|
|
127
|
+
### 工具权限
|
|
128
|
+
|
|
129
|
+
只请求必需的工具:
|
|
130
|
+
- **只读操作**:`Bash, Read, Glob`
|
|
131
|
+
- **文件编辑**:添加 `Edit, Write`
|
|
132
|
+
- **网络访问**:添加 `WebFetch`(谨慎使用)
|
|
133
|
+
|
|
134
|
+
### 示例
|
|
135
|
+
|
|
136
|
+
```yaml
|
|
137
|
+
---
|
|
138
|
+
name: zco-backup
|
|
139
|
+
description: 备份指定目录到时间戳命名的归档
|
|
140
|
+
allowed-tools: Bash, Read, Glob
|
|
141
|
+
---
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## 共享和分发
|
|
145
|
+
|
|
146
|
+
### 项目内共享
|
|
147
|
+
|
|
148
|
+
Skills 通过软链接自动共享到所有链接的项目:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
# 链接配置到其他项目
|
|
152
|
+
./link-to-project.py /path/to/other/project
|
|
153
|
+
|
|
154
|
+
# Skills 自动可用
|
|
155
|
+
cd /path/to/other/project
|
|
156
|
+
zco-plan 001 # 可以直接使用
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### 团队协作
|
|
160
|
+
|
|
161
|
+
1. **提交到 Git**:
|
|
162
|
+
```bash
|
|
163
|
+
git add .claude/skills/zco-{skill-name}/
|
|
164
|
+
git commit -m "feat: add zco-{skill-name} skill"
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
2. **Code Review**:确保 skill 符合规范
|
|
168
|
+
|
|
169
|
+
3. **更新文档**:在 CLAUDE.md 中添加 skill 说明
|
|
170
|
+
|
|
171
|
+
## 维护
|
|
172
|
+
|
|
173
|
+
### 更新现有 Skill
|
|
174
|
+
|
|
175
|
+
1. 修改 `SKILL.md` 文件
|
|
176
|
+
2. 更新版本号(如果有)
|
|
177
|
+
3. 测试功能
|
|
178
|
+
4. 提交更改
|
|
179
|
+
|
|
180
|
+
### 废弃 Skill
|
|
181
|
+
|
|
182
|
+
如果 skill 不再需要:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
# 1. 添加废弃标记
|
|
186
|
+
# 在 SKILL.md 开头添加:
|
|
187
|
+
# ⚠️ **DEPRECATED**: 此 skill 已废弃,请使用 zco-new-skill 替代
|
|
188
|
+
|
|
189
|
+
# 2. 几个版本后删除
|
|
190
|
+
rm -rf .claude/skills/zco-old-skill/
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## 故障排查
|
|
194
|
+
|
|
195
|
+
### Skill 无法识别
|
|
196
|
+
|
|
197
|
+
**问题**:Claude 无法识别 skill
|
|
198
|
+
|
|
199
|
+
**检查项**:
|
|
200
|
+
1. ✅ 目录名称以 `zco-` 开头
|
|
201
|
+
2. ✅ 存在 `SKILL.md` 文件(大写)
|
|
202
|
+
3. ✅ YAML front matter 格式正确
|
|
203
|
+
4. ✅ `name` 字段与目录名匹配
|
|
204
|
+
|
|
205
|
+
### Skill 执行失败
|
|
206
|
+
|
|
207
|
+
**问题**:Skill 执行过程中报错
|
|
208
|
+
|
|
209
|
+
**检查项**:
|
|
210
|
+
1. ✅ `allowed-tools` 包含所需工具
|
|
211
|
+
2. ✅ 权限配置允许操作
|
|
212
|
+
3. ✅ 文件路径正确
|
|
213
|
+
4. ✅ 依赖项已安装
|
|
214
|
+
|
|
215
|
+
## 参考资源
|
|
216
|
+
|
|
217
|
+
- **项目文档**:[CLAUDE.md](../../CLAUDE.md)
|
|
218
|
+
- **示例 Skill**:[zco-plan](zco-plan/SKILL.md)
|
|
219
|
+
- **计划管理**:[docs/plans/README.md](../../docs/plans/README.md)
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
**文档版本**: 1.0.0
|
|
224
|
+
**最后更新**: 2026-01-08
|
|
225
|
+
**维护者**: 开发团队
|