@ai-coders/context 0.3.0 → 0.4.0

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.
Files changed (228) hide show
  1. package/README.md +32 -25
  2. package/dist/commands/shared/agents.d.ts +2 -0
  3. package/dist/commands/shared/agents.d.ts.map +1 -0
  4. package/dist/commands/shared/agents.js +15 -0
  5. package/dist/commands/shared/agents.js.map +1 -0
  6. package/dist/commands/shared/selection.d.ts +12 -0
  7. package/dist/commands/shared/selection.d.ts.map +1 -0
  8. package/dist/commands/shared/selection.js +95 -0
  9. package/dist/commands/shared/selection.js.map +1 -0
  10. package/dist/generators/agents/agentConfig.d.ts.map +1 -1
  11. package/dist/generators/agents/agentConfig.js +42 -0
  12. package/dist/generators/agents/agentConfig.js.map +1 -1
  13. package/dist/generators/agents/agentGenerator.d.ts +0 -1
  14. package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
  15. package/dist/generators/agents/agentGenerator.js +7 -47
  16. package/dist/generators/agents/agentGenerator.js.map +1 -1
  17. package/dist/generators/agents/agentTypes.d.ts +1 -1
  18. package/dist/generators/agents/agentTypes.d.ts.map +1 -1
  19. package/dist/generators/agents/agentTypes.js +4 -1
  20. package/dist/generators/agents/agentTypes.js.map +1 -1
  21. package/dist/generators/agents/templates/indexTemplate.d.ts.map +1 -1
  22. package/dist/generators/agents/templates/indexTemplate.js +2 -1
  23. package/dist/generators/agents/templates/indexTemplate.js.map +1 -1
  24. package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
  25. package/dist/generators/agents/templates/playbookTemplate.js +39 -3
  26. package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
  27. package/dist/generators/documentation/documentationGenerator.d.ts +3 -1
  28. package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
  29. package/dist/generators/documentation/documentationGenerator.js +88 -15
  30. package/dist/generators/documentation/documentationGenerator.js.map +1 -1
  31. package/dist/generators/documentation/guideRegistry.js +8 -8
  32. package/dist/generators/documentation/guideRegistry.js.map +1 -1
  33. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts +2 -0
  34. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -0
  35. package/dist/generators/documentation/templates/apiReferenceTemplate.js +490 -0
  36. package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -0
  37. package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
  38. package/dist/generators/documentation/templates/architectureTemplate.js +27 -27
  39. package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
  40. package/dist/generators/documentation/templates/common.js +2 -2
  41. package/dist/generators/documentation/templates/common.js.map +1 -1
  42. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
  43. package/dist/generators/documentation/templates/dataFlowTemplate.js +5 -20
  44. package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
  45. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
  46. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +5 -20
  47. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
  48. package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
  49. package/dist/generators/documentation/templates/glossaryTemplate.js +9 -23
  50. package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
  51. package/dist/generators/documentation/templates/index.d.ts +4 -0
  52. package/dist/generators/documentation/templates/index.d.ts.map +1 -1
  53. package/dist/generators/documentation/templates/index.js +9 -1
  54. package/dist/generators/documentation/templates/index.js.map +1 -1
  55. package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -1
  56. package/dist/generators/documentation/templates/indexTemplate.js +5 -19
  57. package/dist/generators/documentation/templates/indexTemplate.js.map +1 -1
  58. package/dist/generators/documentation/templates/migrationTemplate.d.ts +2 -0
  59. package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -0
  60. package/dist/generators/documentation/templates/migrationTemplate.js +422 -0
  61. package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -0
  62. package/dist/generators/documentation/templates/onboardingTemplate.d.ts +2 -0
  63. package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -0
  64. package/dist/generators/documentation/templates/onboardingTemplate.js +431 -0
  65. package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -0
  66. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
  67. package/dist/generators/documentation/templates/projectOverviewTemplate.js +22 -25
  68. package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
  69. package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
  70. package/dist/generators/documentation/templates/securityTemplate.js +5 -19
  71. package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
  72. package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
  73. package/dist/generators/documentation/templates/testingTemplate.js +5 -19
  74. package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
  75. package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
  76. package/dist/generators/documentation/templates/toolingTemplate.js +6 -20
  77. package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
  78. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts +2 -0
  79. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -0
  80. package/dist/generators/documentation/templates/troubleshootingTemplate.js +292 -0
  81. package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -0
  82. package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -1
  83. package/dist/generators/plans/templates/indexTemplate.js +3 -2
  84. package/dist/generators/plans/templates/indexTemplate.js.map +1 -1
  85. package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
  86. package/dist/generators/plans/templates/planTemplate.js +96 -13
  87. package/dist/generators/plans/templates/planTemplate.js.map +1 -1
  88. package/dist/generators/shared/generatorUtils.d.ts +1 -1
  89. package/dist/generators/shared/generatorUtils.d.ts.map +1 -1
  90. package/dist/generators/shared/generatorUtils.js +1 -1
  91. package/dist/generators/shared/generatorUtils.js.map +1 -1
  92. package/dist/index.d.ts +2 -2
  93. package/dist/index.d.ts.map +1 -1
  94. package/dist/index.js +111 -1007
  95. package/dist/index.js.map +1 -1
  96. package/dist/prompts/defaults.d.ts +3 -0
  97. package/dist/prompts/defaults.d.ts.map +1 -0
  98. package/dist/prompts/defaults.js +95 -0
  99. package/dist/prompts/defaults.js.map +1 -0
  100. package/dist/services/baseLLMClient.d.ts +3 -3
  101. package/dist/services/baseLLMClient.d.ts.map +1 -1
  102. package/dist/services/baseLLMClient.js +44 -5
  103. package/dist/services/baseLLMClient.js.map +1 -1
  104. package/dist/services/fill/fillService.d.ts +46 -0
  105. package/dist/services/fill/fillService.d.ts.map +1 -0
  106. package/dist/services/fill/fillService.js +254 -0
  107. package/dist/services/fill/fillService.js.map +1 -0
  108. package/dist/services/init/initService.d.ts +37 -0
  109. package/dist/services/init/initService.d.ts.map +1 -0
  110. package/dist/services/init/initService.js +167 -0
  111. package/dist/services/init/initService.js.map +1 -0
  112. package/dist/services/llmClientFactory.d.ts +2 -8
  113. package/dist/services/llmClientFactory.d.ts.map +1 -1
  114. package/dist/services/llmClientFactory.js +10 -96
  115. package/dist/services/llmClientFactory.js.map +1 -1
  116. package/dist/services/openRouterClient.d.ts +0 -3
  117. package/dist/services/openRouterClient.d.ts.map +1 -1
  118. package/dist/services/openRouterClient.js +2 -49
  119. package/dist/services/openRouterClient.js.map +1 -1
  120. package/dist/services/plan/planService.d.ts +57 -0
  121. package/dist/services/plan/planService.d.ts.map +1 -0
  122. package/dist/services/plan/planService.js +334 -0
  123. package/dist/services/plan/planService.js.map +1 -0
  124. package/dist/services/shared/llmConfig.d.ts +22 -0
  125. package/dist/services/shared/llmConfig.d.ts.map +1 -0
  126. package/dist/services/shared/llmConfig.js +38 -0
  127. package/dist/services/shared/llmConfig.js.map +1 -0
  128. package/dist/types.d.ts +7 -2
  129. package/dist/types.d.ts.map +1 -1
  130. package/dist/utils/fileMapper.d.ts +1 -1
  131. package/dist/utils/fileMapper.d.ts.map +1 -1
  132. package/dist/utils/fileMapper.js +40 -19
  133. package/dist/utils/fileMapper.js.map +1 -1
  134. package/dist/utils/i18n.d.ts +23 -33
  135. package/dist/utils/i18n.d.ts.map +1 -1
  136. package/dist/utils/i18n.js +48 -68
  137. package/dist/utils/i18n.js.map +1 -1
  138. package/dist/utils/promptLoader.d.ts +12 -0
  139. package/dist/utils/promptLoader.d.ts.map +1 -0
  140. package/dist/utils/promptLoader.js +81 -0
  141. package/dist/utils/promptLoader.js.map +1 -0
  142. package/dist/utils/versionChecker.d.ts +15 -0
  143. package/dist/utils/versionChecker.d.ts.map +1 -0
  144. package/dist/utils/versionChecker.js +49 -0
  145. package/dist/utils/versionChecker.js.map +1 -0
  146. package/package.json +9 -10
  147. package/prompts/update_plan_prompt.md +4 -5
  148. package/prompts/update_scaffold_prompt.md +7 -8
  149. package/dist/generators/agents/contextUtils.d.ts +0 -8
  150. package/dist/generators/agents/contextUtils.d.ts.map +0 -1
  151. package/dist/generators/agents/contextUtils.js +0 -15
  152. package/dist/generators/agents/contextUtils.js.map +0 -1
  153. package/dist/generators/agents/promptFormatter.d.ts +0 -9
  154. package/dist/generators/agents/promptFormatter.d.ts.map +0 -1
  155. package/dist/generators/agents/promptFormatter.js +0 -84
  156. package/dist/generators/agents/promptFormatter.js.map +0 -1
  157. package/dist/generators/analyzers/codebaseAnalyzer.d.ts +0 -45
  158. package/dist/generators/analyzers/codebaseAnalyzer.d.ts.map +0 -1
  159. package/dist/generators/analyzers/codebaseAnalyzer.js +0 -293
  160. package/dist/generators/analyzers/codebaseAnalyzer.js.map +0 -1
  161. package/dist/generators/analyzers/index.d.ts +0 -3
  162. package/dist/generators/analyzers/index.d.ts.map +0 -1
  163. package/dist/generators/analyzers/index.js +0 -6
  164. package/dist/generators/analyzers/index.js.map +0 -1
  165. package/dist/generators/documentation/documentationTemplates.d.ts +0 -21
  166. package/dist/generators/documentation/documentationTemplates.d.ts.map +0 -1
  167. package/dist/generators/documentation/documentationTemplates.js +0 -359
  168. package/dist/generators/documentation/documentationTemplates.js.map +0 -1
  169. package/dist/generators/documentation/documentationTypes.d.ts +0 -11
  170. package/dist/generators/documentation/documentationTypes.d.ts.map +0 -1
  171. package/dist/generators/documentation/documentationTypes.js +0 -22
  172. package/dist/generators/documentation/documentationTypes.js.map +0 -1
  173. package/dist/generators/documentation/documentationUtils.d.ts +0 -7
  174. package/dist/generators/documentation/documentationUtils.d.ts.map +0 -1
  175. package/dist/generators/documentation/documentationUtils.js +0 -28
  176. package/dist/generators/documentation/documentationUtils.js.map +0 -1
  177. package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts +0 -33
  178. package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts.map +0 -1
  179. package/dist/generators/documentation/incrementalDocumentationGenerator.js +0 -400
  180. package/dist/generators/documentation/incrementalDocumentationGenerator.js.map +0 -1
  181. package/dist/generators/documentation/templates.d.ts +0 -31
  182. package/dist/generators/documentation/templates.d.ts.map +0 -1
  183. package/dist/generators/documentation/templates.js +0 -566
  184. package/dist/generators/documentation/templates.js.map +0 -1
  185. package/dist/generators/guidelines/agentIntegration.d.ts +0 -43
  186. package/dist/generators/guidelines/agentIntegration.d.ts.map +0 -1
  187. package/dist/generators/guidelines/agentIntegration.js +0 -157
  188. package/dist/generators/guidelines/agentIntegration.js.map +0 -1
  189. package/dist/generators/guidelines/guidelineTypes.d.ts +0 -40
  190. package/dist/generators/guidelines/guidelineTypes.d.ts.map +0 -1
  191. package/dist/generators/guidelines/guidelineTypes.js +0 -144
  192. package/dist/generators/guidelines/guidelineTypes.js.map +0 -1
  193. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts +0 -30
  194. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts.map +0 -1
  195. package/dist/generators/guidelines/guidelinesAnalyzer.js +0 -263
  196. package/dist/generators/guidelines/guidelinesAnalyzer.js.map +0 -1
  197. package/dist/generators/guidelines/guidelinesGenerator.d.ts +0 -30
  198. package/dist/generators/guidelines/guidelinesGenerator.d.ts.map +0 -1
  199. package/dist/generators/guidelines/guidelinesGenerator.js +0 -249
  200. package/dist/generators/guidelines/guidelinesGenerator.js.map +0 -1
  201. package/dist/generators/guidelines/guidelinesTemplates.d.ts +0 -23
  202. package/dist/generators/guidelines/guidelinesTemplates.d.ts.map +0 -1
  203. package/dist/generators/guidelines/guidelinesTemplates.js +0 -304
  204. package/dist/generators/guidelines/guidelinesTemplates.js.map +0 -1
  205. package/dist/generators/guidelines/index.d.ts +0 -6
  206. package/dist/generators/guidelines/index.d.ts.map +0 -1
  207. package/dist/generators/guidelines/index.js +0 -16
  208. package/dist/generators/guidelines/index.js.map +0 -1
  209. package/dist/generators/moduleGrouper.d.ts +0 -14
  210. package/dist/generators/moduleGrouper.d.ts.map +0 -1
  211. package/dist/generators/moduleGrouper.js +0 -82
  212. package/dist/generators/moduleGrouper.js.map +0 -1
  213. package/dist/generators/projectAnalyzer.d.ts +0 -14
  214. package/dist/generators/projectAnalyzer.d.ts.map +0 -1
  215. package/dist/generators/projectAnalyzer.js +0 -217
  216. package/dist/generators/projectAnalyzer.js.map +0 -1
  217. package/dist/services/changeAnalyzer.d.ts +0 -44
  218. package/dist/services/changeAnalyzer.d.ts.map +0 -1
  219. package/dist/services/changeAnalyzer.js +0 -344
  220. package/dist/services/changeAnalyzer.js.map +0 -1
  221. package/dist/utils/interactiveMode.d.ts +0 -21
  222. package/dist/utils/interactiveMode.d.ts.map +0 -1
  223. package/dist/utils/interactiveMode.js +0 -737
  224. package/dist/utils/interactiveMode.js.map +0 -1
  225. package/dist/utils/tokenEstimator.d.ts +0 -28
  226. package/dist/utils/tokenEstimator.d.ts.map +0 -1
  227. package/dist/utils/tokenEstimator.js +0 -134
  228. package/dist/utils/tokenEstimator.js.map +0 -1
