@ai-coders/context 0.7.0 → 0.7.1
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 +25 -5
- 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 +29 -4
- package/dist/generators/agents/agentGenerator.js.map +1 -1
- package/dist/generators/documentation/codebaseMapGenerator.d.ts +45 -0
- package/dist/generators/documentation/codebaseMapGenerator.d.ts.map +1 -1
- package/dist/generators/documentation/codebaseMapGenerator.js +429 -10
- package/dist/generators/documentation/codebaseMapGenerator.js.map +1 -1
- package/dist/generators/documentation/documentationGenerator.d.ts +2 -0
- package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
- package/dist/generators/documentation/documentationGenerator.js +28 -6
- package/dist/generators/documentation/documentationGenerator.js.map +1 -1
- package/dist/generators/documentation/index.d.ts +1 -1
- package/dist/generators/documentation/index.d.ts.map +1 -1
- package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
- package/dist/generators/plans/templates/planTemplate.js +54 -18
- package/dist/generators/plans/templates/planTemplate.js.map +1 -1
- package/dist/generators/shared/structures/agents/definitions.d.ts +1 -1
- package/dist/generators/shared/structures/agents/definitions.d.ts.map +1 -1
- package/dist/generators/shared/structures/agents/definitions.js +554 -15
- package/dist/generators/shared/structures/agents/definitions.js.map +1 -1
- package/dist/generators/shared/structures/agents/factory.d.ts +17 -1
- package/dist/generators/shared/structures/agents/factory.d.ts.map +1 -1
- package/dist/generators/shared/structures/agents/factory.js +117 -91
- package/dist/generators/shared/structures/agents/factory.js.map +1 -1
- package/dist/generators/shared/structures/documentation/architecture.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/architecture.js +55 -0
- package/dist/generators/shared/structures/documentation/architecture.js.map +1 -1
- package/dist/generators/shared/structures/documentation/dataFlow.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/dataFlow.js +35 -0
- package/dist/generators/shared/structures/documentation/dataFlow.js.map +1 -1
- package/dist/generators/shared/structures/documentation/glossary.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/glossary.js +20 -0
- package/dist/generators/shared/structures/documentation/glossary.js.map +1 -1
- package/dist/generators/shared/structures/documentation/projectOverview.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/projectOverview.js +48 -0
- package/dist/generators/shared/structures/documentation/projectOverview.js.map +1 -1
- package/dist/generators/shared/structures/documentation/security.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/security.js +45 -0
- package/dist/generators/shared/structures/documentation/security.js.map +1 -1
- package/dist/generators/shared/structures/documentation/testing.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/testing.js +73 -0
- package/dist/generators/shared/structures/documentation/testing.js.map +1 -1
- package/dist/generators/shared/structures/documentation/tooling.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/tooling.js +59 -0
- package/dist/generators/shared/structures/documentation/tooling.js.map +1 -1
- package/dist/generators/shared/structures/documentation/workflow.d.ts.map +1 -1
- package/dist/generators/shared/structures/documentation/workflow.js +60 -0
- package/dist/generators/shared/structures/documentation/workflow.js.map +1 -1
- package/dist/generators/shared/structures/serialization.d.ts.map +1 -1
- package/dist/generators/shared/structures/serialization.js +5 -0
- package/dist/generators/shared/structures/serialization.js.map +1 -1
- package/dist/generators/shared/structures/skills/definitions.d.ts +1 -1
- package/dist/generators/shared/structures/skills/definitions.d.ts.map +1 -1
- package/dist/generators/shared/structures/skills/definitions.js +420 -11
- package/dist/generators/shared/structures/skills/definitions.js.map +1 -1
- package/dist/generators/shared/structures/skills/factory.d.ts +10 -1
- package/dist/generators/shared/structures/skills/factory.d.ts.map +1 -1
- package/dist/generators/shared/structures/skills/factory.js +55 -36
- package/dist/generators/shared/structures/skills/factory.js.map +1 -1
- package/dist/generators/shared/structures/types.d.ts +2 -0
- package/dist/generators/shared/structures/types.d.ts.map +1 -1
- package/dist/index.js +68 -59
- package/dist/index.js.map +1 -1
- package/dist/services/ai/schemas.d.ts +2 -0
- package/dist/services/ai/schemas.d.ts.map +1 -1
- package/dist/services/ai/schemas.js +3 -1
- package/dist/services/ai/schemas.js.map +1 -1
- package/dist/services/ai/tools/fillScaffoldingTool.d.ts +1 -0
- package/dist/services/ai/tools/fillScaffoldingTool.d.ts.map +1 -1
- package/dist/services/ai/tools/fillScaffoldingTool.js +19 -1
- 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.js +5 -1
- package/dist/services/ai/tools/getCodebaseMapTool.js.map +1 -1
- package/dist/services/ai/tools/initializeContextTool.d.ts.map +1 -1
- package/dist/services/ai/tools/initializeContextTool.js +13 -0
- package/dist/services/ai/tools/initializeContextTool.js.map +1 -1
- package/dist/services/autoFill/autoFillService.d.ts +52 -0
- package/dist/services/autoFill/autoFillService.d.ts.map +1 -0
- package/dist/services/autoFill/autoFillService.js +473 -0
- package/dist/services/autoFill/autoFillService.js.map +1 -0
- package/dist/services/autoFill/index.d.ts +2 -0
- package/dist/services/autoFill/index.d.ts.map +1 -0
- package/dist/services/autoFill/index.js +6 -0
- package/dist/services/autoFill/index.js.map +1 -0
- package/dist/services/init/initService.d.ts +2 -0
- package/dist/services/init/initService.d.ts.map +1 -1
- package/dist/services/init/initService.js +29 -3
- package/dist/services/init/initService.js.map +1 -1
- package/dist/services/semantic/contextBuilder.d.ts.map +1 -1
- package/dist/services/semantic/contextBuilder.js +2 -1
- package/dist/services/semantic/contextBuilder.js.map +1 -1
- package/dist/services/semantic/types.d.ts.map +1 -1
- package/dist/services/semantic/types.js +2 -0
- package/dist/services/semantic/types.js.map +1 -1
- package/dist/utils/i18n.d.ts +4 -2
- package/dist/utils/i18n.d.ts.map +1 -1
- package/dist/utils/i18n.js +8 -4
- package/dist/utils/i18n.js.map +1 -1
- package/package.json +1 -1
|
@@ -4,10 +4,125 @@
|
|
|
4
4
|
*/
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.createAgentStructure = createAgentStructure;
|
|
7
|
+
/**
|
|
8
|
+
* Map of section headings to content keys
|
|
9
|
+
*/
|
|
10
|
+
const SECTION_KEY_MAP = {
|
|
11
|
+
'Mission': 'mission',
|
|
12
|
+
'Responsibilities': 'responsibilities',
|
|
13
|
+
'Best Practices': 'bestPractices',
|
|
14
|
+
'Key Project Resources': 'keyProjectResources',
|
|
15
|
+
'Repository Starting Points': 'repositoryStartingPoints',
|
|
16
|
+
'Key Files': 'keyFiles',
|
|
17
|
+
'Architecture Context': 'architectureContext',
|
|
18
|
+
'Key Symbols for This Agent': 'keySymbols',
|
|
19
|
+
'Documentation Touchpoints': 'documentationTouchpoints',
|
|
20
|
+
'Collaboration Checklist': 'collaborationChecklist',
|
|
21
|
+
'Hand-off Notes': 'handoffNotes',
|
|
22
|
+
};
|
|
7
23
|
/**
|
|
8
24
|
* Create an agent structure with standard sections
|
|
9
25
|
*/
|
|
10
|
-
function createAgentStructure(agentType, title, description, additionalContext) {
|
|
26
|
+
function createAgentStructure(agentType, title, description, additionalContext, defaultContent) {
|
|
27
|
+
const sections = [
|
|
28
|
+
{
|
|
29
|
+
heading: 'Mission',
|
|
30
|
+
order: 1,
|
|
31
|
+
contentType: 'prose',
|
|
32
|
+
guidance: `Describe how the ${title.toLowerCase()} agent supports the team and when to engage it.`,
|
|
33
|
+
required: true,
|
|
34
|
+
headingLevel: 2,
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
heading: 'Responsibilities',
|
|
38
|
+
order: 2,
|
|
39
|
+
contentType: 'list',
|
|
40
|
+
guidance: 'List specific responsibilities this agent handles. Be concrete about what tasks it performs.',
|
|
41
|
+
required: true,
|
|
42
|
+
headingLevel: 2,
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
heading: 'Best Practices',
|
|
46
|
+
order: 3,
|
|
47
|
+
contentType: 'list',
|
|
48
|
+
guidance: 'List best practices and guidelines for this agent to follow.',
|
|
49
|
+
required: true,
|
|
50
|
+
headingLevel: 2,
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
heading: 'Key Project Resources',
|
|
54
|
+
order: 4,
|
|
55
|
+
contentType: 'list',
|
|
56
|
+
guidance: 'Link to documentation index, agent handbook, AGENTS.md, and contributor guide.',
|
|
57
|
+
required: true,
|
|
58
|
+
headingLevel: 2,
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
heading: 'Repository Starting Points',
|
|
62
|
+
order: 5,
|
|
63
|
+
contentType: 'list',
|
|
64
|
+
guidance: 'List top-level directories relevant to this agent with brief descriptions.',
|
|
65
|
+
required: true,
|
|
66
|
+
headingLevel: 2,
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
heading: 'Key Files',
|
|
70
|
+
order: 6,
|
|
71
|
+
contentType: 'list',
|
|
72
|
+
guidance: 'List entry points, pattern implementations, and service files relevant to this agent.',
|
|
73
|
+
required: true,
|
|
74
|
+
headingLevel: 2,
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
heading: 'Architecture Context',
|
|
78
|
+
order: 7,
|
|
79
|
+
contentType: 'list',
|
|
80
|
+
guidance: 'For each architectural layer, describe directories, symbol counts, and key exports.',
|
|
81
|
+
required: false,
|
|
82
|
+
headingLevel: 2,
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
heading: 'Key Symbols for This Agent',
|
|
86
|
+
order: 8,
|
|
87
|
+
contentType: 'list',
|
|
88
|
+
guidance: 'List symbols (classes, functions, types) most relevant to this agent with links.',
|
|
89
|
+
required: true,
|
|
90
|
+
headingLevel: 2,
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
heading: 'Documentation Touchpoints',
|
|
94
|
+
order: 9,
|
|
95
|
+
contentType: 'list',
|
|
96
|
+
guidance: 'Link to relevant documentation files this agent should reference.',
|
|
97
|
+
required: true,
|
|
98
|
+
headingLevel: 2,
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
heading: 'Collaboration Checklist',
|
|
102
|
+
order: 10,
|
|
103
|
+
contentType: 'checklist',
|
|
104
|
+
guidance: 'Numbered checklist for agent workflow: confirm assumptions, review PRs, update docs, capture learnings.',
|
|
105
|
+
required: true,
|
|
106
|
+
headingLevel: 2,
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
heading: 'Hand-off Notes',
|
|
110
|
+
order: 11,
|
|
111
|
+
contentType: 'prose',
|
|
112
|
+
guidance: 'Summarize outcomes, remaining risks, and suggested follow-up actions after the agent completes work.',
|
|
113
|
+
required: false,
|
|
114
|
+
headingLevel: 2,
|
|
115
|
+
},
|
|
116
|
+
];
|
|
117
|
+
// Apply default content to sections
|
|
118
|
+
if (defaultContent) {
|
|
119
|
+
for (const section of sections) {
|
|
120
|
+
const key = SECTION_KEY_MAP[section.heading];
|
|
121
|
+
if (key && defaultContent[key]) {
|
|
122
|
+
section.defaultContent = defaultContent[key];
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
11
126
|
return {
|
|
12
127
|
fileType: 'agent',
|
|
13
128
|
documentName: agentType,
|
|
@@ -15,96 +130,7 @@ function createAgentStructure(agentType, title, description, additionalContext)
|
|
|
15
130
|
description,
|
|
16
131
|
tone: 'instructional',
|
|
17
132
|
audience: 'ai-agents',
|
|
18
|
-
sections
|
|
19
|
-
{
|
|
20
|
-
heading: 'Mission',
|
|
21
|
-
order: 1,
|
|
22
|
-
contentType: 'prose',
|
|
23
|
-
guidance: `Describe how the ${title.toLowerCase()} agent supports the team and when to engage it.`,
|
|
24
|
-
required: true,
|
|
25
|
-
headingLevel: 2,
|
|
26
|
-
},
|
|
27
|
-
{
|
|
28
|
-
heading: 'Responsibilities',
|
|
29
|
-
order: 2,
|
|
30
|
-
contentType: 'list',
|
|
31
|
-
guidance: 'List specific responsibilities this agent handles. Be concrete about what tasks it performs.',
|
|
32
|
-
required: true,
|
|
33
|
-
headingLevel: 2,
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
heading: 'Best Practices',
|
|
37
|
-
order: 3,
|
|
38
|
-
contentType: 'list',
|
|
39
|
-
guidance: 'List best practices and guidelines for this agent to follow.',
|
|
40
|
-
required: true,
|
|
41
|
-
headingLevel: 2,
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
heading: 'Key Project Resources',
|
|
45
|
-
order: 4,
|
|
46
|
-
contentType: 'list',
|
|
47
|
-
guidance: 'Link to documentation index, agent handbook, AGENTS.md, and contributor guide.',
|
|
48
|
-
required: true,
|
|
49
|
-
headingLevel: 2,
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
heading: 'Repository Starting Points',
|
|
53
|
-
order: 5,
|
|
54
|
-
contentType: 'list',
|
|
55
|
-
guidance: 'List top-level directories relevant to this agent with brief descriptions.',
|
|
56
|
-
required: true,
|
|
57
|
-
headingLevel: 2,
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
heading: 'Key Files',
|
|
61
|
-
order: 6,
|
|
62
|
-
contentType: 'list',
|
|
63
|
-
guidance: 'List entry points, pattern implementations, and service files relevant to this agent.',
|
|
64
|
-
required: true,
|
|
65
|
-
headingLevel: 2,
|
|
66
|
-
},
|
|
67
|
-
{
|
|
68
|
-
heading: 'Architecture Context',
|
|
69
|
-
order: 7,
|
|
70
|
-
contentType: 'list',
|
|
71
|
-
guidance: 'For each architectural layer, describe directories, symbol counts, and key exports.',
|
|
72
|
-
required: false,
|
|
73
|
-
headingLevel: 2,
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
heading: 'Key Symbols for This Agent',
|
|
77
|
-
order: 8,
|
|
78
|
-
contentType: 'list',
|
|
79
|
-
guidance: 'List symbols (classes, functions, types) most relevant to this agent with links.',
|
|
80
|
-
required: true,
|
|
81
|
-
headingLevel: 2,
|
|
82
|
-
},
|
|
83
|
-
{
|
|
84
|
-
heading: 'Documentation Touchpoints',
|
|
85
|
-
order: 9,
|
|
86
|
-
contentType: 'list',
|
|
87
|
-
guidance: 'Link to relevant documentation files this agent should reference.',
|
|
88
|
-
required: true,
|
|
89
|
-
headingLevel: 2,
|
|
90
|
-
},
|
|
91
|
-
{
|
|
92
|
-
heading: 'Collaboration Checklist',
|
|
93
|
-
order: 10,
|
|
94
|
-
contentType: 'checklist',
|
|
95
|
-
guidance: 'Numbered checklist for agent workflow: confirm assumptions, review PRs, update docs, capture learnings.',
|
|
96
|
-
required: true,
|
|
97
|
-
headingLevel: 2,
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
heading: 'Hand-off Notes',
|
|
101
|
-
order: 11,
|
|
102
|
-
contentType: 'prose',
|
|
103
|
-
guidance: 'Summarize outcomes, remaining risks, and suggested follow-up actions after the agent completes work.',
|
|
104
|
-
required: false,
|
|
105
|
-
headingLevel: 2,
|
|
106
|
-
},
|
|
107
|
-
],
|
|
133
|
+
sections,
|
|
108
134
|
linkTo: ['../docs/README.md', 'README.md', '../../AGENTS.md'],
|
|
109
135
|
additionalContext,
|
|
110
136
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/agents/factory.ts"],"names":[],"mappings":";AAAA;;GAEG;;
|
|
1
|
+
{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/agents/factory.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAyCH,oDAuHC;AA3ID;;GAEG;AACH,MAAM,eAAe,GAA8C;IACjE,SAAS,EAAE,SAAS;IACpB,kBAAkB,EAAE,kBAAkB;IACtC,gBAAgB,EAAE,eAAe;IACjC,uBAAuB,EAAE,qBAAqB;IAC9C,4BAA4B,EAAE,0BAA0B;IACxD,WAAW,EAAE,UAAU;IACvB,sBAAsB,EAAE,qBAAqB;IAC7C,4BAA4B,EAAE,YAAY;IAC1C,2BAA2B,EAAE,0BAA0B;IACvD,yBAAyB,EAAE,wBAAwB;IACnD,gBAAgB,EAAE,cAAc;CACjC,CAAC;AAEF;;GAEG;AACH,SAAgB,oBAAoB,CAClC,SAAiB,EACjB,KAAa,EACb,WAAmB,EACnB,iBAA0B,EAC1B,cAAoC;IAEpC,MAAM,QAAQ,GAAsB;QAClC;YACE,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oBAAoB,KAAK,CAAC,WAAW,EAAE,iDAAiD;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,8FAA8F;YACxG,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8DAA8D;YACxE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,uBAAuB;YAChC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,gFAAgF;YAC1F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uFAAuF;YACjG,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,qFAAqF;YAC/F,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,mEAAmE;YAC7E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,yBAAyB;YAClC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,sGAAsG;YAChH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF,CAAC;IAEF,oCAAoC;IACpC,IAAI,cAAc,EAAE,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,YAAY,EAAE,SAAS;QACvB,KAAK,EAAE,GAAG,KAAK,iBAAiB;QAChC,WAAW;QACX,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,WAAW;QACrB,QAAQ;QACR,MAAM,EAAE,CAAC,mBAAmB,EAAE,WAAW,EAAE,iBAAiB,CAAC;QAC7D,iBAAiB;KAClB,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"architecture.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,qBAAqB,EAAE,
|
|
1
|
+
{"version":3,"file":"architecture.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,qBAAqB,EAAE,iBA2KnC,CAAC"}
|
|
@@ -16,6 +16,9 @@ exports.architectureStructure = {
|
|
|
16
16
|
guidance: 'Describe how the system is assembled and why the current design exists.',
|
|
17
17
|
required: true,
|
|
18
18
|
headingLevel: 2,
|
|
19
|
+
defaultContent: `This document describes the system architecture, design patterns, and key technical decisions.
|
|
20
|
+
|
|
21
|
+
For complete symbol counts and dependency analysis, see [\`codebase-map.json\`](./codebase-map.json).`,
|
|
19
22
|
},
|
|
20
23
|
{
|
|
21
24
|
heading: 'System Architecture Overview',
|
|
@@ -24,6 +27,17 @@ exports.architectureStructure = {
|
|
|
24
27
|
guidance: 'Summarize the top-level topology (monolith, modular service, microservices) and deployment model. Highlight how requests traverse the system and where control pivots between layers.',
|
|
25
28
|
required: true,
|
|
26
29
|
headingLevel: 2,
|
|
30
|
+
defaultContent: `**Architecture Style**: [Monolith / Modular Monolith / Microservices]
|
|
31
|
+
|
|
32
|
+
**Key Components**:
|
|
33
|
+
- **Entry Layer**: Handles incoming requests (CLI, HTTP, etc.)
|
|
34
|
+
- **Service Layer**: Core business logic and orchestration
|
|
35
|
+
- **Data Layer**: Persistence and external service integration
|
|
36
|
+
|
|
37
|
+
**Request Flow**:
|
|
38
|
+
1. Request enters through entry point
|
|
39
|
+
2. Routed to appropriate service handler
|
|
40
|
+
3. Service processes and returns response`,
|
|
27
41
|
},
|
|
28
42
|
{
|
|
29
43
|
heading: 'Architectural Layers',
|
|
@@ -33,6 +47,12 @@ exports.architectureStructure = {
|
|
|
33
47
|
exampleContent: '- **Services**: Core business logic (`src/services/`)\n- **Generators**: Content generation (`src/generators/`)\n\n> See [`codebase-map.json`](./codebase-map.json) for complete symbol counts and dependency graphs.',
|
|
34
48
|
required: true,
|
|
35
49
|
headingLevel: 2,
|
|
50
|
+
defaultContent: `- **Entry Points**: Application entry and initialization (\`src/\`)
|
|
51
|
+
- **Services**: Core business logic (\`src/services/\`)
|
|
52
|
+
- **Models/Types**: Data structures and type definitions (\`src/types/\`)
|
|
53
|
+
- **Utilities**: Shared helper functions (\`src/utils/\`)
|
|
54
|
+
|
|
55
|
+
> See [\`codebase-map.json\`](./codebase-map.json) for complete symbol counts and dependency graphs.`,
|
|
36
56
|
},
|
|
37
57
|
{
|
|
38
58
|
heading: 'Detected Design Patterns',
|
|
@@ -42,6 +62,11 @@ exports.architectureStructure = {
|
|
|
42
62
|
exampleContent: '| Pattern | Confidence | Locations | Description |\n|---------|------------|-----------|-------------|\n| Factory | 85% | `LLMClientFactory` | Creates LLM client instances |',
|
|
43
63
|
required: true,
|
|
44
64
|
headingLevel: 2,
|
|
65
|
+
defaultContent: `| Pattern | Locations | Description |
|
|
66
|
+
|---------|-----------|-------------|
|
|
67
|
+
| [Pattern Name] | \`src/path/\` | [Brief description] |
|
|
68
|
+
|
|
69
|
+
*Update this table as patterns are identified in the codebase.*`,
|
|
45
70
|
},
|
|
46
71
|
{
|
|
47
72
|
heading: 'Entry Points',
|
|
@@ -50,6 +75,8 @@ exports.architectureStructure = {
|
|
|
50
75
|
guidance: 'List entry points with markdown links to the actual files.',
|
|
51
76
|
required: true,
|
|
52
77
|
headingLevel: 2,
|
|
78
|
+
defaultContent: `- [\`src/index.ts\`](../src/index.ts) — Main module entry
|
|
79
|
+
- [\`src/cli.ts\`](../src/cli.ts) — CLI entry point (if applicable)`,
|
|
53
80
|
},
|
|
54
81
|
{
|
|
55
82
|
heading: 'Public API',
|
|
@@ -58,6 +85,11 @@ exports.architectureStructure = {
|
|
|
58
85
|
guidance: 'Table of exported symbols with Symbol, Type, and Location columns.',
|
|
59
86
|
required: true,
|
|
60
87
|
headingLevel: 2,
|
|
88
|
+
defaultContent: `| Symbol | Type | Location |
|
|
89
|
+
|--------|------|----------|
|
|
90
|
+
| [ExportName] | class/function/type | \`src/path.ts\` |
|
|
91
|
+
|
|
92
|
+
See [\`codebase-map.json\`](./codebase-map.json) for the complete public API listing.`,
|
|
61
93
|
},
|
|
62
94
|
{
|
|
63
95
|
heading: 'Internal System Boundaries',
|
|
@@ -82,6 +114,13 @@ exports.architectureStructure = {
|
|
|
82
114
|
guidance: 'Summarize architectural decisions, experiments, or ADR outcomes. Explain why selected approaches won over alternatives.',
|
|
83
115
|
required: false,
|
|
84
116
|
headingLevel: 2,
|
|
117
|
+
defaultContent: `Document key architectural decisions here. Consider creating Architecture Decision Records (ADRs) for significant choices.
|
|
118
|
+
|
|
119
|
+
**Template**:
|
|
120
|
+
- **Decision**: [What was decided]
|
|
121
|
+
- **Context**: [Why this decision was needed]
|
|
122
|
+
- **Alternatives**: [What else was considered]
|
|
123
|
+
- **Consequences**: [Impact of this decision]`,
|
|
85
124
|
},
|
|
86
125
|
{
|
|
87
126
|
heading: 'Diagrams',
|
|
@@ -90,6 +129,14 @@ exports.architectureStructure = {
|
|
|
90
129
|
guidance: 'Link architectural diagrams or add mermaid definitions showing system components and their relationships.',
|
|
91
130
|
required: false,
|
|
92
131
|
headingLevel: 2,
|
|
132
|
+
defaultContent: `\`\`\`mermaid
|
|
133
|
+
graph TD
|
|
134
|
+
A[Entry Point] --> B[Service Layer]
|
|
135
|
+
B --> C[Data Layer]
|
|
136
|
+
B --> D[External Services]
|
|
137
|
+
\`\`\`
|
|
138
|
+
|
|
139
|
+
*Replace with actual system architecture diagram.*`,
|
|
93
140
|
},
|
|
94
141
|
{
|
|
95
142
|
heading: 'Risks & Constraints',
|
|
@@ -106,6 +153,11 @@ exports.architectureStructure = {
|
|
|
106
153
|
guidance: 'List top directories with approximate file counts.',
|
|
107
154
|
required: true,
|
|
108
155
|
headingLevel: 2,
|
|
156
|
+
defaultContent: `- \`src/\` — Source code
|
|
157
|
+
- \`tests/\` — Test files
|
|
158
|
+
- \`docs/\` — Documentation
|
|
159
|
+
|
|
160
|
+
*See [\`codebase-map.json\`](./codebase-map.json) for detailed file counts.*`,
|
|
109
161
|
},
|
|
110
162
|
{
|
|
111
163
|
heading: 'Related Resources',
|
|
@@ -114,6 +166,9 @@ exports.architectureStructure = {
|
|
|
114
166
|
guidance: 'Link to Project Overview and other relevant documentation.',
|
|
115
167
|
required: true,
|
|
116
168
|
headingLevel: 2,
|
|
169
|
+
defaultContent: `- [Project Overview](./project-overview.md)
|
|
170
|
+
- [Data Flow](./data-flow.md) (if applicable)
|
|
171
|
+
- [Codebase Map](./codebase-map.json)`,
|
|
117
172
|
},
|
|
118
173
|
],
|
|
119
174
|
linkTo: ['project-overview.md', 'data-flow.md', 'codebase-map.json'],
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"architecture.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAsB;IACtD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yEAAyE;YACnF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"architecture.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/architecture.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAsB;IACtD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yEAAyE;YACnF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;sGAEgF;SACjG;QACD;YACE,OAAO,EAAE,8BAA8B;YACvC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uLAAuL;YACjM,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;;;;0CAUoB;SACrC;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,wJAAwJ;YAClK,cAAc,EAAE,uNAAuN;YACvO,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;qGAK+E;SAChG;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,qGAAqG;YAC/G,cAAc,EAAE,+KAA+K;YAC/L,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;gEAI0C;SAC3D;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;oEAC8C;SAC/D;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oEAAoE;YAC9E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;sFAIgE;SACjF;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,2JAA2J;YACrK,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8IAA8I;YACxJ,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yHAAyH;YACnI,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;8CAMwB;SACzC;QACD;YACE,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,SAAS;YACtB,QAAQ,EAAE,2GAA2G;YACrH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;mDAO6B;SAC9C;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,2FAA2F;YACrG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;6EAIuD;SACxE;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;sCAEgB;SACjC;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,EAAE,cAAc,EAAE,mBAAmB,CAAC;CACrE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataFlow.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,
|
|
1
|
+
{"version":3,"file":"dataFlow.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBAsG/B,CAAC"}
|
|
@@ -16,6 +16,9 @@ exports.dataFlowStructure = {
|
|
|
16
16
|
guidance: 'Explain how data enters, moves through, and exits the system, including interactions with external services.',
|
|
17
17
|
required: true,
|
|
18
18
|
headingLevel: 2,
|
|
19
|
+
defaultContent: `This document describes how data flows through the system, including internal processing and external integrations.
|
|
20
|
+
|
|
21
|
+
Understanding data flow helps with debugging, performance optimization, and maintaining system reliability.`,
|
|
19
22
|
},
|
|
20
23
|
{
|
|
21
24
|
heading: 'Module Dependencies',
|
|
@@ -25,6 +28,13 @@ exports.dataFlowStructure = {
|
|
|
25
28
|
exampleContent: '- **src/** → `utils`, `config`\n- **services/** → `utils`',
|
|
26
29
|
required: true,
|
|
27
30
|
headingLevel: 2,
|
|
31
|
+
defaultContent: `Module dependency overview:
|
|
32
|
+
|
|
33
|
+
- **Entry Layer** → Services, Utils
|
|
34
|
+
- **Services** → Data Access, External APIs
|
|
35
|
+
- **Data Access** → Database, Cache
|
|
36
|
+
|
|
37
|
+
*See [\`codebase-map.json\`](./codebase-map.json) for detailed dependency graphs.*`,
|
|
28
38
|
},
|
|
29
39
|
{
|
|
30
40
|
heading: 'Service Layer',
|
|
@@ -33,6 +43,11 @@ exports.dataFlowStructure = {
|
|
|
33
43
|
guidance: 'List service classes with links to their implementations.',
|
|
34
44
|
required: true,
|
|
35
45
|
headingLevel: 2,
|
|
46
|
+
defaultContent: `Key services in the system:
|
|
47
|
+
|
|
48
|
+
- **[ServiceName]** — [Purpose] (\`src/services/path.ts\`)
|
|
49
|
+
|
|
50
|
+
*See [\`codebase-map.json\`](./codebase-map.json) for complete service listings.*`,
|
|
36
51
|
},
|
|
37
52
|
{
|
|
38
53
|
heading: 'High-level Flow',
|
|
@@ -41,6 +56,19 @@ exports.dataFlowStructure = {
|
|
|
41
56
|
guidance: 'Summarize the primary pipeline from input to output. Reference diagrams or embed Mermaid definitions.',
|
|
42
57
|
required: true,
|
|
43
58
|
headingLevel: 2,
|
|
59
|
+
defaultContent: `\`\`\`mermaid
|
|
60
|
+
flowchart LR
|
|
61
|
+
A[Input] --> B[Processing]
|
|
62
|
+
B --> C[Storage]
|
|
63
|
+
B --> D[Output]
|
|
64
|
+
\`\`\`
|
|
65
|
+
|
|
66
|
+
**Data Flow Steps**:
|
|
67
|
+
1. Data enters through entry points (API, CLI, etc.)
|
|
68
|
+
2. Services process and transform data
|
|
69
|
+
3. Results are stored and/or returned to caller
|
|
70
|
+
|
|
71
|
+
*Replace with actual system data flow.*`,
|
|
44
72
|
},
|
|
45
73
|
{
|
|
46
74
|
heading: 'Internal Movement',
|
|
@@ -57,6 +85,13 @@ exports.dataFlowStructure = {
|
|
|
57
85
|
guidance: 'Document each integration with purpose, authentication, payload shapes, and retry strategy.',
|
|
58
86
|
required: false,
|
|
59
87
|
headingLevel: 2,
|
|
88
|
+
defaultContent: `**External Services**:
|
|
89
|
+
|
|
90
|
+
| Service | Purpose | Auth Method |
|
|
91
|
+
|---------|---------|-------------|
|
|
92
|
+
| [Service] | [Purpose] | [API Key/OAuth/etc.] |
|
|
93
|
+
|
|
94
|
+
*Document error handling and retry strategies for each integration.*`,
|
|
60
95
|
},
|
|
61
96
|
{
|
|
62
97
|
heading: 'Observability & Failure Modes',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataFlow.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,WAAW;IACzB,KAAK,EAAE,0BAA0B;IACjC,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8GAA8G;YACxH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"dataFlow.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/dataFlow.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,WAAW;IACzB,KAAK,EAAE,0BAA0B;IACjC,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8GAA8G;YACxH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;4GAEsF;SACvG;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,uEAAuE;YACjF,cAAc,EAAE,2DAA2D;YAC3E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;mFAM6D;SAC9E;QACD;YACE,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2DAA2D;YACrE,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;kFAI4D;SAC7E;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;;;;;;wCAYkB;SACnC;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iFAAiF;YAC3F,QAAQ,EAAE,KAAK;YACf,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;YACf,cAAc,EAAE;;;;;;qEAM+C;SAChE;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8GAA8G;YACxH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,CAAC;CAC5B,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,
|
|
1
|
+
{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBAsF/B,CAAC"}
|
|
@@ -16,6 +16,9 @@ exports.glossaryStructure = {
|
|
|
16
16
|
guidance: 'List project-specific terminology, acronyms, domain entities, and user personas.',
|
|
17
17
|
required: true,
|
|
18
18
|
headingLevel: 2,
|
|
19
|
+
defaultContent: `This document defines project-specific terminology, concepts, and domain knowledge.
|
|
20
|
+
|
|
21
|
+
Use this as a reference when encountering unfamiliar terms in the codebase or documentation.`,
|
|
19
22
|
},
|
|
20
23
|
{
|
|
21
24
|
heading: 'Type Definitions',
|
|
@@ -24,6 +27,11 @@ exports.glossaryStructure = {
|
|
|
24
27
|
guidance: 'List exported type definitions and interfaces with links to their locations.',
|
|
25
28
|
required: true,
|
|
26
29
|
headingLevel: 2,
|
|
30
|
+
defaultContent: `Key type definitions in this project:
|
|
31
|
+
|
|
32
|
+
- **[TypeName]** — [Description] (\`src/types/path.ts\`)
|
|
33
|
+
|
|
34
|
+
*See [\`codebase-map.json\`](./codebase-map.json) for complete type listings.*`,
|
|
27
35
|
},
|
|
28
36
|
{
|
|
29
37
|
heading: 'Enumerations',
|
|
@@ -32,6 +40,11 @@ exports.glossaryStructure = {
|
|
|
32
40
|
guidance: 'List exported enums with links to their locations.',
|
|
33
41
|
required: true,
|
|
34
42
|
headingLevel: 2,
|
|
43
|
+
defaultContent: `Enums defined in this project:
|
|
44
|
+
|
|
45
|
+
- **[EnumName]** — [Description] (\`src/types/path.ts\`)
|
|
46
|
+
|
|
47
|
+
*See [\`codebase-map.json\`](./codebase-map.json) for complete enum listings.*`,
|
|
35
48
|
},
|
|
36
49
|
{
|
|
37
50
|
heading: 'Core Terms',
|
|
@@ -40,6 +53,9 @@ exports.glossaryStructure = {
|
|
|
40
53
|
guidance: 'Define key terms, their relevance, and where they surface in the codebase.',
|
|
41
54
|
required: true,
|
|
42
55
|
headingLevel: 2,
|
|
56
|
+
defaultContent: `**[Term]**: [Definition and context]
|
|
57
|
+
|
|
58
|
+
Add project-specific terminology here as the codebase evolves.`,
|
|
43
59
|
},
|
|
44
60
|
{
|
|
45
61
|
heading: 'Acronyms & Abbreviations',
|
|
@@ -48,6 +64,10 @@ exports.glossaryStructure = {
|
|
|
48
64
|
guidance: 'Expand abbreviations and note associated services or APIs.',
|
|
49
65
|
required: false,
|
|
50
66
|
headingLevel: 2,
|
|
67
|
+
defaultContent: `| Acronym | Expansion | Context |
|
|
68
|
+
|---------|-----------|---------|
|
|
69
|
+
| API | Application Programming Interface | External/internal interfaces |
|
|
70
|
+
| CLI | Command Line Interface | User interaction |`,
|
|
51
71
|
},
|
|
52
72
|
{
|
|
53
73
|
heading: 'Personas / Actors',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"glossary.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,4EAA4E;IACzF,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"glossary.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,4EAA4E;IACzF,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;6FAEuE;SACxF;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;+EAIyD;SAC1E;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;+EAIyD;SAC1E;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;+DAEyC;SAC1D;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;oDAG8B;SAC/C;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,+GAA+G;YACzH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,CAAC;CAChC,CAAC"}
|
|
@@ -1 +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,
|
|
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,iBA8JtC,CAAC"}
|
|
@@ -16,6 +16,9 @@ exports.projectOverviewStructure = {
|
|
|
16
16
|
guidance: 'Summarize in 2-3 sentences what problem this project solves and who benefits from it. Focus on the value proposition.',
|
|
17
17
|
required: true,
|
|
18
18
|
headingLevel: 2,
|
|
19
|
+
defaultContent: `This project provides [describe main functionality]. It helps [target users] to [key benefit].
|
|
20
|
+
|
|
21
|
+
The codebase is organized to support [main use case] with a focus on [key qualities like maintainability, performance, etc.].`,
|
|
19
22
|
},
|
|
20
23
|
{
|
|
21
24
|
heading: 'Codebase Reference',
|
|
@@ -25,6 +28,7 @@ exports.projectOverviewStructure = {
|
|
|
25
28
|
exampleContent: '> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [`codebase-map.json`](./codebase-map.json).',
|
|
26
29
|
required: true,
|
|
27
30
|
headingLevel: 2,
|
|
31
|
+
defaultContent: `> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [\`codebase-map.json\`](./codebase-map.json).`,
|
|
28
32
|
},
|
|
29
33
|
{
|
|
30
34
|
heading: 'Quick Facts',
|
|
@@ -34,6 +38,10 @@ exports.projectOverviewStructure = {
|
|
|
34
38
|
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
39
|
required: true,
|
|
36
40
|
headingLevel: 2,
|
|
41
|
+
defaultContent: `- **Root**: \`./\`
|
|
42
|
+
- **Primary Language**: [Language] ([X] files)
|
|
43
|
+
- **Entry Point**: \`src/index.ts\` or \`src/main.ts\`
|
|
44
|
+
- **Full Analysis**: [\`codebase-map.json\`](./codebase-map.json)`,
|
|
37
45
|
},
|
|
38
46
|
{
|
|
39
47
|
heading: 'Entry Points',
|
|
@@ -42,6 +50,9 @@ exports.projectOverviewStructure = {
|
|
|
42
50
|
guidance: 'List main entry points with links (CLI, server, library exports). Use markdown links with line numbers.',
|
|
43
51
|
required: true,
|
|
44
52
|
headingLevel: 2,
|
|
53
|
+
defaultContent: `- **Main Entry**: \`src/index.ts\` - Primary module exports
|
|
54
|
+
- **CLI**: \`src/cli.ts\` - Command-line interface (if applicable)
|
|
55
|
+
- **Server**: \`src/server.ts\` - HTTP server entry (if applicable)`,
|
|
45
56
|
},
|
|
46
57
|
{
|
|
47
58
|
heading: 'Key Exports',
|
|
@@ -50,6 +61,10 @@ exports.projectOverviewStructure = {
|
|
|
50
61
|
guidance: 'Reference codebase-map.json for the complete list.',
|
|
51
62
|
required: true,
|
|
52
63
|
headingLevel: 2,
|
|
64
|
+
defaultContent: `See [\`codebase-map.json\`](./codebase-map.json) for the complete list of exported symbols.
|
|
65
|
+
|
|
66
|
+
Key public APIs:
|
|
67
|
+
- [List main exported classes/functions]`,
|
|
53
68
|
},
|
|
54
69
|
{
|
|
55
70
|
heading: 'File Structure & Code Organization',
|
|
@@ -59,6 +74,11 @@ exports.projectOverviewStructure = {
|
|
|
59
74
|
exampleContent: '- `src/` — TypeScript source files and CLI entrypoints.\n- `tests/` — Automated tests and fixtures.',
|
|
60
75
|
required: true,
|
|
61
76
|
headingLevel: 2,
|
|
77
|
+
defaultContent: `- \`src/\` — Source code and main application logic
|
|
78
|
+
- \`tests/\` or \`__tests__/\` — Test files and fixtures
|
|
79
|
+
- \`dist/\` or \`build/\` — Compiled output (gitignored)
|
|
80
|
+
- \`docs/\` — Documentation files
|
|
81
|
+
- \`scripts/\` — Build and utility scripts`,
|
|
62
82
|
},
|
|
63
83
|
{
|
|
64
84
|
heading: 'Technology Stack Summary',
|
|
@@ -67,6 +87,18 @@ exports.projectOverviewStructure = {
|
|
|
67
87
|
guidance: 'Outline primary runtimes, languages, and platforms in use. Note build tooling, linting, and formatting infrastructure.',
|
|
68
88
|
required: true,
|
|
69
89
|
headingLevel: 2,
|
|
90
|
+
defaultContent: `**Runtime**: Node.js
|
|
91
|
+
|
|
92
|
+
**Language**: TypeScript/JavaScript
|
|
93
|
+
|
|
94
|
+
**Build Tools**:
|
|
95
|
+
- TypeScript compiler (tsc) or bundler (esbuild, webpack, etc.)
|
|
96
|
+
- Package manager: npm/yarn/pnpm
|
|
97
|
+
|
|
98
|
+
**Code Quality**:
|
|
99
|
+
- Linting: ESLint
|
|
100
|
+
- Formatting: Prettier
|
|
101
|
+
- Type checking: TypeScript strict mode`,
|
|
70
102
|
},
|
|
71
103
|
{
|
|
72
104
|
heading: 'Core Framework Stack',
|
|
@@ -91,6 +123,13 @@ exports.projectOverviewStructure = {
|
|
|
91
123
|
guidance: 'Highlight essential CLIs, scripts, or developer environments. Link to Tooling guide for deeper setup.',
|
|
92
124
|
required: false,
|
|
93
125
|
headingLevel: 2,
|
|
126
|
+
defaultContent: `See [Tooling](./tooling.md) for detailed development environment setup.
|
|
127
|
+
|
|
128
|
+
**Essential Commands**:
|
|
129
|
+
- \`npm install\` — Install dependencies
|
|
130
|
+
- \`npm run build\` — Build the project
|
|
131
|
+
- \`npm run test\` — Run tests
|
|
132
|
+
- \`npm run dev\` — Start development mode`,
|
|
94
133
|
},
|
|
95
134
|
{
|
|
96
135
|
heading: 'Getting Started Checklist',
|
|
@@ -100,6 +139,12 @@ exports.projectOverviewStructure = {
|
|
|
100
139
|
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
140
|
required: true,
|
|
102
141
|
headingLevel: 2,
|
|
142
|
+
defaultContent: `1. Clone the repository
|
|
143
|
+
2. Install dependencies: \`npm install\`
|
|
144
|
+
3. Copy environment template: \`cp .env.example .env\` (if applicable)
|
|
145
|
+
4. Run tests to verify setup: \`npm run test\`
|
|
146
|
+
5. Start development: \`npm run dev\`
|
|
147
|
+
6. Review [Development Workflow](./development-workflow.md) for day-to-day tasks`,
|
|
103
148
|
},
|
|
104
149
|
{
|
|
105
150
|
heading: 'Next Steps',
|
|
@@ -108,6 +153,9 @@ exports.projectOverviewStructure = {
|
|
|
108
153
|
guidance: 'Capture product positioning, key stakeholders, and links to external documentation or product specs.',
|
|
109
154
|
required: false,
|
|
110
155
|
headingLevel: 2,
|
|
156
|
+
defaultContent: `- Review [Architecture](./architecture.md) for system design details
|
|
157
|
+
- See [Development Workflow](./development-workflow.md) for contribution guidelines
|
|
158
|
+
- Check [Testing Strategy](./testing-strategy.md) for quality requirements`,
|
|
111
159
|
},
|
|
112
160
|
],
|
|
113
161
|
linkTo: ['architecture.md', 'development-workflow.md', 'tooling.md', 'codebase-map.json'],
|