@ai-coders/context 0.6.1 → 0.7.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.
- package/README.md +122 -68
- package/dist/commands/export.d.ts +4 -0
- package/dist/commands/export.d.ts.map +1 -0
- package/dist/commands/export.js +39 -0
- package/dist/commands/export.js.map +1 -0
- package/dist/commands/fill.d.ts +13 -0
- package/dist/commands/fill.d.ts.map +1 -0
- package/dist/commands/fill.js +65 -0
- package/dist/commands/fill.js.map +1 -0
- package/dist/commands/index.d.ts +29 -0
- package/dist/commands/index.d.ts.map +1 -0
- package/dist/commands/index.js +74 -0
- package/dist/commands/index.js.map +1 -0
- package/dist/commands/init.d.ts +12 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +64 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/mcp.d.ts +4 -0
- package/dist/commands/mcp.d.ts.map +1 -0
- package/dist/commands/mcp.js +92 -0
- package/dist/commands/mcp.js.map +1 -0
- package/dist/commands/plan.d.ts +9 -0
- package/dist/commands/plan.d.ts.map +1 -0
- package/dist/commands/plan.js +126 -0
- package/dist/commands/plan.js.map +1 -0
- package/dist/commands/report.d.ts +4 -0
- package/dist/commands/report.d.ts.map +1 -0
- package/dist/commands/report.js +36 -0
- package/dist/commands/report.js.map +1 -0
- package/dist/commands/serve.d.ts +4 -0
- package/dist/commands/serve.d.ts.map +1 -0
- package/dist/commands/serve.js +29 -0
- package/dist/commands/serve.js.map +1 -0
- package/dist/commands/skill.d.ts +4 -0
- package/dist/commands/skill.d.ts.map +1 -0
- package/dist/commands/skill.js +217 -0
- package/dist/commands/skill.js.map +1 -0
- package/dist/commands/start.d.ts +4 -0
- package/dist/commands/start.d.ts.map +1 -0
- package/dist/commands/start.js +56 -0
- package/dist/commands/start.js.map +1 -0
- package/dist/commands/sync.d.ts +9 -0
- package/dist/commands/sync.d.ts.map +1 -0
- package/dist/commands/sync.js +134 -0
- package/dist/commands/sync.js.map +1 -0
- package/dist/commands/types.d.ts +17 -0
- package/dist/commands/types.d.ts.map +1 -0
- package/dist/commands/types.js +3 -0
- package/dist/commands/types.js.map +1 -0
- package/dist/commands/update.d.ts +4 -0
- package/dist/commands/update.d.ts.map +1 -0
- package/dist/commands/update.js +111 -0
- package/dist/commands/update.js.map +1 -0
- package/dist/commands/workflow.d.ts +4 -0
- package/dist/commands/workflow.d.ts.map +1 -0
- package/dist/commands/workflow.js +171 -0
- package/dist/commands/workflow.js.map +1 -0
- package/dist/generators/agents/agentGenerator.d.ts +2 -0
- package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
- package/dist/generators/agents/agentGenerator.js +46 -2
- package/dist/generators/agents/agentGenerator.js.map +1 -1
- package/dist/generators/agents/templates/index.d.ts +0 -1
- package/dist/generators/agents/templates/index.d.ts.map +1 -1
- package/dist/generators/agents/templates/index.js +1 -3
- package/dist/generators/agents/templates/index.js.map +1 -1
- package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
- package/dist/generators/agents/templates/playbookTemplate.js +11 -0
- package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
- package/dist/generators/documentation/documentationGenerator.d.ts +2 -1
- package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
- package/dist/generators/documentation/documentationGenerator.js +53 -34
- package/dist/generators/documentation/documentationGenerator.js.map +1 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.js +11 -0
- package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/architectureTemplate.d.ts +11 -0
- package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.js +11 -0
- package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +11 -0
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/index.d.ts +0 -12
- package/dist/generators/documentation/templates/index.d.ts.map +1 -1
- package/dist/generators/documentation/templates/index.js +1 -25
- package/dist/generators/documentation/templates/index.js.map +1 -1
- package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/migrationTemplate.js +11 -0
- package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/onboardingTemplate.js +11 -0
- package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.js +11 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/securityTemplate.js +11 -0
- package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/testingTemplate.js +11 -0
- package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/toolingTemplate.js +11 -0
- package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.js +11 -0
- package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -1
- package/dist/generators/plans/templates/planTemplate.d.ts +11 -0
- package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
- package/dist/generators/plans/templates/planTemplate.js.map +1 -1
- package/dist/generators/shared/index.d.ts +1 -0
- package/dist/generators/shared/index.d.ts.map +1 -1
- package/dist/generators/shared/index.js +16 -0
- package/dist/generators/shared/index.js.map +1 -1
- package/dist/generators/shared/scaffoldStructures.d.ts +13 -0
- package/dist/generators/shared/scaffoldStructures.d.ts.map +1 -0
- package/dist/generators/shared/scaffoldStructures.js +30 -0
- package/dist/generators/shared/scaffoldStructures.js.map +1 -0
- package/dist/generators/shared/structures/agents/definitions.d.ts +18 -0
- package/dist/generators/shared/structures/agents/definitions.d.ts.map +1 -0
- package/dist/generators/shared/structures/agents/definitions.js +22 -0
- package/dist/generators/shared/structures/agents/definitions.js.map +1 -0
- package/dist/generators/shared/structures/agents/factory.d.ts +9 -0
- package/dist/generators/shared/structures/agents/factory.d.ts.map +1 -0
- package/dist/generators/shared/structures/agents/factory.js +112 -0
- package/dist/generators/shared/structures/agents/factory.js.map +1 -0
- package/dist/generators/shared/structures/agents/index.d.ts +6 -0
- package/dist/generators/shared/structures/agents/index.d.ts.map +1 -0
- package/dist/generators/shared/structures/agents/index.js +24 -0
- package/dist/generators/shared/structures/agents/index.js.map +1 -0
- package/dist/generators/shared/structures/documentation/apiReference.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/apiReference.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/apiReference.js +100 -0
- package/dist/generators/shared/structures/documentation/apiReference.js.map +1 -0
- package/dist/generators/shared/structures/documentation/architecture.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/architecture.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/architecture.js +121 -0
- package/dist/generators/shared/structures/documentation/architecture.js.map +1 -0
- package/dist/generators/shared/structures/documentation/dataFlow.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/dataFlow.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/dataFlow.js +72 -0
- package/dist/generators/shared/structures/documentation/dataFlow.js.map +1 -0
- package/dist/generators/shared/structures/documentation/glossary.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/glossary.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/glossary.js +71 -0
- package/dist/generators/shared/structures/documentation/glossary.js.map +1 -0
- package/dist/generators/shared/structures/documentation/index.d.ts +16 -0
- package/dist/generators/shared/structures/documentation/index.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/index.js +31 -0
- package/dist/generators/shared/structures/documentation/index.js.map +1 -0
- package/dist/generators/shared/structures/documentation/migration.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/migration.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/migration.js +113 -0
- package/dist/generators/shared/structures/documentation/migration.js.map +1 -0
- package/dist/generators/shared/structures/documentation/onboarding.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/onboarding.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/onboarding.js +99 -0
- package/dist/generators/shared/structures/documentation/onboarding.js.map +1 -0
- package/dist/generators/shared/structures/documentation/projectOverview.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/projectOverview.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/projectOverview.js +115 -0
- package/dist/generators/shared/structures/documentation/projectOverview.js.map +1 -0
- package/dist/generators/shared/structures/documentation/security.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/security.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/security.js +55 -0
- package/dist/generators/shared/structures/documentation/security.js.map +1 -0
- package/dist/generators/shared/structures/documentation/testing.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/testing.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/testing.js +57 -0
- package/dist/generators/shared/structures/documentation/testing.js.map +1 -0
- package/dist/generators/shared/structures/documentation/tooling.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/tooling.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/tooling.js +55 -0
- package/dist/generators/shared/structures/documentation/tooling.js.map +1 -0
- package/dist/generators/shared/structures/documentation/troubleshooting.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/troubleshooting.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/troubleshooting.js +91 -0
- package/dist/generators/shared/structures/documentation/troubleshooting.js.map +1 -0
- package/dist/generators/shared/structures/documentation/workflow.d.ts +3 -0
- package/dist/generators/shared/structures/documentation/workflow.d.ts.map +1 -0
- package/dist/generators/shared/structures/documentation/workflow.js +56 -0
- package/dist/generators/shared/structures/documentation/workflow.js.map +1 -0
- package/dist/generators/shared/structures/index.d.ts +15 -0
- package/dist/generators/shared/structures/index.d.ts.map +1 -0
- package/dist/generators/shared/structures/index.js +37 -0
- package/dist/generators/shared/structures/index.js.map +1 -0
- package/dist/generators/shared/structures/plans/index.d.ts +5 -0
- package/dist/generators/shared/structures/plans/index.d.ts.map +1 -0
- package/dist/generators/shared/structures/plans/index.js +9 -0
- package/dist/generators/shared/structures/plans/index.js.map +1 -0
- package/dist/generators/shared/structures/plans/planStructure.d.ts +6 -0
- package/dist/generators/shared/structures/plans/planStructure.d.ts.map +1 -0
- package/dist/generators/shared/structures/plans/planStructure.js +65 -0
- package/dist/generators/shared/structures/plans/planStructure.js.map +1 -0
- package/dist/generators/shared/structures/registry.d.ts +18 -0
- package/dist/generators/shared/structures/registry.d.ts.map +1 -0
- package/dist/generators/shared/structures/registry.js +104 -0
- package/dist/generators/shared/structures/registry.js.map +1 -0
- package/dist/generators/shared/structures/serialization.d.ts +15 -0
- package/dist/generators/shared/structures/serialization.d.ts.map +1 -0
- package/dist/generators/shared/structures/serialization.js +119 -0
- package/dist/generators/shared/structures/serialization.js.map +1 -0
- package/dist/generators/shared/structures/skills/definitions.d.ts +14 -0
- package/dist/generators/shared/structures/skills/definitions.d.ts.map +1 -0
- package/dist/generators/shared/structures/skills/definitions.js +18 -0
- package/dist/generators/shared/structures/skills/definitions.js.map +1 -0
- package/dist/generators/shared/structures/skills/factory.d.ts +9 -0
- package/dist/generators/shared/structures/skills/factory.d.ts.map +1 -0
- package/dist/generators/shared/structures/skills/factory.js +56 -0
- package/dist/generators/shared/structures/skills/factory.js.map +1 -0
- package/dist/generators/shared/structures/skills/index.d.ts +6 -0
- package/dist/generators/shared/structures/skills/index.d.ts.map +1 -0
- package/dist/generators/shared/structures/skills/index.js +20 -0
- package/dist/generators/shared/structures/skills/index.js.map +1 -0
- package/dist/generators/shared/structures/types.d.ts +59 -0
- package/dist/generators/shared/structures/types.d.ts.map +1 -0
- package/dist/generators/shared/structures/types.js +6 -0
- package/dist/generators/shared/structures/types.js.map +1 -0
- package/dist/generators/shared/structures/validation.d.ts +13 -0
- package/dist/generators/shared/structures/validation.d.ts.map +1 -0
- package/dist/generators/shared/structures/validation.js +51 -0
- package/dist/generators/shared/structures/validation.js.map +1 -0
- package/dist/generators/skills/skillGenerator.d.ts +5 -0
- package/dist/generators/skills/skillGenerator.d.ts.map +1 -1
- package/dist/generators/skills/skillGenerator.js +26 -17
- package/dist/generators/skills/skillGenerator.js.map +1 -1
- package/dist/generators/skills/templates/skillTemplate.d.ts +10 -0
- package/dist/generators/skills/templates/skillTemplate.d.ts.map +1 -1
- package/dist/generators/skills/templates/skillTemplate.js +10 -0
- package/dist/generators/skills/templates/skillTemplate.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +203 -5
- package/dist/index.js.map +1 -1
- package/dist/prompts/defaults.d.ts +5 -0
- package/dist/prompts/defaults.d.ts.map +1 -1
- package/dist/prompts/defaults.js +44 -1
- package/dist/prompts/defaults.js.map +1 -1
- package/dist/services/ai/agents/documentationAgent.d.ts +2 -0
- package/dist/services/ai/agents/documentationAgent.d.ts.map +1 -1
- package/dist/services/ai/agents/documentationAgent.js +33 -9
- package/dist/services/ai/agents/documentationAgent.js.map +1 -1
- package/dist/services/ai/agents/playbookAgent.d.ts +2 -0
- package/dist/services/ai/agents/playbookAgent.d.ts.map +1 -1
- package/dist/services/ai/agents/playbookAgent.js +44 -19
- package/dist/services/ai/agents/playbookAgent.js.map +1 -1
- package/dist/services/ai/agents/skillAgent.d.ts +2 -0
- package/dist/services/ai/agents/skillAgent.d.ts.map +1 -1
- package/dist/services/ai/agents/skillAgent.js +54 -22
- package/dist/services/ai/agents/skillAgent.js.map +1 -1
- package/dist/services/ai/schemas.d.ts +136 -9
- package/dist/services/ai/schemas.d.ts.map +1 -1
- package/dist/services/ai/schemas.js +65 -4
- package/dist/services/ai/schemas.js.map +1 -1
- package/dist/services/ai/toolRegistry.d.ts.map +1 -1
- package/dist/services/ai/toolRegistry.js +25 -17
- package/dist/services/ai/toolRegistry.js.map +1 -1
- package/dist/services/ai/tools/checkScaffoldingTool.d.ts.map +1 -1
- package/dist/services/ai/tools/checkScaffoldingTool.js +4 -1
- package/dist/services/ai/tools/checkScaffoldingTool.js.map +1 -1
- package/dist/services/ai/tools/fillScaffoldingTool.d.ts +19 -21
- package/dist/services/ai/tools/fillScaffoldingTool.d.ts.map +1 -1
- package/dist/services/ai/tools/fillScaffoldingTool.js +41 -142
- package/dist/services/ai/tools/fillScaffoldingTool.js.map +1 -1
- package/dist/services/ai/tools/getCodebaseMapTool.d.ts +1 -1
- package/dist/services/ai/tools/getCodebaseMapTool.d.ts.map +1 -1
- package/dist/services/ai/tools/getCodebaseMapTool.js +4 -1
- package/dist/services/ai/tools/getCodebaseMapTool.js.map +1 -1
- package/dist/services/ai/tools/index.d.ts +1 -1
- package/dist/services/ai/tools/index.d.ts.map +1 -1
- package/dist/services/ai/tools/index.js +1 -3
- package/dist/services/ai/tools/index.js.map +1 -1
- package/dist/services/ai/tools/initializeContextTool.d.ts +108 -16
- package/dist/services/ai/tools/initializeContextTool.d.ts.map +1 -1
- package/dist/services/ai/tools/initializeContextTool.js +177 -67
- package/dist/services/ai/tools/initializeContextTool.js.map +1 -1
- package/dist/services/ai/tools/scaffoldPlanTool.d.ts +14 -3
- package/dist/services/ai/tools/scaffoldPlanTool.d.ts.map +1 -1
- package/dist/services/ai/tools/scaffoldPlanTool.js +34 -4
- package/dist/services/ai/tools/scaffoldPlanTool.js.map +1 -1
- package/dist/services/ai/tools/toolFactory.d.ts +35 -0
- package/dist/services/ai/tools/toolFactory.d.ts.map +1 -0
- package/dist/services/ai/tools/toolFactory.js +20 -0
- package/dist/services/ai/tools/toolFactory.js.map +1 -0
- package/dist/services/export/contextExportService.d.ts +45 -0
- package/dist/services/export/contextExportService.d.ts.map +1 -0
- package/dist/services/export/contextExportService.js +161 -0
- package/dist/services/export/contextExportService.js.map +1 -0
- package/dist/services/export/exportRulesService.d.ts +15 -1
- package/dist/services/export/exportRulesService.d.ts.map +1 -1
- package/dist/services/export/exportRulesService.js +100 -36
- package/dist/services/export/exportRulesService.js.map +1 -1
- package/dist/services/export/index.d.ts +2 -0
- package/dist/services/export/index.d.ts.map +1 -1
- package/dist/services/export/index.js +3 -1
- package/dist/services/export/index.js.map +1 -1
- package/dist/services/export/skillExportService.d.ts +6 -1
- package/dist/services/export/skillExportService.d.ts.map +1 -1
- package/dist/services/export/skillExportService.js +46 -22
- package/dist/services/export/skillExportService.js.map +1 -1
- package/dist/services/fill/fillService.d.ts.map +1 -1
- package/dist/services/fill/fillService.js +30 -3
- package/dist/services/fill/fillService.js.map +1 -1
- package/dist/services/fill/skillFillService.d.ts.map +1 -1
- package/dist/services/fill/skillFillService.js +8 -1
- package/dist/services/fill/skillFillService.js.map +1 -1
- package/dist/services/import/presets.d.ts +12 -0
- package/dist/services/import/presets.d.ts.map +1 -1
- package/dist/services/import/presets.js +32 -152
- package/dist/services/import/presets.js.map +1 -1
- package/dist/services/init/initService.d.ts +1 -0
- package/dist/services/init/initService.d.ts.map +1 -1
- package/dist/services/init/initService.js +42 -9
- package/dist/services/init/initService.js.map +1 -1
- package/dist/services/mcp/actionLogger.d.ts +19 -0
- package/dist/services/mcp/actionLogger.d.ts.map +1 -0
- package/dist/services/mcp/actionLogger.js +128 -0
- package/dist/services/mcp/actionLogger.js.map +1 -0
- package/dist/services/mcp/gateway/agent.d.ts +17 -0
- package/dist/services/mcp/gateway/agent.d.ts.map +1 -0
- package/dist/services/mcp/gateway/agent.js +147 -0
- package/dist/services/mcp/gateway/agent.js.map +1 -0
- package/dist/services/mcp/gateway/context.d.ts +21 -0
- package/dist/services/mcp/gateway/context.d.ts.map +1 -0
- package/dist/services/mcp/gateway/context.js +249 -0
- package/dist/services/mcp/gateway/context.js.map +1 -0
- package/dist/services/mcp/gateway/explore.d.ts +16 -0
- package/dist/services/mcp/gateway/explore.d.ts.map +1 -0
- package/dist/services/mcp/gateway/explore.js +60 -0
- package/dist/services/mcp/gateway/explore.js.map +1 -0
- package/dist/services/mcp/gateway/index.d.ts +24 -0
- package/dist/services/mcp/gateway/index.d.ts.map +1 -0
- package/dist/services/mcp/gateway/index.js +53 -0
- package/dist/services/mcp/gateway/index.js.map +1 -0
- package/dist/services/mcp/gateway/metrics.d.ts +56 -0
- package/dist/services/mcp/gateway/metrics.d.ts.map +1 -0
- package/dist/services/mcp/gateway/metrics.js +153 -0
- package/dist/services/mcp/gateway/metrics.js.map +1 -0
- package/dist/services/mcp/gateway/plan.d.ts +18 -0
- package/dist/services/mcp/gateway/plan.d.ts.map +1 -0
- package/dist/services/mcp/gateway/plan.js +273 -0
- package/dist/services/mcp/gateway/plan.js.map +1 -0
- package/dist/services/mcp/gateway/project.d.ts +16 -0
- package/dist/services/mcp/gateway/project.d.ts.map +1 -0
- package/dist/services/mcp/gateway/project.js +149 -0
- package/dist/services/mcp/gateway/project.js.map +1 -0
- package/dist/services/mcp/gateway/projectReport.d.ts +20 -0
- package/dist/services/mcp/gateway/projectReport.d.ts.map +1 -0
- package/dist/services/mcp/gateway/projectReport.js +61 -0
- package/dist/services/mcp/gateway/projectReport.js.map +1 -0
- package/dist/services/mcp/gateway/projectSetup.d.ts +29 -0
- package/dist/services/mcp/gateway/projectSetup.d.ts.map +1 -0
- package/dist/services/mcp/gateway/projectSetup.js +141 -0
- package/dist/services/mcp/gateway/projectSetup.js.map +1 -0
- package/dist/services/mcp/gateway/response.d.ts +45 -0
- package/dist/services/mcp/gateway/response.d.ts.map +1 -0
- package/dist/services/mcp/gateway/response.js +111 -0
- package/dist/services/mcp/gateway/response.js.map +1 -0
- package/dist/services/mcp/gateway/shared.d.ts +38 -0
- package/dist/services/mcp/gateway/shared.d.ts.map +1 -0
- package/dist/services/mcp/gateway/shared.js +39 -0
- package/dist/services/mcp/gateway/shared.js.map +1 -0
- package/dist/services/mcp/gateway/skill.d.ts +17 -0
- package/dist/services/mcp/gateway/skill.d.ts.map +1 -0
- package/dist/services/mcp/gateway/skill.js +323 -0
- package/dist/services/mcp/gateway/skill.js.map +1 -0
- package/dist/services/mcp/gateway/sync.d.ts +17 -0
- package/dist/services/mcp/gateway/sync.d.ts.map +1 -0
- package/dist/services/mcp/gateway/sync.js +219 -0
- package/dist/services/mcp/gateway/sync.js.map +1 -0
- package/dist/services/mcp/gateway/types.d.ts +116 -0
- package/dist/services/mcp/gateway/types.d.ts.map +1 -0
- package/dist/services/mcp/gateway/types.js +12 -0
- package/dist/services/mcp/gateway/types.js.map +1 -0
- package/dist/services/mcp/gateway/workflow.d.ts +18 -0
- package/dist/services/mcp/gateway/workflow.d.ts.map +1 -0
- package/dist/services/mcp/gateway/workflow.js +317 -0
- package/dist/services/mcp/gateway/workflow.js.map +1 -0
- package/dist/services/mcp/gateway/workflowAdvance.d.ts +25 -0
- package/dist/services/mcp/gateway/workflowAdvance.d.ts.map +1 -0
- package/dist/services/mcp/gateway/workflowAdvance.js +133 -0
- package/dist/services/mcp/gateway/workflowAdvance.js.map +1 -0
- package/dist/services/mcp/gateway/workflowInit.d.ts +28 -0
- package/dist/services/mcp/gateway/workflowInit.d.ts.map +1 -0
- package/dist/services/mcp/gateway/workflowInit.js +213 -0
- package/dist/services/mcp/gateway/workflowInit.js.map +1 -0
- package/dist/services/mcp/gateway/workflowManage.d.ts +31 -0
- package/dist/services/mcp/gateway/workflowManage.d.ts.map +1 -0
- package/dist/services/mcp/gateway/workflowManage.js +222 -0
- package/dist/services/mcp/gateway/workflowManage.js.map +1 -0
- package/dist/services/mcp/gateway/workflowStatus.d.ts +17 -0
- package/dist/services/mcp/gateway/workflowStatus.d.ts.map +1 -0
- package/dist/services/mcp/gateway/workflowStatus.js +91 -0
- package/dist/services/mcp/gateway/workflowStatus.js.map +1 -0
- package/dist/services/mcp/gatewayTools.d.ts +15 -0
- package/dist/services/mcp/gatewayTools.d.ts.map +1 -0
- package/dist/services/mcp/gatewayTools.js +38 -0
- package/dist/services/mcp/gatewayTools.js.map +1 -0
- package/dist/services/mcp/index.d.ts +7 -0
- package/dist/services/mcp/index.d.ts.map +1 -1
- package/dist/services/mcp/index.js +22 -1
- package/dist/services/mcp/index.js.map +1 -1
- package/dist/services/mcp/mcpInstallService.d.ts +56 -0
- package/dist/services/mcp/mcpInstallService.d.ts.map +1 -0
- package/dist/services/mcp/mcpInstallService.js +549 -0
- package/dist/services/mcp/mcpInstallService.js.map +1 -0
- package/dist/services/mcp/mcpServer.d.ts +45 -19
- package/dist/services/mcp/mcpServer.d.ts.map +1 -1
- package/dist/services/mcp/mcpServer.js +592 -1845
- package/dist/services/mcp/mcpServer.js.map +1 -1
- package/dist/services/passthrough/protocol.d.ts +4 -4
- package/dist/services/qa/index.d.ts +9 -0
- package/dist/services/qa/index.d.ts.map +1 -0
- package/dist/services/qa/index.js +15 -0
- package/dist/services/qa/index.js.map +1 -0
- package/dist/services/qa/patternInferer.d.ts +41 -0
- package/dist/services/qa/patternInferer.d.ts.map +1 -0
- package/dist/services/qa/patternInferer.js +366 -0
- package/dist/services/qa/patternInferer.js.map +1 -0
- package/dist/services/qa/qaService.d.ts +107 -0
- package/dist/services/qa/qaService.d.ts.map +1 -0
- package/dist/services/qa/qaService.js +874 -0
- package/dist/services/qa/qaService.js.map +1 -0
- package/dist/services/qa/topicDetector.d.ts +54 -0
- package/dist/services/qa/topicDetector.d.ts.map +1 -0
- package/dist/services/qa/topicDetector.js +306 -0
- package/dist/services/qa/topicDetector.js.map +1 -0
- package/dist/services/quickSync/quickSyncService.d.ts.map +1 -1
- package/dist/services/quickSync/quickSyncService.js +6 -10
- package/dist/services/quickSync/quickSyncService.js.map +1 -1
- package/dist/services/reverseSync/importSkillsService.d.ts +47 -0
- package/dist/services/reverseSync/importSkillsService.d.ts.map +1 -0
- package/dist/services/reverseSync/importSkillsService.js +362 -0
- package/dist/services/reverseSync/importSkillsService.js.map +1 -0
- package/dist/services/reverseSync/index.d.ts +12 -0
- package/dist/services/reverseSync/index.d.ts.map +1 -0
- package/dist/services/reverseSync/index.js +49 -0
- package/dist/services/reverseSync/index.js.map +1 -0
- package/dist/services/reverseSync/presets.d.ts +51 -0
- package/dist/services/reverseSync/presets.d.ts.map +1 -0
- package/dist/services/reverseSync/presets.js +77 -0
- package/dist/services/reverseSync/presets.js.map +1 -0
- package/dist/services/reverseSync/reverseQuickSyncService.d.ts +37 -0
- package/dist/services/reverseSync/reverseQuickSyncService.d.ts.map +1 -0
- package/dist/services/reverseSync/reverseQuickSyncService.js +265 -0
- package/dist/services/reverseSync/reverseQuickSyncService.js.map +1 -0
- package/dist/services/reverseSync/skillsDetector.d.ts +36 -0
- package/dist/services/reverseSync/skillsDetector.d.ts.map +1 -0
- package/dist/services/reverseSync/skillsDetector.js +287 -0
- package/dist/services/reverseSync/skillsDetector.js.map +1 -0
- package/dist/services/reverseSync/toolDetector.d.ts +36 -0
- package/dist/services/reverseSync/toolDetector.d.ts.map +1 -0
- package/dist/services/reverseSync/toolDetector.js +174 -0
- package/dist/services/reverseSync/toolDetector.js.map +1 -0
- package/dist/services/reverseSync/types.d.ts +203 -0
- package/dist/services/reverseSync/types.d.ts.map +1 -0
- package/dist/services/reverseSync/types.js +9 -0
- package/dist/services/reverseSync/types.js.map +1 -0
- package/dist/services/semantic/codebaseAnalyzer.d.ts +23 -1
- package/dist/services/semantic/codebaseAnalyzer.d.ts.map +1 -1
- package/dist/services/semantic/codebaseAnalyzer.js +531 -0
- package/dist/services/semantic/codebaseAnalyzer.js.map +1 -1
- package/dist/services/semantic/contextBuilder.d.ts.map +1 -1
- package/dist/services/semantic/contextBuilder.js +23 -8
- package/dist/services/semantic/contextBuilder.js.map +1 -1
- package/dist/services/semantic/types.d.ts +50 -0
- package/dist/services/semantic/types.d.ts.map +1 -1
- package/dist/services/semantic/types.js.map +1 -1
- package/dist/services/shared/contentTypeRegistry.d.ts +66 -0
- package/dist/services/shared/contentTypeRegistry.d.ts.map +1 -0
- package/dist/services/shared/contentTypeRegistry.js +113 -0
- package/dist/services/shared/contentTypeRegistry.js.map +1 -0
- package/dist/services/shared/contextRootResolver.d.ts +57 -0
- package/dist/services/shared/contextRootResolver.d.ts.map +1 -0
- package/dist/services/shared/contextRootResolver.js +102 -0
- package/dist/services/shared/contextRootResolver.js.map +1 -0
- package/dist/services/shared/index.d.ts +4 -1
- package/dist/services/shared/index.d.ts.map +1 -1
- package/dist/services/shared/index.js +39 -1
- package/dist/services/shared/index.js.map +1 -1
- package/dist/services/shared/pathHelpers.d.ts +15 -1
- package/dist/services/shared/pathHelpers.d.ts.map +1 -1
- package/dist/services/shared/pathHelpers.js +26 -1
- package/dist/services/shared/pathHelpers.js.map +1 -1
- package/dist/services/shared/toolRegistry.d.ts +135 -0
- package/dist/services/shared/toolRegistry.d.ts.map +1 -0
- package/dist/services/shared/toolRegistry.js +515 -0
- package/dist/services/shared/toolRegistry.js.map +1 -0
- package/dist/services/stack/scaffoldFilter.d.ts +1 -1
- package/dist/services/sync/presets.d.ts +3 -0
- package/dist/services/sync/presets.d.ts.map +1 -1
- package/dist/services/sync/presets.js +20 -32
- package/dist/services/sync/presets.js.map +1 -1
- package/dist/services/sync/syncService.d.ts +8 -0
- package/dist/services/sync/syncService.d.ts.map +1 -1
- package/dist/services/sync/syncService.js +21 -2
- package/dist/services/sync/syncService.js.map +1 -1
- package/dist/services/sync/types.d.ts +1 -1
- package/dist/services/sync/types.d.ts.map +1 -1
- package/dist/services/tools/index.d.ts +95 -0
- package/dist/services/tools/index.d.ts.map +1 -0
- package/dist/services/tools/index.js +236 -0
- package/dist/services/tools/index.js.map +1 -0
- package/dist/services/workflow/workflowService.d.ts +57 -4
- package/dist/services/workflow/workflowService.d.ts.map +1 -1
- package/dist/services/workflow/workflowService.js +79 -6
- package/dist/services/workflow/workflowService.js.map +1 -1
- package/dist/types/scaffoldFrontmatter.d.ts +145 -0
- package/dist/types/scaffoldFrontmatter.d.ts.map +1 -0
- package/dist/types/scaffoldFrontmatter.js +172 -0
- package/dist/types/scaffoldFrontmatter.js.map +1 -0
- package/dist/utils/cliUI.d.ts +1 -1
- package/dist/utils/cliUI.d.ts.map +1 -1
- package/dist/utils/cliUI.js +4 -1
- package/dist/utils/cliUI.js.map +1 -1
- package/dist/utils/frontMatter.d.ts +48 -0
- package/dist/utils/frontMatter.d.ts.map +1 -1
- package/dist/utils/frontMatter.js +135 -0
- package/dist/utils/frontMatter.js.map +1 -1
- package/dist/utils/gitService.d.ts +26 -0
- package/dist/utils/gitService.d.ts.map +1 -1
- package/dist/utils/gitService.js +96 -0
- package/dist/utils/gitService.js.map +1 -1
- package/dist/utils/i18n.d.ts +43 -2
- package/dist/utils/i18n.d.ts.map +1 -1
- package/dist/utils/i18n.js +96 -6
- package/dist/utils/i18n.js.map +1 -1
- package/dist/utils/prompts/index.d.ts +4 -0
- package/dist/utils/prompts/index.d.ts.map +1 -1
- package/dist/utils/prompts/index.js +15 -0
- package/dist/utils/prompts/index.js.map +1 -1
- package/dist/workflow/errors.d.ts +48 -0
- package/dist/workflow/errors.d.ts.map +1 -0
- package/dist/workflow/errors.js +52 -0
- package/dist/workflow/errors.js.map +1 -0
- package/dist/workflow/gates/gateChecker.d.ts +93 -0
- package/dist/workflow/gates/gateChecker.d.ts.map +1 -0
- package/dist/workflow/gates/gateChecker.js +197 -0
- package/dist/workflow/gates/gateChecker.js.map +1 -0
- package/dist/workflow/gates/index.d.ts +7 -0
- package/dist/workflow/gates/index.d.ts.map +1 -0
- package/dist/workflow/gates/index.js +13 -0
- package/dist/workflow/gates/index.js.map +1 -0
- package/dist/workflow/index.d.ts +4 -2
- package/dist/workflow/index.d.ts.map +1 -1
- package/dist/workflow/index.js +14 -3
- package/dist/workflow/index.js.map +1 -1
- package/dist/workflow/orchestrator.d.ts +94 -5
- package/dist/workflow/orchestrator.d.ts.map +1 -1
- package/dist/workflow/orchestrator.js +300 -11
- package/dist/workflow/orchestrator.js.map +1 -1
- package/dist/workflow/plans/planLinker.d.ts +79 -3
- package/dist/workflow/plans/planLinker.d.ts.map +1 -1
- package/dist/workflow/plans/planLinker.js +522 -3
- package/dist/workflow/plans/planLinker.js.map +1 -1
- package/dist/workflow/plans/types.d.ts +64 -0
- package/dist/workflow/plans/types.d.ts.map +1 -1
- package/dist/workflow/roles.d.ts +6 -0
- package/dist/workflow/roles.d.ts.map +1 -1
- package/dist/workflow/roles.js +6 -0
- package/dist/workflow/roles.js.map +1 -1
- package/dist/workflow/scaling.d.ts +1 -0
- package/dist/workflow/scaling.d.ts.map +1 -1
- package/dist/workflow/scaling.js +8 -17
- package/dist/workflow/scaling.js.map +1 -1
- package/dist/workflow/status/statusManager.d.ts +54 -1
- package/dist/workflow/status/statusManager.d.ts.map +1 -1
- package/dist/workflow/status/statusManager.js +539 -9
- package/dist/workflow/status/statusManager.js.map +1 -1
- package/dist/workflow/status/templates.d.ts +14 -5
- package/dist/workflow/status/templates.d.ts.map +1 -1
- package/dist/workflow/status/templates.js +55 -41
- package/dist/workflow/status/templates.js.map +1 -1
- package/dist/workflow/types.d.ts +138 -2
- package/dist/workflow/types.d.ts.map +1 -1
- package/dist/workflow/types.js +0 -1
- package/dist/workflow/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.onboardingStructure = void 0;
|
|
4
|
+
exports.onboardingStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'onboarding',
|
|
7
|
+
title: 'Onboarding Guide',
|
|
8
|
+
description: 'Complete guide for getting new team members productive, including access setup and first contributions',
|
|
9
|
+
tone: 'instructional',
|
|
10
|
+
audience: 'developers',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Onboarding Guide',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Welcome message and high-level overview of the onboarding process.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Day 1: Access & Accounts',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'checklist',
|
|
24
|
+
guidance: 'Checklist for Day 1 access setup including email, chat, code repository, issue tracking, and documentation access.',
|
|
25
|
+
exampleContent: '- [ ] Email account - Verify access to team email\n- [ ] Chat/Communication - Join Slack/Teams and relevant channels\n- [ ] Code repository - GitHub access and SSH key configured\n- [ ] Issue tracking - Jira/GitHub Issues access\n- [ ] Documentation - Wiki/Confluence access',
|
|
26
|
+
required: true,
|
|
27
|
+
headingLevel: 2,
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
heading: 'Day 1-2: Development Environment',
|
|
31
|
+
order: 3,
|
|
32
|
+
contentType: 'list',
|
|
33
|
+
guidance: 'Step-by-step development environment setup with code blocks for installation and configuration commands.',
|
|
34
|
+
exampleContent: '- Install required software (Node.js, npm, Git, IDE)\n- Clone repository with example bash commands\n- Configure environment variables (.env file)\n- Run database migrations if applicable\n- Verify setup with test commands',
|
|
35
|
+
required: true,
|
|
36
|
+
headingLevel: 2,
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
heading: 'Day 2-3: Project Understanding',
|
|
40
|
+
order: 4,
|
|
41
|
+
contentType: 'list',
|
|
42
|
+
guidance: 'Reading list of core documentation and activities for understanding the codebase, team structure, and responsibilities.',
|
|
43
|
+
exampleContent: '- [ ] Read core documentation (Project Overview, Architecture, Development Workflow, Testing Strategy)\n- [ ] Explore project structure and main entry points\n- [ ] Meet team members and understand roles\n- [ ] Review recent pull requests for code standards',
|
|
44
|
+
required: true,
|
|
45
|
+
headingLevel: 2,
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
heading: 'Week 1: First Contributions',
|
|
49
|
+
order: 5,
|
|
50
|
+
contentType: 'list',
|
|
51
|
+
guidance: 'Guidance for making first code contributions, learning workflow, and setting up productivity tools.',
|
|
52
|
+
required: true,
|
|
53
|
+
headingLevel: 2,
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
heading: 'Required Access & Permissions',
|
|
57
|
+
order: 6,
|
|
58
|
+
contentType: 'list',
|
|
59
|
+
guidance: 'List of accounts, access levels, and permissions needed for different roles (repository, deployments, databases, cloud resources).',
|
|
60
|
+
required: true,
|
|
61
|
+
headingLevel: 2,
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
heading: 'Team Communication',
|
|
65
|
+
order: 7,
|
|
66
|
+
contentType: 'list',
|
|
67
|
+
guidance: 'Document chat channels, recurring meetings, and communication guidelines.',
|
|
68
|
+
exampleContent: '- **Channels:** #engineering, #team-name, #deployments, #incidents\n- **Meetings:** Daily standup, Sprint planning, Retrospective, Team sync\n- **Guidelines:** Use threads, mention directly when needed, default to public channels',
|
|
69
|
+
required: true,
|
|
70
|
+
headingLevel: 2,
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
heading: 'Learning Resources',
|
|
74
|
+
order: 8,
|
|
75
|
+
contentType: 'list',
|
|
76
|
+
guidance: 'Links to project-specific documentation, technical skill resources, company handbooks, and external resources.',
|
|
77
|
+
required: true,
|
|
78
|
+
headingLevel: 2,
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
heading: 'Getting Help',
|
|
82
|
+
order: 9,
|
|
83
|
+
contentType: 'prose',
|
|
84
|
+
guidance: 'Escalation steps when stuck: self-debug, search resources, ask onboarding buddy, ask team channel, ask broader engineering.',
|
|
85
|
+
required: true,
|
|
86
|
+
headingLevel: 2,
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
heading: 'Team Culture & Expectations',
|
|
90
|
+
order: 10,
|
|
91
|
+
contentType: 'prose',
|
|
92
|
+
guidance: 'Work hours, code review expectations, development principles, and growth opportunities.',
|
|
93
|
+
required: false,
|
|
94
|
+
headingLevel: 2,
|
|
95
|
+
},
|
|
96
|
+
],
|
|
97
|
+
linkTo: ['development-workflow.md', 'project-overview.md', 'architecture.md'],
|
|
98
|
+
};
|
|
99
|
+
//# sourceMappingURL=onboarding.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/onboarding.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAsB;IACpD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,YAAY;IAC1B,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,wGAAwG;IACrH,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oEAAoE;YAC9E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,oHAAoH;YAC9H,cAAc,EAAE,oRAAoR;YACpS,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kCAAkC;YAC3C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,0GAA0G;YACpH,cAAc,EAAE,gOAAgO;YAChP,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gCAAgC;YACzC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,yHAAyH;YACnI,cAAc,EAAE,mQAAmQ;YACnR,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,6BAA6B;YACtC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,qGAAqG;YAC/G,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oIAAoI;YAC9I,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2EAA2E;YACrF,cAAc,EAAE,uOAAuO;YACvP,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,gHAAgH;YAC1H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,6HAA6H;YACvI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,6BAA6B;YACtC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yFAAyF;YACnG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,EAAE,qBAAqB,EAAE,iBAAiB,CAAC;CAC9E,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"projectOverview.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/projectOverview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,wBAAwB,EAAE,iBA8GtC,CAAC"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.projectOverviewStructure = void 0;
|
|
4
|
+
exports.projectOverviewStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'project-overview',
|
|
7
|
+
title: 'Project Overview',
|
|
8
|
+
description: 'High-level overview of the project, its purpose, and key components',
|
|
9
|
+
tone: 'conversational',
|
|
10
|
+
audience: 'mixed',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Project Overview',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Summarize in 2-3 sentences what problem this project solves and who benefits from it. Focus on the value proposition.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Codebase Reference',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'prose',
|
|
24
|
+
guidance: 'Add a callout pointing to codebase-map.json for detailed symbol counts, architecture layers, and dependencies. Do NOT list all symbols inline.',
|
|
25
|
+
exampleContent: '> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [`codebase-map.json`](./codebase-map.json).',
|
|
26
|
+
required: true,
|
|
27
|
+
headingLevel: 2,
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
heading: 'Quick Facts',
|
|
31
|
+
order: 3,
|
|
32
|
+
contentType: 'list',
|
|
33
|
+
guidance: 'List root directory path, primary languages (with file counts), and key entry points. Reference codebase-map.json for full analysis.',
|
|
34
|
+
exampleContent: '- Root: `/path/to/repo`\n- Languages: TypeScript (150 files), Python (20 files)\n- Entry: `src/index.ts`\n- Full analysis: [`codebase-map.json`](./codebase-map.json)',
|
|
35
|
+
required: true,
|
|
36
|
+
headingLevel: 2,
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
heading: 'Entry Points',
|
|
40
|
+
order: 4,
|
|
41
|
+
contentType: 'list',
|
|
42
|
+
guidance: 'List main entry points with links (CLI, server, library exports). Use markdown links with line numbers.',
|
|
43
|
+
required: true,
|
|
44
|
+
headingLevel: 2,
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
heading: 'Key Exports',
|
|
48
|
+
order: 5,
|
|
49
|
+
contentType: 'list',
|
|
50
|
+
guidance: 'Reference codebase-map.json for the complete list.',
|
|
51
|
+
required: true,
|
|
52
|
+
headingLevel: 2,
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
heading: 'File Structure & Code Organization',
|
|
56
|
+
order: 6,
|
|
57
|
+
contentType: 'list',
|
|
58
|
+
guidance: 'List top-level directories with brief descriptions of their purpose.',
|
|
59
|
+
exampleContent: '- `src/` — TypeScript source files and CLI entrypoints.\n- `tests/` — Automated tests and fixtures.',
|
|
60
|
+
required: true,
|
|
61
|
+
headingLevel: 2,
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
heading: 'Technology Stack Summary',
|
|
65
|
+
order: 7,
|
|
66
|
+
contentType: 'prose',
|
|
67
|
+
guidance: 'Outline primary runtimes, languages, and platforms in use. Note build tooling, linting, and formatting infrastructure.',
|
|
68
|
+
required: true,
|
|
69
|
+
headingLevel: 2,
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
heading: 'Core Framework Stack',
|
|
73
|
+
order: 8,
|
|
74
|
+
contentType: 'prose',
|
|
75
|
+
guidance: 'Document core frameworks per layer (backend, frontend, data, messaging). Mention architectural patterns enforced by these frameworks.',
|
|
76
|
+
required: false,
|
|
77
|
+
headingLevel: 2,
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
heading: 'UI & Interaction Libraries',
|
|
81
|
+
order: 9,
|
|
82
|
+
contentType: 'prose',
|
|
83
|
+
guidance: 'List UI kits, CLI interaction helpers, or design system dependencies. Note theming, accessibility, or localization considerations.',
|
|
84
|
+
required: false,
|
|
85
|
+
headingLevel: 2,
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
heading: 'Development Tools Overview',
|
|
89
|
+
order: 10,
|
|
90
|
+
contentType: 'prose',
|
|
91
|
+
guidance: 'Highlight essential CLIs, scripts, or developer environments. Link to Tooling guide for deeper setup.',
|
|
92
|
+
required: false,
|
|
93
|
+
headingLevel: 2,
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
heading: 'Getting Started Checklist',
|
|
97
|
+
order: 11,
|
|
98
|
+
contentType: 'checklist',
|
|
99
|
+
guidance: 'Provide numbered steps to get a new developer productive. Include install, run, and verify steps.',
|
|
100
|
+
exampleContent: '1. Install dependencies with `npm install`.\n2. Explore the CLI by running `npm run dev`.\n3. Review Development Workflow for day-to-day tasks.',
|
|
101
|
+
required: true,
|
|
102
|
+
headingLevel: 2,
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
heading: 'Next Steps',
|
|
106
|
+
order: 12,
|
|
107
|
+
contentType: 'prose',
|
|
108
|
+
guidance: 'Capture product positioning, key stakeholders, and links to external documentation or product specs.',
|
|
109
|
+
required: false,
|
|
110
|
+
headingLevel: 2,
|
|
111
|
+
},
|
|
112
|
+
],
|
|
113
|
+
linkTo: ['architecture.md', 'development-workflow.md', 'tooling.md', 'codebase-map.json'],
|
|
114
|
+
};
|
|
115
|
+
//# sourceMappingURL=projectOverview.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"projectOverview.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/projectOverview.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAsB;IACzD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,kBAAkB;IAChC,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,qEAAqE;IAClF,IAAI,EAAE,gBAAgB;IACtB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uHAAuH;YACjI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gJAAgJ;YAC1J,cAAc,EAAE,kJAAkJ;YAClK,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,sIAAsI;YAChJ,cAAc,EAAE,uKAAuK;YACvL,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oCAAoC;YAC7C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,sEAAsE;YAChF,cAAc,EAAE,qGAAqG;YACrH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wHAAwH;YAClI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uIAAuI;YACjJ,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oIAAoI;YAC9I,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,mGAAmG;YAC7G,cAAc,EAAE,iJAAiJ;YACjK,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,sGAAsG;YAChH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,EAAE,yBAAyB,EAAE,YAAY,EAAE,mBAAmB,CAAC;CAC1F,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBAkD/B,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.securityStructure = void 0;
|
|
4
|
+
exports.securityStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'security',
|
|
7
|
+
title: 'Security & Compliance Notes',
|
|
8
|
+
description: 'Security policies, authentication, secrets management, and compliance requirements',
|
|
9
|
+
tone: 'formal',
|
|
10
|
+
audience: 'developers',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Security & Compliance Notes',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Capture the policies and guardrails that keep this project secure and compliant.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Authentication & Authorization',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'prose',
|
|
24
|
+
guidance: 'Describe identity providers, token formats, session strategies, and role/permission models.',
|
|
25
|
+
required: true,
|
|
26
|
+
headingLevel: 2,
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
heading: 'Secrets & Sensitive Data',
|
|
30
|
+
order: 3,
|
|
31
|
+
contentType: 'prose',
|
|
32
|
+
guidance: 'Document storage locations (vaults, parameter stores), rotation cadence, encryption practices, and data classifications.',
|
|
33
|
+
required: true,
|
|
34
|
+
headingLevel: 2,
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
heading: 'Compliance & Policies',
|
|
38
|
+
order: 4,
|
|
39
|
+
contentType: 'list',
|
|
40
|
+
guidance: 'List applicable standards (GDPR, SOC2, HIPAA, internal policies) and evidence requirements.',
|
|
41
|
+
required: false,
|
|
42
|
+
headingLevel: 2,
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
heading: 'Incident Response',
|
|
46
|
+
order: 5,
|
|
47
|
+
contentType: 'prose',
|
|
48
|
+
guidance: 'Note on-call contacts, escalation steps, and tooling for detection, triage, and post-incident analysis.',
|
|
49
|
+
required: false,
|
|
50
|
+
headingLevel: 2,
|
|
51
|
+
},
|
|
52
|
+
],
|
|
53
|
+
linkTo: ['architecture.md'],
|
|
54
|
+
};
|
|
55
|
+
//# sourceMappingURL=security.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/security.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,6BAA6B;IACpC,WAAW,EAAE,oFAAoF;IACjG,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,6BAA6B;YACtC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gCAAgC;YACzC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,6FAA6F;YACvG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,0HAA0H;YACpI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,6FAA6F;YACvG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,CAAC;CAC5B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,wBAAwB,EAAE,iBAoDtC,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.testingStrategyStructure = void 0;
|
|
4
|
+
exports.testingStrategyStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'testing-strategy',
|
|
7
|
+
title: 'Testing Strategy',
|
|
8
|
+
description: 'Test frameworks, patterns, coverage requirements, and quality gates',
|
|
9
|
+
tone: 'instructional',
|
|
10
|
+
audience: 'developers',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Testing Strategy',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Document how quality is maintained across the codebase.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Test Types',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'list',
|
|
24
|
+
guidance: 'For Unit, Integration, and E2E tests: list frameworks, file naming conventions, and required tooling.',
|
|
25
|
+
exampleContent: '- **Unit**: Jest, files named `*.test.ts`\n- **Integration**: Describe scenarios\n- **E2E**: Note harnesses or environments',
|
|
26
|
+
required: true,
|
|
27
|
+
headingLevel: 2,
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
heading: 'Running Tests',
|
|
31
|
+
order: 3,
|
|
32
|
+
contentType: 'list',
|
|
33
|
+
guidance: 'Commands for running all tests, watch mode, and coverage. Use code blocks.',
|
|
34
|
+
exampleContent: '- All tests: `npm run test`\n- Watch mode: `npm run test -- --watch`\n- Coverage: `npm run test -- --coverage`',
|
|
35
|
+
required: true,
|
|
36
|
+
headingLevel: 2,
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
heading: 'Quality Gates',
|
|
40
|
+
order: 4,
|
|
41
|
+
contentType: 'list',
|
|
42
|
+
guidance: 'Define minimum coverage expectations. Capture linting or formatting requirements before merging.',
|
|
43
|
+
required: true,
|
|
44
|
+
headingLevel: 2,
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
heading: 'Troubleshooting',
|
|
48
|
+
order: 5,
|
|
49
|
+
contentType: 'prose',
|
|
50
|
+
guidance: 'Document flaky suites, long-running tests, or environment quirks.',
|
|
51
|
+
required: false,
|
|
52
|
+
headingLevel: 2,
|
|
53
|
+
},
|
|
54
|
+
],
|
|
55
|
+
linkTo: ['development-workflow.md'],
|
|
56
|
+
};
|
|
57
|
+
//# sourceMappingURL=testing.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testing.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/testing.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAsB;IACzD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,kBAAkB;IAChC,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,qEAAqE;IAClF,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yDAAyD;YACnE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uGAAuG;YACjH,cAAc,EAAE,6HAA6H;YAC7I,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,cAAc,EAAE,gHAAgH;YAChI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,kGAAkG;YAC5G,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,mEAAmE;YAC7E,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,CAAC;CACpC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tooling.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/tooling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,gBAAgB,EAAE,iBAkD9B,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.toolingStructure = void 0;
|
|
4
|
+
exports.toolingStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'tooling',
|
|
7
|
+
title: 'Tooling & Productivity Guide',
|
|
8
|
+
description: 'Scripts, IDE settings, automation, and developer productivity tips',
|
|
9
|
+
tone: 'instructional',
|
|
10
|
+
audience: 'developers',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Tooling & Productivity Guide',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Collect the scripts, automation, and editor settings that keep contributors efficient.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Required Tooling',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'list',
|
|
24
|
+
guidance: 'List tools with installation instructions, version requirements, and what they power.',
|
|
25
|
+
required: true,
|
|
26
|
+
headingLevel: 2,
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
heading: 'Recommended Automation',
|
|
30
|
+
order: 3,
|
|
31
|
+
contentType: 'prose',
|
|
32
|
+
guidance: 'Document pre-commit hooks, linting/formatting commands, code generators, or scaffolding scripts. Include shortcuts or watch modes.',
|
|
33
|
+
required: true,
|
|
34
|
+
headingLevel: 2,
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
heading: 'IDE / Editor Setup',
|
|
38
|
+
order: 4,
|
|
39
|
+
contentType: 'list',
|
|
40
|
+
guidance: 'List extensions or plugins that catch issues early. Share snippets, templates, or workspace settings.',
|
|
41
|
+
required: false,
|
|
42
|
+
headingLevel: 2,
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
heading: 'Productivity Tips',
|
|
46
|
+
order: 5,
|
|
47
|
+
contentType: 'prose',
|
|
48
|
+
guidance: 'Document terminal aliases, container workflows, or local emulators. Link to shared scripts or dotfiles.',
|
|
49
|
+
required: false,
|
|
50
|
+
headingLevel: 2,
|
|
51
|
+
},
|
|
52
|
+
],
|
|
53
|
+
linkTo: ['development-workflow.md'],
|
|
54
|
+
};
|
|
55
|
+
//# sourceMappingURL=tooling.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tooling.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/tooling.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAsB;IACjD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE,8BAA8B;IACrC,WAAW,EAAE,oEAAoE;IACjF,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,8BAA8B;YACvC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wFAAwF;YAClG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uFAAuF;YACjG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oIAAoI;YAC9I,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,CAAC;CACpC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"troubleshooting.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/troubleshooting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,wBAAwB,EAAE,iBAsFtC,CAAC"}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.troubleshootingStructure = void 0;
|
|
4
|
+
exports.troubleshootingStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'troubleshooting',
|
|
7
|
+
title: 'Troubleshooting Guide',
|
|
8
|
+
description: 'Diagnostic procedures and solutions for common issues, designed for both developers and AI agents',
|
|
9
|
+
tone: 'technical',
|
|
10
|
+
audience: 'mixed',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Troubleshooting Guide',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Describe the purpose and agent protocol: run diagnostics, match symptoms to patterns, resolve if confident, escalate if uncertain.',
|
|
17
|
+
exampleContent: '**Agent Protocol:**\n1. Run diagnostic script to gather facts\n2. Match symptoms to known patterns\n3. Execute resolution if confidence high (>80%)\n4. Escalate to human if uncertain\n5. Log all diagnostic steps',
|
|
18
|
+
required: true,
|
|
19
|
+
headingLevel: 2,
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
heading: 'Agent Diagnostic Script',
|
|
23
|
+
order: 2,
|
|
24
|
+
contentType: 'code-block',
|
|
25
|
+
guidance: 'Provide bash script for agents to diagnose system state including application status, errors, resources, services, and processes.',
|
|
26
|
+
exampleContent: 'Script that checks: health endpoint, recent errors, CPU/memory/disk usage, database/cache connectivity, recent changes, and processes',
|
|
27
|
+
required: true,
|
|
28
|
+
headingLevel: 2,
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
heading: 'Agent Decision Tree',
|
|
32
|
+
order: 3,
|
|
33
|
+
contentType: 'diagram',
|
|
34
|
+
guidance: 'ASCII or Mermaid diagram showing how agents classify issues based on diagnostic output (not responding, database unreachable, errors, performance).',
|
|
35
|
+
exampleContent: 'App responding? → DB reachable? → Error log entries? → Resource usage normal?',
|
|
36
|
+
required: true,
|
|
37
|
+
headingLevel: 2,
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
heading: 'Common Issues & Solutions',
|
|
41
|
+
order: 4,
|
|
42
|
+
contentType: 'prose',
|
|
43
|
+
guidance: 'Document common issues organized by category (startup, database, performance) with: error detection patterns, agent diagnostic procedures, auto-resolution scripts, and escalation criteria.',
|
|
44
|
+
required: true,
|
|
45
|
+
headingLevel: 2,
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
heading: 'Application Won\'t Start',
|
|
49
|
+
order: 5,
|
|
50
|
+
contentType: 'list',
|
|
51
|
+
guidance: 'List common startup issues (port in use, missing modules, missing environment variables) with bash commands for diagnosis and resolution.',
|
|
52
|
+
exampleContent: '- Port in use: use lsof to find process, kill it, restart app\n- Missing module: clear node_modules and reinstall\n- Missing env var: check .env.example and set required variables',
|
|
53
|
+
required: true,
|
|
54
|
+
headingLevel: 2,
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
heading: 'Performance Issues',
|
|
58
|
+
order: 6,
|
|
59
|
+
contentType: 'prose',
|
|
60
|
+
guidance: 'Document how to diagnose performance problems (high CPU, memory, slow queries) with monitoring commands and optimization steps.',
|
|
61
|
+
required: false,
|
|
62
|
+
headingLevel: 2,
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
heading: 'Database Issues',
|
|
66
|
+
order: 7,
|
|
67
|
+
contentType: 'prose',
|
|
68
|
+
guidance: 'Document database connection diagnostics with connection checking procedures and startup attempts for containerized or local databases.',
|
|
69
|
+
required: false,
|
|
70
|
+
headingLevel: 2,
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
heading: 'Escalation Criteria',
|
|
74
|
+
order: 8,
|
|
75
|
+
contentType: 'prose',
|
|
76
|
+
guidance: 'Define when agents must escalate: unknown patterns, data corruption risk, security issues, multiple failed attempts, or human approval needed.',
|
|
77
|
+
required: true,
|
|
78
|
+
headingLevel: 2,
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
heading: 'Escalation Format',
|
|
82
|
+
order: 9,
|
|
83
|
+
contentType: 'code-block',
|
|
84
|
+
guidance: 'Provide template for structured escalation including issue description, symptoms, diagnostics run, attempted resolutions, and recommendations.',
|
|
85
|
+
required: false,
|
|
86
|
+
headingLevel: 2,
|
|
87
|
+
},
|
|
88
|
+
],
|
|
89
|
+
linkTo: ['development-workflow.md', 'security.md'],
|
|
90
|
+
};
|
|
91
|
+
//# sourceMappingURL=troubleshooting.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"troubleshooting.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/troubleshooting.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAsB;IACzD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,iBAAiB;IAC/B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,mGAAmG;IAChH,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oIAAoI;YAC9I,cAAc,EAAE,qNAAqN;YACrO,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,YAAY;YACzB,QAAQ,EAAE,mIAAmI;YAC7I,cAAc,EAAE,uIAAuI;YACvJ,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,SAAS;YACtB,QAAQ,EAAE,qJAAqJ;YAC/J,cAAc,EAAE,+EAA+E;YAC/F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8LAA8L;YACxM,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2IAA2I;YACrJ,cAAc,EAAE,qLAAqL;YACrM,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iIAAiI;YAC3I,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yIAAyI;YACnJ,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gJAAgJ;YAC1J,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,YAAY;YACzB,QAAQ,EAAE,gJAAgJ;YAC1J,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,EAAE,aAAa,CAAC;CACnD,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,4BAA4B,EAAE,iBAmD1C,CAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.developmentWorkflowStructure = void 0;
|
|
4
|
+
exports.developmentWorkflowStructure = {
|
|
5
|
+
fileType: 'doc',
|
|
6
|
+
documentName: 'development-workflow',
|
|
7
|
+
title: 'Development Workflow',
|
|
8
|
+
description: 'Day-to-day engineering processes, branching, and contribution guidelines',
|
|
9
|
+
tone: 'instructional',
|
|
10
|
+
audience: 'developers',
|
|
11
|
+
sections: [
|
|
12
|
+
{
|
|
13
|
+
heading: 'Development Workflow',
|
|
14
|
+
order: 1,
|
|
15
|
+
contentType: 'prose',
|
|
16
|
+
guidance: 'Outline the day-to-day engineering process for this repository.',
|
|
17
|
+
required: true,
|
|
18
|
+
headingLevel: 2,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
heading: 'Branching & Releases',
|
|
22
|
+
order: 2,
|
|
23
|
+
contentType: 'list',
|
|
24
|
+
guidance: 'Describe the branching model (trunk-based, Git Flow, etc.). Note release cadence and tagging conventions.',
|
|
25
|
+
required: true,
|
|
26
|
+
headingLevel: 2,
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
heading: 'Local Development',
|
|
30
|
+
order: 3,
|
|
31
|
+
contentType: 'list',
|
|
32
|
+
guidance: 'Commands to install dependencies, run locally, and build for distribution. Use code blocks for commands.',
|
|
33
|
+
exampleContent: '- Install: `npm install`\n- Run: `npm run dev`\n- Build: `npm run build`',
|
|
34
|
+
required: true,
|
|
35
|
+
headingLevel: 2,
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
heading: 'Code Review Expectations',
|
|
39
|
+
order: 4,
|
|
40
|
+
contentType: 'prose',
|
|
41
|
+
guidance: 'Summarize review checklists and required approvals. Reference AGENTS.md for agent collaboration tips.',
|
|
42
|
+
required: true,
|
|
43
|
+
headingLevel: 2,
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
heading: 'Onboarding Tasks',
|
|
47
|
+
order: 5,
|
|
48
|
+
contentType: 'prose',
|
|
49
|
+
guidance: 'Point newcomers to first issues or starter tickets. Link to internal runbooks or dashboards.',
|
|
50
|
+
required: false,
|
|
51
|
+
headingLevel: 2,
|
|
52
|
+
},
|
|
53
|
+
],
|
|
54
|
+
linkTo: ['testing-strategy.md', 'tooling.md'],
|
|
55
|
+
};
|
|
56
|
+
//# sourceMappingURL=workflow.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/workflow.ts"],"names":[],"mappings":";;;AAEa,QAAA,4BAA4B,GAAsB;IAC7D,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,sBAAsB;IACpC,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EAAE,0EAA0E;IACvF,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iEAAiE;YAC3E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2GAA2G;YACrH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,0GAA0G;YACpH,cAAc,EAAE,0EAA0E;YAC1F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8FAA8F;YACxG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,EAAE,YAAY,CAAC;CAC9C,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Scaffold structures index
|
|
3
|
+
*
|
|
4
|
+
* This file serves as the main barrel export for all scaffold structures,
|
|
5
|
+
* providing backward compatibility with the original scaffoldStructures.ts import path.
|
|
6
|
+
*/
|
|
7
|
+
export * from './types';
|
|
8
|
+
export * from './documentation';
|
|
9
|
+
export * from './agents';
|
|
10
|
+
export * from './skills';
|
|
11
|
+
export * from './plans';
|
|
12
|
+
export * from './registry';
|
|
13
|
+
export * from './validation';
|
|
14
|
+
export * from './serialization';
|
|
15
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generators/shared/structures/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,SAAS,CAAC;AAGxB,cAAc,iBAAiB,CAAC;AAGhC,cAAc,UAAU,CAAC;AAGzB,cAAc,UAAU,CAAC;AAGzB,cAAc,SAAS,CAAC;AAGxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC"}
|