@@ -0,0 +1,431 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.renderOnboarding = renderOnboarding;
4
+ function renderOnboarding() {
5
+ return `
6
+ <!-- agent-update:start:onboarding-guide -->
7
+ # Onboarding Guide
8
+
9
+ Welcome to the team! This guide will help you get set up and productive quickly.
10
+
11
+ ## Onboarding Checklist
12
+
13
+ ### Day 1: Access & Accounts
14
+ - [ ] **Email account** - Verify access to team email
15
+ - [ ] **Chat/Communication**
16
+ - [ ] Slack/Teams workspace invitation
17
+ - [ ] Join relevant channels: #engineering, #team-name, #general
18
+ - [ ] **Code repository access**
19
+ - [ ] GitHub/GitLab account added to organization
20
+ - [ ] SSH key configured for git operations
21
+ - [ ] Clone main repository
22
+ - [ ] **Issue tracking**
23
+ - [ ] Jira/GitHub Issues access
24
+ - [ ] Assigned to team project/board
25
+ - [ ] **Documentation access**
26
+ - [ ] Wiki/Confluence access
27
+ - [ ] Shared drive access (Google Drive, Notion, etc.)
28
+ - [ ] **Meeting invites**
29
+ - [ ] Added to recurring team meetings
30
+ - [ ] Calendar access configured
31
+
32
+ ### Day 1-2: Development Environment
33
+ - [ ] **Install required software**
34
+ - [ ] Node.js (version: TODO: specify version)
35
+ - [ ] npm/yarn package manager
36
+ - [ ] Git (latest stable version)
37
+ - [ ] Code editor/IDE (VS Code, WebStorm, etc.)
38
+ - [ ] Docker Desktop (if applicable)
39
+ - [ ] Database client (if applicable)
40
+ - [ ] **Configure development environment**
41
+ \`\`\`bash
42
+ # Clone repository
43
+ git clone git@github.com:org/repo.git
44
+ cd repo
45
+
46
+ # Copy environment configuration
47
+ cp .env.example .env
48
+ # Edit .env with local settings
49
+
50
+ # Install dependencies
51
+ npm install
52
+
53
+ # Run database migrations (if applicable)
54
+ npm run migrate
55
+
56
+ # Start development server
57
+ npm run dev
58
+ \`\`\`
59
+ - [ ] **Verify environment setup**
60
+ - [ ] Application runs locally
61
+ - [ ] Tests pass: \`npm test\`
62
+ - [ ] Linting works: \`npm run lint\`
63
+ - [ ] Can access local application in browser
64
+ - [ ] **Editor configuration**
65
+ - [ ] Install recommended VS Code extensions (see .vscode/extensions.json)
66
+ - [ ] Configure code formatting (Prettier, ESLint)
67
+ - [ ] Set up debugger configuration
68
+
69
+ ### Day 2-3: Project Understanding
70
+ - [ ] **Read core documentation**
71
+ - [ ] [Project Overview](./project-overview.md)
72
+ - [ ] [Architecture Notes](./architecture.md)
73
+ - [ ] [Development Workflow](./development-workflow.md)
74
+ - [ ] [Testing Strategy](./testing.md)
75
+ - [ ] **Understand the codebase**
76
+ - [ ] Explore project structure
77
+ - [ ] Review main application entry points
78
+ - [ ] Understand key modules and their responsibilities
79
+ - [ ] Read recent pull requests to see code review standards
80
+ - [ ] **Meet the team**
81
+ - [ ] 1:1 with manager
82
+ - [ ] Meet team members
83
+ - [ ] Meet cross-functional partners (Product, Design, QA)
84
+ - [ ] Understand team roles and responsibilities
85
+
86
+ ### Week 1: First Contributions
87
+ - [ ] **Start with good first issues**
88
+ - [ ] Find issues tagged "good-first-issue" or similar
89
+ - [ ] Complete 1-2 small bug fixes or documentation updates
90
+ - [ ] Go through code review process
91
+ - [ ] Get first PR merged
92
+ - [ ] **Learn the workflow**
93
+ - [ ] Create feature branch
94
+ - [ ] Make changes and write tests
95
+ - [ ] Submit pull request
96
+ - [ ] Address review feedback
97
+ - [ ] Merge and deploy (or see deployment process)
98
+ - [ ] **Set up productivity tools**
99
+ - [ ] Configure git aliases
100
+ - [ ] Set up any team-specific CLI tools
101
+ - [ ] Bookmark important dashboards/tools
102
+ - [ ] Join pair programming sessions
103
+
104
+ ### Week 2-4: Ramp Up
105
+ - [ ] **Take on larger tasks**
106
+ - [ ] Pick up medium complexity issues
107
+ - [ ] Work on feature development
108
+ - [ ] Participate in design discussions
109
+ - [ ] **Deepen knowledge**
110
+ - [ ] Understand deployment process
111
+ - [ ] Learn monitoring and debugging tools
112
+ - [ ] Review production architecture
113
+ - [ ] Shadow on-call engineer (if applicable)
114
+ - [ ] **Contribute to team processes**
115
+ - [ ] Attend sprint planning/standup
116
+ - [ ] Participate in retrospectives
117
+ - [ ] Update documentation as you learn
118
+
119
+ ### Month 2-3: Full Productivity
120
+ - [ ] **Own features end-to-end**
121
+ - [ ] Design, implement, test, and deploy features
122
+ - [ ] Participate in on-call rotation (if applicable)
123
+ - [ ] Help onboard newer team members
124
+ - [ ] **Identify improvements**
125
+ - [ ] Suggest process improvements
126
+ - [ ] Improve documentation
127
+ - [ ] Refactor problem areas
128
+
129
+ ---
130
+
131
+ ## Development Environment Setup
132
+
133
+ ### Prerequisites
134
+ **Operating System:**
135
+ - macOS 10.15+ or Linux (Ubuntu 20.04+)
136
+ - Windows 10/11 with WSL2 (Windows Subsystem for Linux)
137
+
138
+ **Required Tools:**
139
+ - **Node.js:** v18.0.0 or higher ([Download](https://nodejs.org/))
140
+ - **npm:** v9.0.0 or higher (comes with Node.js)
141
+ - **Git:** v2.30.0 or higher ([Download](https://git-scm.com/))
142
+ - **Docker:** (Optional) For running services locally
143
+
144
+ ### Step-by-Step Setup
145
+
146
+ #### 1. Install Node.js
147
+ \`\`\`bash
148
+ # macOS (using Homebrew)
149
+ brew install node@18
150
+
151
+ # Linux (using nvm)
152
+ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
153
+ nvm install 18
154
+ nvm use 18
155
+
156
+ # Verify installation
157
+ node --version # Should show v18.x.x
158
+ npm --version # Should show v9.x.x
159
+ \`\`\`
160
+
161
+ #### 2. Configure Git
162
+ \`\`\`bash
163
+ # Set your identity
164
+ git config --global user.name "Your Name"
165
+ git config --global user.email "your.email@company.com"
166
+
167
+ # Set up SSH key for GitHub
168
+ ssh-keygen -t ed25519 -C "your.email@company.com"
169
+ # Follow prompts, then add key to GitHub:
170
+ # https://github.com/settings/keys
171
+
172
+ # Test SSH connection
173
+ ssh -T git@github.com
174
+ \`\`\`
175
+
176
+ #### 3. Clone and Setup Project
177
+ \`\`\`bash
178
+ # Clone repository
179
+ git clone git@github.com:org/repo.git
180
+ cd repo
181
+
182
+ # Install dependencies
183
+ npm install
184
+
185
+ # Copy environment template
186
+ cp .env.example .env
187
+
188
+ # Edit .env with your local settings
189
+ # Required variables:
190
+ # - DATABASE_URL (if using database)
191
+ # - API_KEY (if applicable)
192
+ # - Any other project-specific variables
193
+ \`\`\`
194
+
195
+ #### 4. Database Setup (if applicable)
196
+ \`\`\`bash
197
+ # Option 1: Docker (recommended)
198
+ docker-compose up -d db
199
+
200
+ # Option 2: Local installation
201
+ # Install PostgreSQL/MySQL/MongoDB locally
202
+ # Create database
203
+ createdb project_dev
204
+
205
+ # Run migrations
206
+ npm run migrate
207
+
208
+ # Seed database with sample data (optional)
209
+ npm run seed
210
+ \`\`\`
211
+
212
+ #### 5. Verify Setup
213
+ \`\`\`bash
214
+ # Run tests
215
+ npm test
216
+
217
+ # Start development server
218
+ npm run dev
219
+
220
+ # In another terminal, verify it's running
221
+ curl http://localhost:3000/health
222
+ # Or open http://localhost:3000 in browser
223
+ \`\`\`
224
+
225
+ ### Common Setup Issues
226
+
227
+ #### Port Already in Use
228
+ \`\`\`bash
229
+ # Find process using port 3000
230
+ lsof -ti:3000
231
+
232
+ # Kill the process
233
+ kill -9 $(lsof -ti:3000)
234
+
235
+ # Or use a different port
236
+ PORT=3001 npm run dev
237
+ \`\`\`
238
+
239
+ #### Database Connection Errors
240
+ - Verify database is running: \`docker ps\` or service status
241
+ - Check DATABASE_URL in .env file
242
+ - Ensure database exists: \`createdb project_dev\`
243
+ - Verify migrations ran: \`npm run migrate:status\`
244
+
245
+ #### Module Not Found Errors
246
+ \`\`\`bash
247
+ # Clear cache and reinstall
248
+ rm -rf node_modules package-lock.json
249
+ npm install
250
+ \`\`\`
251
+
252
+ ---
253
+
254
+ ## Required Access & Permissions
255
+
256
+ ### Accounts to Request
257
+ 1. **GitHub Organization** - Request from: TODO: Add contact
258
+ 2. **AWS/Cloud Access** - Request from: TODO: Add DevOps contact
259
+ 3. **Database Access** - Request from: TODO: Add DBA contact
260
+ 4. **Monitoring/APM Tools** - Request from: TODO: Add contact
261
+ 5. **CI/CD Pipeline** - Request from: TODO: Add DevOps contact
262
+ 6. **Issue Tracker (Jira/etc.)** - Request from: TODO: Add PM contact
263
+
264
+ ### Team Permissions
265
+ - **Repository:** Write access to main repo
266
+ - **Deployments:** Staging access (production access granted after 1-2 months)
267
+ - **Databases:** Read access to staging, read-only to production
268
+ - **Cloud Resources:** Developer role in non-production environments
269
+
270
+ ---
271
+
272
+ ## Team Communication
273
+
274
+ ### Chat Channels
275
+ - **#engineering** - General engineering discussions
276
+ - **#team-[name]** - Your team's channel
277
+ - **#deployments** - Deployment notifications
278
+ - **#incidents** - Production issues and incidents
279
+ - **#random** - Non-work related chat
280
+
281
+ ### Meetings
282
+ - **Daily Standup** - Every day at TODO: time
283
+ - **Sprint Planning** - TODO: frequency and day
284
+ - **Sprint Retrospective** - TODO: frequency and day
285
+ - **Team Sync** - TODO: frequency and day
286
+ - **1:1 with Manager** - Weekly (scheduled individually)
287
+
288
+ ### Communication Guidelines
289
+ - Use threads in Slack to keep conversations organized
290
+ - @mention people directly when you need their attention
291
+ - Use @here sparingly (only for time-sensitive team updates)
292
+ - Update your status when away or in focus time
293
+ - Default to public channels over DMs when possible
294
+
295
+ ---
296
+
297
+ ## Learning Resources
298
+
299
+ ### Project-Specific
300
+ - **Architecture Documentation** - [Link to architecture docs](./architecture.md)
301
+ - **API Documentation** - [Link to API docs](./api-reference.md)
302
+ - **Deployment Guide** - [Link to deployment docs](./deployment.md)
303
+ - **Troubleshooting** - [Link to troubleshooting guide](./troubleshooting.md)
304
+
305
+ ### Technical Skills
306
+ - **Node.js Best Practices** - [Link to guide or external resource]
307
+ - **TypeScript Handbook** - [TypeScript docs](https://www.typescriptlang.org/docs/)
308
+ - **Testing Guide** - [Link to testing strategy](./testing.md)
309
+ - **Security Guidelines** - [Link to security docs](./security.md)
310
+
311
+ ### Company/Team
312
+ - **Engineering Handbook** - TODO: Add link
313
+ - **Company Values** - TODO: Add link
314
+ - **Team Charter** - TODO: Add link
315
+
316
+ ### External Resources
317
+ - **JavaScript/TypeScript** - MDN Web Docs, TypeScript handbook
318
+ - **React** - Official React documentation (if applicable)
319
+ - **Database** - PostgreSQL/MySQL/MongoDB documentation
320
+ - **DevOps** - Docker, Kubernetes documentation (if applicable)
321
+
322
+ ---
323
+
324
+ ## First Tasks
325
+
326
+ ### Suggested First Issues
327
+ Look for issues tagged with:
328
+ - \`good-first-issue\` - Easy issues for newcomers
329
+ - \`documentation\` - Documentation improvements
330
+ - \`bug\` with low priority - Simple bug fixes
331
+ - \`refactoring\` - Code cleanup tasks
332
+
333
+ ### Starter Tasks Ideas
334
+ 1. **Fix a typo** in documentation or comments
335
+ 2. **Add tests** to increase coverage for existing code
336
+ 3. **Improve error messages** to be more helpful
337
+ 4. **Update dependencies** that have security patches
338
+ 5. **Add logging** to better understand system behavior
339
+
340
+ ---
341
+
342
+ ## Getting Help
343
+
344
+ ### When You're Stuck
345
+ 1. **Try to debug yourself** (15-30 minutes) - Check logs, search documentation
346
+ 2. **Search existing resources** - Check Slack history, documentation, issues
347
+ 3. **Ask your onboarding buddy** - Your assigned mentor for the first few weeks
348
+ 4. **Ask in team channel** - #team-[name] for team-specific questions
349
+ 5. **Ask in #engineering** - For broader technical questions
350
+
351
+ ### No Stupid Questions
352
+ - We were all new once - ask questions freely!
353
+ - Questions often uncover documentation gaps or process issues
354
+ - If you're confused, others probably are too
355
+ - Asking helps us improve onboarding for future team members
356
+
357
+ ### Escalation
358
+ - **Technical questions** - Ask in #engineering or tech leads
359
+ - **Access issues** - Ask IT or DevOps team
360
+ - **Process questions** - Ask your manager or team lead
361
+ - **Urgent production issues** - Follow incident response process
362
+
363
+ ---
364
+
365
+ ## Team Culture & Expectations
366
+
367
+ ### Work Hours
368
+ - **Core hours:** TODO: e.g., 10am-4pm (team's local timezone)
369
+ - **Flexibility:** Work when you're most productive
370
+ - **Availability:** Be responsive during core hours
371
+ - **Overtime:** Not expected regularly, communicate if overwhelmed
372
+
373
+ ### Code Review
374
+ - **Response time:** Aim to review within 24 hours
375
+ - **Constructive feedback:** Focus on code, not person
376
+ - **Questions welcome:** Ask questions in PR comments
377
+ - **Learn from reviews:** Reviews are learning opportunities both ways
378
+
379
+ ### Development Principles
380
+ - **Test your code:** Write tests for new functionality
381
+ - **Small PRs:** Keep changes focused and reviewable
382
+ - **Documentation:** Update docs when changing behavior
383
+ - **Security:** Think about security implications
384
+ - **Performance:** Consider performance impact of changes
385
+
386
+ ### Growth & Development
387
+ - **Learning time:** Dedicate time each week to learning
388
+ - **Pair programming:** Great way to learn and teach
389
+ - **Conference talks:** Share knowledge through internal or external talks
390
+ - **Side projects:** Explore new technologies and ideas
391
+ - **Career development:** Regular discussions with manager about growth
392
+
393
+ ---
394
+
395
+ ## Feedback & Questions
396
+
397
+ ### Onboarding Feedback
398
+ We're always improving! Please provide feedback on:
399
+ - What was confusing or missing?
400
+ - What was particularly helpful?
401
+ - Suggestions for improvement?
402
+
403
+ **Submit feedback:** TODO: Add link to feedback form or channel
404
+
405
+ ### Questions About This Guide
406
+ - Update this guide as you find gaps
407
+ - Ask in #engineering if something is unclear
408
+ - Your feedback helps future team members!
409
+
410
+ <!-- agent-readonly:guidance -->
411
+ ## AI Update Checklist
412
+ 1. Verify all tool versions and installation instructions are current
413
+ 2. Update access request contacts with current team members
414
+ 3. Ensure all documentation links are valid
415
+ 4. Add new accounts or tools that team members need
416
+ 5. Update team communication channels and meeting schedules
417
+ 6. Refresh learning resources with current recommendations
418
+ 7. Verify suggested first issues are still appropriate
419
+
420
+ <!-- agent-readonly:sources -->
421
+ ## Acceptable Sources
422
+ - Development environment setup scripts and documentation
423
+ - Team wiki or handbook
424
+ - IT/DevOps onboarding documentation
425
+ - Feedback from recent new hires
426
+ - Repository README and CONTRIBUTING files
427
+
428
+ <!-- agent-update:end -->
429
+ `;
430
+ }
431
+ //# sourceMappingURL=onboardingTemplate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onboardingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/onboardingTemplate.ts"],"names":[],"mappings":";;AACA,4CA2aC;AA3aD,SAAgB,gBAAgB;IAE9B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwaR,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"projectOverviewTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA+DnF"}
1
+ {"version":3,"file":"projectOverviewTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA6DnF"}
@@ -1,30 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderProjectOverview = renderProjectOverview;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  const common_1 = require("./common");
6
5
  function renderProjectOverview(context) {
7
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
8
- id: 'project-overview',
9
- goal: 'Explain why the project exists, who it serves, and how to get productive quickly.',
10
- requiredInputs: [
11
- 'Latest product or roadmap brief',
12
- 'Repository metadata (README highlights, package manifests)',
13
- 'List of stakeholders or domain experts for verification'
14
- ],
15
- successCriteria: [
16
- 'Quick Facts mirror current tooling, stack, and entry points',
17
- 'Directory map explains where primary capabilities live',
18
- 'Next steps point to authoritative specs or dashboards'
19
- ],
20
- relatedAgents: ['documentation-writer', 'architect-specialist']
21
- });
22
6
  const directoryList = (0, common_1.formatDirectoryList)(context, true);
