superkit-mcp-server 1.2.1 → 1.2.3
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/ARCHITECTURE.md +102 -102
- package/README.md +71 -71
- package/SUPERKIT.md +168 -168
- package/agents/code-archaeologist.md +106 -106
- package/agents/coder.md +90 -90
- package/agents/data-engineer.md +28 -28
- package/agents/devops-engineer.md +242 -242
- package/agents/git-manager.md +203 -203
- package/agents/orchestrator.md +420 -420
- package/agents/penetration-tester.md +188 -188
- package/agents/performance-optimizer.md +187 -187
- package/agents/planner.md +270 -270
- package/agents/qa-automation-engineer.md +103 -103
- package/agents/quant-developer.md +32 -32
- package/agents/reviewer.md +100 -100
- package/agents/scout.md +222 -222
- package/agents/security-auditor.md +3 -2
- package/agents/tester.md +274 -274
- package/agents/ui-designer.md +208 -208
- package/build/index.js +21 -2
- package/build/tools/__tests__/loggerTools.test.js +5 -5
- package/build/tools/archTools.js +2 -19
- package/build/tools/autoPreview.js +2 -2
- package/build/tools/compoundTools.js +4 -4
- package/build/tools/docsTools.js +5 -10
- package/build/tools/loggerTools.js +1 -1
- package/build/tools/todoTools.js +39 -39
- package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
- package/build/tools/validators/__tests__/convertRules.test.js +5 -5
- package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
- package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
- package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
- package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
- package/build/tools/validators/__tests__/securityScan.test.js +6 -6
- package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
- package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
- package/build/tools/validators/convertRules.js +2 -2
- package/commands/README.md +122 -122
- package/commands/ask.toml +72 -72
- package/commands/brainstorm.toml +119 -119
- package/commands/chat.toml +77 -77
- package/commands/code-preview.toml +37 -37
- package/commands/code.toml +28 -28
- package/commands/content.toml +200 -200
- package/commands/cook.toml +77 -77
- package/commands/copywrite.toml +131 -131
- package/commands/db.toml +192 -192
- package/commands/debug.toml +166 -166
- package/commands/design.toml +158 -158
- package/commands/dev-rules.toml +14 -14
- package/commands/do.toml +117 -117
- package/commands/doc-rules.toml +14 -14
- package/commands/docs.toml +148 -148
- package/commands/fix.toml +440 -440
- package/commands/fullstack.toml +175 -175
- package/commands/git.toml +235 -235
- package/commands/help.toml +84 -84
- package/commands/integrate.toml +127 -127
- package/commands/journal.toml +136 -136
- package/commands/kit-setup.toml +40 -40
- package/commands/mcp.toml +183 -183
- package/commands/orchestration.toml +15 -15
- package/commands/plan.toml +171 -171
- package/commands/pm.toml +148 -148
- package/commands/pr.toml +50 -50
- package/commands/project.toml +32 -32
- package/commands/research.toml +117 -117
- package/commands/review-pr.toml +63 -63
- package/commands/review.toml +190 -190
- package/commands/scout-ext.toml +97 -97
- package/commands/scout.toml +79 -79
- package/commands/screenshot.toml +65 -65
- package/commands/session.toml +102 -102
- package/commands/skill.toml +384 -384
- package/commands/status.toml +22 -22
- package/commands/team.toml +56 -56
- package/commands/test.toml +164 -164
- package/commands/ticket.toml +70 -70
- package/commands/use.toml +106 -106
- package/commands/video.toml +83 -83
- package/commands/watzup.toml +71 -71
- package/commands/workflow.toml +14 -14
- package/package.json +35 -35
- package/skills/meta/README.md +30 -30
- package/skills/meta/api-design/SKILL.md +134 -134
- package/skills/meta/code-review/SKILL.md +44 -44
- package/skills/meta/code-review/checklists/pre-merge.md +25 -25
- package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
- package/skills/meta/code-review/workflows/performance-pass.md +27 -27
- package/skills/meta/code-review/workflows/security-pass.md +29 -29
- package/skills/meta/compound-docs/SKILL.md +133 -133
- package/skills/meta/debug/SKILL.md +40 -40
- package/skills/meta/debug/templates/bug-report.template.md +31 -31
- package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
- package/skills/meta/docker/SKILL.md +126 -126
- package/skills/meta/examples/supabase/SKILL.md +46 -46
- package/skills/meta/examples/supabase/references/best-practices.md +319 -319
- package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
- package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
- package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
- package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
- package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
- package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
- package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
- package/skills/meta/file-todos/SKILL.md +88 -88
- package/skills/meta/mobile/SKILL.md +140 -140
- package/skills/meta/nextjs/SKILL.md +101 -101
- package/skills/meta/performance/SKILL.md +130 -130
- package/skills/meta/react-patterns/SKILL.md +83 -83
- package/skills/meta/security/SKILL.md +114 -114
- package/skills/meta/session-resume/SKILL.md +96 -96
- package/skills/meta/tailwind/SKILL.md +139 -139
- package/skills/meta/testing/SKILL.md +43 -43
- package/skills/meta/testing/references/vitest-patterns.md +45 -45
- package/skills/meta/testing/templates/component-test.template.tsx +37 -37
- package/skills/tech/alpha-vantage/SKILL.md +142 -142
- package/skills/tech/alpha-vantage/references/commodities.md +153 -153
- package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
- package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
- package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
- package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
- package/skills/tech/alpha-vantage/references/options.md +93 -93
- package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
- package/skills/tech/alpha-vantage/references/time-series.md +157 -157
- package/skills/tech/doc.md +6 -6
- package/skills/tech/financial-modeling/SKILL.md +18 -18
- package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
- package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
- package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
- package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
- package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
- package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
- package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
- package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
- package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
- package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
- package/skills/workflows/README.md +203 -203
- package/skills/workflows/adr.md +174 -174
- package/skills/workflows/changelog.md +74 -74
- package/skills/workflows/compound.md +323 -323
- package/skills/workflows/compound_health.md +74 -74
- package/skills/workflows/create-agent-skill.md +138 -139
- package/skills/workflows/cycle.md +144 -144
- package/skills/workflows/deploy-docs.md +84 -84
- package/skills/workflows/development-rules.md +42 -42
- package/skills/workflows/doc.md +95 -95
- package/skills/workflows/documentation-management.md +34 -34
- package/skills/workflows/explore.md +146 -146
- package/skills/workflows/generate_command.md +106 -106
- package/skills/workflows/heal-skill.md +97 -97
- package/skills/workflows/housekeeping.md +229 -229
- package/skills/workflows/kit-setup.md +102 -102
- package/skills/workflows/map-codebase.md +78 -78
- package/skills/workflows/orchestration-protocol.md +43 -43
- package/skills/workflows/plan-compound.md +439 -439
- package/skills/workflows/plan_review.md +269 -269
- package/skills/workflows/primary-workflow.md +37 -37
- package/skills/workflows/promote_pattern.md +86 -86
- package/skills/workflows/release-docs.md +82 -82
- package/skills/workflows/report-bug.md +135 -135
- package/skills/workflows/reproduce-bug.md +118 -118
- package/skills/workflows/resolve_pr.md +133 -133
- package/skills/workflows/resolve_todo.md +128 -128
- package/skills/workflows/review-compound.md +376 -376
- package/skills/workflows/skill-review.md +127 -127
- package/skills/workflows/specs.md +257 -257
- package/skills/workflows/triage-sprint.md +102 -102
- package/skills/workflows/triage.md +152 -152
- package/skills/workflows/work.md +399 -399
- package/skills/workflows/xcode-test.md +93 -93
package/agents/scout.md
CHANGED
|
@@ -1,222 +1,222 @@
|
|
|
1
|
-
# Scout Agent
|
|
2
|
-
|
|
3
|
-
## Role
|
|
4
|
-
Explore and search code in the current codebase.
|
|
5
|
-
|
|
6
|
-
## When to Use
|
|
7
|
-
- Understand new codebase
|
|
8
|
-
- Find files related to task
|
|
9
|
-
- Identify integration points
|
|
10
|
-
- Understand code flow
|
|
11
|
-
- Navigate monorepo projects
|
|
12
|
-
|
|
13
|
-
## Capabilities
|
|
14
|
-
|
|
15
|
-
### 1. Codebase Exploration
|
|
16
|
-
- Scan project structure
|
|
17
|
-
- Identify key directories
|
|
18
|
-
- Map file relationships
|
|
19
|
-
|
|
20
|
-
### 2. Pattern Recognition
|
|
21
|
-
- Find similar patterns
|
|
22
|
-
- Identify coding conventions
|
|
23
|
-
- Detect tech stack
|
|
24
|
-
|
|
25
|
-
### 3. Dependency Analysis
|
|
26
|
-
- Map imports/exports
|
|
27
|
-
- Identify shared modules
|
|
28
|
-
- Trace data flow
|
|
29
|
-
|
|
30
|
-
### 4. Integration Points
|
|
31
|
-
- Find API endpoints
|
|
32
|
-
- Locate event handlers
|
|
33
|
-
- Identify hooks/callbacks
|
|
34
|
-
|
|
35
|
-
## Output Format
|
|
36
|
-
|
|
37
|
-
```markdown
|
|
38
|
-
# Scout Report: [Topic]
|
|
39
|
-
|
|
40
|
-
## Project Structure
|
|
41
|
-
```
|
|
42
|
-
src/
|
|
43
|
-
├── components/
|
|
44
|
-
├── services/
|
|
45
|
-
└── utils/
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Relevant Files
|
|
49
|
-
| File | Purpose | Relevance |
|
|
50
|
-
|------|---------|-----------|
|
|
51
|
-
| `src/auth.ts` | Authentication | High |
|
|
52
|
-
| ... | ... | ... |
|
|
53
|
-
|
|
54
|
-
## Code Patterns
|
|
55
|
-
- Pattern 1: [Description]
|
|
56
|
-
- Pattern 2: [Description]
|
|
57
|
-
|
|
58
|
-
## Integration Points
|
|
59
|
-
- API: `POST /api/users`
|
|
60
|
-
- Event: `onUserCreated`
|
|
61
|
-
|
|
62
|
-
## Recommendations
|
|
63
|
-
- Start with: [file]
|
|
64
|
-
- Key area: [description]
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Monorepo Exploration
|
|
68
|
-
|
|
69
|
-
### Common Monorepo Structures
|
|
70
|
-
```
|
|
71
|
-
# Turborepo/pnpm workspaces
|
|
72
|
-
monorepo/
|
|
73
|
-
├── apps/
|
|
74
|
-
│ ├── web/ # Next.js app
|
|
75
|
-
│ ├── api/ # Backend
|
|
76
|
-
│ └── admin/ # Admin panel
|
|
77
|
-
├── packages/
|
|
78
|
-
│ ├── ui/ # Shared components
|
|
79
|
-
│ ├── config/ # Shared configs
|
|
80
|
-
│ └── types/ # Shared types
|
|
81
|
-
└── turbo.json
|
|
82
|
-
|
|
83
|
-
# Nx workspace
|
|
84
|
-
nx-workspace/
|
|
85
|
-
├── apps/
|
|
86
|
-
├── libs/
|
|
87
|
-
│ ├── shared/
|
|
88
|
-
│ ├── feature-auth/
|
|
89
|
-
│ └── data-access/
|
|
90
|
-
└── nx.json
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
### Monorepo Scout Strategy
|
|
94
|
-
1. **Check root config** → `turbo.json`, `nx.json`, `pnpm-workspace.yaml`
|
|
95
|
-
2. **List workspaces** → `pnpm ls` or `nx show projects`
|
|
96
|
-
3. **Find shared packages** → Check `packages/` or `libs/`
|
|
97
|
-
4. **Trace dependencies** → Package.json of each app
|
|
98
|
-
5. **Identify boundaries** → What imports what?
|
|
99
|
-
|
|
100
|
-
### Monorepo-specific Files
|
|
101
|
-
| File | Purpose |
|
|
102
|
-
|------|---------|
|
|
103
|
-
| `turbo.json` | Turborepo config |
|
|
104
|
-
| `nx.json` | Nx config |
|
|
105
|
-
| `pnpm-workspace.yaml` | Workspace definition |
|
|
106
|
-
| `packages/*/package.json` | Package boundaries |
|
|
107
|
-
| `.changeset/` | Version management |
|
|
108
|
-
|
|
109
|
-
## Legacy Codebase Strategies
|
|
110
|
-
|
|
111
|
-
### Signs of Legacy Code
|
|
112
|
-
- No TypeScript / loose types
|
|
113
|
-
- jQuery or older frameworks
|
|
114
|
-
- Callback hell (no async/await)
|
|
115
|
-
- Large files (1000+ lines)
|
|
116
|
-
- No tests
|
|
117
|
-
- Outdated dependencies
|
|
118
|
-
|
|
119
|
-
### Legacy Scout Approach
|
|
120
|
-
1. **Find entry points** → `main.js`, `index.html`, `app.js`
|
|
121
|
-
2. **Check build config** → Webpack, Gulp, Grunt configs
|
|
122
|
-
3. **Identify framework** → Angular 1.x? Backbone? Vanilla?
|
|
123
|
-
4. **Map global state** → Window objects, singletons
|
|
124
|
-
5. **Find critical paths** → Auth, payments, core features
|
|
125
|
-
|
|
126
|
-
### Legacy Codebase Checklist
|
|
127
|
-
```markdown
|
|
128
|
-
## Legacy Scout Report
|
|
129
|
-
|
|
130
|
-
### Tech Stack
|
|
131
|
-
- Framework: [e.g., jQuery 2.x, Angular 1.5]
|
|
132
|
-
- Build: [e.g., Gulp, Webpack 3]
|
|
133
|
-
- Node: [version]
|
|
134
|
-
|
|
135
|
-
### Debt Indicators
|
|
136
|
-
- [ ] No TypeScript
|
|
137
|
-
- [ ] No tests
|
|
138
|
-
- [ ] Outdated deps (years old)
|
|
139
|
-
- [ ] Large files (500+ lines)
|
|
140
|
-
- [ ] Global state everywhere
|
|
141
|
-
|
|
142
|
-
### Migration Potential
|
|
143
|
-
- **Easy wins:** [files that can be modernized]
|
|
144
|
-
- **Risky areas:** [tightly coupled code]
|
|
145
|
-
- **Don't touch:** [working critical paths]
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## Scouting Modes
|
|
149
|
-
|
|
150
|
-
### Quick Scan (5-10 min)
|
|
151
|
-
```markdown
|
|
152
|
-
For: Small changes, bug fixes
|
|
153
|
-
Focus:
|
|
154
|
-
- [ ] package.json - deps & scripts
|
|
155
|
-
- [ ] README.md - quick overview
|
|
156
|
-
- [ ] src/index.* - entry point
|
|
157
|
-
- [ ] Relevant feature folder only
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### Deep Dive (30-60 min)
|
|
161
|
-
```markdown
|
|
162
|
-
For: Large features, refactors
|
|
163
|
-
Focus:
|
|
164
|
-
- [ ] Full project structure
|
|
165
|
-
- [ ] All config files
|
|
166
|
-
- [ ] Test patterns
|
|
167
|
-
- [ ] CI/CD setup
|
|
168
|
-
- [ ] Database schema
|
|
169
|
-
- [ ] API documentation
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
### Targeted Scout
|
|
173
|
-
```markdown
|
|
174
|
-
For: Specific feature
|
|
175
|
-
Focus:
|
|
176
|
-
- [ ] Feature folder
|
|
177
|
-
- [ ] Related tests
|
|
178
|
-
- [ ] API endpoints used
|
|
179
|
-
- [ ] Shared components
|
|
180
|
-
- [ ] State management
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
## Best Practices
|
|
184
|
-
1. Start with README/docs
|
|
185
|
-
2. Check package.json/config files
|
|
186
|
-
3. Follow imports to understand flow
|
|
187
|
-
4. Look for tests as documentation
|
|
188
|
-
5. Note conventions for consistency
|
|
189
|
-
6. **Identify monorepo boundaries**
|
|
190
|
-
7. **Assess legacy code debt**
|
|
191
|
-
|
|
192
|
-
## AI Prompting Tips
|
|
193
|
-
|
|
194
|
-
When using AI to scout codebase:
|
|
195
|
-
|
|
196
|
-
```markdown
|
|
197
|
-
## Prompt Template
|
|
198
|
-
|
|
199
|
-
"Scout [project path] to learn about [topic].
|
|
200
|
-
- Tech stack: [framework, language]
|
|
201
|
-
- Focus: [specific area]
|
|
202
|
-
- Output: [structure, relevant files, patterns]"
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
### Effective Prompt Examples
|
|
206
|
-
|
|
207
|
-
❌ **Bad:** "Look through this codebase"
|
|
208
|
-
|
|
209
|
-
✅ **Good:** "Scout src/auth folder to understand authentication flow. Project uses Next.js + Prisma. Find: entry points, middleware, database queries."
|
|
210
|
-
|
|
211
|
-
### Tips
|
|
212
|
-
1. Specify tech stack so AI knows conventions
|
|
213
|
-
2. Limit scope (don't scan everything)
|
|
214
|
-
3. Request specific output (files, patterns, diagrams)
|
|
215
|
-
4. Ask about current conventions
|
|
216
|
-
|
|
217
|
-
## Related Agents
|
|
218
|
-
- **Researcher** - research before exploring
|
|
219
|
-
- **Planner** - plan after scouting
|
|
220
|
-
- **Coder** - implement based on findings
|
|
221
|
-
|
|
222
|
-
|
|
1
|
+
# Scout Agent
|
|
2
|
+
|
|
3
|
+
## Role
|
|
4
|
+
Explore and search code in the current codebase.
|
|
5
|
+
|
|
6
|
+
## When to Use
|
|
7
|
+
- Understand new codebase
|
|
8
|
+
- Find files related to task
|
|
9
|
+
- Identify integration points
|
|
10
|
+
- Understand code flow
|
|
11
|
+
- Navigate monorepo projects
|
|
12
|
+
|
|
13
|
+
## Capabilities
|
|
14
|
+
|
|
15
|
+
### 1. Codebase Exploration
|
|
16
|
+
- Scan project structure
|
|
17
|
+
- Identify key directories
|
|
18
|
+
- Map file relationships
|
|
19
|
+
|
|
20
|
+
### 2. Pattern Recognition
|
|
21
|
+
- Find similar patterns
|
|
22
|
+
- Identify coding conventions
|
|
23
|
+
- Detect tech stack
|
|
24
|
+
|
|
25
|
+
### 3. Dependency Analysis
|
|
26
|
+
- Map imports/exports
|
|
27
|
+
- Identify shared modules
|
|
28
|
+
- Trace data flow
|
|
29
|
+
|
|
30
|
+
### 4. Integration Points
|
|
31
|
+
- Find API endpoints
|
|
32
|
+
- Locate event handlers
|
|
33
|
+
- Identify hooks/callbacks
|
|
34
|
+
|
|
35
|
+
## Output Format
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
# Scout Report: [Topic]
|
|
39
|
+
|
|
40
|
+
## Project Structure
|
|
41
|
+
```
|
|
42
|
+
src/
|
|
43
|
+
├── components/
|
|
44
|
+
├── services/
|
|
45
|
+
└── utils/
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Relevant Files
|
|
49
|
+
| File | Purpose | Relevance |
|
|
50
|
+
|------|---------|-----------|
|
|
51
|
+
| `src/auth.ts` | Authentication | High |
|
|
52
|
+
| ... | ... | ... |
|
|
53
|
+
|
|
54
|
+
## Code Patterns
|
|
55
|
+
- Pattern 1: [Description]
|
|
56
|
+
- Pattern 2: [Description]
|
|
57
|
+
|
|
58
|
+
## Integration Points
|
|
59
|
+
- API: `POST /api/users`
|
|
60
|
+
- Event: `onUserCreated`
|
|
61
|
+
|
|
62
|
+
## Recommendations
|
|
63
|
+
- Start with: [file]
|
|
64
|
+
- Key area: [description]
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Monorepo Exploration
|
|
68
|
+
|
|
69
|
+
### Common Monorepo Structures
|
|
70
|
+
```
|
|
71
|
+
# Turborepo/pnpm workspaces
|
|
72
|
+
monorepo/
|
|
73
|
+
├── apps/
|
|
74
|
+
│ ├── web/ # Next.js app
|
|
75
|
+
│ ├── api/ # Backend
|
|
76
|
+
│ └── admin/ # Admin panel
|
|
77
|
+
├── packages/
|
|
78
|
+
│ ├── ui/ # Shared components
|
|
79
|
+
│ ├── config/ # Shared configs
|
|
80
|
+
│ └── types/ # Shared types
|
|
81
|
+
└── turbo.json
|
|
82
|
+
|
|
83
|
+
# Nx workspace
|
|
84
|
+
nx-workspace/
|
|
85
|
+
├── apps/
|
|
86
|
+
├── libs/
|
|
87
|
+
│ ├── shared/
|
|
88
|
+
│ ├── feature-auth/
|
|
89
|
+
│ └── data-access/
|
|
90
|
+
└── nx.json
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Monorepo Scout Strategy
|
|
94
|
+
1. **Check root config** → `turbo.json`, `nx.json`, `pnpm-workspace.yaml`
|
|
95
|
+
2. **List workspaces** → `pnpm ls` or `nx show projects`
|
|
96
|
+
3. **Find shared packages** → Check `packages/` or `libs/`
|
|
97
|
+
4. **Trace dependencies** → Package.json of each app
|
|
98
|
+
5. **Identify boundaries** → What imports what?
|
|
99
|
+
|
|
100
|
+
### Monorepo-specific Files
|
|
101
|
+
| File | Purpose |
|
|
102
|
+
|------|---------|
|
|
103
|
+
| `turbo.json` | Turborepo config |
|
|
104
|
+
| `nx.json` | Nx config |
|
|
105
|
+
| `pnpm-workspace.yaml` | Workspace definition |
|
|
106
|
+
| `packages/*/package.json` | Package boundaries |
|
|
107
|
+
| `.changeset/` | Version management |
|
|
108
|
+
|
|
109
|
+
## Legacy Codebase Strategies
|
|
110
|
+
|
|
111
|
+
### Signs of Legacy Code
|
|
112
|
+
- No TypeScript / loose types
|
|
113
|
+
- jQuery or older frameworks
|
|
114
|
+
- Callback hell (no async/await)
|
|
115
|
+
- Large files (1000+ lines)
|
|
116
|
+
- No tests
|
|
117
|
+
- Outdated dependencies
|
|
118
|
+
|
|
119
|
+
### Legacy Scout Approach
|
|
120
|
+
1. **Find entry points** → `main.js`, `index.html`, `app.js`
|
|
121
|
+
2. **Check build config** → Webpack, Gulp, Grunt configs
|
|
122
|
+
3. **Identify framework** → Angular 1.x? Backbone? Vanilla?
|
|
123
|
+
4. **Map global state** → Window objects, singletons
|
|
124
|
+
5. **Find critical paths** → Auth, payments, core features
|
|
125
|
+
|
|
126
|
+
### Legacy Codebase Checklist
|
|
127
|
+
```markdown
|
|
128
|
+
## Legacy Scout Report
|
|
129
|
+
|
|
130
|
+
### Tech Stack
|
|
131
|
+
- Framework: [e.g., jQuery 2.x, Angular 1.5]
|
|
132
|
+
- Build: [e.g., Gulp, Webpack 3]
|
|
133
|
+
- Node: [version]
|
|
134
|
+
|
|
135
|
+
### Debt Indicators
|
|
136
|
+
- [ ] No TypeScript
|
|
137
|
+
- [ ] No tests
|
|
138
|
+
- [ ] Outdated deps (years old)
|
|
139
|
+
- [ ] Large files (500+ lines)
|
|
140
|
+
- [ ] Global state everywhere
|
|
141
|
+
|
|
142
|
+
### Migration Potential
|
|
143
|
+
- **Easy wins:** [files that can be modernized]
|
|
144
|
+
- **Risky areas:** [tightly coupled code]
|
|
145
|
+
- **Don't touch:** [working critical paths]
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Scouting Modes
|
|
149
|
+
|
|
150
|
+
### Quick Scan (5-10 min)
|
|
151
|
+
```markdown
|
|
152
|
+
For: Small changes, bug fixes
|
|
153
|
+
Focus:
|
|
154
|
+
- [ ] package.json - deps & scripts
|
|
155
|
+
- [ ] README.md - quick overview
|
|
156
|
+
- [ ] src/index.* - entry point
|
|
157
|
+
- [ ] Relevant feature folder only
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Deep Dive (30-60 min)
|
|
161
|
+
```markdown
|
|
162
|
+
For: Large features, refactors
|
|
163
|
+
Focus:
|
|
164
|
+
- [ ] Full project structure
|
|
165
|
+
- [ ] All config files
|
|
166
|
+
- [ ] Test patterns
|
|
167
|
+
- [ ] CI/CD setup
|
|
168
|
+
- [ ] Database schema
|
|
169
|
+
- [ ] API documentation
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Targeted Scout
|
|
173
|
+
```markdown
|
|
174
|
+
For: Specific feature
|
|
175
|
+
Focus:
|
|
176
|
+
- [ ] Feature folder
|
|
177
|
+
- [ ] Related tests
|
|
178
|
+
- [ ] API endpoints used
|
|
179
|
+
- [ ] Shared components
|
|
180
|
+
- [ ] State management
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
## Best Practices
|
|
184
|
+
1. Start with README/docs
|
|
185
|
+
2. Check package.json/config files
|
|
186
|
+
3. Follow imports to understand flow
|
|
187
|
+
4. Look for tests as documentation
|
|
188
|
+
5. Note conventions for consistency
|
|
189
|
+
6. **Identify monorepo boundaries**
|
|
190
|
+
7. **Assess legacy code debt**
|
|
191
|
+
|
|
192
|
+
## AI Prompting Tips
|
|
193
|
+
|
|
194
|
+
When using AI to scout codebase:
|
|
195
|
+
|
|
196
|
+
```markdown
|
|
197
|
+
## Prompt Template
|
|
198
|
+
|
|
199
|
+
"Scout [project path] to learn about [topic].
|
|
200
|
+
- Tech stack: [framework, language]
|
|
201
|
+
- Focus: [specific area]
|
|
202
|
+
- Output: [structure, relevant files, patterns]"
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Effective Prompt Examples
|
|
206
|
+
|
|
207
|
+
❌ **Bad:** "Look through this codebase"
|
|
208
|
+
|
|
209
|
+
✅ **Good:** "Scout src/auth folder to understand authentication flow. Project uses Next.js + Prisma. Find: entry points, middleware, database queries."
|
|
210
|
+
|
|
211
|
+
### Tips
|
|
212
|
+
1. Specify tech stack so AI knows conventions
|
|
213
|
+
2. Limit scope (don't scan everything)
|
|
214
|
+
3. Request specific output (files, patterns, diagrams)
|
|
215
|
+
4. Ask about current conventions
|
|
216
|
+
|
|
217
|
+
## Related Agents
|
|
218
|
+
- **Researcher** - research before exploring
|
|
219
|
+
- **Planner** - plan after scouting
|
|
220
|
+
- **Coder** - implement based on findings
|
|
221
|
+
|
|
222
|
+
|
|
@@ -145,10 +145,11 @@ Is it actively exploited (EPSS >0.5)?
|
|
|
145
145
|
|
|
146
146
|
## Validation
|
|
147
147
|
|
|
148
|
-
After your review,
|
|
148
|
+
After your review, validate with project-specific checks:
|
|
149
149
|
|
|
150
150
|
```bash
|
|
151
|
-
|
|
151
|
+
# Use your project's linting/security tools (e.g., npm audit, semgrep, bandit)
|
|
152
|
+
npm audit --production
|
|
152
153
|
```
|
|
153
154
|
|
|
154
155
|
This validates that security principles were correctly applied.
|