thought-cabinet 0.0.2
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 +15 -0
- package/README.md +145 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +2113 -0
- package/dist/index.js.map +1 -0
- package/package.json +58 -0
- package/src/agent-assets/agents/codebase-analyzer.md +147 -0
- package/src/agent-assets/agents/codebase-locator.md +126 -0
- package/src/agent-assets/agents/codebase-pattern-finder.md +241 -0
- package/src/agent-assets/agents/thoughts-analyzer.md +154 -0
- package/src/agent-assets/agents/thoughts-locator.md +122 -0
- package/src/agent-assets/agents/web-search-researcher.md +113 -0
- package/src/agent-assets/commands/commit.md +46 -0
- package/src/agent-assets/commands/create_plan.md +278 -0
- package/src/agent-assets/commands/implement_plan.md +91 -0
- package/src/agent-assets/commands/iterate_plan.md +254 -0
- package/src/agent-assets/commands/research_codebase.md +107 -0
- package/src/agent-assets/commands/validate_plan.md +178 -0
- package/src/agent-assets/settings.template.json +7 -0
- package/src/agent-assets/skills/generating-research-document/SKILL.md +41 -0
- package/src/agent-assets/skills/generating-research-document/document_template.md +97 -0
- package/src/agent-assets/skills/writing-plan/SKILL.md +162 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: writing-plan
|
|
3
|
+
description: Write implementation plan documents to thoughts/shared/plans/. Use when (1) creating a new implementation plan after research is complete, (2) writing technical specifications with phases and success criteria, (3) documenting planned changes with file paths and code snippets. Triggers on requests like "write the plan", "create the plan document", or after plan structure has been approved.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Write Implementation Plan
|
|
7
|
+
|
|
8
|
+
Write structured implementation plans to `thoughts/shared/plans/YYYY-MM-DD-description.md`.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. **Determine file path**: `thoughts/shared/plans/YYYY-MM-DD-description.md`
|
|
13
|
+
- YYYY-MM-DD: today's date
|
|
14
|
+
- description: brief kebab-case summary (e.g., `improve-error-handling`)
|
|
15
|
+
|
|
16
|
+
2. **Write plan** using the template structure below
|
|
17
|
+
|
|
18
|
+
3. **Sync thoughts directory**: Run `thoughtcabinet sync` after writing
|
|
19
|
+
|
|
20
|
+
## Plan Template
|
|
21
|
+
|
|
22
|
+
````markdown
|
|
23
|
+
# [Feature/Task Name] Implementation Plan
|
|
24
|
+
|
|
25
|
+
## Overview
|
|
26
|
+
|
|
27
|
+
[Brief description of what we're implementing and why]
|
|
28
|
+
|
|
29
|
+
## Current State Analysis
|
|
30
|
+
|
|
31
|
+
[What exists now, what's missing, key constraints discovered]
|
|
32
|
+
|
|
33
|
+
## Desired End State
|
|
34
|
+
|
|
35
|
+
[Specification of the desired end state and how to verify it]
|
|
36
|
+
|
|
37
|
+
### Key Discoveries:
|
|
38
|
+
|
|
39
|
+
- [Important finding with file:line reference]
|
|
40
|
+
- [Pattern to follow]
|
|
41
|
+
- [Constraint to work within]
|
|
42
|
+
|
|
43
|
+
## What We're NOT Doing
|
|
44
|
+
|
|
45
|
+
[Explicitly list out-of-scope items to prevent scope creep]
|
|
46
|
+
|
|
47
|
+
## Implementation Approach
|
|
48
|
+
|
|
49
|
+
[High-level strategy and reasoning]
|
|
50
|
+
|
|
51
|
+
## Phase 1: [Descriptive Name]
|
|
52
|
+
|
|
53
|
+
### Overview
|
|
54
|
+
|
|
55
|
+
[What this phase accomplishes]
|
|
56
|
+
|
|
57
|
+
### Changes Required:
|
|
58
|
+
|
|
59
|
+
#### 1. [Component/File Group]
|
|
60
|
+
|
|
61
|
+
**File**: `path/to/file.ext`
|
|
62
|
+
**Changes**: [Summary of changes]
|
|
63
|
+
|
|
64
|
+
```[language]
|
|
65
|
+
// Specific code to add/modify
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Success Criteria:
|
|
69
|
+
|
|
70
|
+
#### Automated Verification:
|
|
71
|
+
|
|
72
|
+
- [ ] Migration applies cleanly: `make migrate`
|
|
73
|
+
- [ ] Unit tests pass: `make test`
|
|
74
|
+
- [ ] Type checking passes: `npm run typecheck`
|
|
75
|
+
- [ ] Linting passes: `make lint`
|
|
76
|
+
|
|
77
|
+
#### Manual Verification:
|
|
78
|
+
|
|
79
|
+
- [ ] Feature works as expected when tested via UI
|
|
80
|
+
- [ ] Performance is acceptable
|
|
81
|
+
- [ ] No regressions in related features
|
|
82
|
+
|
|
83
|
+
**Implementation Note**: After completing this phase and all automated verification passes, pause for manual confirmation before proceeding to the next phase.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Phase 2: [Descriptive Name]
|
|
88
|
+
|
|
89
|
+
[Similar structure...]
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Testing Strategy
|
|
94
|
+
|
|
95
|
+
### Unit Tests:
|
|
96
|
+
|
|
97
|
+
- [What to test]
|
|
98
|
+
- [Key edge cases]
|
|
99
|
+
|
|
100
|
+
### Integration Tests:
|
|
101
|
+
|
|
102
|
+
- [End-to-end scenarios]
|
|
103
|
+
|
|
104
|
+
### Manual Testing Steps:
|
|
105
|
+
|
|
106
|
+
1. [Specific verification step]
|
|
107
|
+
2. [Edge case to test manually]
|
|
108
|
+
|
|
109
|
+
## Performance Considerations
|
|
110
|
+
|
|
111
|
+
[Any performance implications or optimizations needed]
|
|
112
|
+
|
|
113
|
+
## Migration Notes
|
|
114
|
+
|
|
115
|
+
[If applicable, how to handle existing data/systems]
|
|
116
|
+
|
|
117
|
+
## References
|
|
118
|
+
|
|
119
|
+
- Related research: `thoughts/shared/research/[relevant].md`
|
|
120
|
+
- Similar implementation: `[file:line]`
|
|
121
|
+
````
|
|
122
|
+
|
|
123
|
+
## Success Criteria Guidelines
|
|
124
|
+
|
|
125
|
+
Always separate into two categories:
|
|
126
|
+
|
|
127
|
+
**Automated Verification** (commands agents can run):
|
|
128
|
+
|
|
129
|
+
- Build/compile commands
|
|
130
|
+
- Test suites
|
|
131
|
+
- Type checking
|
|
132
|
+
- Linting
|
|
133
|
+
|
|
134
|
+
**Manual Verification** (requires human):
|
|
135
|
+
|
|
136
|
+
- UI/UX functionality
|
|
137
|
+
- Performance under real conditions
|
|
138
|
+
- User acceptance criteria
|
|
139
|
+
|
|
140
|
+
## Common Patterns
|
|
141
|
+
|
|
142
|
+
### Database Changes:
|
|
143
|
+
|
|
144
|
+
1. Schema/migration
|
|
145
|
+
2. Store methods
|
|
146
|
+
3. Business logic
|
|
147
|
+
4. API endpoints
|
|
148
|
+
5. Client updates
|
|
149
|
+
|
|
150
|
+
### New Features:
|
|
151
|
+
|
|
152
|
+
1. Data model
|
|
153
|
+
2. Backend logic
|
|
154
|
+
3. API endpoints
|
|
155
|
+
4. UI implementation
|
|
156
|
+
|
|
157
|
+
### Refactoring:
|
|
158
|
+
|
|
159
|
+
1. Document current behavior
|
|
160
|
+
2. Plan incremental changes
|
|
161
|
+
3. Maintain backwards compatibility
|
|
162
|
+
4. Include migration strategy
|