23
7
  const languageSummary = context.primaryLanguages.length > 0
24
8
  ? context.primaryLanguages.map(lang => `- ${lang.extension} (${lang.count} files)`).join('\n')
25
9
  : '- Language mix pending analysis.';
26
- return `${frontMatter}
27
- <!-- ai-task:project-overview -->
10
+ return `
11
+ <!-- agent-update:start:project-overview -->
28
12
  # Project Overview
29
13
 
30
14
  > TODO: Summarize the problem this project solves and who benefits from it.
@@ -34,13 +18,24 @@ function renderProjectOverview(context) {
34
18
  - Primary languages detected:
35
19
  ${languageSummary}
36
20
 
37
- ## Directory Map
21
+ ## File Structure & Code Organization
38
22
  ${directoryList || '*Add a short description for each relevant directory.*'}
39
23
 
40
- ## Technology Signals
41
- - Highlight frameworks, runtimes, state management patterns, data layers, and cross-service communication patterns detected in the repository.
42
- - Note build tooling, linting, and formatting infrastructure they should be aware of.
43
- - Call out external services (APIs, queues, cloud resources) and their integration points.
24
+ ## Technology Stack Summary
25
+ - Outline primary runtimes, languages, and platforms in use.
26
+ - Note build tooling, linting, and formatting infrastructure the team relies on.
27
+
28
+ ## Core Framework Stack
29
+ - Document core frameworks per layer (backend, frontend, data, messaging).
30
+ - Mention architectural patterns enforced by these frameworks.
31
+
32
+ ## UI & Interaction Libraries
33
+ - List UI kits, CLI interaction helpers, or design system dependencies.
34
+ - Note theming, accessibility, or localization considerations contributors must follow.
35
+
36
+ ## Development Tools Overview
37
+ - Highlight essential CLIs, scripts, or developer environments.
38
+ - Link to [Tooling & Productivity Guide](./tooling.md) for deeper setup instructions.
44
39
 
45
40
  ## Getting Started Checklist
46
41
  1. Install dependencies with \`npm install\`.
@@ -50,19 +45,21 @@ ${directoryList || '*Add a short description for each relevant directory.*'}
50
45
  ## Next Steps
51
46
  Capture product positioning, key stakeholders, and links to external documentation or product specs here.
52
47
 
48
+ <!-- agent-readonly:guidance -->
53
49
  ## AI Update Checklist
54
50
  1. Review roadmap items or issues labelled “release” to confirm current goals.
55
51
  2. Cross-check Quick Facts against \`package.json\` and environment docs.
56
- 3. Refresh the Directory Map to reflect new or retired modules; keep guidance actionable.
52
+ 3. Refresh the File Structure & Code Organization section to reflect new or retired modules; keep guidance actionable.
57
53
  4. Link critical dashboards, specs, or runbooks used by the team.
58
54
  5. Flag any details that require human confirmation (e.g., stakeholder ownership).
59
55
 
56
+ <!-- agent-readonly:sources -->
60
57
  ## Acceptable Sources
61
58
  - Recent commits, release notes, or ADRs describing high-level changes.
62
59
  - Product requirement documents linked from this repository.
63
60
  - Confirmed statements from maintainers or product leads.
64
61
 
65
- <!-- /ai-task -->
62
+ <!-- agent-update:end -->
66
63
  `;
67
64
  }
