ccjk 1.3.1
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/LICENSE +21 -0
- package/README.ja.md +455 -0
- package/README.ko.md +455 -0
- package/README.md +550 -0
- package/README.zh-CN.md +488 -0
- package/bin/ccjk.mjs +2 -0
- package/dist/chunks/api-providers.mjs +89 -0
- package/dist/chunks/claude-code-config-manager.mjs +733 -0
- package/dist/chunks/claude-code-incremental-manager.mjs +603 -0
- package/dist/chunks/codex-config-switch.mjs +427 -0
- package/dist/chunks/codex-provider-manager.mjs +232 -0
- package/dist/chunks/codex-uninstaller.mjs +404 -0
- package/dist/chunks/commands.mjs +120 -0
- package/dist/chunks/features.mjs +642 -0
- package/dist/chunks/simple-config.mjs +10445 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.mjs +5972 -0
- package/dist/i18n/locales/en/api.json +63 -0
- package/dist/i18n/locales/en/ccjk.json +276 -0
- package/dist/i18n/locales/en/ccr.json +65 -0
- package/dist/i18n/locales/en/cli.json +57 -0
- package/dist/i18n/locales/en/codex.json +124 -0
- package/dist/i18n/locales/en/cometix.json +29 -0
- package/dist/i18n/locales/en/common.json +20 -0
- package/dist/i18n/locales/en/configuration.json +77 -0
- package/dist/i18n/locales/en/errors.json +26 -0
- package/dist/i18n/locales/en/installation.json +80 -0
- package/dist/i18n/locales/en/interview.json +104 -0
- package/dist/i18n/locales/en/language.json +19 -0
- package/dist/i18n/locales/en/mcp.json +38 -0
- package/dist/i18n/locales/en/menu.json +51 -0
- package/dist/i18n/locales/en/multi-config.json +79 -0
- package/dist/i18n/locales/en/shencha.json +14 -0
- package/dist/i18n/locales/en/team.json +7 -0
- package/dist/i18n/locales/en/tools.json +42 -0
- package/dist/i18n/locales/en/uninstall.json +56 -0
- package/dist/i18n/locales/en/updater.json +25 -0
- package/dist/i18n/locales/en/workflow.json +25 -0
- package/dist/i18n/locales/zh-CN/api.json +63 -0
- package/dist/i18n/locales/zh-CN/ccjk.json +276 -0
- package/dist/i18n/locales/zh-CN/ccr.json +65 -0
- package/dist/i18n/locales/zh-CN/cli.json +57 -0
- package/dist/i18n/locales/zh-CN/codex.json +124 -0
- package/dist/i18n/locales/zh-CN/cometix.json +29 -0
- package/dist/i18n/locales/zh-CN/common.json +20 -0
- package/dist/i18n/locales/zh-CN/configuration.json +77 -0
- package/dist/i18n/locales/zh-CN/errors.json +26 -0
- package/dist/i18n/locales/zh-CN/installation.json +80 -0
- package/dist/i18n/locales/zh-CN/interview.json +104 -0
- package/dist/i18n/locales/zh-CN/language.json +19 -0
- package/dist/i18n/locales/zh-CN/mcp.json +38 -0
- package/dist/i18n/locales/zh-CN/menu.json +51 -0
- package/dist/i18n/locales/zh-CN/multi-config.json +79 -0
- package/dist/i18n/locales/zh-CN/shencha.json +14 -0
- package/dist/i18n/locales/zh-CN/team.json +7 -0
- package/dist/i18n/locales/zh-CN/tools.json +42 -0
- package/dist/i18n/locales/zh-CN/uninstall.json +56 -0
- package/dist/i18n/locales/zh-CN/updater.json +25 -0
- package/dist/i18n/locales/zh-CN/workflow.json +25 -0
- package/dist/index.d.mts +2644 -0
- package/dist/index.d.ts +2644 -0
- package/dist/index.mjs +1706 -0
- package/package.json +157 -0
- package/templates/CLAUDE.md +219 -0
- package/templates/claude-code/CLAUDE.md +250 -0
- package/templates/claude-code/common/settings.json +38 -0
- package/templates/claude-code/en/workflow/bmad/commands/bmad-init.md +165 -0
- package/templates/claude-code/en/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/claude-code/en/workflow/common/agents/init-architect.md +114 -0
- package/templates/claude-code/en/workflow/common/commands/init-project.md +53 -0
- package/templates/claude-code/en/workflow/plan/agents/planner.md +116 -0
- package/templates/claude-code/en/workflow/plan/agents/ui-ux-designer.md +91 -0
- package/templates/claude-code/en/workflow/plan/commands/feat.md +105 -0
- package/templates/claude-code/zh-CN/workflow/bmad/commands/bmad-init.md +172 -0
- package/templates/claude-code/zh-CN/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/claude-code/zh-CN/workflow/common/agents/init-architect.md +114 -0
- package/templates/claude-code/zh-CN/workflow/common/commands/init-project.md +53 -0
- package/templates/claude-code/zh-CN/workflow/plan/agents/planner.md +116 -0
- package/templates/claude-code/zh-CN/workflow/plan/agents/ui-ux-designer.md +91 -0
- package/templates/claude-code/zh-CN/workflow/plan/commands/feat.md +105 -0
- package/templates/codex/common/config.toml +0 -0
- package/templates/common/output-styles/en/casual-friendly.md +97 -0
- package/templates/common/output-styles/en/engineer-professional.md +88 -0
- package/templates/common/output-styles/en/expert-concise.md +93 -0
- package/templates/common/output-styles/en/laowang-engineer.md +127 -0
- package/templates/common/output-styles/en/nekomata-engineer.md +120 -0
- package/templates/common/output-styles/en/ojousama-engineer.md +121 -0
- package/templates/common/output-styles/en/teaching-mode.md +102 -0
- package/templates/common/output-styles/en/technical-precise.md +101 -0
- package/templates/common/output-styles/zh-CN/engineer-professional.md +89 -0
- package/templates/common/output-styles/zh-CN/laowang-engineer.md +127 -0
- package/templates/common/output-styles/zh-CN/nekomata-engineer.md +120 -0
- package/templates/common/output-styles/zh-CN/ojousama-engineer.md +121 -0
- package/templates/common/workflow/git/en/git-cleanBranches.md +102 -0
- package/templates/common/workflow/git/en/git-commit.md +205 -0
- package/templates/common/workflow/git/en/git-rollback.md +90 -0
- package/templates/common/workflow/git/en/git-worktree.md +276 -0
- package/templates/common/workflow/git/zh-CN/git-cleanBranches.md +102 -0
- package/templates/common/workflow/git/zh-CN/git-commit.md +205 -0
- package/templates/common/workflow/git/zh-CN/git-rollback.md +90 -0
- package/templates/common/workflow/git/zh-CN/git-worktree.md +276 -0
- package/templates/common/workflow/interview/en/interview.md +212 -0
- package/templates/common/workflow/interview/zh-CN/interview.md +212 -0
- package/templates/common/workflow/sixStep/en/workflow.md +251 -0
- package/templates/common/workflow/sixStep/zh-CN/workflow.md +215 -0
- package/templates/industry/devops/en/ci-cd-pipeline.md +410 -0
- package/templates/industry/web-dev/en/api-design.md +299 -0
- package/templates/industry/web-dev/en/react-nextjs-setup.md +236 -0
package/package.json
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ccjk",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "1.3.1",
|
|
5
|
+
"packageManager": "pnpm@10.17.1",
|
|
6
|
+
"description": "Claude Code JinKu - Advanced AI-powered development assistant with skills, agents, and LLM-driven audit",
|
|
7
|
+
"author": {
|
|
8
|
+
"name": "CCJK Team"
|
|
9
|
+
},
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"homepage": "https://github.com/miounet11/ccjk",
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "git+https://github.com/miounet11/ccjk.git"
|
|
15
|
+
},
|
|
16
|
+
"bugs": "https://github.com/miounet11/ccjk/issues",
|
|
17
|
+
"keywords": [
|
|
18
|
+
"claude",
|
|
19
|
+
"claude-code",
|
|
20
|
+
"codex",
|
|
21
|
+
"ccjk",
|
|
22
|
+
"jinku",
|
|
23
|
+
"ai-assistant",
|
|
24
|
+
"ai-coding",
|
|
25
|
+
"code-assistant",
|
|
26
|
+
"developer-tools",
|
|
27
|
+
"devtools",
|
|
28
|
+
"cli",
|
|
29
|
+
"automation",
|
|
30
|
+
"mcp",
|
|
31
|
+
"anthropic",
|
|
32
|
+
"openai",
|
|
33
|
+
"gemini",
|
|
34
|
+
"gpt",
|
|
35
|
+
"llm",
|
|
36
|
+
"machine-learning",
|
|
37
|
+
"artificial-intelligence",
|
|
38
|
+
"skills",
|
|
39
|
+
"agents",
|
|
40
|
+
"subagents",
|
|
41
|
+
"shencha",
|
|
42
|
+
"audit",
|
|
43
|
+
"code-review",
|
|
44
|
+
"security-audit",
|
|
45
|
+
"devops",
|
|
46
|
+
"cicd",
|
|
47
|
+
"testing",
|
|
48
|
+
"documentation",
|
|
49
|
+
"refactoring",
|
|
50
|
+
"plugin-system",
|
|
51
|
+
"typescript",
|
|
52
|
+
"javascript",
|
|
53
|
+
"python",
|
|
54
|
+
"react",
|
|
55
|
+
"vue",
|
|
56
|
+
"nextjs",
|
|
57
|
+
"nodejs",
|
|
58
|
+
"fullstack",
|
|
59
|
+
"backend",
|
|
60
|
+
"frontend",
|
|
61
|
+
"api",
|
|
62
|
+
"microservices",
|
|
63
|
+
"docker",
|
|
64
|
+
"kubernetes",
|
|
65
|
+
"performance",
|
|
66
|
+
"optimization",
|
|
67
|
+
"best-practices",
|
|
68
|
+
"clean-code",
|
|
69
|
+
"productivity",
|
|
70
|
+
"workflow",
|
|
71
|
+
"cursor-alternative",
|
|
72
|
+
"copilot-alternative",
|
|
73
|
+
"codeium-alternative"
|
|
74
|
+
],
|
|
75
|
+
"main": "dist/index.mjs",
|
|
76
|
+
"module": "dist/index.mjs",
|
|
77
|
+
"types": "dist/index.d.mts",
|
|
78
|
+
"bin": {
|
|
79
|
+
"ccjk": "bin/ccjk.mjs"
|
|
80
|
+
},
|
|
81
|
+
"files": [
|
|
82
|
+
"bin",
|
|
83
|
+
"dist",
|
|
84
|
+
"templates"
|
|
85
|
+
],
|
|
86
|
+
"engines": {
|
|
87
|
+
"node": ">=20"
|
|
88
|
+
},
|
|
89
|
+
"scripts": {
|
|
90
|
+
"dev": "tsx ./src/cli.ts",
|
|
91
|
+
"build": "unbuild",
|
|
92
|
+
"start": "node bin/ccjk.mjs",
|
|
93
|
+
"typecheck": "tsc --noEmit",
|
|
94
|
+
"prepublishOnly": "pnpm build",
|
|
95
|
+
"lint": "eslint",
|
|
96
|
+
"lint:fix": "eslint --fix",
|
|
97
|
+
"test": "vitest",
|
|
98
|
+
"test:ui": "vitest --ui",
|
|
99
|
+
"test:coverage": "vitest run --coverage",
|
|
100
|
+
"test:run": "vitest run",
|
|
101
|
+
"test:watch": "vitest watch",
|
|
102
|
+
"changeset": "changeset",
|
|
103
|
+
"version": "changeset version",
|
|
104
|
+
"update:deps": "pnpx taze major -r -w",
|
|
105
|
+
"release": "pnpm build && changeset publish",
|
|
106
|
+
"prepare": "husky",
|
|
107
|
+
"commitlint": "commitlint",
|
|
108
|
+
"commitlint:check": "commitlint --from HEAD~1 --to HEAD --verbose",
|
|
109
|
+
"docs:dev": "pnpm -F @ccjk/docs dev",
|
|
110
|
+
"docs:build": "pnpm -F @ccjk/docs build",
|
|
111
|
+
"docs:preview": "pnpm -F @ccjk/docs preview"
|
|
112
|
+
},
|
|
113
|
+
"dependencies": {
|
|
114
|
+
"@types/semver": "catalog:types",
|
|
115
|
+
"ansis": "catalog:cli",
|
|
116
|
+
"cac": "catalog:cli",
|
|
117
|
+
"dayjs": "catalog:runtime",
|
|
118
|
+
"find-up-simple": "catalog:runtime",
|
|
119
|
+
"fs-extra": "catalog:runtime",
|
|
120
|
+
"i18next": "catalog:runtime",
|
|
121
|
+
"i18next-fs-backend": "catalog:runtime",
|
|
122
|
+
"inquirer": "catalog:cli",
|
|
123
|
+
"inquirer-toggle": "catalog:cli",
|
|
124
|
+
"ora": "catalog:cli",
|
|
125
|
+
"pathe": "catalog:runtime",
|
|
126
|
+
"semver": "catalog:runtime",
|
|
127
|
+
"smol-toml": "catalog:runtime",
|
|
128
|
+
"tinyexec": "catalog:runtime",
|
|
129
|
+
"trash": "catalog:runtime"
|
|
130
|
+
},
|
|
131
|
+
"devDependencies": {
|
|
132
|
+
"@antfu/eslint-config": "catalog:build",
|
|
133
|
+
"@changesets/cli": "catalog:tooling",
|
|
134
|
+
"@commitlint/cli": "catalog:tooling",
|
|
135
|
+
"@commitlint/config-conventional": "catalog:tooling",
|
|
136
|
+
"@commitlint/types": "catalog:tooling",
|
|
137
|
+
"@types/fs-extra": "catalog:types",
|
|
138
|
+
"@types/inquirer": "catalog:types",
|
|
139
|
+
"@types/node": "catalog:types",
|
|
140
|
+
"@vitest/coverage-v8": "catalog:testing",
|
|
141
|
+
"@vitest/ui": "catalog:testing",
|
|
142
|
+
"eslint": "catalog:build",
|
|
143
|
+
"eslint-plugin-format": "catalog:build",
|
|
144
|
+
"glob": "catalog:testing",
|
|
145
|
+
"husky": "catalog:tooling",
|
|
146
|
+
"lint-staged": "catalog:tooling",
|
|
147
|
+
"tsx": "catalog:build",
|
|
148
|
+
"typescript": "catalog:build",
|
|
149
|
+
"unbuild": "catalog:build",
|
|
150
|
+
"vitest": "catalog:testing"
|
|
151
|
+
},
|
|
152
|
+
"lint-staged": {
|
|
153
|
+
"*": [
|
|
154
|
+
"pnpm lint"
|
|
155
|
+
]
|
|
156
|
+
}
|
|
157
|
+
}
|
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# Templates Module
|
|
2
|
+
|
|
3
|
+
**Last Updated**: Sun Dec 15 09:15:34 CST 2025
|
|
4
|
+
[Root](../CLAUDE.md) > **templates**
|
|
5
|
+
|
|
6
|
+
## Module Responsibilities
|
|
7
|
+
|
|
8
|
+
Template system module providing multilingual configuration templates, AI personality styles, and workflow definitions for both Claude Code and Codex environments. Supports Chinese (zh-CN) and English (en) locales with comprehensive workflow coverage.
|
|
9
|
+
|
|
10
|
+
## Entry Points and Startup
|
|
11
|
+
|
|
12
|
+
- **Main Template Directories**:
|
|
13
|
+
- `claude-code/` - Claude Code specific templates
|
|
14
|
+
- `codex/` - Codex specific templates
|
|
15
|
+
- `common/` - Shared configuration templates
|
|
16
|
+
|
|
17
|
+
## External Interfaces
|
|
18
|
+
|
|
19
|
+
### Template Structure
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
templates/
|
|
23
|
+
├── common/ # Shared templates (cross code-tool)
|
|
24
|
+
│ ├── output-styles/ # AI personality styles
|
|
25
|
+
│ │ ├── en/ # English output styles
|
|
26
|
+
│ │ │ ├── engineer-professional.md
|
|
27
|
+
│ │ │ ├── laowang-engineer.md
|
|
28
|
+
│ │ │ ├── nekomata-engineer.md
|
|
29
|
+
│ │ │ └── ojousama-engineer.md
|
|
30
|
+
│ │ └── zh-CN/ # Chinese output styles
|
|
31
|
+
│ │ ├── engineer-professional.md
|
|
32
|
+
│ │ ├── laowang-engineer.md
|
|
33
|
+
│ │ ├── nekomata-engineer.md
|
|
34
|
+
│ │ └── ojousama-engineer.md
|
|
35
|
+
│ └── workflow/
|
|
36
|
+
│ ├── git/ # Git workflow
|
|
37
|
+
│ │ ├── en/ # English git commands
|
|
38
|
+
│ │ │ ├── git-commit.md
|
|
39
|
+
│ │ │ ├── git-worktree.md
|
|
40
|
+
│ │ │ ├── git-cleanBranches.md
|
|
41
|
+
│ │ │ └── git-rollback.md
|
|
42
|
+
│ │ └── zh-CN/ # Chinese git commands
|
|
43
|
+
│ │ ├── git-commit.md
|
|
44
|
+
│ │ ├── git-worktree.md
|
|
45
|
+
│ │ ├── git-cleanBranches.md
|
|
46
|
+
│ │ └── git-rollback.md
|
|
47
|
+
│ └── sixStep/ # Six-step workflow
|
|
48
|
+
│ ├── en/ # English workflow
|
|
49
|
+
│ │ └── workflow.md
|
|
50
|
+
│ └── zh-CN/ # Chinese workflow
|
|
51
|
+
│ └── workflow.md
|
|
52
|
+
├── claude-code/ # Claude Code templates
|
|
53
|
+
│ ├── common/ # Common configurations
|
|
54
|
+
│ ├── zh-CN/ # Chinese templates
|
|
55
|
+
│ │ └── workflow/ # Workflow templates
|
|
56
|
+
│ │ ├── common/ # Common tools workflow
|
|
57
|
+
│ │ ├── plan/ # Planning workflow
|
|
58
|
+
│ │ └── bmad/ # BMAD workflow
|
|
59
|
+
│ └── en/ # English templates
|
|
60
|
+
│ └── workflow/ # Workflow templates
|
|
61
|
+
└── codex/ # Codex templates
|
|
62
|
+
├── common/ # Common configurations
|
|
63
|
+
├── zh-CN/ # Chinese templates
|
|
64
|
+
│ └── workflow/ # Workflow templates
|
|
65
|
+
└── en/ # English templates
|
|
66
|
+
└── workflow/ # Workflow templates
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Template Categories
|
|
70
|
+
|
|
71
|
+
#### 1. Output Styles (AI Personalities)
|
|
72
|
+
|
|
73
|
+
- **engineer-professional** - Professional engineering style
|
|
74
|
+
- **nekomata-engineer** - Nekomata engineer personality
|
|
75
|
+
- **laowang-engineer** - Laowang engineer personality
|
|
76
|
+
- **default** - Default output style
|
|
77
|
+
- **explanatory** - Explanatory style
|
|
78
|
+
- **learning** - Learning-focused style
|
|
79
|
+
|
|
80
|
+
#### 2. Workflow Templates
|
|
81
|
+
|
|
82
|
+
##### Common Tools Workflow
|
|
83
|
+
- **Commands**: `init-project`
|
|
84
|
+
- **Agents**: `init-architect`, `get-current-datetime`
|
|
85
|
+
- **Purpose**: Essential development tools and project initialization
|
|
86
|
+
|
|
87
|
+
##### Planning Workflow (Plan)
|
|
88
|
+
- **Commands**: `feat`, `workflow`
|
|
89
|
+
- **Agents**: `planner`, `ui-ux-designer`
|
|
90
|
+
- **Purpose**: Feature planning and UX design
|
|
91
|
+
|
|
92
|
+
##### Six-Step Workflow
|
|
93
|
+
- **Commands**: `ccjk-update-docs`, `ccjk-pr`, `ccjk-release`
|
|
94
|
+
- **Purpose**: Structured development process
|
|
95
|
+
|
|
96
|
+
##### BMAD Workflow
|
|
97
|
+
- **Commands**: Enterprise-level workflow commands
|
|
98
|
+
- **Purpose**: Business model and architecture design
|
|
99
|
+
|
|
100
|
+
##### Git Workflow
|
|
101
|
+
- **Commands**: `git-commit`, `git-worktree`, `git-cleanBranches`, `git-rollback`
|
|
102
|
+
- **Purpose**: Version control management with conventional commits, worktree management, branch cleanup, and rollback operations
|
|
103
|
+
|
|
104
|
+
## Key Dependencies and Configuration
|
|
105
|
+
|
|
106
|
+
### Template Processing
|
|
107
|
+
|
|
108
|
+
- **Language Support**: zh-CN and en locales
|
|
109
|
+
- **Code Tool Support**: Claude Code and Codex
|
|
110
|
+
- **Template Format**: Markdown-based configuration files
|
|
111
|
+
- **Variable Substitution**: Dynamic content replacement
|
|
112
|
+
|
|
113
|
+
### Configuration Integration
|
|
114
|
+
|
|
115
|
+
- **Workflow Installer**: Integration with `src/utils/workflow-installer.ts`
|
|
116
|
+
- **Language Detection**: Integration with `src/i18n/` system
|
|
117
|
+
- **Platform Support**: Cross-platform path handling
|
|
118
|
+
|
|
119
|
+
## Data Models
|
|
120
|
+
|
|
121
|
+
### Template Organization
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
interface TemplateStructure {
|
|
125
|
+
codeTool: 'claude-code' | 'codex'
|
|
126
|
+
locale: 'zh-CN' | 'en'
|
|
127
|
+
category: 'common' | 'output-styles' | 'workflow'
|
|
128
|
+
workflow?: {
|
|
129
|
+
type: 'common' | 'plan' | 'sixStep' | 'bmad' | 'git'
|
|
130
|
+
commands: string[]
|
|
131
|
+
agents: string[]
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Output Style Configuration
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
interface OutputStyle {
|
|
140
|
+
id: string
|
|
141
|
+
name: { 'zh-CN': string, 'en': string }
|
|
142
|
+
description: { 'zh-CN': string, 'en': string }
|
|
143
|
+
template: string
|
|
144
|
+
personality: string
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Testing and Quality
|
|
149
|
+
|
|
150
|
+
### Template Validation
|
|
151
|
+
|
|
152
|
+
- **File**: `tests/templates/chinese-templates.test.ts`
|
|
153
|
+
- **Coverage**: Template completeness and format validation
|
|
154
|
+
- **Validation**: Markdown syntax and variable substitution
|
|
155
|
+
|
|
156
|
+
### Quality Metrics
|
|
157
|
+
|
|
158
|
+
- **Template Coverage**: 100% for both locales
|
|
159
|
+
- **Code Tool Support**: Claude Code and Codex fully supported
|
|
160
|
+
- **Workflow Coverage**: 5 major workflow categories
|
|
161
|
+
- **Output Styles**: 6 AI personality styles
|
|
162
|
+
|
|
163
|
+
## Common Issues
|
|
164
|
+
|
|
165
|
+
- **Path Handling**: Cross-platform path compatibility
|
|
166
|
+
- **Encoding**: UTF-8 encoding for multilingual content
|
|
167
|
+
- **Template Variables**: Proper variable substitution
|
|
168
|
+
- **File Permissions**: Executable permissions for command files
|
|
169
|
+
|
|
170
|
+
## Related Files
|
|
171
|
+
|
|
172
|
+
- `src/utils/workflow-installer.ts` - Template installation logic
|
|
173
|
+
- `src/config/workflows.ts` - Workflow configuration definitions
|
|
174
|
+
- `src/i18n/` - Internationalization support
|
|
175
|
+
- `tests/templates/` - Template validation tests
|
|
176
|
+
|
|
177
|
+
## Change Log (Module-Specific)
|
|
178
|
+
|
|
179
|
+
### Recent Updates
|
|
180
|
+
|
|
181
|
+
- Consolidated sixStep workflow templates to `templates/common/workflow/sixStep/` with unified `.ccjk` plan directory for both Claude Code and Codex
|
|
182
|
+
- Consolidated output-styles/system-prompt templates to `templates/common/output-styles/`
|
|
183
|
+
- Consolidated git workflow templates to `templates/common/workflow/git/`
|
|
184
|
+
- Added Codex template support for dual code tool architecture
|
|
185
|
+
- Enhanced workflow templates with comprehensive command coverage
|
|
186
|
+
- Improved AI personality styles with professional variations
|
|
187
|
+
- Added cross-platform template compatibility
|
|
188
|
+
- Enhanced template validation and testing coverage
|
|
189
|
+
|
|
190
|
+
## FAQ
|
|
191
|
+
|
|
192
|
+
### Q: How to add a new workflow template?
|
|
193
|
+
|
|
194
|
+
1. Create workflow directory under `templates/{code-tool}/{locale}/workflow/`
|
|
195
|
+
2. Add command files in `commands/` subdirectory
|
|
196
|
+
3. Add agent files in `agents/` subdirectory (if needed)
|
|
197
|
+
4. Update `src/config/workflows.ts` with new workflow definition
|
|
198
|
+
5. Add translations in `src/i18n/locales/{locale}/workflow.ts`
|
|
199
|
+
|
|
200
|
+
### Q: How to add a new output style?
|
|
201
|
+
|
|
202
|
+
1. Create style file in `templates/common/output-styles/{locale}/`
|
|
203
|
+
2. Define style configuration with name and description
|
|
204
|
+
3. Add style to available options in configuration
|
|
205
|
+
4. Test style rendering with sample content
|
|
206
|
+
|
|
207
|
+
### Q: How to support a new language?
|
|
208
|
+
|
|
209
|
+
1. Create new locale directory under `templates/{code-tool}/{new-locale}/`
|
|
210
|
+
2. Copy existing templates and translate content
|
|
211
|
+
3. Update i18n system to support new locale
|
|
212
|
+
4. Add locale to supported languages list
|
|
213
|
+
|
|
214
|
+
### Q: How to maintain template consistency?
|
|
215
|
+
|
|
216
|
+
- Use template validation tests
|
|
217
|
+
- Follow naming conventions
|
|
218
|
+
- Maintain parallel structure across locales
|
|
219
|
+
- Document template variables and usage
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
# Templates Module
|
|
2
|
+
|
|
3
|
+
**Last Updated**: Mon Oct 27 19:39:26 CST 2025
|
|
4
|
+
[Root](../CLAUDE.md) > **templates**
|
|
5
|
+
|
|
6
|
+
## Module Responsibilities
|
|
7
|
+
|
|
8
|
+
Template configuration module providing multilingual configuration templates, workflow templates, and AI memory templates, supporting both Chinese and English environments for comprehensive Claude Code environment setup.
|
|
9
|
+
|
|
10
|
+
## Entry Points and Startup
|
|
11
|
+
|
|
12
|
+
- **Main Entry Points**:
|
|
13
|
+
- `common/` - Common configuration templates
|
|
14
|
+
- `zh-CN/` - Chinese template collection
|
|
15
|
+
- `en/` - English template collection
|
|
16
|
+
|
|
17
|
+
## External Interfaces
|
|
18
|
+
|
|
19
|
+
### Template Structure
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
templates/
|
|
23
|
+
├── common/ # Common configuration templates
|
|
24
|
+
│ ├── CLAUDE.md # Base CLAUDE.md template
|
|
25
|
+
│ └── settings.json # Claude settings template
|
|
26
|
+
├── zh-CN/ # Chinese template collection
|
|
27
|
+
│ ├── memory/ # AI memory templates
|
|
28
|
+
│ └── workflow/ # Workflow templates
|
|
29
|
+
└── en/ # English template collection
|
|
30
|
+
├── memory/ # AI memory templates
|
|
31
|
+
└── workflow/ # Workflow templates
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Template Category System
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
// Template categories
|
|
38
|
+
interface TemplateCategories {
|
|
39
|
+
memory: {
|
|
40
|
+
'mcp.md': string // MCP service guidance
|
|
41
|
+
'technical-guides.md': string // Technical implementation guides
|
|
42
|
+
'personality.md': string // AI personality configuration
|
|
43
|
+
'rules.md': string // Core programming principles
|
|
44
|
+
}
|
|
45
|
+
workflow: {
|
|
46
|
+
common: WorkflowCommands // Common tools workflow
|
|
47
|
+
plan: WorkflowCommands // Feature planning workflow
|
|
48
|
+
sixStep: WorkflowCommands // Six-step development workflow
|
|
49
|
+
bmad: WorkflowCommands // BMad enterprise workflow
|
|
50
|
+
git: WorkflowCommands // Git operation workflow
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Key Dependencies and Configuration
|
|
56
|
+
|
|
57
|
+
### Template Installation Process
|
|
58
|
+
|
|
59
|
+
- Templates are copied to `~/.claude/` directory during initialization
|
|
60
|
+
- Language-specific templates selected based on user configuration
|
|
61
|
+
- Automatic template merging and update mechanisms
|
|
62
|
+
- Template validation and consistency checking
|
|
63
|
+
|
|
64
|
+
### Configuration Files
|
|
65
|
+
|
|
66
|
+
- `common/settings.json` - Base Claude settings template
|
|
67
|
+
- `common/CLAUDE.md` - Project guidance template
|
|
68
|
+
- Language-specific memory and workflow templates
|
|
69
|
+
|
|
70
|
+
## Data Models
|
|
71
|
+
|
|
72
|
+
### Workflow Template Structure
|
|
73
|
+
|
|
74
|
+
#### Common Tools Workflow (`common/`)
|
|
75
|
+
|
|
76
|
+
- **Commands**: `init-project.md` - Project initialization command
|
|
77
|
+
- **Agents**: `init-architect.md`, `get-current-datetime.md` - Core utility agents
|
|
78
|
+
|
|
79
|
+
#### Feature Planning Workflow (`plan/`)
|
|
80
|
+
|
|
81
|
+
- **Commands**: `feat.md` - Feature development command
|
|
82
|
+
- **Agents**: `planner.md`, `ui-ux-designer.md` - Planning and design agents
|
|
83
|
+
|
|
84
|
+
#### Six-Step Development Workflow (`sixStep/`)
|
|
85
|
+
|
|
86
|
+
- **Commands**: `workflow.md` - Six-step development process
|
|
87
|
+
- **Agents**: None - Process-oriented workflow
|
|
88
|
+
|
|
89
|
+
#### BMad Enterprise Workflow (`bmad/`)
|
|
90
|
+
|
|
91
|
+
- **Commands**: `bmad-init.md` - BMad initialization
|
|
92
|
+
- **Agents**: Complete enterprise development team simulation
|
|
93
|
+
|
|
94
|
+
#### Git Workflow (`git/`)
|
|
95
|
+
|
|
96
|
+
- **Commands**: `git-commit.md`, `git-worktree.md`, `git-cleanBranches.md`, `git-rollback.md`
|
|
97
|
+
- **Agents**: None - Git operation commands
|
|
98
|
+
|
|
99
|
+
### Memory Template Structure
|
|
100
|
+
|
|
101
|
+
#### AI Memory Templates
|
|
102
|
+
|
|
103
|
+
- **mcp.md**: MCP service usage guidelines and best practices
|
|
104
|
+
- **technical-guides.md**: Technical execution guidelines and standards
|
|
105
|
+
- **personality.md**: AI assistant behavior and personality configuration
|
|
106
|
+
- **rules.md**: Core programming principles and workflow methodology
|
|
107
|
+
|
|
108
|
+
### Template Language Support
|
|
109
|
+
|
|
110
|
+
#### Chinese Templates (`zh-CN/`)
|
|
111
|
+
|
|
112
|
+
- Complete Chinese localization for all templates
|
|
113
|
+
- Chinese AI interaction patterns
|
|
114
|
+
- Chinese technical documentation standards
|
|
115
|
+
- Chinese workflow descriptions
|
|
116
|
+
|
|
117
|
+
#### English Templates (`en/`)
|
|
118
|
+
|
|
119
|
+
- Complete English localization for all templates
|
|
120
|
+
- English AI interaction patterns
|
|
121
|
+
- English technical documentation standards
|
|
122
|
+
- English workflow descriptions
|
|
123
|
+
|
|
124
|
+
## Testing and Quality
|
|
125
|
+
|
|
126
|
+
### Template Validation Strategy
|
|
127
|
+
|
|
128
|
+
- **Consistency Testing**: Verify Chinese-English template correspondence
|
|
129
|
+
- **Syntax Testing**: Validate markdown syntax and formatting
|
|
130
|
+
- **Content Testing**: Verify template completeness and accuracy
|
|
131
|
+
- **Integration Testing**: Test template installation and configuration
|
|
132
|
+
|
|
133
|
+
### Quality Metrics
|
|
134
|
+
|
|
135
|
+
#### ✅ Template Completeness
|
|
136
|
+
|
|
137
|
+
- Chinese-English template parity: **100%**
|
|
138
|
+
- Workflow category coverage: **5/5 categories**
|
|
139
|
+
- Memory template coverage: **4/4 templates**
|
|
140
|
+
- Command template coverage: **Complete**
|
|
141
|
+
|
|
142
|
+
#### ✅ Language Support
|
|
143
|
+
|
|
144
|
+
- Chinese localization: **Complete**
|
|
145
|
+
- English localization: **Complete**
|
|
146
|
+
- Template structure consistency: **Validated**
|
|
147
|
+
- Content accuracy: **Verified**
|
|
148
|
+
|
|
149
|
+
#### ✅ Installation Testing
|
|
150
|
+
|
|
151
|
+
- Template copying mechanism: **Tested**
|
|
152
|
+
- Language selection logic: **Verified**
|
|
153
|
+
- Template merging: **Functional**
|
|
154
|
+
- Update mechanism: **Working**
|
|
155
|
+
|
|
156
|
+
### Test Coverage
|
|
157
|
+
|
|
158
|
+
- **Template Tests**: `tests/templates/chinese-templates.test.ts`
|
|
159
|
+
- **Installation Tests**: Integration tests for template deployment
|
|
160
|
+
- **Validation Tests**: Template structure and content verification
|
|
161
|
+
|
|
162
|
+
## FAQ
|
|
163
|
+
|
|
164
|
+
### Q: How to add new workflow templates?
|
|
165
|
+
|
|
166
|
+
1. Add template files in both `zh-CN/workflow/` and `en/workflow/`
|
|
167
|
+
2. Update workflow configuration in `src/config/workflows.ts`
|
|
168
|
+
3. Add corresponding translation keys in i18n files
|
|
169
|
+
4. Test template installation and functionality
|
|
170
|
+
|
|
171
|
+
### Q: How to modify AI memory templates?
|
|
172
|
+
|
|
173
|
+
1. Update template files in both language directories
|
|
174
|
+
2. Ensure consistency between Chinese and English versions
|
|
175
|
+
3. Test AI behavior changes with modified templates
|
|
176
|
+
4. Update documentation if needed
|
|
177
|
+
|
|
178
|
+
### Q: How are templates installed during initialization?
|
|
179
|
+
|
|
180
|
+
Templates are copied from the package to `~/.claude/` directory based on user's language selection, with smart merging to preserve existing customizations.
|
|
181
|
+
|
|
182
|
+
### Q: How to maintain template version compatibility?
|
|
183
|
+
|
|
184
|
+
- Use semantic versioning for major template changes
|
|
185
|
+
- Provide migration guides for breaking changes
|
|
186
|
+
- Maintain backward compatibility when possible
|
|
187
|
+
- Test template updates with existing configurations
|
|
188
|
+
|
|
189
|
+
## Related File List
|
|
190
|
+
|
|
191
|
+
### Common Configuration Templates
|
|
192
|
+
|
|
193
|
+
- `common/CLAUDE.md` - Base project guidance template
|
|
194
|
+
- `common/settings.json` - Claude configuration template
|
|
195
|
+
|
|
196
|
+
### Chinese Templates (`zh-CN/`)
|
|
197
|
+
|
|
198
|
+
#### Memory Templates
|
|
199
|
+
|
|
200
|
+
- `memory/mcp.md` - MCP服务使用指南
|
|
201
|
+
- `memory/technical-guides.md` - 技术执行准则
|
|
202
|
+
- `memory/personality.md` - AI助手个性配置
|
|
203
|
+
- `memory/rules.md` - 核心编程原则
|
|
204
|
+
|
|
205
|
+
#### Workflow Templates
|
|
206
|
+
|
|
207
|
+
- `workflow/common/commands/init-project.md` - 项目初始化命令
|
|
208
|
+
- `workflow/common/agents/init-architect.md` - 初始化架构师
|
|
209
|
+
- `workflow/common/agents/get-current-datetime.md` - 时间工具
|
|
210
|
+
- `workflow/plan/commands/feat.md` - 功能开发命令
|
|
211
|
+
- `workflow/plan/agents/planner.md` - 规划师
|
|
212
|
+
- `workflow/plan/agents/ui-ux-designer.md` - UI/UX设计师
|
|
213
|
+
- `workflow/sixStep/commands/workflow.md` - 六步开发流程
|
|
214
|
+
- `workflow/bmad/commands/bmad-init.md` - BMad初始化
|
|
215
|
+
- `workflow/git/commands/` - Git操作命令集
|
|
216
|
+
|
|
217
|
+
### English Templates (`en/`)
|
|
218
|
+
|
|
219
|
+
#### Memory Templates
|
|
220
|
+
|
|
221
|
+
- `memory/mcp.md` - MCP Services Usage Guide
|
|
222
|
+
- `memory/technical-guides.md` - Technical Execution Guidelines
|
|
223
|
+
- `memory/personality.md` - AI Assistant Personality Configuration
|
|
224
|
+
- `memory/rules.md` - Core Programming Principles
|
|
225
|
+
|
|
226
|
+
#### Workflow Templates
|
|
227
|
+
|
|
228
|
+
- `workflow/common/commands/init-project.md` - Project initialization command
|
|
229
|
+
- `workflow/common/agents/init-architect.md` - Initialization architect
|
|
230
|
+
- `workflow/common/agents/get-current-datetime.md` - DateTime utility
|
|
231
|
+
- `workflow/plan/commands/feat.md` - Feature development command
|
|
232
|
+
- `workflow/plan/agents/planner.md` - Planner agent
|
|
233
|
+
- `workflow/plan/agents/ui-ux-designer.md` - UI/UX designer
|
|
234
|
+
- `workflow/sixStep/commands/workflow.md` - Six-step development workflow
|
|
235
|
+
- `workflow/bmad/commands/bmad-init.md` - BMad initialization
|
|
236
|
+
- `workflow/git/commands/` - Git operation commands
|
|
237
|
+
|
|
238
|
+
### Test Files
|
|
239
|
+
|
|
240
|
+
- `tests/templates/chinese-templates.test.ts` - Chinese template validation
|
|
241
|
+
- Template integration tests distributed across test suites
|
|
242
|
+
|
|
243
|
+
## Changelog
|
|
244
|
+
|
|
245
|
+
### 2025-08-20
|
|
246
|
+
|
|
247
|
+
- **Module Documentation Created**: Completed comprehensive documentation of templates module
|
|
248
|
+
- **Template Architecture Analysis**: Detailed analysis of bilingual template structure and workflow organization
|
|
249
|
+
- **Quality Assessment**: Verified complete Chinese-English template parity and coverage
|
|
250
|
+
- **Template Category Documentation**: Complete recording of 5 workflow categories and 4 memory templates
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json.schemastore.org/claude-code-settings.json",
|
|
3
|
+
"env": {
|
|
4
|
+
"DISABLE_TELEMETRY": "1",
|
|
5
|
+
"DISABLE_ERROR_REPORTING": "1",
|
|
6
|
+
"CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
|
|
7
|
+
"MCP_TIMEOUT": "60000"
|
|
8
|
+
},
|
|
9
|
+
"includeCoAuthoredBy": false,
|
|
10
|
+
"permissions": {
|
|
11
|
+
"allow": [
|
|
12
|
+
"Bash",
|
|
13
|
+
"BashOutput",
|
|
14
|
+
"Edit",
|
|
15
|
+
"Glob",
|
|
16
|
+
"Grep",
|
|
17
|
+
"KillShell",
|
|
18
|
+
"NotebookEdit",
|
|
19
|
+
"Read",
|
|
20
|
+
"SlashCommand",
|
|
21
|
+
"Task",
|
|
22
|
+
"TodoWrite",
|
|
23
|
+
"WebFetch",
|
|
24
|
+
"WebSearch",
|
|
25
|
+
"Write",
|
|
26
|
+
"mcp__ide",
|
|
27
|
+
"mcp__exa",
|
|
28
|
+
"mcp__context7",
|
|
29
|
+
"mcp__mcp-deepwiki",
|
|
30
|
+
"mcp__Playwright",
|
|
31
|
+
"mcp__spec-workflow",
|
|
32
|
+
"mcp__open-websearch",
|
|
33
|
+
"mcp__serena"
|
|
34
|
+
],
|
|
35
|
+
"deny": []
|
|
36
|
+
},
|
|
37
|
+
"hooks": {}
|
|
38
|
+
}
|