@ggailabs/cli-context 0.5.5 → 1.0.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.
Potentially problematic release.
This version of @ggailabs/cli-context might be problematic. Click here for more details.
- package/dist/.context/docs/GENESIS_SYSTEM_PROMPT.md +62 -0
- package/dist/.context/eng/agents/architect.md +15 -0
- package/dist/.context/eng/agents/backend_typescript.md +1000 -0
- package/dist/.context/eng/agents/bug_hunter.md +49 -0
- package/dist/.context/eng/agents/code_reviewer.md +313 -0
- package/dist/.context/eng/agents/devops_specialist.md +718 -0
- package/dist/.context/eng/agents/frontend_specialist.md +1027 -0
- package/dist/.context/eng/agents/qa_specialist.md +1234 -0
- package/dist/.context/eng/agents/security_reviewer.md +382 -0
- package/dist/.context/eng/agents/ui_specialist.md +16 -0
- package/dist/.context/eng/docs/AGENT_HANDOFF_PROMPT.md +44 -0
- package/dist/.context/eng/docs/GENESIS_DESIGN_SYSTEM.md +15 -0
- package/dist/.context/eng/docs/GG_METHODOLOGY.md +48 -0
- package/dist/.context/eng/docs/OPERATIONS_LOG.md +30 -0
- package/dist/.context/eng/docs/PROJECT_MAP.md +35 -0
- package/dist/.context/eng/docs/standards/devops.md +0 -0
- package/dist/.context/eng/docs/standards/frontend.md +0 -0
- package/dist/.context/eng/docs/standards/typescript.md +12 -0
- package/dist/.context/eng/skills/agent_logging.md +18 -0
- package/dist/.context/eng/skills/brainstorming.md +227 -0
- package/dist/.context/eng/skills/exploring_codebase.md +1217 -0
- package/dist/.context/eng/skills/patterns/compliance_check.md +246 -0
- package/dist/.context/eng/skills/patterns/coverage_table.md +401 -0
- package/dist/.context/eng/skills/patterns/exit_criteria.md +31 -0
- package/dist/.context/eng/skills/patterns/failure_recovery.md +74 -0
- package/dist/.context/eng/skills/patterns/quality_gate.md +295 -0
- package/dist/.context/eng/skills/patterns/standards_workflow.md +391 -0
- package/dist/.context/eng/skills/patterns/state_tracking.md +30 -0
- package/dist/.context/eng/skills/patterns/task_tracking.md +38 -0
- package/dist/.context/eng/skills/previce.md +45 -0
- package/dist/.context/eng/skills/tdd.md +421 -0
- package/dist/.context/eng/skills/writing_plans.md +105 -0
- package/dist/.context/plans/.gitkeep +0 -0
- package/dist/.context/pt-br/agents/architect.md +69 -0
- package/dist/.context/pt-br/agents/backend_typescript.md +1000 -0
- package/dist/.context/pt-br/agents/bug_hunter.md +49 -0
- package/dist/.context/pt-br/agents/code_reviewer.md +313 -0
- package/dist/.context/pt-br/agents/devops_specialist.md +718 -0
- package/dist/.context/pt-br/agents/frontend_specialist.md +1027 -0
- package/dist/.context/pt-br/agents/qa_specialist.md +1234 -0
- package/dist/.context/pt-br/agents/security_reviewer.md +382 -0
- package/dist/.context/pt-br/agents/ui_specialist.md +55 -0
- package/dist/.context/pt-br/docs/AGENT_HANDOFF_PROMPT.md +44 -0
- package/dist/.context/pt-br/docs/GENESIS_DESIGN_SYSTEM.md +88 -0
- package/dist/.context/pt-br/docs/GG_METHODOLOGY.md +48 -0
- package/dist/.context/pt-br/docs/OPERATIONS_LOG.md +30 -0
- package/dist/.context/pt-br/docs/PROJECT_MAP.md +37 -0
- package/dist/.context/pt-br/docs/standards/devops.md +707 -0
- package/dist/.context/pt-br/docs/standards/frontend.md +748 -0
- package/dist/.context/pt-br/docs/standards/typescript.md +1150 -0
- package/dist/.context/pt-br/skills/agent_logging.md +36 -0
- package/dist/.context/pt-br/skills/brainstorming.md +227 -0
- package/dist/.context/pt-br/skills/exploring_codebase.md +1217 -0
- package/dist/.context/pt-br/skills/patterns/compliance_check.md +246 -0
- package/dist/.context/pt-br/skills/patterns/coverage_table.md +401 -0
- package/dist/.context/pt-br/skills/patterns/exit_criteria.md +31 -0
- package/dist/.context/pt-br/skills/patterns/failure_recovery.md +74 -0
- package/dist/.context/pt-br/skills/patterns/quality_gate.md +295 -0
- package/dist/.context/pt-br/skills/patterns/standards_workflow.md +391 -0
- package/dist/.context/pt-br/skills/patterns/state_tracking.md +30 -0
- package/dist/.context/pt-br/skills/patterns/task_tracking.md +38 -0
- package/dist/.context/pt-br/skills/previce.md +45 -0
- package/dist/.context/pt-br/skills/tdd.md +421 -0
- package/dist/.context/pt-br/skills/writing_plans.md +105 -0
- package/dist/.context/workflow/.gitkeep +0 -0
- package/dist/commands/init.js +140 -0
- package/dist/commands/monitor.js +34 -0
- package/dist/index.js +20 -568
- package/dist/services/monitor-service.js +340 -0
- package/dist/services/scaffolder.js +164 -0
- package/package.json +16 -58
- package/LICENSE +0 -21
- package/README.md +0 -197
- package/dist/generators/agents/agentConfig.d.ts +0 -4
- package/dist/generators/agents/agentConfig.d.ts.map +0 -1
- package/dist/generators/agents/agentConfig.js +0 -180
- package/dist/generators/agents/agentConfig.js.map +0 -1
- package/dist/generators/agents/agentGenerator.d.ts +0 -9
- package/dist/generators/agents/agentGenerator.d.ts.map +0 -1
- package/dist/generators/agents/agentGenerator.js +0 -97
- package/dist/generators/agents/agentGenerator.js.map +0 -1
- package/dist/generators/agents/agentTypes.d.ts +0 -4
- package/dist/generators/agents/agentTypes.d.ts.map +0 -1
- package/dist/generators/agents/agentTypes.js +0 -25
- package/dist/generators/agents/agentTypes.js.map +0 -1
- package/dist/generators/agents/index.d.ts +0 -4
- package/dist/generators/agents/index.d.ts.map +0 -1
- package/dist/generators/agents/index.js +0 -12
- package/dist/generators/agents/index.js.map +0 -1
- package/dist/generators/agents/templates/index.d.ts +0 -4
- package/dist/generators/agents/templates/index.d.ts.map +0 -1
- package/dist/generators/agents/templates/index.js +0 -8
- package/dist/generators/agents/templates/index.js.map +0 -1
- package/dist/generators/agents/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/agents/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/agents/templates/indexTemplate.js +0 -36
- package/dist/generators/agents/templates/indexTemplate.js.map +0 -1
- package/dist/generators/agents/templates/playbookTemplate.d.ts +0 -4
- package/dist/generators/agents/templates/playbookTemplate.d.ts.map +0 -1
- package/dist/generators/agents/templates/playbookTemplate.js +0 -99
- package/dist/generators/agents/templates/playbookTemplate.js.map +0 -1
- package/dist/generators/agents/templates/types.d.ts +0 -14
- package/dist/generators/agents/templates/types.d.ts.map +0 -1
- package/dist/generators/agents/templates/types.js +0 -3
- package/dist/generators/agents/templates/types.js.map +0 -1
- package/dist/generators/documentation/documentationGenerator.d.ts +0 -15
- package/dist/generators/documentation/documentationGenerator.d.ts.map +0 -1
- package/dist/generators/documentation/documentationGenerator.js +0 -188
- package/dist/generators/documentation/documentationGenerator.js.map +0 -1
- package/dist/generators/documentation/guideRegistry.d.ts +0 -6
- package/dist/generators/documentation/guideRegistry.d.ts.map +0 -1
- package/dist/generators/documentation/guideRegistry.js +0 -82
- package/dist/generators/documentation/guideRegistry.js.map +0 -1
- package/dist/generators/documentation/index.d.ts +0 -2
- package/dist/generators/documentation/index.d.ts.map +0 -1
- package/dist/generators/documentation/index.js +0 -6
- package/dist/generators/documentation/index.js.map +0 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.js +0 -490
- package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/architectureTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/architectureTemplate.js +0 -66
- package/dist/generators/documentation/templates/architectureTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/common.d.ts +0 -7
- package/dist/generators/documentation/templates/common.d.ts.map +0 -1
- package/dist/generators/documentation/templates/common.js +0 -58
- package/dist/generators/documentation/templates/common.js.map +0 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.js +0 -40
- package/dist/generators/documentation/templates/dataFlowTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +0 -44
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/glossaryTemplate.js +0 -41
- package/dist/generators/documentation/templates/glossaryTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/index.d.ts +0 -15
- package/dist/generators/documentation/templates/index.d.ts.map +0 -1
- package/dist/generators/documentation/templates/index.js +0 -30
- package/dist/generators/documentation/templates/index.js.map +0 -1
- package/dist/generators/documentation/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/indexTemplate.js +0 -42
- package/dist/generators/documentation/templates/indexTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/migrationTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/migrationTemplate.js +0 -422
- package/dist/generators/documentation/templates/migrationTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/onboardingTemplate.js +0 -431
- package/dist/generators/documentation/templates/onboardingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.js +0 -65
- package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/securityTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/securityTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/securityTemplate.js +0 -39
- package/dist/generators/documentation/templates/securityTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/testingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/testingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/testingTemplate.js +0 -45
- package/dist/generators/documentation/templates/testingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/toolingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/toolingTemplate.js +0 -42
- package/dist/generators/documentation/templates/toolingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.js +0 -292
- package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/types.d.ts +0 -23
- package/dist/generators/documentation/templates/types.d.ts.map +0 -1
- package/dist/generators/documentation/templates/types.js +0 -3
- package/dist/generators/documentation/templates/types.js.map +0 -1
- package/dist/generators/plans/index.d.ts +0 -2
- package/dist/generators/plans/index.d.ts.map +0 -1
- package/dist/generators/plans/index.js +0 -6
- package/dist/generators/plans/index.js.map +0 -1
- package/dist/generators/plans/planGenerator.d.ts +0 -22
- package/dist/generators/plans/planGenerator.d.ts.map +0 -1
- package/dist/generators/plans/planGenerator.js +0 -109
- package/dist/generators/plans/planGenerator.js.map +0 -1
- package/dist/generators/plans/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/plans/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/plans/templates/indexTemplate.js +0 -37
- package/dist/generators/plans/templates/indexTemplate.js.map +0 -1
- package/dist/generators/plans/templates/planTemplate.d.ts +0 -3
- package/dist/generators/plans/templates/planTemplate.d.ts.map +0 -1
- package/dist/generators/plans/templates/planTemplate.js +0 -166
- package/dist/generators/plans/templates/planTemplate.js.map +0 -1
- package/dist/generators/plans/templates/types.d.ts +0 -19
- package/dist/generators/plans/templates/types.d.ts.map +0 -1
- package/dist/generators/plans/templates/types.js +0 -3
- package/dist/generators/plans/templates/types.js.map +0 -1
- package/dist/generators/shared/contextGenerator.d.ts +0 -7
- package/dist/generators/shared/contextGenerator.d.ts.map +0 -1
- package/dist/generators/shared/contextGenerator.js +0 -13
- package/dist/generators/shared/contextGenerator.js.map +0 -1
- package/dist/generators/shared/directoryTemplateHelpers.d.ts +0 -2
- package/dist/generators/shared/directoryTemplateHelpers.d.ts.map +0 -1
- package/dist/generators/shared/directoryTemplateHelpers.js +0 -12
- package/dist/generators/shared/directoryTemplateHelpers.js.map +0 -1
- package/dist/generators/shared/generatorUtils.d.ts +0 -16
- package/dist/generators/shared/generatorUtils.d.ts.map +0 -1
- package/dist/generators/shared/generatorUtils.js +0 -119
- package/dist/generators/shared/generatorUtils.js.map +0 -1
- package/dist/generators/shared/index.d.ts +0 -4
- package/dist/generators/shared/index.d.ts.map +0 -1
- package/dist/generators/shared/index.js +0 -10
- package/dist/generators/shared/index.js.map +0 -1
- package/dist/index.d.ts +0 -9
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/prompts/defaults.d.ts +0 -3
- package/dist/prompts/defaults.d.ts.map +0 -1
- package/dist/prompts/defaults.js +0 -95
- package/dist/prompts/defaults.js.map +0 -1
- package/dist/services/baseLLMClient.d.ts +0 -12
- package/dist/services/baseLLMClient.d.ts.map +0 -1
- package/dist/services/baseLLMClient.js +0 -80
- package/dist/services/baseLLMClient.js.map +0 -1
- package/dist/services/fill/fillService.d.ts +0 -46
- package/dist/services/fill/fillService.d.ts.map +0 -1
- package/dist/services/fill/fillService.js +0 -254
- package/dist/services/fill/fillService.js.map +0 -1
- package/dist/services/init/initService.d.ts +0 -37
- package/dist/services/init/initService.d.ts.map +0 -1
- package/dist/services/init/initService.js +0 -167
- package/dist/services/init/initService.js.map +0 -1
- package/dist/services/llmClientFactory.d.ts +0 -8
- package/dist/services/llmClientFactory.d.ts.map +0 -1
- package/dist/services/llmClientFactory.js +0 -23
- package/dist/services/llmClientFactory.js.map +0 -1
- package/dist/services/openRouterClient.d.ts +0 -9
- package/dist/services/openRouterClient.d.ts.map +0 -1
- package/dist/services/openRouterClient.js +0 -49
- package/dist/services/openRouterClient.js.map +0 -1
- package/dist/services/plan/planService.d.ts +0 -57
- package/dist/services/plan/planService.d.ts.map +0 -1
- package/dist/services/plan/planService.js +0 -334
- package/dist/services/plan/planService.js.map +0 -1
- package/dist/services/shared/llmConfig.d.ts +0 -22
- package/dist/services/shared/llmConfig.d.ts.map +0 -1
- package/dist/services/shared/llmConfig.js +0 -38
- package/dist/services/shared/llmConfig.js.map +0 -1
- package/dist/types.d.ts +0 -65
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
- package/dist/utils/cliUI.d.ts +0 -27
- package/dist/utils/cliUI.d.ts.map +0 -1
- package/dist/utils/cliUI.js +0 -252
- package/dist/utils/cliUI.js.map +0 -1
- package/dist/utils/fileMapper.d.ts +0 -11
- package/dist/utils/fileMapper.d.ts.map +0 -1
- package/dist/utils/fileMapper.js +0 -146
- package/dist/utils/fileMapper.js.map +0 -1
- package/dist/utils/gitService.d.ts +0 -50
- package/dist/utils/gitService.d.ts.map +0 -1
- package/dist/utils/gitService.js +0 -470
- package/dist/utils/gitService.js.map +0 -1
- package/dist/utils/i18n.d.ts +0 -171
- package/dist/utils/i18n.d.ts.map +0 -1
- package/dist/utils/i18n.js +0 -381
- package/dist/utils/i18n.js.map +0 -1
- package/dist/utils/promptLoader.d.ts +0 -12
- package/dist/utils/promptLoader.d.ts.map +0 -1
- package/dist/utils/promptLoader.js +0 -81
- package/dist/utils/promptLoader.js.map +0 -1
- package/dist/utils/versionChecker.d.ts +0 -15
- package/dist/utils/versionChecker.d.ts.map +0 -1
- package/dist/utils/versionChecker.js +0 -49
- package/dist/utils/versionChecker.js.map +0 -1
- package/prompts/update_plan_prompt.md +0 -41
- package/prompts/update_scaffold_prompt.md +0 -47
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"indexTemplate.js","sourceRoot":"","sources":["../../../../src/generators/agents/templates/indexTemplate.ts"],"names":[],"mappings":";;AAGA,4CAyBC;AA3BD,gDAAwD;AAExD,SAAgB,gBAAgB,CAAC,UAAgC;IAC/D,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACzC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,qBAAqB,GAAG,oCAAsB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,iCAAiC,CAAC;QACrG,OAAO,MAAM,KAAK,OAAO,IAAI,UAAU,qBAAqB,EAAE,CAAC;IACjE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO;;;;;EAKP,YAAY;;;;;;;;;;;;CAYb,CAAC;AACF,CAAC;AAED,SAAS,WAAW,CAAC,SAAiB;IACpC,OAAO,SAAS;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"playbookTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,SAAS,EACpB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,WAAW,EAAE,aAAa,EAAE,GAC3B,MAAM,CAkFR"}
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.renderAgentPlaybook = renderAgentPlaybook;
|
|
4
|
-
const agentConfig_1 = require("../agentConfig");
|
|
5
|
-
const directoryTemplateHelpers_1 = require("../../shared/directoryTemplateHelpers");
|
|
6
|
-
function renderAgentPlaybook(agentType, topLevelDirectories, touchpoints) {
|
|
7
|
-
const title = formatTitle(agentType);
|
|
8
|
-
const responsibilities = agentConfig_1.AGENT_RESPONSIBILITIES[agentType] || ['Clarify this agent\'s responsibilities.'];
|
|
9
|
-
const bestPractices = agentConfig_1.AGENT_BEST_PRACTICES[agentType] || ['Document preferred workflows.'];
|
|
10
|
-
const directoryList = (0, directoryTemplateHelpers_1.formatDirectoryList)(topLevelDirectories);
|
|
11
|
-
const markerId = `agent-${agentType}`;
|
|
12
|
-
const touchpointList = touchpoints
|
|
13
|
-
.map(tp => `- [${tp.title}](${tp.path}) — ${tp.marker}`)
|
|
14
|
-
.join('\n');
|
|
15
|
-
return `<!-- agent-update:start:${markerId} -->
|
|
16
|
-
# ${title} Agent Playbook
|
|
17
|
-
|
|
18
|
-
## Mission
|
|
19
|
-
Describe how the ${title.toLowerCase()} agent supports the team and when to engage it.
|
|
20
|
-
|
|
21
|
-
## Responsibilities
|
|
22
|
-
${formatList(responsibilities)}
|
|
23
|
-
|
|
24
|
-
## Best Practices
|
|
25
|
-
${formatList(bestPractices)}
|
|
26
|
-
|
|
27
|
-
## Key Project Resources
|
|
28
|
-
- Documentation index: [docs/README.md](../docs/README.md)
|
|
29
|
-
- Agent handbook: [agents/README.md](./README.md)
|
|
30
|
-
- Agent knowledge base: [AGENTS.md](../../AGENTS.md)
|
|
31
|
-
- Contributor guide: [CONTRIBUTING.md](../../CONTRIBUTING.md)
|
|
32
|
-
|
|
33
|
-
## Repository Starting Points
|
|
34
|
-
${directoryList || '- Add directory highlights relevant to this agent.'}
|
|
35
|
-
|
|
36
|
-
## Documentation Touchpoints
|
|
37
|
-
${touchpointList}
|
|
38
|
-
|
|
39
|
-
<!-- agent-readonly:guidance -->
|
|
40
|
-
## Collaboration Checklist
|
|
41
|
-
1. Confirm assumptions with issue reporters or maintainers.
|
|
42
|
-
2. Review open pull requests affecting this area.
|
|
43
|
-
3. Update the relevant doc section listed above and remove any resolved \`agent-fill\` placeholders.
|
|
44
|
-
4. Capture learnings back in [docs/README.md](../docs/README.md) or the appropriate task marker.
|
|
45
|
-
|
|
46
|
-
## Success Metrics
|
|
47
|
-
Track effectiveness of this agent's contributions:
|
|
48
|
-
- **Code Quality:** Reduced bug count, improved test coverage, decreased technical debt
|
|
49
|
-
- **Velocity:** Time to complete typical tasks, deployment frequency
|
|
50
|
-
- **Documentation:** Coverage of features, accuracy of guides, usage by team
|
|
51
|
-
- **Collaboration:** PR review turnaround time, feedback quality, knowledge sharing
|
|
52
|
-
|
|
53
|
-
**Target Metrics:**
|
|
54
|
-
- TODO: Define measurable goals specific to this agent (e.g., "Reduce bug resolution time by 30%")
|
|
55
|
-
- TODO: Track trends over time to identify improvement areas
|
|
56
|
-
|
|
57
|
-
## Troubleshooting Common Issues
|
|
58
|
-
Document frequent problems this agent encounters and their solutions:
|
|
59
|
-
|
|
60
|
-
### Issue: [Common Problem]
|
|
61
|
-
**Symptoms:** Describe what indicates this problem
|
|
62
|
-
**Root Cause:** Why this happens
|
|
63
|
-
**Resolution:** Step-by-step fix
|
|
64
|
-
**Prevention:** How to avoid in the future
|
|
65
|
-
|
|
66
|
-
**Example:**
|
|
67
|
-
### Issue: Build Failures Due to Outdated Dependencies
|
|
68
|
-
**Symptoms:** Tests fail with module resolution errors
|
|
69
|
-
**Root Cause:** Package versions incompatible with codebase
|
|
70
|
-
**Resolution:**
|
|
71
|
-
1. Review package.json for version ranges
|
|
72
|
-
2. Run \`npm update\` to get compatible versions
|
|
73
|
-
3. Test locally before committing
|
|
74
|
-
**Prevention:** Keep dependencies updated regularly, use lockfiles
|
|
75
|
-
|
|
76
|
-
## Hand-off Notes
|
|
77
|
-
Summarize outcomes, remaining risks, and suggested follow-up actions after the agent completes its work.
|
|
78
|
-
|
|
79
|
-
## Evidence to Capture
|
|
80
|
-
- Reference commits, issues, or ADRs used to justify updates.
|
|
81
|
-
- Command output or logs that informed recommendations.
|
|
82
|
-
- Follow-up items for maintainers or future agent runs.
|
|
83
|
-
- Performance metrics and benchmarks where applicable.
|
|
84
|
-
<!-- agent-update:end -->
|
|
85
|
-
`;
|
|
86
|
-
}
|
|
87
|
-
function formatTitle(agentType) {
|
|
88
|
-
return agentType
|
|
89
|
-
.split('-')
|
|
90
|
-
.map(segment => segment.charAt(0).toUpperCase() + segment.slice(1))
|
|
91
|
-
.join(' ');
|
|
92
|
-
}
|
|
93
|
-
function formatList(items) {
|
|
94
|
-
if (!items.length) {
|
|
95
|
-
return '- _No entries defined yet._';
|
|
96
|
-
}
|
|
97
|
-
return items.map(item => `- ${item}`).join('\n');
|
|
98
|
-
}
|
|
99
|
-
//# sourceMappingURL=playbookTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"playbookTemplate.js","sourceRoot":"","sources":["../../../../src/generators/agents/templates/playbookTemplate.ts"],"names":[],"mappings":";;AAKA,kDAsFC;AA3FD,gDAA8E;AAE9E,oFAA4E;AAG5E,SAAgB,mBAAmB,CACjC,SAAoB,EACpB,mBAA6B,EAC7B,WAA4B;IAE5B,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,gBAAgB,GAAG,oCAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IAC1G,MAAM,aAAa,GAAG,kCAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC3F,MAAM,aAAa,GAAG,IAAA,8CAAmB,EAAC,mBAAmB,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAG,SAAS,SAAS,EAAE,CAAC;IAEtC,MAAM,cAAc,GAAG,WAAW;SAC/B,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;SACvD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,2BAA2B,QAAQ;IACxC,KAAK;;;mBAGU,KAAK,CAAC,WAAW,EAAE;;;EAGpC,UAAU,CAAC,gBAAgB,CAAC;;;EAG5B,UAAU,CAAC,aAAa,CAAC;;;;;;;;;EASzB,aAAa,IAAI,oDAAoD;;;EAGrE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgDf,CAAC;AACF,CAAC;AAED,SAAS,WAAW,CAAC,SAAiB;IACpC,OAAO,SAAS;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAe;IACjC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC"}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { AgentType } from '../agentTypes';
|
|
2
|
-
export interface DocTouchpoint {
|
|
3
|
-
title: string;
|
|
4
|
-
path: string;
|
|
5
|
-
marker: string;
|
|
6
|
-
}
|
|
7
|
-
export interface AgentTemplateContext {
|
|
8
|
-
agentType: AgentType;
|
|
9
|
-
topLevelDirectories: string[];
|
|
10
|
-
docTouchpoints: DocTouchpoint[];
|
|
11
|
-
responsibilities: string[];
|
|
12
|
-
bestPractices: string[];
|
|
13
|
-
}
|
|
14
|
-
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/generators/agents/templates/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/generators/agents/templates/types.ts"],"names":[],"mappings":""}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { RepoStructure } from '../../types';
|
|
2
|
-
interface DocumentationGenerationConfig {
|
|
3
|
-
selectedDocs?: string[];
|
|
4
|
-
}
|
|
5
|
-
export declare class DocumentationGenerator {
|
|
6
|
-
constructor(..._legacyArgs: unknown[]);
|
|
7
|
-
generateDocumentation(repoStructure: RepoStructure, outputDir: string, config?: DocumentationGenerationConfig, verbose?: boolean): Promise<number>;
|
|
8
|
-
private buildContext;
|
|
9
|
-
private deriveTopLevelDirectories;
|
|
10
|
-
private getDocSections;
|
|
11
|
-
private updateAgentGuideReferences;
|
|
12
|
-
private createDefaultAgentGuide;
|
|
13
|
-
}
|
|
14
|
-
export {};
|
|
15
|
-
//# sourceMappingURL=documentationGenerator.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationGenerator.d.ts","sourceRoot":"","sources":["../../../src/generators/documentation/documentationGenerator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAsB5C,UAAU,6BAA6B;IACrC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,qBAAa,sBAAsB;gBACrB,GAAG,WAAW,EAAE,OAAO,EAAE;IAE/B,qBAAqB,CACzB,aAAa,EAAE,aAAa,EAC5B,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,6BAAkC,EAC1C,OAAO,GAAE,OAAe,GACvB,OAAO,CAAC,MAAM,CAAC;IAqBlB,OAAO,CAAC,YAAY;IA4BpB,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,cAAc;YAkCR,0BAA0B;IAgCxC,OAAO,CAAC,uBAAuB;CA0ChC"}
|
|
@@ -1,188 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
-
var ownKeys = function(o) {
|
|
20
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
-
var ar = [];
|
|
22
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
-
return ar;
|
|
24
|
-
};
|
|
25
|
-
return ownKeys(o);
|
|
26
|
-
};
|
|
27
|
-
return function (mod) {
|
|
28
|
-
if (mod && mod.__esModule) return mod;
|
|
29
|
-
var result = {};
|
|
30
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
-
__setModuleDefault(result, mod);
|
|
32
|
-
return result;
|
|
33
|
-
};
|
|
34
|
-
})();
|
|
35
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.DocumentationGenerator = void 0;
|
|
37
|
-
const path = __importStar(require("path"));
|
|
38
|
-
const fs = __importStar(require("fs-extra"));
|
|
39
|
-
const shared_1 = require("../shared");
|
|
40
|
-
const templates_1 = require("./templates");
|
|
41
|
-
const guideRegistry_1 = require("./guideRegistry");
|
|
42
|
-
class DocumentationGenerator {
|
|
43
|
-
constructor(..._legacyArgs) { }
|
|
44
|
-
async generateDocumentation(repoStructure, outputDir, config = {}, verbose = false) {
|
|
45
|
-
const docsDir = path.join(outputDir, 'docs');
|
|
46
|
-
await shared_1.GeneratorUtils.ensureDirectoryAndLog(docsDir, verbose, 'Generating documentation scaffold in');
|
|
47
|
-
const guidesToGenerate = (0, guideRegistry_1.getGuidesByKeys)(config.selectedDocs);
|
|
48
|
-
const context = this.buildContext(repoStructure, guidesToGenerate);
|
|
49
|
-
const sections = this.getDocSections(guidesToGenerate);
|
|
50
|
-
let created = 0;
|
|
51
|
-
for (const section of sections) {
|
|
52
|
-
const targetPath = path.join(docsDir, section.fileName);
|
|
53
|
-
const content = section.content(context);
|
|
54
|
-
await shared_1.GeneratorUtils.writeFileWithLogging(targetPath, content, verbose, `Created ${section.fileName}`);
|
|
55
|
-
created += 1;
|
|
56
|
-
}
|
|
57
|
-
await this.updateAgentGuideReferences(repoStructure, verbose);
|
|
58
|
-
return created;
|
|
59
|
-
}
|
|
60
|
-
buildContext(repoStructure, guides) {
|
|
61
|
-
const topLevelStats = repoStructure.topLevelDirectoryStats ?? [];
|
|
62
|
-
const topLevelDirectories = topLevelStats.length
|
|
63
|
-
? topLevelStats.map(stat => stat.name)
|
|
64
|
-
: this.deriveTopLevelDirectories(repoStructure);
|
|
65
|
-
const directoryStats = topLevelStats.length
|
|
66
|
-
? topLevelStats.map(stat => ({ name: stat.name, fileCount: stat.fileCount }))
|
|
67
|
-
: topLevelDirectories.map(name => ({
|
|
68
|
-
name,
|
|
69
|
-
fileCount: repoStructure.files.filter(file => file.relativePath.startsWith(`${name}/`)).length
|
|
70
|
-
}));
|
|
71
|
-
const primaryLanguages = shared_1.GeneratorUtils.getTopFileExtensions(repoStructure, 5)
|
|
72
|
-
.filter(([ext]) => !!ext)
|
|
73
|
-
.map(([extension, count]) => ({ extension, count }));
|
|
74
|
-
return {
|
|
75
|
-
repoStructure,
|
|
76
|
-
topLevelDirectories,
|
|
77
|
-
primaryLanguages,
|
|
78
|
-
directoryStats,
|
|
79
|
-
guides
|
|
80
|
-
};
|
|
81
|
-
}
|
|
82
|
-
deriveTopLevelDirectories(repoStructure) {
|
|
83
|
-
const directorySet = new Set();
|
|
84
|
-
repoStructure.directories.forEach(dir => {
|
|
85
|
-
const [firstSegment] = dir.relativePath.split(/[\\/]/).filter(Boolean);
|
|
86
|
-
if (firstSegment) {
|
|
87
|
-
directorySet.add(firstSegment);
|
|
88
|
-
}
|
|
89
|
-
});
|
|
90
|
-
return Array.from(directorySet).sort();
|
|
91
|
-
}
|
|
92
|
-
getDocSections(guides) {
|
|
93
|
-
const sections = [
|
|
94
|
-
{
|
|
95
|
-
fileName: 'README.md',
|
|
96
|
-
content: context => (0, templates_1.renderIndex)(context)
|
|
97
|
-
}
|
|
98
|
-
];
|
|
99
|
-
const renderMap = {
|
|
100
|
-
'project-overview': templates_1.renderProjectOverview,
|
|
101
|
-
architecture: templates_1.renderArchitectureNotes,
|
|
102
|
-
'development-workflow': () => (0, templates_1.renderDevelopmentWorkflow)(),
|
|
103
|
-
'testing-strategy': () => (0, templates_1.renderTestingStrategy)(),
|
|
104
|
-
glossary: templates_1.renderGlossary,
|
|
105
|
-
'data-flow': templates_1.renderDataFlow,
|
|
106
|
-
security: () => (0, templates_1.renderSecurity)(),
|
|
107
|
-
tooling: () => (0, templates_1.renderToolingGuide)()
|
|
108
|
-
};
|
|
109
|
-
guides.forEach(guide => {
|
|
110
|
-
const renderer = renderMap[guide.key];
|
|
111
|
-
if (!renderer) {
|
|
112
|
-
return;
|
|
113
|
-
}
|
|
114
|
-
sections.push({
|
|
115
|
-
fileName: guide.file,
|
|
116
|
-
content: renderer
|
|
117
|
-
});
|
|
118
|
-
});
|
|
119
|
-
return sections;
|
|
120
|
-
}
|
|
121
|
-
async updateAgentGuideReferences(repoStructure, verbose) {
|
|
122
|
-
const repoRoot = repoStructure.rootPath;
|
|
123
|
-
const agentGuidePath = path.join(repoRoot, 'AGENTS.md');
|
|
124
|
-
try {
|
|
125
|
-
const exists = await fs.pathExists(agentGuidePath);
|
|
126
|
-
if (!exists) {
|
|
127
|
-
const template = this.createDefaultAgentGuide(repoStructure);
|
|
128
|
-
await fs.writeFile(agentGuidePath, template, 'utf-8');
|
|
129
|
-
shared_1.GeneratorUtils.logProgress('Created AGENTS.md using the agents.md example starter.', verbose);
|
|
130
|
-
return;
|
|
131
|
-
}
|
|
132
|
-
const content = await fs.readFile(agentGuidePath, 'utf-8');
|
|
133
|
-
const docsReference = '.context/docs/README.md';
|
|
134
|
-
const agentsReference = '.context/agents/README.md';
|
|
135
|
-
if (content.includes(docsReference) && content.includes(agentsReference)) {
|
|
136
|
-
return;
|
|
137
|
-
}
|
|
138
|
-
const referencesBlock = `\n## AI Context References\n- Documentation index: \`${docsReference}\`\n- Agent playbooks: \`${agentsReference}\`\n`;
|
|
139
|
-
const updatedContent = `${content.trimEnd()}${referencesBlock}\n`;
|
|
140
|
-
await fs.writeFile(agentGuidePath, updatedContent, 'utf-8');
|
|
141
|
-
shared_1.GeneratorUtils.logProgress('Linked AGENTS.md to generated docs and agent indexes.', verbose);
|
|
142
|
-
}
|
|
143
|
-
catch (error) {
|
|
144
|
-
shared_1.GeneratorUtils.logError('Failed to update AGENTS.md with documentation references', error, verbose);
|
|
145
|
-
}
|
|
146
|
-
}
|
|
147
|
-
createDefaultAgentGuide(repoStructure) {
|
|
148
|
-
const directories = (repoStructure.topLevelDirectoryStats?.length
|
|
149
|
-
? repoStructure.topLevelDirectoryStats.map(stat => stat.name)
|
|
150
|
-
: this.deriveTopLevelDirectories(repoStructure)).filter(Boolean);
|
|
151
|
-
const directorySection = directories.length
|
|
152
|
-
? directories
|
|
153
|
-
.slice(0, 8)
|
|
154
|
-
.map(dir => `- \`${dir}/\` — explain what lives here and when agents should edit it.`)
|
|
155
|
-
.join('\n')
|
|
156
|
-
: '- Document the major directories so agents know where to work.';
|
|
157
|
-
return `# AGENTS.md
|
|
158
|
-
|
|
159
|
-
## Dev environment tips
|
|
160
|
-
- Install dependencies with \`npm install\` before running scaffolds.
|
|
161
|
-
- Use \`npm run dev\` for the interactive TypeScript session that powers local experimentation.
|
|
162
|
-
- Run \`npm run build\` to refresh the CommonJS bundle in \`dist/\` before shipping changes.
|
|
163
|
-
- Store generated artefacts in \`.context/\` so reruns stay deterministic.
|
|
164
|
-
|
|
165
|
-
## Testing instructions
|
|
166
|
-
- Execute \`npm run test\` to run the Jest suite.
|
|
167
|
-
- Append \`-- --watch\` while iterating on a failing spec.
|
|
168
|
-
- Trigger \`npm run build && npm run test\` before opening a PR to mimic CI.
|
|
169
|
-
- Add or update tests alongside any generator or CLI changes.
|
|
170
|
-
|
|
171
|
-
## PR instructions
|
|
172
|
-
- Follow Conventional Commits (for example, \`feat(scaffolding): add doc links\`).
|
|
173
|
-
- Cross-link new scaffolds in \`docs/README.md\` and \`agents/README.md\` so future agents can find them.
|
|
174
|
-
- Attach sample CLI output or generated markdown when behaviour shifts.
|
|
175
|
-
- Confirm the built artefacts in \`dist/\` match the new source changes.
|
|
176
|
-
|
|
177
|
-
## Repository map
|
|
178
|
-
${directorySection}
|
|
179
|
-
|
|
180
|
-
## AI Context References
|
|
181
|
-
- Documentation index: \`.context/docs/README.md\`
|
|
182
|
-
- Agent playbooks: \`.context/agents/README.md\`
|
|
183
|
-
- Contributor guide: \`CONTRIBUTING.md\`
|
|
184
|
-
`;
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
exports.DocumentationGenerator = DocumentationGenerator;
|
|
188
|
-
//# sourceMappingURL=documentationGenerator.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationGenerator.js","sourceRoot":"","sources":["../../../src/generators/documentation/documentationGenerator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAC7B,6CAA+B;AAE/B,sCAA2C;AAC3C,2CAYqB;AACrB,mDAAkD;AAWlD,MAAa,sBAAsB;IACjC,YAAY,GAAG,WAAsB,IAAG,CAAC;IAEzC,KAAK,CAAC,qBAAqB,CACzB,aAA4B,EAC5B,SAAiB,EACjB,SAAwC,EAAE,EAC1C,UAAmB,KAAK;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7C,MAAM,uBAAc,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,sCAAsC,CAAC,CAAC;QAErG,MAAM,gBAAgB,GAAG,IAAA,+BAAe,EAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAEvD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YACxD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACzC,MAAM,uBAAc,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACvG,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;QAED,MAAM,IAAI,CAAC,0BAA0B,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAE9D,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,YAAY,CAClB,aAA4B,EAC5B,MAAmB;QAEnB,MAAM,aAAa,GAAG,aAAa,CAAC,sBAAsB,IAAI,EAAE,CAAC;QACjE,MAAM,mBAAmB,GAAG,aAAa,CAAC,MAAM;YAC9C,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;YACtC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM;YACzC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;YAC7E,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC/B,IAAI;gBACJ,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM;aAC/F,CAAC,CAAC,CAAC;QACR,MAAM,gBAAgB,GAAG,uBAAc,CAAC,oBAAoB,CAAC,aAAa,EAAE,CAAC,CAAC;aAC3E,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAEvD,OAAO;YACL,aAAa;YACb,mBAAmB;YACnB,gBAAgB;YAChB,cAAc;YACd,MAAM;SACP,CAAC;IACJ,CAAC;IAEO,yBAAyB,CAAC,aAA4B;QAC5D,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QACvC,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtC,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACvE,IAAI,YAAY,EAAE,CAAC;gBACjB,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;IAEO,cAAc,CAAC,MAAmB;QACxC,MAAM,QAAQ,GAAiB;YAC7B;gBACE,QAAQ,EAAE,WAAW;gBACrB,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,uBAAW,EAAC,OAAO,CAAC;aACzC;SACF,CAAC;QAEF,MAAM,SAAS,GAAsE;YACnF,kBAAkB,EAAE,iCAAqB;YACzC,YAAY,EAAE,mCAAuB;YACrC,sBAAsB,EAAE,GAAG,EAAE,CAAC,IAAA,qCAAyB,GAAE;YACzD,kBAAkB,EAAE,GAAG,EAAE,CAAC,IAAA,iCAAqB,GAAE;YACjD,QAAQ,EAAE,0BAAc;YACxB,WAAW,EAAE,0BAAc;YAC3B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,0BAAc,GAAE;YAChC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAA,8BAAkB,GAAE;SACpC,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO;YACT,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC;gBACZ,QAAQ,EAAE,KAAK,CAAC,IAAI;gBACpB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,aAA4B,EAAE,OAAgB;QACrF,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QACxC,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YACnD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;gBAC7D,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACtD,uBAAc,CAAC,WAAW,CAAC,wDAAwD,EAAE,OAAO,CAAC,CAAC;gBAC9F,OAAO;YACT,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,aAAa,GAAG,yBAAyB,CAAC;YAChD,MAAM,eAAe,GAAG,2BAA2B,CAAC;YAEpD,IAAI,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;gBACzE,OAAO;YACT,CAAC;YAED,MAAM,eAAe,GAAG,wDAAwD,aAAa,4BAA4B,eAAe,MAAM,CAAC;YAC/I,MAAM,cAAc,GAAG,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,eAAe,IAAI,CAAC;YAElE,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;YAE5D,uBAAc,CAAC,WAAW,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;QAC/F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,uBAAc,CAAC,QAAQ,CAAC,0DAA0D,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;IAEO,uBAAuB,CAAC,aAA4B;QAC1D,MAAM,WAAW,GAAG,CAAC,aAAa,CAAC,sBAAsB,EAAE,MAAM;YAC/D,CAAC,CAAC,aAAa,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;YAC7D,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAChD,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAElB,MAAM,gBAAgB,GAAG,WAAW,CAAC,MAAM;YACzC,CAAC,CAAC,WAAW;iBACR,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;iBACX,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,+DAA+D,CAAC;iBACrF,IAAI,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,gEAAgE,CAAC;QAErE,OAAO;;;;;;;;;;;;;;;;;;;;;EAqBT,gBAAgB;;;;;;CAMjB,CAAC;IACA,CAAC;CACF;AAhLD,wDAgLC"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { GuideMeta } from './templates/types';
|
|
2
|
-
export declare const DOCUMENT_GUIDES: GuideMeta[];
|
|
3
|
-
export declare const DOCUMENT_GUIDE_KEYS: string[];
|
|
4
|
-
export declare function getGuidesByKeys(keys?: string[]): GuideMeta[];
|
|
5
|
-
export declare function getDocFilesByKeys(keys?: string[]): Set<string> | undefined;
|
|
6
|
-
//# sourceMappingURL=guideRegistry.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"guideRegistry.d.ts","sourceRoot":"","sources":["../../../src/generators/documentation/guideRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,eAAO,MAAM,eAAe,EAAE,SAAS,EAyDtC,CAAC;AAEF,eAAO,MAAM,mBAAmB,UAA0C,CAAC;AAE3E,wBAAgB,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAQ5D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,SAAS,CAQ1E"}
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DOCUMENT_GUIDE_KEYS = exports.DOCUMENT_GUIDES = void 0;
|
|
4
|
-
exports.getGuidesByKeys = getGuidesByKeys;
|
|
5
|
-
exports.getDocFilesByKeys = getDocFilesByKeys;
|
|
6
|
-
exports.DOCUMENT_GUIDES = [
|
|
7
|
-
{
|
|
8
|
-
key: 'project-overview',
|
|
9
|
-
title: 'Project Overview',
|
|
10
|
-
file: 'project-overview.md',
|
|
11
|
-
marker: 'agent-update:project-overview',
|
|
12
|
-
primaryInputs: 'Roadmap, README, stakeholder notes'
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
key: 'architecture',
|
|
16
|
-
title: 'Architecture Notes',
|
|
17
|
-
file: 'architecture.md',
|
|
18
|
-
marker: 'agent-update:architecture-notes',
|
|
19
|
-
primaryInputs: 'ADRs, service boundaries, dependency graphs'
|
|
20
|
-
},
|
|
21
|
-
{
|
|
22
|
-
key: 'development-workflow',
|
|
23
|
-
title: 'Development Workflow',
|
|
24
|
-
file: 'development-workflow.md',
|
|
25
|
-
marker: 'agent-update:development-workflow',
|
|
26
|
-
primaryInputs: 'Branching rules, CI config, contributing guide'
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
key: 'testing-strategy',
|
|
30
|
-
title: 'Testing Strategy',
|
|
31
|
-
file: 'testing-strategy.md',
|
|
32
|
-
marker: 'agent-update:testing-strategy',
|
|
33
|
-
primaryInputs: 'Test configs, CI gates, known flaky suites'
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
key: 'glossary',
|
|
37
|
-
title: 'Glossary & Domain Concepts',
|
|
38
|
-
file: 'glossary.md',
|
|
39
|
-
marker: 'agent-update:glossary',
|
|
40
|
-
primaryInputs: 'Business terminology, user personas, domain rules'
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
key: 'data-flow',
|
|
44
|
-
title: 'Data Flow & Integrations',
|
|
45
|
-
file: 'data-flow.md',
|
|
46
|
-
marker: 'agent-update:data-flow',
|
|
47
|
-
primaryInputs: 'System diagrams, integration specs, queue topics'
|
|
48
|
-
},
|
|
49
|
-
{
|
|
50
|
-
key: 'security',
|
|
51
|
-
title: 'Security & Compliance Notes',
|
|
52
|
-
file: 'security.md',
|
|
53
|
-
marker: 'agent-update:security',
|
|
54
|
-
primaryInputs: 'Auth model, secrets management, compliance requirements'
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
key: 'tooling',
|
|
58
|
-
title: 'Tooling & Productivity Guide',
|
|
59
|
-
file: 'tooling.md',
|
|
60
|
-
marker: 'agent-update:tooling',
|
|
61
|
-
primaryInputs: 'CLI scripts, IDE configs, automation workflows'
|
|
62
|
-
}
|
|
63
|
-
];
|
|
64
|
-
exports.DOCUMENT_GUIDE_KEYS = exports.DOCUMENT_GUIDES.map(guide => guide.key);
|
|
65
|
-
function getGuidesByKeys(keys) {
|
|
66
|
-
if (!keys || keys.length === 0) {
|
|
67
|
-
return exports.DOCUMENT_GUIDES;
|
|
68
|
-
}
|
|
69
|
-
const set = new Set(keys);
|
|
70
|
-
const filtered = exports.DOCUMENT_GUIDES.filter(guide => set.has(guide.key));
|
|
71
|
-
return filtered.length > 0 ? filtered : exports.DOCUMENT_GUIDES;
|
|
72
|
-
}
|
|
73
|
-
function getDocFilesByKeys(keys) {
|
|
74
|
-
if (!keys || keys.length === 0) {
|
|
75
|
-
return undefined;
|
|
76
|
-
}
|
|
77
|
-
const files = exports.DOCUMENT_GUIDES
|
|
78
|
-
.filter(guide => keys.includes(guide.key))
|
|
79
|
-
.map(guide => guide.file);
|
|
80
|
-
return files.length ? new Set(files) : undefined;
|
|
81
|
-
}
|
|
82
|
-
//# sourceMappingURL=guideRegistry.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"guideRegistry.js","sourceRoot":"","sources":["../../../src/generators/documentation/guideRegistry.ts"],"names":[],"mappings":";;;AA+DA,0CAQC;AAED,8CAQC;AA/EY,QAAA,eAAe,GAAgB;IAC1C;QACE,GAAG,EAAE,kBAAkB;QACvB,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,oCAAoC;KACpD;IACD;QACE,GAAG,EAAE,cAAc;QACnB,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE,iCAAiC;QACzC,aAAa,EAAE,6CAA6C;KAC7D;IACD;QACE,GAAG,EAAE,sBAAsB;QAC3B,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,yBAAyB;QAC/B,MAAM,EAAE,mCAAmC;QAC3C,aAAa,EAAE,gDAAgD;KAChE;IACD;QACE,GAAG,EAAE,kBAAkB;QACvB,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,+BAA+B;QACvC,aAAa,EAAE,4CAA4C;KAC5D;IACD;QACE,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,aAAa;QACnB,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,mDAAmD;KACnE;IACD;QACE,GAAG,EAAE,WAAW;QAChB,KAAK,EAAE,0BAA0B;QACjC,IAAI,EAAE,cAAc;QACpB,MAAM,EAAE,wBAAwB;QAChC,aAAa,EAAE,kDAAkD;KAClE;IACD;QACE,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,6BAA6B;QACpC,IAAI,EAAE,aAAa;QACnB,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,yDAAyD;KACzE;IACD;QACE,GAAG,EAAE,SAAS;QACd,KAAK,EAAE,8BAA8B;QACrC,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,sBAAsB;QAC9B,aAAa,EAAE,gDAAgD;KAChE;CACF,CAAC;AAEW,QAAA,mBAAmB,GAAG,uBAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAE3E,SAAgB,eAAe,CAAC,IAAe;IAC7C,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,uBAAe,CAAC;IACzB,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,QAAQ,GAAG,uBAAe,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAe,CAAC;AAC1D,CAAC;AAED,SAAgB,iBAAiB,CAAC,IAAe;IAC/C,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,uBAAe;SAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACzC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generators/documentation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DocumentationGenerator = void 0;
|
|
4
|
-
var documentationGenerator_1 = require("./documentationGenerator");
|
|
5
|
-
Object.defineProperty(exports, "DocumentationGenerator", { enumerable: true, get: function () { return documentationGenerator_1.DocumentationGenerator; } });
|
|
6
|
-
//# sourceMappingURL=index.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generators/documentation/index.ts"],"names":[],"mappings":";;;AAAA,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"apiReferenceTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/apiReferenceTemplate.ts"],"names":[],"mappings":"AAAA,wBAAgB,kBAAkB,IAAI,MAAM,CAqe3C"}
|