@mindfoldhq/trellis 0.5.0-beta.1 → 0.5.0-beta.11
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 +1 -1
- package/dist/commands/init.d.ts +10 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +384 -120
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +97 -41
- package/dist/commands/update.js.map +1 -1
- package/dist/configurators/index.d.ts.map +1 -1
- package/dist/configurators/index.js +10 -8
- package/dist/configurators/index.js.map +1 -1
- package/dist/configurators/opencode.d.ts +10 -3
- package/dist/configurators/opencode.d.ts.map +1 -1
- package/dist/configurators/opencode.js +58 -32
- package/dist/configurators/opencode.js.map +1 -1
- package/dist/configurators/qoder.d.ts +7 -6
- package/dist/configurators/qoder.d.ts.map +1 -1
- package/dist/configurators/qoder.js +17 -9
- package/dist/configurators/qoder.js.map +1 -1
- package/dist/configurators/shared.d.ts +3 -1
- package/dist/configurators/shared.d.ts.map +1 -1
- package/dist/configurators/shared.js +26 -3
- package/dist/configurators/shared.js.map +1 -1
- package/dist/migrations/manifests/0.5.0-beta.0.json +2 -0
- package/dist/migrations/manifests/0.5.0-beta.1.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.11.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.2.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.3.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.4.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.5.json +222 -0
- package/dist/migrations/manifests/0.5.0-beta.6.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.7.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.8.json +9 -0
- package/dist/migrations/manifests/0.5.0-beta.9.json +48 -0
- package/dist/templates/claude/agents/{check.md → trellis-check.md} +1 -2
- package/dist/templates/{cursor/agents/implement.md → claude/agents/trellis-implement.md} +1 -2
- package/dist/templates/{cursor/agents/research.md → claude/agents/trellis-research.md} +1 -2
- package/dist/templates/claude/settings.json +3 -0
- package/dist/templates/{cursor/agents/check.md → codebuddy/agents/trellis-check.md} +1 -2
- package/dist/templates/{claude/agents/implement.md → codebuddy/agents/trellis-implement.md} +1 -2
- package/dist/templates/{droid/droids/research.md → codebuddy/agents/trellis-research.md} +1 -2
- package/dist/templates/codex/agents/trellis-check.toml +38 -0
- package/dist/templates/codex/agents/{implement.toml → trellis-implement.toml} +1 -1
- package/dist/templates/codex/agents/{research.toml → trellis-research.toml} +1 -1
- package/dist/templates/codex/skills/start/SKILL.md +1 -1
- package/dist/templates/common/skills/brainstorm.md +47 -4
- package/dist/templates/copilot/prompts/start.prompt.md +13 -16
- package/dist/templates/{droid/droids/check.md → cursor/agents/trellis-check.md} +1 -2
- package/dist/templates/{codebuddy/agents/implement.md → cursor/agents/trellis-implement.md} +1 -2
- package/dist/templates/{claude/agents/research.md → cursor/agents/trellis-research.md} +1 -2
- package/dist/templates/{codebuddy/agents/check.md → droid/droids/trellis-check.md} +1 -2
- package/dist/templates/droid/droids/{implement.md → trellis-implement.md} +1 -2
- package/dist/templates/{codebuddy/agents/research.md → droid/droids/trellis-research.md} +1 -2
- package/dist/templates/gemini/agents/trellis-check.md +94 -0
- package/dist/templates/gemini/agents/trellis-implement.md +94 -0
- package/dist/templates/gemini/agents/trellis-research.md +137 -0
- package/dist/templates/kiro/agents/{check.json → trellis-check.json} +1 -1
- package/dist/templates/kiro/agents/{implement.json → trellis-implement.json} +1 -1
- package/dist/templates/kiro/agents/{research.json → trellis-research.json} +1 -1
- package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md.txt +24 -0
- package/dist/templates/opencode/plugins/inject-subagent-context.js +10 -8
- package/dist/templates/opencode/plugins/inject-workflow-state.js +27 -15
- package/dist/templates/opencode/plugins/session-start.js +5 -7
- package/dist/templates/qoder/agents/trellis-check.md +94 -0
- package/dist/templates/qoder/agents/trellis-implement.md +94 -0
- package/dist/templates/qoder/agents/trellis-research.md +137 -0
- package/dist/templates/shared-hooks/inject-subagent-context.py +4 -3
- package/dist/templates/shared-hooks/inject-workflow-state.py +21 -8
- package/dist/templates/shared-hooks/session-start.py +15 -4
- package/dist/templates/trellis/config.yaml +6 -0
- package/dist/templates/trellis/index.d.ts +0 -1
- package/dist/templates/trellis/index.d.ts.map +1 -1
- package/dist/templates/trellis/index.js +0 -2
- package/dist/templates/trellis/index.js.map +1 -1
- package/dist/templates/trellis/scripts/common/cli_adapter.py +29 -6
- package/dist/templates/trellis/scripts/common/task_context.py +20 -5
- package/dist/templates/trellis/scripts/common/types.py +0 -2
- package/dist/templates/trellis/scripts/task.py +7 -0
- package/dist/templates/trellis/workflow.md +15 -7
- package/dist/types/ai-tools.d.ts +9 -0
- package/dist/types/ai-tools.d.ts.map +1 -1
- package/dist/types/ai-tools.js +13 -0
- package/dist/types/ai-tools.js.map +1 -1
- package/dist/utils/project-detector.d.ts +2 -0
- package/dist/utils/project-detector.d.ts.map +1 -1
- package/dist/utils/project-detector.js +120 -11
- package/dist/utils/project-detector.js.map +1 -1
- package/dist/utils/task-json.d.ts +46 -0
- package/dist/utils/task-json.d.ts.map +1 -0
- package/dist/utils/task-json.js +49 -0
- package/dist/utils/task-json.js.map +1 -0
- package/package.json +4 -4
- package/dist/templates/codex/agents/check.toml +0 -23
- package/dist/templates/gemini/agents/check.md +0 -95
- package/dist/templates/gemini/agents/implement.md +0 -95
- package/dist/templates/gemini/agents/research.md +0 -138
- package/dist/templates/markdown/spec/backend/directory-structure.md +0 -292
- package/dist/templates/markdown/spec/backend/index.md +0 -40
- package/dist/templates/markdown/spec/backend/script-conventions.md +0 -742
- package/dist/templates/markdown/spec/guides/code-reuse-thinking-guide.md +0 -118
- package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md +0 -394
- package/dist/templates/qoder/agents/check.md +0 -95
- package/dist/templates/qoder/agents/implement.md +0 -95
- package/dist/templates/qoder/agents/research.md +0 -138
- package/dist/templates/trellis/scripts/create_bootstrap.py +0 -298
- /package/dist/templates/opencode/agents/{check.md → trellis-check.md} +0 -0
- /package/dist/templates/opencode/agents/{implement.md → trellis-implement.md} +0 -0
- /package/dist/templates/opencode/agents/{research.md → trellis-research.md} +0 -0
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# Code Reuse Thinking Guide
|
|
2
|
-
|
|
3
|
-
> **Purpose**: Stop and think before creating new code - does it already exist?
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## The Problem
|
|
8
|
-
|
|
9
|
-
**Duplicated code is the #1 source of inconsistency bugs.**
|
|
10
|
-
|
|
11
|
-
When you copy-paste or rewrite existing logic:
|
|
12
|
-
- Bug fixes don't propagate
|
|
13
|
-
- Behavior diverges over time
|
|
14
|
-
- Codebase becomes harder to understand
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## Before Writing New Code
|
|
19
|
-
|
|
20
|
-
### Step 1: Search First
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
# Search for similar function names
|
|
24
|
-
grep -r "functionName" .
|
|
25
|
-
|
|
26
|
-
# Search for similar logic
|
|
27
|
-
grep -r "keyword" .
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
### Step 2: Ask These Questions
|
|
31
|
-
|
|
32
|
-
| Question | If Yes... |
|
|
33
|
-
|----------|-----------|
|
|
34
|
-
| Does a similar function exist? | Use or extend it |
|
|
35
|
-
| Is this pattern used elsewhere? | Follow the existing pattern |
|
|
36
|
-
| Could this be a shared utility? | Create it in the right place |
|
|
37
|
-
| Am I copying code from another file? | **STOP** - extract to shared |
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## Common Duplication Patterns
|
|
42
|
-
|
|
43
|
-
### Pattern 1: Copy-Paste Functions
|
|
44
|
-
|
|
45
|
-
**Bad**: Copying a validation function to another file
|
|
46
|
-
|
|
47
|
-
**Good**: Extract to shared utilities, import where needed
|
|
48
|
-
|
|
49
|
-
### Pattern 2: Similar Components
|
|
50
|
-
|
|
51
|
-
**Bad**: Creating a new component that's 80% similar to existing
|
|
52
|
-
|
|
53
|
-
**Good**: Extend existing component with props/variants
|
|
54
|
-
|
|
55
|
-
### Pattern 3: Repeated Constants
|
|
56
|
-
|
|
57
|
-
**Bad**: Defining the same constant in multiple files
|
|
58
|
-
|
|
59
|
-
**Good**: Single source of truth, import everywhere
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## When to Abstract
|
|
64
|
-
|
|
65
|
-
**Abstract when**:
|
|
66
|
-
- Same code appears 3+ times
|
|
67
|
-
- Logic is complex enough to have bugs
|
|
68
|
-
- Multiple people might need this
|
|
69
|
-
|
|
70
|
-
**Don't abstract when**:
|
|
71
|
-
- Only used once
|
|
72
|
-
- Trivial one-liner
|
|
73
|
-
- Abstraction would be more complex than duplication
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## After Batch Modifications
|
|
78
|
-
|
|
79
|
-
When you've made similar changes to multiple files:
|
|
80
|
-
|
|
81
|
-
1. **Review**: Did you catch all instances?
|
|
82
|
-
2. **Search**: Run grep to find any missed
|
|
83
|
-
3. **Consider**: Should this be abstracted?
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Checklist Before Commit
|
|
88
|
-
|
|
89
|
-
- [ ] Searched for existing similar code
|
|
90
|
-
- [ ] No copy-pasted logic that should be shared
|
|
91
|
-
- [ ] Constants defined in one place
|
|
92
|
-
- [ ] Similar patterns follow same structure
|
|
93
|
-
|
|
94
|
-
---
|
|
95
|
-
|
|
96
|
-
## Template File Registration (Trellis-specific)
|
|
97
|
-
|
|
98
|
-
When adding new files to `src/templates/trellis/scripts/`:
|
|
99
|
-
|
|
100
|
-
**CRITICAL**: New script files must be registered in THREE places:
|
|
101
|
-
|
|
102
|
-
1. **`src/templates/trellis/index.ts`**:
|
|
103
|
-
- Add `export const xxxScript = readTemplate("scripts/path/file.py");`
|
|
104
|
-
- Add to `getAllScripts()` Map
|
|
105
|
-
|
|
106
|
-
2. **`src/commands/update.ts`**:
|
|
107
|
-
- Add to import statement
|
|
108
|
-
- Add to `collectTemplateFiles()` Map
|
|
109
|
-
|
|
110
|
-
**Why this matters**: Without registration, `trellis update` won't sync the file to user projects. Bug fixes and features won't propagate.
|
|
111
|
-
|
|
112
|
-
### Quick Checklist for New Scripts
|
|
113
|
-
|
|
114
|
-
```bash
|
|
115
|
-
# After adding a new .py file, verify:
|
|
116
|
-
grep -l "newFileName" src/templates/trellis/index.ts # Should match
|
|
117
|
-
grep -l "newFileName" src/commands/update.ts # Should match
|
|
118
|
-
```
|
|
@@ -1,394 +0,0 @@
|
|
|
1
|
-
# Cross-Platform Thinking Guide
|
|
2
|
-
|
|
3
|
-
> **Purpose**: Catch platform-specific assumptions before they become bugs.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Why This Matters
|
|
8
|
-
|
|
9
|
-
**Most cross-platform bugs come from implicit assumptions**:
|
|
10
|
-
|
|
11
|
-
- Assumed shebang works → breaks on Windows
|
|
12
|
-
- Assumed `/` path separator → breaks on Windows
|
|
13
|
-
- Assumed `\n` line endings → inconsistent behavior
|
|
14
|
-
- Assumed command availability → `grep` vs `findstr`
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## Platform Differences Checklist
|
|
19
|
-
|
|
20
|
-
### 1. Script Execution
|
|
21
|
-
|
|
22
|
-
| Assumption | macOS/Linux | Windows |
|
|
23
|
-
|------------|-------------|---------|
|
|
24
|
-
| Shebang (`#!/usr/bin/env python3`) | ✅ Works | ❌ Ignored |
|
|
25
|
-
| Direct execution (`./script.py`) | ✅ Works | ❌ Fails |
|
|
26
|
-
| `python3` command | ✅ Always available | ⚠️ May need `python` |
|
|
27
|
-
| `python` command | ⚠️ May be Python 2 | ✅ Usually Python 3 |
|
|
28
|
-
|
|
29
|
-
**Rule 1**: Always use explicit `python3` in documentation, help text, and error messages.
|
|
30
|
-
|
|
31
|
-
```python
|
|
32
|
-
# BAD - Assumes shebang works
|
|
33
|
-
print("Usage: ./script.py <args>")
|
|
34
|
-
print("Run: script.py <args>")
|
|
35
|
-
|
|
36
|
-
# GOOD - Explicit interpreter
|
|
37
|
-
print("Usage: python3 script.py <args>")
|
|
38
|
-
print("Run: python3 ./script.py <args>")
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**Rule 2**: When calling Python from TypeScript/Node.js, detect the available command:
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
function getPythonCommand(): string {
|
|
45
|
-
try {
|
|
46
|
-
execSync("python3 --version", { stdio: "pipe" });
|
|
47
|
-
return "python3";
|
|
48
|
-
} catch {
|
|
49
|
-
try {
|
|
50
|
-
execSync("python --version", { stdio: "pipe" });
|
|
51
|
-
return "python";
|
|
52
|
-
} catch {
|
|
53
|
-
return "python3"; // Default, will fail with clear error
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
**Rule 3**: When calling Python from Python, use `sys.executable`:
|
|
60
|
-
|
|
61
|
-
```python
|
|
62
|
-
import sys
|
|
63
|
-
import subprocess
|
|
64
|
-
|
|
65
|
-
# BAD - Hardcoded command
|
|
66
|
-
subprocess.run(["python3", "other_script.py"])
|
|
67
|
-
|
|
68
|
-
# GOOD - Use current interpreter
|
|
69
|
-
subprocess.run([sys.executable, "other_script.py"])
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### 2. Path Handling
|
|
73
|
-
|
|
74
|
-
| Assumption | macOS/Linux | Windows |
|
|
75
|
-
|------------|-------------|---------|
|
|
76
|
-
| `/` separator | ✅ Works | ⚠️ Sometimes works |
|
|
77
|
-
| `\` separator | ❌ Escape char | ✅ Native |
|
|
78
|
-
| `pathlib.Path` | ✅ Works | ✅ Works |
|
|
79
|
-
|
|
80
|
-
**Rule**: Use `pathlib.Path` for all path operations.
|
|
81
|
-
|
|
82
|
-
```python
|
|
83
|
-
# BAD - String concatenation
|
|
84
|
-
path = base + "/" + filename
|
|
85
|
-
|
|
86
|
-
# GOOD - pathlib
|
|
87
|
-
from pathlib import Path
|
|
88
|
-
path = Path(base) / filename
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### 3. Line Endings
|
|
92
|
-
|
|
93
|
-
| Format | macOS/Linux | Windows | Git |
|
|
94
|
-
|--------|-------------|---------|-----|
|
|
95
|
-
| `\n` (LF) | ✅ Native | ⚠️ Some tools | ✅ Normalized |
|
|
96
|
-
| `\r\n` (CRLF) | ⚠️ Extra char | ✅ Native | Converted |
|
|
97
|
-
|
|
98
|
-
**Rule**: Use `.gitattributes` to enforce consistent line endings.
|
|
99
|
-
|
|
100
|
-
```gitattributes
|
|
101
|
-
* text=auto eol=lf
|
|
102
|
-
*.sh text eol=lf
|
|
103
|
-
*.py text eol=lf
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### 4. Environment Variables
|
|
107
|
-
|
|
108
|
-
| Variable | macOS/Linux | Windows |
|
|
109
|
-
|----------|-------------|---------|
|
|
110
|
-
| `HOME` | ✅ Set | ❌ Use `USERPROFILE` |
|
|
111
|
-
| `PATH` separator | `:` | `;` |
|
|
112
|
-
| Case sensitivity | ✅ Case-sensitive | ❌ Case-insensitive |
|
|
113
|
-
|
|
114
|
-
**Rule**: Use `pathlib.Path.home()` instead of environment variables.
|
|
115
|
-
|
|
116
|
-
```python
|
|
117
|
-
# BAD
|
|
118
|
-
home = os.environ.get("HOME")
|
|
119
|
-
|
|
120
|
-
# GOOD
|
|
121
|
-
home = Path.home()
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### 5. Command Availability
|
|
125
|
-
|
|
126
|
-
| Command | macOS/Linux | Windows |
|
|
127
|
-
|---------|-------------|---------|
|
|
128
|
-
| `grep` | ✅ Built-in | ❌ Not available |
|
|
129
|
-
| `find` | ✅ Built-in | ⚠️ Different syntax |
|
|
130
|
-
| `cat` | ✅ Built-in | ❌ Use `type` |
|
|
131
|
-
| `tail -f` | ✅ Built-in | ❌ Not available |
|
|
132
|
-
|
|
133
|
-
**Rule**: Use Python standard library instead of shell commands when possible.
|
|
134
|
-
|
|
135
|
-
```python
|
|
136
|
-
# BAD - tail -f is not available on Windows
|
|
137
|
-
subprocess.run(["tail", "-f", log_file])
|
|
138
|
-
|
|
139
|
-
# GOOD - Cross-platform implementation
|
|
140
|
-
def tail_follow(file_path: Path) -> None:
|
|
141
|
-
"""Follow a file like 'tail -f', cross-platform compatible."""
|
|
142
|
-
with open(file_path, "r", encoding="utf-8", errors="replace") as f:
|
|
143
|
-
f.seek(0, 2) # Go to end
|
|
144
|
-
while True:
|
|
145
|
-
line = f.readline()
|
|
146
|
-
if line:
|
|
147
|
-
print(line, end="", flush=True)
|
|
148
|
-
else:
|
|
149
|
-
time.sleep(0.1)
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
### 6. File Encoding
|
|
153
|
-
|
|
154
|
-
| Default Encoding | macOS/Linux | Windows |
|
|
155
|
-
|------------------|-------------|---------|
|
|
156
|
-
| Terminal | UTF-8 | Often CP1252 or GBK |
|
|
157
|
-
| File I/O | UTF-8 | System locale |
|
|
158
|
-
| Git output | UTF-8 | May vary |
|
|
159
|
-
|
|
160
|
-
**Rule**: Always explicitly specify `encoding="utf-8"` and use `errors="replace"`.
|
|
161
|
-
|
|
162
|
-
> **Checklist**: When writing scripts that print non-ASCII, did you configure stdout encoding?
|
|
163
|
-
> See `backend/script-conventions.md` for the specific pattern.
|
|
164
|
-
|
|
165
|
-
```python
|
|
166
|
-
# BAD - Relies on system default
|
|
167
|
-
with open(file, "r") as f:
|
|
168
|
-
content = f.read()
|
|
169
|
-
|
|
170
|
-
result = subprocess.run(cmd, capture_output=True, text=True)
|
|
171
|
-
|
|
172
|
-
# GOOD - Explicit encoding with error handling
|
|
173
|
-
with open(file, "r", encoding="utf-8", errors="replace") as f:
|
|
174
|
-
content = f.read()
|
|
175
|
-
|
|
176
|
-
result = subprocess.run(
|
|
177
|
-
cmd,
|
|
178
|
-
capture_output=True,
|
|
179
|
-
text=True,
|
|
180
|
-
encoding="utf-8",
|
|
181
|
-
errors="replace"
|
|
182
|
-
)
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
**Git commands**: Force UTF-8 output encoding:
|
|
186
|
-
|
|
187
|
-
```python
|
|
188
|
-
# Force git to output UTF-8
|
|
189
|
-
git_args = ["git", "-c", "i18n.logOutputEncoding=UTF-8"] + args
|
|
190
|
-
result = subprocess.run(
|
|
191
|
-
git_args,
|
|
192
|
-
capture_output=True,
|
|
193
|
-
text=True,
|
|
194
|
-
encoding="utf-8",
|
|
195
|
-
errors="replace"
|
|
196
|
-
)
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
---
|
|
200
|
-
|
|
201
|
-
## Change Propagation Checklist
|
|
202
|
-
|
|
203
|
-
When making platform-related changes, check **all these locations**:
|
|
204
|
-
|
|
205
|
-
### Documentation & Help Text
|
|
206
|
-
- [ ] Docstrings at top of Python files
|
|
207
|
-
- [ ] `--help` output / argparse descriptions
|
|
208
|
-
- [ ] Usage examples in README
|
|
209
|
-
- [ ] Error messages that suggest commands
|
|
210
|
-
- [ ] Markdown documentation (`.md` files)
|
|
211
|
-
|
|
212
|
-
### Code Locations
|
|
213
|
-
- [ ] `src/templates/` - Template files for new projects
|
|
214
|
-
- [ ] `.trellis/scripts/` - Project's own scripts (if self-hosting)
|
|
215
|
-
- [ ] `dist/` - Built output (rebuild after changes)
|
|
216
|
-
|
|
217
|
-
### Search Pattern
|
|
218
|
-
```bash
|
|
219
|
-
# Find all places that might need updating
|
|
220
|
-
grep -r "python [a-z]" --include="*.py" --include="*.md"
|
|
221
|
-
grep -r "\./" --include="*.py" --include="*.md" | grep -v python3
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
---
|
|
225
|
-
|
|
226
|
-
## Pre-Commit Checklist
|
|
227
|
-
|
|
228
|
-
Before committing cross-platform code:
|
|
229
|
-
|
|
230
|
-
- [ ] All Python invocations use `python3` explicitly (docs) or `sys.executable` (code)
|
|
231
|
-
- [ ] All paths use `pathlib.Path`
|
|
232
|
-
- [ ] No hardcoded path separators (`/` or `\`)
|
|
233
|
-
- [ ] No platform-specific commands without fallbacks (e.g., `tail -f`)
|
|
234
|
-
- [ ] All file I/O specifies `encoding="utf-8"` and `errors="replace"`
|
|
235
|
-
- [ ] All subprocess calls specify `encoding="utf-8"` and `errors="replace"`
|
|
236
|
-
- [ ] Git commands use `-c i18n.logOutputEncoding=UTF-8`
|
|
237
|
-
- [ ] External tool API formats verified from documentation
|
|
238
|
-
- [ ] Documentation matches code behavior
|
|
239
|
-
- [ ] Ran search to find all affected locations
|
|
240
|
-
|
|
241
|
-
### 7. External Tool API Contracts
|
|
242
|
-
|
|
243
|
-
When integrating with external tools (Claude Code, Cursor, etc.), their API contracts are **implicit assumptions**.
|
|
244
|
-
|
|
245
|
-
**Rule**: Verify API formats from official documentation, don't guess.
|
|
246
|
-
|
|
247
|
-
```python
|
|
248
|
-
# BAD - Guessed format
|
|
249
|
-
output = {"continue": True, "message": "..."}
|
|
250
|
-
|
|
251
|
-
# GOOD - Verified format from documentation
|
|
252
|
-
output = {
|
|
253
|
-
"hookSpecificOutput": {
|
|
254
|
-
"hookEventName": "SessionStart",
|
|
255
|
-
"additionalContext": "..."
|
|
256
|
-
}
|
|
257
|
-
}
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
> **Warning**: Different hook types may have different output formats.
|
|
261
|
-
> Always check the specific documentation for each hook event.
|
|
262
|
-
|
|
263
|
-
---
|
|
264
|
-
|
|
265
|
-
## JSON/External Data Defensive Checks
|
|
266
|
-
|
|
267
|
-
When parsing JSON or external data, TypeScript types are **compile-time only**. Runtime data may not match.
|
|
268
|
-
|
|
269
|
-
**Rule**: Always add defensive checks for required fields before using them.
|
|
270
|
-
|
|
271
|
-
```typescript
|
|
272
|
-
// BAD - Trusts TypeScript type definition
|
|
273
|
-
interface MigrationItem {
|
|
274
|
-
from: string; // TypeScript says required
|
|
275
|
-
to?: string;
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
function process(item: MigrationItem) {
|
|
279
|
-
const path = item.from; // Runtime: could be undefined!
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
// GOOD - Defensive check before use
|
|
283
|
-
function process(item: MigrationItem) {
|
|
284
|
-
if (!item.from) return; // Skip invalid data
|
|
285
|
-
const path = item.from; // Now guaranteed
|
|
286
|
-
}
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
**When to apply**:
|
|
290
|
-
- Parsing JSON files (manifests, configs)
|
|
291
|
-
- API responses
|
|
292
|
-
- User input
|
|
293
|
-
- Any data from external sources
|
|
294
|
-
|
|
295
|
-
**Pattern**: Check existence → then use
|
|
296
|
-
|
|
297
|
-
```typescript
|
|
298
|
-
// Filter pattern - skip invalid items
|
|
299
|
-
const validItems = items.filter(item => item.from && item.to);
|
|
300
|
-
|
|
301
|
-
// Early return pattern - bail on invalid
|
|
302
|
-
if (!data.requiredField) {
|
|
303
|
-
console.warn("Missing required field");
|
|
304
|
-
return defaultValue;
|
|
305
|
-
}
|
|
306
|
-
```
|
|
307
|
-
|
|
308
|
-
---
|
|
309
|
-
|
|
310
|
-
## Common Mistakes
|
|
311
|
-
|
|
312
|
-
### 1. "It works on my Mac"
|
|
313
|
-
|
|
314
|
-
```python
|
|
315
|
-
# Developer's Mac
|
|
316
|
-
subprocess.run(["./script.py"]) # Works!
|
|
317
|
-
|
|
318
|
-
# User's Windows
|
|
319
|
-
subprocess.run(["./script.py"]) # FileNotFoundError
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
### 2. "The shebang should handle it"
|
|
323
|
-
|
|
324
|
-
```python
|
|
325
|
-
#!/usr/bin/env python3
|
|
326
|
-
# This line is IGNORED on Windows
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
### 3. "I updated the template"
|
|
330
|
-
|
|
331
|
-
```
|
|
332
|
-
src/templates/script.py ← Updated
|
|
333
|
-
.trellis/scripts/script.py ← Forgot to sync!
|
|
334
|
-
```
|
|
335
|
-
|
|
336
|
-
### 4. "Python 3 is always python3"
|
|
337
|
-
|
|
338
|
-
```bash
|
|
339
|
-
# Developer's Mac/Linux
|
|
340
|
-
python3 script.py # Works!
|
|
341
|
-
|
|
342
|
-
# User's Windows (Python from python.org)
|
|
343
|
-
python3 script.py # 'python3' is not recognized
|
|
344
|
-
python script.py # Works!
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
### 5. "UTF-8 is the default everywhere"
|
|
348
|
-
|
|
349
|
-
```python
|
|
350
|
-
# Developer's Mac (UTF-8 default)
|
|
351
|
-
subprocess.run(cmd, capture_output=True, text=True) # Works!
|
|
352
|
-
|
|
353
|
-
# User's Windows (GBK/CP1252 default)
|
|
354
|
-
subprocess.run(cmd, capture_output=True, text=True) # Garbled Chinese/Unicode
|
|
355
|
-
```
|
|
356
|
-
|
|
357
|
-
> **Note**: stdout encoding is also affected. See `backend/script-conventions.md` for the fix.
|
|
358
|
-
|
|
359
|
-
---
|
|
360
|
-
|
|
361
|
-
## Recovery: When You Find a Platform Bug
|
|
362
|
-
|
|
363
|
-
1. **Fix the immediate issue**
|
|
364
|
-
2. **Search for similar patterns** (grep the codebase)
|
|
365
|
-
3. **Update this guide** with the new pattern
|
|
366
|
-
4. **Add to pre-commit checklist** if recurring
|
|
367
|
-
|
|
368
|
-
---
|
|
369
|
-
|
|
370
|
-
**Core Principle**: If it's not explicit, it's an assumption. And assumptions break.
|
|
371
|
-
|
|
372
|
-
---
|
|
373
|
-
|
|
374
|
-
## Release Checklist: Versioned Files
|
|
375
|
-
|
|
376
|
-
When releasing a new version, ensure **all versioned files** are created/updated:
|
|
377
|
-
|
|
378
|
-
- [ ] `src/migrations/manifests/{version}.json` - Migration manifest exists
|
|
379
|
-
- [ ] Manifest has correct version, description, changelog
|
|
380
|
-
- [ ] `pnpm build` copies manifests to `dist/`
|
|
381
|
-
- [ ] Test upgrade path from older versions (not just adjacent)
|
|
382
|
-
|
|
383
|
-
**Why this matters**: Missing manifests cause "path undefined" errors when users upgrade from older versions.
|
|
384
|
-
|
|
385
|
-
```bash
|
|
386
|
-
# Verify all expected manifests exist
|
|
387
|
-
ls src/migrations/manifests/
|
|
388
|
-
|
|
389
|
-
# Test upgrade path
|
|
390
|
-
node -e "
|
|
391
|
-
const { getMigrationsForVersion } = require('./dist/migrations/index.js');
|
|
392
|
-
console.log('From 0.2.12:', getMigrationsForVersion('0.2.12', 'CURRENT').length);
|
|
393
|
-
"
|
|
394
|
-
```
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: check
|
|
3
|
-
description: |
|
|
4
|
-
Code quality check expert. Reviews code changes against specs and self-fixes issues.
|
|
5
|
-
tools: Read, Write, Edit, Bash, Glob, Grep, mcp__exa__web_search_exa, mcp__exa__get_code_context_exa
|
|
6
|
-
model: opus
|
|
7
|
-
---
|
|
8
|
-
# Check Agent
|
|
9
|
-
|
|
10
|
-
You are the Check Agent in the Trellis workflow.
|
|
11
|
-
|
|
12
|
-
## Context
|
|
13
|
-
|
|
14
|
-
Before checking, read:
|
|
15
|
-
- `.trellis/spec/` - Development guidelines
|
|
16
|
-
- Pre-commit checklist for quality standards
|
|
17
|
-
|
|
18
|
-
## Core Responsibilities
|
|
19
|
-
|
|
20
|
-
1. **Get code changes** - Use git diff to get uncommitted code
|
|
21
|
-
2. **Check against specs** - Verify code follows guidelines
|
|
22
|
-
3. **Self-fix** - Fix issues yourself, not just report them
|
|
23
|
-
4. **Run verification** - typecheck and lint
|
|
24
|
-
|
|
25
|
-
## Important
|
|
26
|
-
|
|
27
|
-
**Fix issues yourself**, don't just report them.
|
|
28
|
-
|
|
29
|
-
You have write and edit tools, you can modify code directly.
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## Workflow
|
|
34
|
-
|
|
35
|
-
### Step 1: Get Changes
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
git diff --name-only # List changed files
|
|
39
|
-
git diff # View specific changes
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Step 2: Check Against Specs
|
|
43
|
-
|
|
44
|
-
Read relevant specs in `.trellis/spec/` to check code:
|
|
45
|
-
|
|
46
|
-
- Does it follow directory structure conventions
|
|
47
|
-
- Does it follow naming conventions
|
|
48
|
-
- Does it follow code patterns
|
|
49
|
-
- Are there missing types
|
|
50
|
-
- Are there potential bugs
|
|
51
|
-
|
|
52
|
-
### Step 3: Self-Fix
|
|
53
|
-
|
|
54
|
-
After finding issues:
|
|
55
|
-
|
|
56
|
-
1. Fix the issue directly (use edit tool)
|
|
57
|
-
2. Record what was fixed
|
|
58
|
-
3. Continue checking other issues
|
|
59
|
-
|
|
60
|
-
### Step 4: Run Verification
|
|
61
|
-
|
|
62
|
-
Run project's lint and typecheck commands to verify changes.
|
|
63
|
-
|
|
64
|
-
If failed, fix issues and re-run.
|
|
65
|
-
|
|
66
|
-
---
|
|
67
|
-
|
|
68
|
-
## Report Format
|
|
69
|
-
|
|
70
|
-
```markdown
|
|
71
|
-
## Self-Check Complete
|
|
72
|
-
|
|
73
|
-
### Files Checked
|
|
74
|
-
|
|
75
|
-
- src/components/Feature.tsx
|
|
76
|
-
- src/hooks/useFeature.ts
|
|
77
|
-
|
|
78
|
-
### Issues Found and Fixed
|
|
79
|
-
|
|
80
|
-
1. `<file>:<line>` - <what was fixed>
|
|
81
|
-
2. `<file>:<line>` - <what was fixed>
|
|
82
|
-
|
|
83
|
-
### Issues Not Fixed
|
|
84
|
-
|
|
85
|
-
(If there are issues that cannot be self-fixed, list them here with reasons)
|
|
86
|
-
|
|
87
|
-
### Verification Results
|
|
88
|
-
|
|
89
|
-
- TypeCheck: Passed
|
|
90
|
-
- Lint: Passed
|
|
91
|
-
|
|
92
|
-
### Summary
|
|
93
|
-
|
|
94
|
-
Checked X files, found Y issues, all fixed.
|
|
95
|
-
```
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: implement
|
|
3
|
-
description: |
|
|
4
|
-
Code implementation expert. Understands specs and requirements, then implements features. No git commit allowed.
|
|
5
|
-
tools: Read, Write, Edit, Bash, Glob, Grep, mcp__exa__web_search_exa, mcp__exa__get_code_context_exa
|
|
6
|
-
model: opus
|
|
7
|
-
---
|
|
8
|
-
# Implement Agent
|
|
9
|
-
|
|
10
|
-
You are the Implement Agent in the Trellis workflow.
|
|
11
|
-
|
|
12
|
-
## Context
|
|
13
|
-
|
|
14
|
-
Before implementing, read:
|
|
15
|
-
- `.trellis/workflow.md` - Project workflow
|
|
16
|
-
- `.trellis/spec/` - Development guidelines
|
|
17
|
-
- Task `prd.md` - Requirements document
|
|
18
|
-
- Task `info.md` - Technical design (if exists)
|
|
19
|
-
|
|
20
|
-
## Core Responsibilities
|
|
21
|
-
|
|
22
|
-
1. **Understand specs** - Read relevant spec files in `.trellis/spec/`
|
|
23
|
-
2. **Understand requirements** - Read prd.md and info.md
|
|
24
|
-
3. **Implement features** - Write code following specs and design
|
|
25
|
-
4. **Self-check** - Ensure code quality
|
|
26
|
-
5. **Report results** - Report completion status
|
|
27
|
-
|
|
28
|
-
## Forbidden Operations
|
|
29
|
-
|
|
30
|
-
**Do NOT execute these git commands:**
|
|
31
|
-
|
|
32
|
-
- `git commit`
|
|
33
|
-
- `git push`
|
|
34
|
-
- `git merge`
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## Workflow
|
|
39
|
-
|
|
40
|
-
### 1. Understand Specs
|
|
41
|
-
|
|
42
|
-
Read relevant specs based on task type:
|
|
43
|
-
|
|
44
|
-
- Spec layers: `.trellis/spec/<package>/<layer>/`
|
|
45
|
-
- Shared guides: `.trellis/spec/guides/`
|
|
46
|
-
|
|
47
|
-
### 2. Understand Requirements
|
|
48
|
-
|
|
49
|
-
Read the task's prd.md and info.md:
|
|
50
|
-
|
|
51
|
-
- What are the core requirements
|
|
52
|
-
- Key points of technical design
|
|
53
|
-
- Which files to modify/create
|
|
54
|
-
|
|
55
|
-
### 3. Implement Features
|
|
56
|
-
|
|
57
|
-
- Write code following specs and technical design
|
|
58
|
-
- Follow existing code patterns
|
|
59
|
-
- Only do what's required, no over-engineering
|
|
60
|
-
|
|
61
|
-
### 4. Verify
|
|
62
|
-
|
|
63
|
-
Run project's lint and typecheck commands to verify changes.
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## Report Format
|
|
68
|
-
|
|
69
|
-
```markdown
|
|
70
|
-
## Implementation Complete
|
|
71
|
-
|
|
72
|
-
### Files Modified
|
|
73
|
-
|
|
74
|
-
- `src/components/Feature.tsx` - New component
|
|
75
|
-
- `src/hooks/useFeature.ts` - New hook
|
|
76
|
-
|
|
77
|
-
### Implementation Summary
|
|
78
|
-
|
|
79
|
-
1. Created Feature component...
|
|
80
|
-
2. Added useFeature hook...
|
|
81
|
-
|
|
82
|
-
### Verification Results
|
|
83
|
-
|
|
84
|
-
- Lint: Passed
|
|
85
|
-
- TypeCheck: Passed
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## Code Standards
|
|
91
|
-
|
|
92
|
-
- Follow existing code patterns
|
|
93
|
-
- Don't add unnecessary abstractions
|
|
94
|
-
- Only do what's required, no over-engineering
|
|
95
|
-
- Keep code readable
|