68
65
  //# sourceMappingURL=projectOverviewTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"projectOverviewTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":";;AAIA,sDA+DC;AAnED,+CAAkD;AAElD,qCAA+C;AAE/C,SAAgB,qBAAqB,CAAC,OAAqC;IACzE,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,mFAAmF;QACzF,cAAc,EAAE;YACd,iCAAiC;YACjC,4DAA4D;YAC5D,yDAAyD;SAC1D;QACD,eAAe,EAAE;YACf,6DAA6D;YAC7D,wDAAwD;YACxD,uDAAuD;SACxD;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;KAChE,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9F,CAAC,CAAC,kCAAkC,CAAC;IAEvC,OAAO,GAAG,WAAW;;;;;;;iBAON,OAAO,CAAC,aAAa,CAAC,QAAQ;;EAE7C,eAAe;;;EAGf,aAAa,IAAI,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B1E,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"projectOverviewTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":";;AAGA,sDA6DC;AA/DD,qCAA+C;AAE/C,SAAgB,qBAAqB,CAAC,OAAqC;IAEzE,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9F,CAAC,CAAC,kCAAkC,CAAC;IAEvC,OAAO;;;;;;;iBAOQ,OAAO,CAAC,aAAa,CAAC,QAAQ;;EAE7C,eAAe;;;EAGf,aAAa,IAAI,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyC1E,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"securityTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,cAAc,IAAI,MAAM,CAgDvC"}
