@codemieai/code 0.0.32 → 0.0.34
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 +73 -7
- package/bin/codemie-opencode.js +11 -0
- package/dist/agents/codemie-code/agent.d.ts +17 -1
- package/dist/agents/codemie-code/agent.d.ts.map +1 -1
- package/dist/agents/codemie-code/agent.js +62 -3
- package/dist/agents/codemie-code/agent.js.map +1 -1
- package/dist/agents/codemie-code/index.d.ts +1 -0
- package/dist/agents/codemie-code/index.d.ts.map +1 -1
- package/dist/agents/codemie-code/index.js +28 -2
- package/dist/agents/codemie-code/index.js.map +1 -1
- package/dist/agents/codemie-code/prompts.d.ts +12 -3
- package/dist/agents/codemie-code/prompts.d.ts.map +1 -1
- package/dist/agents/codemie-code/prompts.js +25 -5
- package/dist/agents/codemie-code/prompts.js.map +1 -1
- package/dist/agents/codemie-code/types.d.ts +3 -0
- package/dist/agents/codemie-code/types.d.ts.map +1 -1
- package/dist/agents/codemie-code/types.js.map +1 -1
- package/dist/agents/codemie-code/ui/todoPanel.d.ts.map +1 -1
- package/dist/agents/codemie-code/ui/todoPanel.js +4 -0
- package/dist/agents/codemie-code/ui/todoPanel.js.map +1 -1
- package/dist/agents/core/AgentCLI.d.ts.map +1 -1
- package/dist/agents/core/AgentCLI.js +3 -1
- package/dist/agents/core/AgentCLI.js.map +1 -1
- package/dist/agents/core/BaseAgentAdapter.d.ts.map +1 -1
- package/dist/agents/core/BaseAgentAdapter.js +46 -2
- package/dist/agents/core/BaseAgentAdapter.js.map +1 -1
- package/dist/agents/core/session/BaseSessionAdapter.d.ts +25 -0
- package/dist/agents/core/session/BaseSessionAdapter.d.ts.map +1 -1
- package/dist/agents/core/session/SessionStore.d.ts +15 -0
- package/dist/agents/core/session/SessionStore.d.ts.map +1 -1
- package/dist/agents/core/session/SessionStore.js +46 -0
- package/dist/agents/core/session/SessionStore.js.map +1 -1
- package/dist/agents/core/session/discovery-types.d.ts +53 -0
- package/dist/agents/core/session/discovery-types.d.ts.map +1 -0
- package/dist/agents/core/session/discovery-types.js +8 -0
- package/dist/agents/core/session/discovery-types.js.map +1 -0
- package/dist/agents/core/session/types.d.ts +2 -0
- package/dist/agents/core/session/types.d.ts.map +1 -1
- package/dist/agents/core/types.d.ts +45 -0
- package/dist/agents/core/types.d.ts.map +1 -1
- package/dist/agents/plugins/claude/claude.plugin.d.ts +44 -1
- package/dist/agents/plugins/claude/claude.plugin.d.ts.map +1 -1
- package/dist/agents/plugins/claude/claude.plugin.js +214 -0
- package/dist/agents/plugins/claude/claude.plugin.js.map +1 -1
- package/dist/agents/plugins/claude/plugin/.claude-plugin/plugin.json +1 -1
- package/dist/agents/plugins/claude/plugin/README.md +40 -2
- package/dist/agents/plugins/claude/plugin/claude-templates/README.md +5 -5
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/CLAUDE.md.template +177 -436
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/code-review-agent-template.md.template +49 -82
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/refactor-cleaner-agent.md.template +337 -0
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/solution-architect-agent.md.template +129 -419
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/unit-tester-agent.md.template +146 -693
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/api/api-patterns.md.template +110 -138
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/architecture.md.template +197 -0
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/data/database-patterns.md.template +171 -91
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/development/development-practices.md.template +219 -131
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/security/security-practices.md.template +223 -98
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/standards/code-quality.md.template +131 -95
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/testing/testing-patterns.md.template +247 -75
- package/dist/agents/plugins/claude/plugin/commands/README.md +133 -0
- package/dist/agents/plugins/claude/plugin/commands/codemie-init.md +336 -544
- package/dist/agents/plugins/claude/plugin/commands/codemie-subagents.md +232 -503
- package/dist/agents/plugins/claude/plugin/commands/memory-add.md +311 -30
- package/dist/agents/plugins/claude/plugin/commands/memory-refresh.md +218 -39
- package/dist/agents/plugins/claude/plugin/hooks/hooks.json +11 -0
- package/dist/agents/plugins/gemini/extension/gemini-extension.json +1 -1
- package/dist/agents/plugins/gemini/extension/hooks/hooks.json +12 -0
- package/dist/agents/plugins/gemini/gemini.plugin.d.ts.map +1 -1
- package/dist/agents/plugins/gemini/gemini.plugin.js +2 -4
- package/dist/agents/plugins/gemini/gemini.plugin.js.map +1 -1
- package/dist/agents/plugins/opencode/index.d.ts +8 -0
- package/dist/agents/plugins/opencode/index.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/index.js +12 -0
- package/dist/agents/plugins/opencode/index.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode-message-types.d.ts +207 -0
- package/dist/agents/plugins/opencode/opencode-message-types.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode-message-types.js +59 -0
- package/dist/agents/plugins/opencode/opencode-message-types.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode-model-configs.d.ts +65 -0
- package/dist/agents/plugins/opencode/opencode-model-configs.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode-model-configs.js +184 -0
- package/dist/agents/plugins/opencode/opencode-model-configs.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode.paths.d.ts +62 -0
- package/dist/agents/plugins/opencode/opencode.paths.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode.paths.js +148 -0
- package/dist/agents/plugins/opencode/opencode.paths.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode.plugin.d.ts +35 -0
- package/dist/agents/plugins/opencode/opencode.plugin.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode.plugin.js +338 -0
- package/dist/agents/plugins/opencode/opencode.plugin.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode.session.d.ts +77 -0
- package/dist/agents/plugins/opencode/opencode.session.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode.session.js +424 -0
- package/dist/agents/plugins/opencode/opencode.session.js.map +1 -0
- package/dist/agents/plugins/opencode/opencode.storage-utils.d.ts +25 -0
- package/dist/agents/plugins/opencode/opencode.storage-utils.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/opencode.storage-utils.js +96 -0
- package/dist/agents/plugins/opencode/opencode.storage-utils.js.map +1 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.d.ts +30 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.js +116 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.js.map +1 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.d.ts +102 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.d.ts.map +1 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.js +584 -0
- package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.js.map +1 -0
- package/dist/agents/registry.d.ts.map +1 -1
- package/dist/agents/registry.js +2 -0
- package/dist/agents/registry.js.map +1 -1
- package/dist/cli/commands/doctor/checks/AgentsCheck.d.ts +5 -0
- package/dist/cli/commands/doctor/checks/AgentsCheck.d.ts.map +1 -1
- package/dist/cli/commands/doctor/checks/AgentsCheck.js +29 -0
- package/dist/cli/commands/doctor/checks/AgentsCheck.js.map +1 -1
- package/dist/cli/commands/hook.d.ts.map +1 -1
- package/dist/cli/commands/hook.js +63 -6
- package/dist/cli/commands/hook.js.map +1 -1
- package/dist/cli/commands/install.d.ts.map +1 -1
- package/dist/cli/commands/install.js +86 -7
- package/dist/cli/commands/install.js.map +1 -1
- package/dist/cli/commands/opencode-metrics.d.ts +13 -0
- package/dist/cli/commands/opencode-metrics.d.ts.map +1 -0
- package/dist/cli/commands/opencode-metrics.js +200 -0
- package/dist/cli/commands/opencode-metrics.js.map +1 -0
- package/dist/cli/commands/setup.d.ts.map +1 -1
- package/dist/cli/commands/setup.js +113 -0
- package/dist/cli/commands/setup.js.map +1 -1
- package/dist/cli/commands/skill.d.ts +6 -0
- package/dist/cli/commands/skill.d.ts.map +1 -0
- package/dist/cli/commands/skill.js +196 -0
- package/dist/cli/commands/skill.js.map +1 -0
- package/dist/cli/commands/update.d.ts.map +1 -1
- package/dist/cli/commands/update.js +34 -6
- package/dist/cli/commands/update.js.map +1 -1
- package/dist/cli/index.js +4 -0
- package/dist/cli/index.js.map +1 -1
- package/dist/migrations/003-remove-hooks-node.migration.d.ts +22 -0
- package/dist/migrations/003-remove-hooks-node.migration.d.ts.map +1 -0
- package/dist/migrations/003-remove-hooks-node.migration.js +103 -0
- package/dist/migrations/003-remove-hooks-node.migration.js.map +1 -0
- package/dist/migrations/index.d.ts +1 -0
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +1 -1
- package/dist/migrations/index.js.map +1 -1
- package/dist/providers/plugins/sso/session/processors/metrics/metrics-api-client.d.ts +3 -2
- package/dist/providers/plugins/sso/session/processors/metrics/metrics-api-client.d.ts.map +1 -1
- package/dist/providers/plugins/sso/session/processors/metrics/metrics-api-client.js +6 -2
- package/dist/providers/plugins/sso/session/processors/metrics/metrics-api-client.js.map +1 -1
- package/dist/providers/plugins/sso/sso.http-client.js +2 -2
- package/dist/providers/plugins/sso/sso.http-client.js.map +1 -1
- package/dist/providers/plugins/sso/sso.setup-steps.d.ts.map +1 -1
- package/dist/providers/plugins/sso/sso.setup-steps.js +14 -10
- package/dist/providers/plugins/sso/sso.setup-steps.js.map +1 -1
- package/dist/skills/core/SkillDiscovery.d.ts +83 -0
- package/dist/skills/core/SkillDiscovery.d.ts.map +1 -0
- package/dist/skills/core/SkillDiscovery.js +237 -0
- package/dist/skills/core/SkillDiscovery.js.map +1 -0
- package/dist/skills/core/SkillManager.d.ts +86 -0
- package/dist/skills/core/SkillManager.d.ts.map +1 -0
- package/dist/skills/core/SkillManager.js +155 -0
- package/dist/skills/core/SkillManager.js.map +1 -0
- package/dist/skills/core/types.d.ts +120 -0
- package/dist/skills/core/types.d.ts.map +1 -0
- package/dist/skills/core/types.js +20 -0
- package/dist/skills/core/types.js.map +1 -0
- package/dist/skills/index.d.ts +12 -0
- package/dist/skills/index.d.ts.map +1 -0
- package/dist/skills/index.js +12 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/skills/utils/content-loader.d.ts +25 -0
- package/dist/skills/utils/content-loader.d.ts.map +1 -0
- package/dist/skills/utils/content-loader.js +161 -0
- package/dist/skills/utils/content-loader.js.map +1 -0
- package/dist/skills/utils/frontmatter.d.ts +60 -0
- package/dist/skills/utils/frontmatter.d.ts.map +1 -0
- package/dist/skills/utils/frontmatter.js +114 -0
- package/dist/skills/utils/frontmatter.js.map +1 -0
- package/dist/skills/utils/pattern-matcher.d.ts +60 -0
- package/dist/skills/utils/pattern-matcher.d.ts.map +1 -0
- package/dist/skills/utils/pattern-matcher.js +97 -0
- package/dist/skills/utils/pattern-matcher.js.map +1 -0
- package/dist/utils/exec.d.ts.map +1 -1
- package/dist/utils/exec.js +11 -1
- package/dist/utils/exec.js.map +1 -1
- package/dist/utils/installation-detector.d.ts +22 -0
- package/dist/utils/installation-detector.d.ts.map +1 -0
- package/dist/utils/installation-detector.js +49 -0
- package/dist/utils/installation-detector.js.map +1 -0
- package/dist/utils/native-installer.d.ts +49 -0
- package/dist/utils/native-installer.d.ts.map +1 -0
- package/dist/utils/native-installer.js +194 -0
- package/dist/utils/native-installer.js.map +1 -0
- package/dist/utils/version-utils.d.ts +50 -0
- package/dist/utils/version-utils.d.ts.map +1 -0
- package/dist/utils/version-utils.js +92 -0
- package/dist/utils/version-utils.js.map +1 -0
- package/package.json +5 -2
- package/scripts/copy-mr-skill-to-global.ts +252 -0
- package/scripts/demo-hooks.sh +125 -0
- package/scripts/test-hooks.sh +196 -0
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/INDEX.md +0 -205
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/TEMPLATE_SIZES.md +0 -74
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/layered-architecture.md.template +0 -143
- package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/project-structure.md.template +0 -127
|
@@ -1,205 +0,0 @@
|
|
|
1
|
-
# Template Index
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Concise templates for generating Claude Code documentation. Each template is **150-250 lines max**, focusing on contracts and best practices.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Main Template
|
|
10
|
-
|
|
11
|
-
### CLAUDE.md.template
|
|
12
|
-
**Lines**: ~300
|
|
13
|
-
**Purpose**: Main AI-optimized execution guide
|
|
14
|
-
**Use**: Every project (required)
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## Guide Templates (10 Total)
|
|
19
|
-
|
|
20
|
-
### Required (P0) - For All Projects
|
|
21
|
-
|
|
22
|
-
#### development/development-practices.md.template
|
|
23
|
-
**Lines**: ~180
|
|
24
|
-
**Covers**: Error handling, logging, configuration, setup
|
|
25
|
-
**Use**: All projects
|
|
26
|
-
**Combines**: Error patterns + logging + config + setup in one file
|
|
27
|
-
|
|
28
|
-
#### security/security-practices.md.template
|
|
29
|
-
**Lines**: ~160
|
|
30
|
-
**Covers**: Auth, authorization, validation, secrets, SQL injection, XSS
|
|
31
|
-
**Use**: All projects
|
|
32
|
-
|
|
33
|
-
#### testing/testing-patterns.md.template
|
|
34
|
-
**Lines**: ~125
|
|
35
|
-
**Covers**: Unit tests, integration tests, fixtures, mocking
|
|
36
|
-
**Use**: All projects
|
|
37
|
-
|
|
38
|
-
#### standards/code-quality.md.template
|
|
39
|
-
**Lines**: ~135
|
|
40
|
-
**Covers**: Linting, formatting, type safety, naming
|
|
41
|
-
**Use**: All projects
|
|
42
|
-
|
|
43
|
-
#### standards/git-workflow.md.template
|
|
44
|
-
**Lines**: ~160
|
|
45
|
-
**Covers**: Branching, commits, PRs, code review
|
|
46
|
-
**Use**: All projects
|
|
47
|
-
|
|
48
|
-
---
|
|
49
|
-
|
|
50
|
-
### Recommended (P1) - Based on Project Type
|
|
51
|
-
|
|
52
|
-
#### api/api-patterns.md.template
|
|
53
|
-
**Lines**: ~190
|
|
54
|
-
**Covers**: CRUD, validation, auth, pagination, errors, rate limiting
|
|
55
|
-
**Use**: Projects with REST/GraphQL APIs
|
|
56
|
-
|
|
57
|
-
#### architecture/layered-architecture.md.template
|
|
58
|
-
**Lines**: ~125
|
|
59
|
-
**Covers**: Layer responsibilities, communication, error flow, testing
|
|
60
|
-
**Use**: Projects with layered architecture
|
|
61
|
-
|
|
62
|
-
#### architecture/project-structure.md.template
|
|
63
|
-
**Lines**: ~110
|
|
64
|
-
**Covers**: Directory layout, module organization, navigation
|
|
65
|
-
**Use**: For better code navigation (optional)
|
|
66
|
-
|
|
67
|
-
#### data/database-patterns.md.template
|
|
68
|
-
**Lines**: ~160
|
|
69
|
-
**Covers**: Models, CRUD, transactions, migrations, N+1 prevention
|
|
70
|
-
**Use**: Projects using databases
|
|
71
|
-
|
|
72
|
-
#### integration/external-integrations.md.template
|
|
73
|
-
**Lines**: ~145
|
|
74
|
-
**Covers**: API clients, auth, retries, rate limiting, error handling
|
|
75
|
-
**Use**: Projects with external API integrations
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## Template Size Guide
|
|
80
|
-
|
|
81
|
-
**Target**: 150-250 lines per template
|
|
82
|
-
**Philosophy**: Concise, focused, efficient
|
|
83
|
-
**Content**: Best practices and contracts, minimal code examples
|
|
84
|
-
|
|
85
|
-
### Size Breakdown
|
|
86
|
-
|
|
87
|
-
| Template | Lines | Type |
|
|
88
|
-
|----------|-------|------|
|
|
89
|
-
| CLAUDE.md | ~300 | Main |
|
|
90
|
-
| development-practices | ~180 | Required |
|
|
91
|
-
| security-practices | ~160 | Required |
|
|
92
|
-
| testing-patterns | ~125 | Required |
|
|
93
|
-
| code-quality | ~135 | Required |
|
|
94
|
-
| git-workflow | ~160 | Required |
|
|
95
|
-
| api-patterns | ~190 | Optional |
|
|
96
|
-
| layered-architecture | ~125 | Optional |
|
|
97
|
-
| project-structure | ~110 | Optional |
|
|
98
|
-
| database-patterns | ~160 | Optional |
|
|
99
|
-
| external-integrations | ~145 | Optional |
|
|
100
|
-
|
|
101
|
-
**Total**: ~1,790 lines for all templates
|
|
102
|
-
**Generated docs**: 200-400 lines per guide (target)
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
## Template Selection
|
|
107
|
-
|
|
108
|
-
### Decision Matrix
|
|
109
|
-
|
|
110
|
-
| Found in Project | Required Template | Optional Template |
|
|
111
|
-
|------------------|------------------|-------------------|
|
|
112
|
-
| **Always** | development-practices, security-practices, testing-patterns, code-quality, git-workflow | - |
|
|
113
|
-
| REST/GraphQL endpoints | - | api-patterns |
|
|
114
|
-
| Layered architecture | - | layered-architecture, project-structure |
|
|
115
|
-
| Database/ORM | - | database-patterns |
|
|
116
|
-
| External APIs | - | external-integrations |
|
|
117
|
-
|
|
118
|
-
### Quick Selection
|
|
119
|
-
|
|
120
|
-
**Minimal (5 guides)**:
|
|
121
|
-
- development-practices
|
|
122
|
-
- security-practices
|
|
123
|
-
- testing-patterns
|
|
124
|
-
- code-quality
|
|
125
|
-
- git-workflow
|
|
126
|
-
|
|
127
|
-
**Standard Web App (8 guides)**:
|
|
128
|
-
- All minimal +
|
|
129
|
-
- api-patterns
|
|
130
|
-
- layered-architecture
|
|
131
|
-
- database-patterns
|
|
132
|
-
|
|
133
|
-
**Full Stack (10 guides)**:
|
|
134
|
-
- All standard +
|
|
135
|
-
- project-structure
|
|
136
|
-
- external-integrations
|
|
137
|
-
|
|
138
|
-
---
|
|
139
|
-
|
|
140
|
-
## Placeholders
|
|
141
|
-
|
|
142
|
-
### Global (All Templates)
|
|
143
|
-
|
|
144
|
-
- `[PROJECT_NAME]` - Project name
|
|
145
|
-
- `[LANGUAGE]` - Programming language
|
|
146
|
-
- `[FRAMEWORK]` - Main framework
|
|
147
|
-
- `[file:lines]` - Source file reference
|
|
148
|
-
- `[code_example]` - Brief code snippet
|
|
149
|
-
- `# FILL IN` - Project-specific section
|
|
150
|
-
|
|
151
|
-
### Template-Specific
|
|
152
|
-
|
|
153
|
-
- `[DATABASE]` / `[ORM]` - Database patterns
|
|
154
|
-
- `[TEST_FRAMEWORK]` - Testing patterns
|
|
155
|
-
- `[LINTER]` / `[FORMATTER]` - Code quality
|
|
156
|
-
- `[AUTH_METHOD]` - Security/API patterns
|
|
157
|
-
|
|
158
|
-
---
|
|
159
|
-
|
|
160
|
-
## Usage
|
|
161
|
-
|
|
162
|
-
### For Claude Code Generation
|
|
163
|
-
|
|
164
|
-
1. Analyze project (tech stack, patterns)
|
|
165
|
-
2. Select templates (P0 + relevant P1)
|
|
166
|
-
3. For each template:
|
|
167
|
-
- Search codebase for patterns
|
|
168
|
-
- Extract concise examples (< 20 lines)
|
|
169
|
-
- Replace placeholders
|
|
170
|
-
- Fill sections
|
|
171
|
-
4. Generate CLAUDE.md last
|
|
172
|
-
5. **Validate**: Each guide 200-400 lines max
|
|
173
|
-
|
|
174
|
-
### For Manual Use
|
|
175
|
-
|
|
176
|
-
1. Copy template
|
|
177
|
-
2. Replace `[PLACEHOLDERS]`
|
|
178
|
-
3. Fill `# FILL IN` sections
|
|
179
|
-
4. Add brief code examples
|
|
180
|
-
5. Keep concise (200-400 lines)
|
|
181
|
-
|
|
182
|
-
---
|
|
183
|
-
|
|
184
|
-
## Version History
|
|
185
|
-
|
|
186
|
-
### v2.0 (2026-01-14)
|
|
187
|
-
- **Major revision**: Condensed all templates
|
|
188
|
-
- Combined development folder into single file
|
|
189
|
-
- Moved security to separate folder
|
|
190
|
-
- Reduced from 14 to 10 templates
|
|
191
|
-
- Target: 150-250 lines per template
|
|
192
|
-
- Focus: Contracts and best practices, not extensive examples
|
|
193
|
-
|
|
194
|
-
### v1.0 (2026-01-14)
|
|
195
|
-
- Initial release (deprecated)
|
|
196
|
-
|
|
197
|
-
---
|
|
198
|
-
|
|
199
|
-
## References
|
|
200
|
-
|
|
201
|
-
- **Generation Command**: `../codemie-init-skill.md`
|
|
202
|
-
- **README**: `../README.md`
|
|
203
|
-
- **Source**: CodeMie project patterns
|
|
204
|
-
|
|
205
|
-
---
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
# Template Size Report
|
|
2
|
-
|
|
3
|
-
**Generated**: 2026-01-14
|
|
4
|
-
**Version**: 2.0
|
|
5
|
-
|
|
6
|
-
## Summary
|
|
7
|
-
|
|
8
|
-
- **Total Templates**: 10 guide templates
|
|
9
|
-
- **Size Range**: 109-192 lines
|
|
10
|
-
- **Average**: 148 lines
|
|
11
|
-
- **Target Met**: ✅ All templates within 150-250 line goal (minor variance acceptable)
|
|
12
|
-
|
|
13
|
-
## Detailed Breakdown
|
|
14
|
-
|
|
15
|
-
| Template | Lines | Type | Status |
|
|
16
|
-
|----------|-------|------|--------|
|
|
17
|
-
| **api-patterns** | 189 | Optional | ✅ |
|
|
18
|
-
| **layered-architecture** | 125 | Optional | ✅ |
|
|
19
|
-
| **project-structure** | 109 | Optional | ✅ |
|
|
20
|
-
| **database-patterns** | 158 | Optional | ✅ |
|
|
21
|
-
| **development-practices** | 192 | **Required** | ✅ |
|
|
22
|
-
| **external-integrations** | 142 | Optional | ✅ |
|
|
23
|
-
| **security-practices** | 152 | **Required** | ✅ |
|
|
24
|
-
| **code-quality** | 132 | **Required** | ✅ |
|
|
25
|
-
| **git-workflow** | 159 | **Required** | ✅ |
|
|
26
|
-
| **testing-patterns** | 125 | **Required** | ✅ |
|
|
27
|
-
|
|
28
|
-
## By Category
|
|
29
|
-
|
|
30
|
-
### Required Templates (P0)
|
|
31
|
-
- development-practices: 192 lines
|
|
32
|
-
- security-practices: 152 lines
|
|
33
|
-
- testing-patterns: 125 lines
|
|
34
|
-
- code-quality: 132 lines
|
|
35
|
-
- git-workflow: 159 lines
|
|
36
|
-
**Total**: 760 lines
|
|
37
|
-
|
|
38
|
-
### Optional Templates (P1)
|
|
39
|
-
- api-patterns: 189 lines
|
|
40
|
-
- layered-architecture: 125 lines
|
|
41
|
-
- project-structure: 109 lines
|
|
42
|
-
- database-patterns: 158 lines
|
|
43
|
-
- external-integrations: 142 lines
|
|
44
|
-
**Total**: 723 lines
|
|
45
|
-
|
|
46
|
-
## Expected Generated Sizes
|
|
47
|
-
|
|
48
|
-
When filled with project-specific content:
|
|
49
|
-
|
|
50
|
-
**Per Guide**: 200-400 lines (1.5-2x template size)
|
|
51
|
-
- Template placeholders → Real code examples
|
|
52
|
-
- `# FILL IN` sections → Project-specific content
|
|
53
|
-
- Generic patterns → Actual file:line references
|
|
54
|
-
|
|
55
|
-
**Minimal Project** (5 required guides):
|
|
56
|
-
- Generated: ~1,200-2,000 lines total
|
|
57
|
-
|
|
58
|
-
**Standard Project** (8 guides):
|
|
59
|
-
- Generated: ~1,900-3,200 lines total
|
|
60
|
-
|
|
61
|
-
**Full Project** (10 guides):
|
|
62
|
-
- Generated: ~2,400-4,000 lines total
|
|
63
|
-
|
|
64
|
-
## Size Philosophy
|
|
65
|
-
|
|
66
|
-
**Concise but Complete**:
|
|
67
|
-
- Focus on contracts and patterns
|
|
68
|
-
- Brief code examples (< 20 lines)
|
|
69
|
-
- Essential best practices only
|
|
70
|
-
- No redundant explanations
|
|
71
|
-
- Highly scannable tables
|
|
72
|
-
|
|
73
|
-
**Target Achieved**: ✅
|
|
74
|
-
All templates meet the "concise, focused, efficient" goal.
|
|
@@ -1,143 +0,0 @@
|
|
|
1
|
-
# Layered Architecture
|
|
2
|
-
|
|
3
|
-
## Quick Summary
|
|
4
|
-
|
|
5
|
-
[PROJECT_NAME] implements [N]-tier architecture: [Layer1] → [Layer2] → [Layer3].
|
|
6
|
-
|
|
7
|
-
**Category**: Architecture
|
|
8
|
-
**Complexity**: Medium
|
|
9
|
-
**Prerequisites**: [LANGUAGE], [FRAMEWORK]
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## 🚨 SIZE LIMIT WARNING
|
|
14
|
-
|
|
15
|
-
**This generated guide MUST be 200-400 lines maximum.**
|
|
16
|
-
|
|
17
|
-
**When filling this template**:
|
|
18
|
-
- ✅ Code examples: 5-15 lines (NEVER > 20)
|
|
19
|
-
- ✅ ONE example per pattern
|
|
20
|
-
- ✅ Use file:line references, not full code
|
|
21
|
-
- ✅ Use tables for multiple patterns
|
|
22
|
-
- ❌ NO multiple examples for same pattern
|
|
23
|
-
- ❌ NO verbose explanations
|
|
24
|
-
- ❌ NO copying entire functions
|
|
25
|
-
|
|
26
|
-
**Validate line count after generation**: `wc -l [this-file]`
|
|
27
|
-
**If > 400 lines**: Condense immediately before continuing!
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Architecture Overview
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
┌─────────────────────────────────┐
|
|
35
|
-
│ [Layer 1] ([path/]) │ ← HTTP interface
|
|
36
|
-
│ Request/Response handling │
|
|
37
|
-
└────────────┬────────────────────┘
|
|
38
|
-
↓ calls
|
|
39
|
-
┌─────────────────────────────────┐
|
|
40
|
-
│ [Layer 2] ([path/]) │ ← Business logic
|
|
41
|
-
│ Orchestration │
|
|
42
|
-
└────────────┬────────────────────┘
|
|
43
|
-
↓ calls
|
|
44
|
-
┌─────────────────────────────────┐
|
|
45
|
-
│ [Layer 3] ([path/]) │ ← Data access
|
|
46
|
-
│ Persistence │
|
|
47
|
-
└────────────┬────────────────────┘
|
|
48
|
-
↓
|
|
49
|
-
[Database]
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
## Layer Responsibilities
|
|
55
|
-
|
|
56
|
-
### [Layer 1] - [Name]
|
|
57
|
-
|
|
58
|
-
**Purpose**: [Brief description]
|
|
59
|
-
|
|
60
|
-
```[language]
|
|
61
|
-
# Source: [file:lines]
|
|
62
|
-
[layer1_example]
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
**Does**: Validation, routing, response formatting
|
|
66
|
-
**Doesn't**: Business logic, database access
|
|
67
|
-
|
|
68
|
-
---
|
|
69
|
-
|
|
70
|
-
### [Layer 2] - [Name]
|
|
71
|
-
|
|
72
|
-
**Purpose**: [Brief description]
|
|
73
|
-
|
|
74
|
-
```[language]
|
|
75
|
-
# Source: [file:lines]
|
|
76
|
-
[layer2_example]
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
**Does**: Business logic, orchestration
|
|
80
|
-
**Doesn't**: HTTP handling, direct DB access
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
### [Layer 3] - [Name]
|
|
85
|
-
|
|
86
|
-
**Purpose**: [Brief description]
|
|
87
|
-
|
|
88
|
-
```[language]
|
|
89
|
-
# Source: [file:lines]
|
|
90
|
-
[layer3_example]
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
**Does**: Database queries, data access
|
|
94
|
-
**Doesn't**: Business logic, HTTP handling
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
## Communication Rules
|
|
99
|
-
|
|
100
|
-
| ✅ Allowed | ❌ Not Allowed |
|
|
101
|
-
|-----------|---------------|
|
|
102
|
-
| Layer1 → Layer2 → Layer3 | Skip layers |
|
|
103
|
-
| Pass data via models/DTOs | Share state |
|
|
104
|
-
| Async/await throughout | Blocking calls |
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Error Flow
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
[Layer3 Error]
|
|
112
|
-
↓ raise
|
|
113
|
-
[Layer2 Transform]
|
|
114
|
-
↓ raise
|
|
115
|
-
[Layer1 HTTP Response]
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
**Example**:
|
|
119
|
-
```[language]
|
|
120
|
-
# Source: [file:lines]
|
|
121
|
-
[error_flow_example]
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
---
|
|
125
|
-
|
|
126
|
-
## Testing Strategy
|
|
127
|
-
|
|
128
|
-
| Layer | Test Type | Mock |
|
|
129
|
-
|-------|-----------|------|
|
|
130
|
-
| [Layer1] | Unit | Layer2 |
|
|
131
|
-
| [Layer2] | Unit | Layer3 |
|
|
132
|
-
| [Layer3] | Unit | Database |
|
|
133
|
-
| All | Integration | Nothing |
|
|
134
|
-
|
|
135
|
-
---
|
|
136
|
-
|
|
137
|
-
## References
|
|
138
|
-
|
|
139
|
-
- **[Layer1]**: `[path/]`
|
|
140
|
-
- **[Layer2]**: `[path/]`
|
|
141
|
-
- **[Layer3]**: `[path/]`
|
|
142
|
-
|
|
143
|
-
---
|
|
@@ -1,127 +0,0 @@
|
|
|
1
|
-
# Project Structure
|
|
2
|
-
|
|
3
|
-
## Quick Summary
|
|
4
|
-
|
|
5
|
-
[PROJECT_NAME] directory layout and organization guide.
|
|
6
|
-
|
|
7
|
-
**Category**: Architecture
|
|
8
|
-
**Complexity**: Simple
|
|
9
|
-
**Prerequisites**: File system basics
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## 🚨 SIZE LIMIT WARNING
|
|
14
|
-
|
|
15
|
-
**This generated guide MUST be 200-400 lines maximum.**
|
|
16
|
-
|
|
17
|
-
**When filling this template**:
|
|
18
|
-
- ✅ Code examples: 5-15 lines (NEVER > 20)
|
|
19
|
-
- ✅ ONE example per pattern
|
|
20
|
-
- ✅ Use file:line references, not full code
|
|
21
|
-
- ✅ Use tables for multiple patterns
|
|
22
|
-
- ❌ NO multiple examples for same pattern
|
|
23
|
-
- ❌ NO verbose explanations
|
|
24
|
-
- ❌ NO copying entire functions
|
|
25
|
-
|
|
26
|
-
**Validate line count after generation**: `wc -l [this-file]`
|
|
27
|
-
**If > 400 lines**: Condense immediately before continuing!
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Directory Structure
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
[project-root]/
|
|
35
|
-
├── [src]/ Source code
|
|
36
|
-
├── [tests]/ Tests
|
|
37
|
-
├── [config]/ Configuration
|
|
38
|
-
├── [docs]/ Documentation
|
|
39
|
-
├── .gitignore
|
|
40
|
-
├── [build-config] Build/dependency file
|
|
41
|
-
└── README.md
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## Source Organization
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
[src]/
|
|
50
|
-
├── [layer1]/ [Layer 1 description]
|
|
51
|
-
│ └── [module]/
|
|
52
|
-
├── [layer2]/ [Layer 2 description]
|
|
53
|
-
│ └── [module]/
|
|
54
|
-
├── [layer3]/ [Layer 3 description]
|
|
55
|
-
│ └── [module]/
|
|
56
|
-
├── [shared]/ Common utilities
|
|
57
|
-
│ ├── exceptions
|
|
58
|
-
│ ├── constants
|
|
59
|
-
│ └── utils
|
|
60
|
-
└── [main] Entry point
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## Test Organization
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
[tests]/
|
|
69
|
-
├── unit/ Mirrors source structure
|
|
70
|
-
│ └── [module]/
|
|
71
|
-
│ └── test_[file]
|
|
72
|
-
├── integration/
|
|
73
|
-
│ └── test_[feature]
|
|
74
|
-
└── fixtures/
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## File Naming
|
|
80
|
-
|
|
81
|
-
| Type | Convention | Example |
|
|
82
|
-
|------|------------|---------|
|
|
83
|
-
| Modules | [convention] | `[example]` |
|
|
84
|
-
| Tests | [convention] | `test_[name]` |
|
|
85
|
-
| Config | [convention] | `[example]` |
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
## Module Boundaries
|
|
90
|
-
|
|
91
|
-
```
|
|
92
|
-
[Layer1] (Top)
|
|
93
|
-
↓
|
|
94
|
-
[Layer2] (Middle)
|
|
95
|
-
↓
|
|
96
|
-
[Layer3] (Bottom)
|
|
97
|
-
↓
|
|
98
|
-
[Shared/Core]
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
**Rules**:
|
|
102
|
-
- ✅ Upper → Lower
|
|
103
|
-
- ✅ All → Shared
|
|
104
|
-
- ❌ Lower → Upper
|
|
105
|
-
- ❌ Circular dependencies
|
|
106
|
-
|
|
107
|
-
---
|
|
108
|
-
|
|
109
|
-
## Finding Code
|
|
110
|
-
|
|
111
|
-
| Need | Location |
|
|
112
|
-
|------|----------|
|
|
113
|
-
| API endpoints | `[path]` |
|
|
114
|
-
| Business logic | `[path]` |
|
|
115
|
-
| Data models | `[path]` |
|
|
116
|
-
| Database | `[path]` |
|
|
117
|
-
| Exceptions | `[path]` |
|
|
118
|
-
| Config | `[path]` |
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
## References
|
|
123
|
-
|
|
124
|
-
- **Source**: `[src-directory]/`
|
|
125
|
-
- **Tests**: `[test-directory]/`
|
|
126
|
-
|
|
127
|
-
---
|