1
+ {"version":3,"file":"securityTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,cAAc,IAAI,MAAM,CAmCvC"}
@@ -1,25 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderSecurity = renderSecurity;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  function renderSecurity() {
6
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
7
- id: 'security',
8
- goal: 'Document authentication, authorization, data protection, and compliance expectations.',
9
- requiredInputs: [
10
- 'AuthN/AuthZ implementation details',
11
- 'Secrets storage and rotation policies',
12
- 'Compliance frameworks or audit requirements'
13
- ],
14
- successCriteria: [
15
- 'Explains how users and services authenticate',
16
- 'Lists sensitive data classifications and storage locations',
17
- 'Provides clear escalation paths for security incidents'
18
- ],
19
- relatedAgents: ['security-auditor', 'code-reviewer']
20
- });
21
- return `${frontMatter}
22
- <!-- ai-task:security -->
5
+ return `
6
+ <!-- agent-update:start:security -->
23
7
  # Security & Compliance Notes
24
8
 
25
9
  Capture the policies and guardrails that keep this project secure and compliant.
@@ -36,18 +20,20 @@ Capture the policies and guardrails that keep this project secure and compliant.
36
20
  ## Incident Response
37
21
  - On-call contacts, escalation steps, and tooling for detection, triage, and post-incident analysis.
38
22
 
23
+ <!-- agent-readonly:guidance -->
39
24
  ## AI Update Checklist
40
25
  1. Confirm security libraries and infrastructure match current deployments.
41
26
  2. Update secrets management details when storage or naming changes.
42
27
  3. Reflect new compliance obligations or audit findings.
43
28
  4. Ensure incident response procedures include current contacts and tooling.
44
29
 
30
+ <!-- agent-readonly:sources -->
45
31
  ## Acceptable Sources
46
32
  - Security architecture docs, runbooks, policy handbooks.
47
33
  - IAM/authorization configuration (code or infrastructure).
48
34
  - Compliance updates from security or legal teams.
49
35
 
50
- <!-- /ai-task -->
36
+ <!-- agent-update:end -->
51
37
  `;
52
38
  }
53
39
  //# sourceMappingURL=securityTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"securityTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":";;AAEA,wCAgDC;AAlDD,+CAAkD;AAElD,SAAgB,cAAc;IAC5B,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,UAAU;QACd,IAAI,EAAE,uFAAuF;QAC7F,cAAc,EAAE;YACd,oCAAoC;YACpC,uCAAuC;YACvC,6CAA6C;SAC9C;QACD,eAAe,EAAE;YACf,8CAA8C;YAC9C,4DAA4D;YAC5D,wDAAwD;SACzD;QACD,aAAa,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;KACrD,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BtB,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"securityTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":";;AACA,wCAmCC;AAnCD,SAAgB,cAAc;IAE5B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCR,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"testingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,IAAI,MAAM,CAsD9C"}
1
+ {"version":3,"file":"testingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,qBAAqB,IAAI,MAAM,CAyC9C"}
@@ -1,25 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderTestingStrategy = renderTestingStrategy;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  function renderTestingStrategy() {
6
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
7
- id: 'testing-strategy',
8
- goal: 'Explain how the project maintains quality, from unit coverage to release gates.',
9
- requiredInputs: [
10
- 'Testing framework configuration (jest.config.js, etc.)',
11
- 'CI requirements for merges/releases',
12
- 'Known flaky suites or troubleshooting notes'
13
- ],
14
- successCriteria: [
15
- 'Test types list frameworks and ownership at a glance',
16
- 'Commands match package scripts and CI usage',
17
- 'Quality gates describe pass/fail expectations with numbers when possible'
18
- ],
19
- relatedAgents: ['test-writer', 'code-reviewer']
20
- });
21
- return `${frontMatter}
22
- <!-- ai-task:testing-strategy -->
5
+ return `
6
+ <!-- agent-update:start:testing-strategy -->
23
7
  # Testing Strategy
24
8
 
25
9
  Document how quality is maintained across the codebase.
@@ -41,6 +25,7 @@ Document how quality is maintained across the codebase.
41
25
  ## Troubleshooting
42
26
  - Document flaky suites, long-running tests, or environment quirks.
43
27
 
28
+ <!-- agent-readonly:guidance -->
44
29
  ## AI Update Checklist
45
30
  1. Review test scripts and CI workflows to confirm command accuracy.
46
31
  2. Update Quality Gates with current thresholds (coverage %, lint rules, required checks).
@@ -48,12 +33,13 @@ Document how quality is maintained across the codebase.
48
33
  4. Record known flaky areas and link to open issues for visibility.
49
34
  5. Confirm troubleshooting steps remain valid with current tooling.
50
35
 
36
+ <!-- agent-readonly:sources -->
51
37
  ## Acceptable Sources
52
38
  - \`package.json\` scripts and testing configuration files.
53
39
  - CI job definitions (GitHub Actions, CircleCI, etc.).
54
40
  - Issue tracker items labelled “testing” or “flaky” with maintainer confirmation.
55
41
 
56
- <!-- /ai-task -->
42
+ <!-- agent-update:end -->
57
43
  `;
58
44
  }
59
45
  //# sourceMappingURL=testingTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"testingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":";;AAEA,sDAsDC;AAxDD,+CAAkD;AAElD,SAAgB,qBAAqB;IACnC,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,iFAAiF;QACvF,cAAc,EAAE;YACd,wDAAwD;YACxD,qCAAqC;YACrC,6CAA6C;SAC9C;QACD,eAAe,EAAE;YACf,sDAAsD;YACtD,6CAA6C;YAC7C,0EAA0E;SAC3E;QACD,aAAa,EAAE,CAAC,aAAa,EAAE,eAAe,CAAC;KAChD,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCtB,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"testingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":";;AACA,sDAyCC;AAzCD,SAAgB,qBAAqB;IAEnC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCR,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"toolingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,kBAAkB,IAAI,MAAM,CAmD3C"}
1
+ {"version":3,"file":"toolingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,kBAAkB,IAAI,MAAM,CAsC3C"}