@ai-coders/context 0.2.1 → 0.3.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 +113 -580
- package/dist/generators/agents/agentGenerator.d.ts +6 -9
- package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
- package/dist/generators/agents/agentGenerator.js +89 -32
- package/dist/generators/agents/agentGenerator.js.map +1 -1
- package/dist/generators/agents/index.d.ts +0 -2
- package/dist/generators/agents/index.d.ts.map +1 -1
- package/dist/generators/agents/index.js +1 -5
- package/dist/generators/agents/index.js.map +1 -1
- package/dist/generators/agents/templates/index.d.ts +4 -0
- package/dist/generators/agents/templates/index.d.ts.map +1 -0
- package/dist/generators/agents/templates/index.js +8 -0
- package/dist/generators/agents/templates/index.js.map +1 -0
- package/dist/generators/agents/templates/indexTemplate.d.ts +3 -0
- package/dist/generators/agents/templates/indexTemplate.d.ts.map +1 -0
- package/dist/generators/agents/templates/indexTemplate.js +35 -0
- package/dist/generators/agents/templates/indexTemplate.js.map +1 -0
- package/dist/generators/agents/templates/playbookTemplate.d.ts +4 -0
- package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -0
- package/dist/generators/agents/templates/playbookTemplate.js +63 -0
- package/dist/generators/agents/templates/playbookTemplate.js.map +1 -0
- package/dist/generators/agents/templates/types.d.ts +14 -0
- package/dist/generators/agents/templates/types.d.ts.map +1 -0
- package/dist/generators/agents/templates/types.js +3 -0
- package/dist/generators/agents/templates/types.js.map +1 -0
- package/dist/generators/documentation/documentationGenerator.d.ts +9 -15
- package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
- package/dist/generators/documentation/documentationGenerator.js +65 -77
- package/dist/generators/documentation/documentationGenerator.js.map +1 -1
- package/dist/generators/documentation/guideRegistry.d.ts +6 -0
- package/dist/generators/documentation/guideRegistry.d.ts.map +1 -0
- package/dist/generators/documentation/guideRegistry.js +82 -0
- package/dist/generators/documentation/guideRegistry.js.map +1 -0
- package/dist/generators/documentation/index.d.ts +0 -6
- package/dist/generators/documentation/index.d.ts.map +1 -1
- package/dist/generators/documentation/index.js +1 -17
- package/dist/generators/documentation/index.js.map +1 -1
- package/dist/generators/documentation/templates/architectureTemplate.d.ts +3 -0
- package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/architectureTemplate.js +66 -0
- package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/common.d.ts +7 -0
- package/dist/generators/documentation/templates/common.d.ts.map +1 -0
- package/dist/generators/documentation/templates/common.js +58 -0
- package/dist/generators/documentation/templates/common.js.map +1 -0
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts +3 -0
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/dataFlowTemplate.js +55 -0
- package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +59 -0
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/frontMatter.d.ts +11 -0
- package/dist/generators/documentation/templates/frontMatter.d.ts.map +1 -0
- package/dist/generators/documentation/templates/frontMatter.js +29 -0
- package/dist/generators/documentation/templates/frontMatter.js.map +1 -0
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts +3 -0
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/glossaryTemplate.js +55 -0
- package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/index.d.ts +11 -0
- package/dist/generators/documentation/templates/index.d.ts.map +1 -0
- package/dist/generators/documentation/templates/index.js +22 -0
- package/dist/generators/documentation/templates/index.js.map +1 -0
- package/dist/generators/documentation/templates/indexTemplate.d.ts +3 -0
- package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/indexTemplate.js +56 -0
- package/dist/generators/documentation/templates/indexTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts +3 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.js +68 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/securityTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/securityTemplate.js +53 -0
- package/dist/generators/documentation/templates/securityTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/testingTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/testingTemplate.js +59 -0
- package/dist/generators/documentation/templates/testingTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/toolingTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/toolingTemplate.js +56 -0
- package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/types.d.ts +23 -0
- package/dist/generators/documentation/templates/types.d.ts.map +1 -0
- package/dist/generators/documentation/templates/types.js +3 -0
- package/dist/generators/documentation/templates/types.js.map +1 -0
- package/dist/generators/documentation/templates.d.ts +31 -0
- package/dist/generators/documentation/templates.d.ts.map +1 -0
- package/dist/generators/documentation/templates.js +566 -0
- package/dist/generators/documentation/templates.js.map +1 -0
- package/dist/generators/plans/index.d.ts +2 -0
- package/dist/generators/plans/index.d.ts.map +1 -0
- package/dist/generators/plans/index.js +6 -0
- package/dist/generators/plans/index.js.map +1 -0
- package/dist/generators/plans/planGenerator.d.ts +22 -0
- package/dist/generators/plans/planGenerator.d.ts.map +1 -0
- package/dist/generators/plans/planGenerator.js +109 -0
- package/dist/generators/plans/planGenerator.js.map +1 -0
- package/dist/generators/plans/templates/indexTemplate.d.ts +3 -0
- package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -0
- package/dist/generators/plans/templates/indexTemplate.js +36 -0
- package/dist/generators/plans/templates/indexTemplate.js.map +1 -0
- package/dist/generators/plans/templates/planTemplate.d.ts +3 -0
- package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -0
- package/dist/generators/plans/templates/planTemplate.js +83 -0
- package/dist/generators/plans/templates/planTemplate.js.map +1 -0
- package/dist/generators/plans/templates/types.d.ts +19 -0
- package/dist/generators/plans/templates/types.d.ts.map +1 -0
- package/dist/generators/plans/templates/types.js +3 -0
- package/dist/generators/plans/templates/types.js.map +1 -0
- package/dist/generators/shared/contextGenerator.d.ts +2 -7
- package/dist/generators/shared/contextGenerator.d.ts.map +1 -1
- package/dist/generators/shared/contextGenerator.js +2 -98
- package/dist/generators/shared/contextGenerator.js.map +1 -1
- package/dist/generators/shared/directoryTemplateHelpers.d.ts +2 -0
- package/dist/generators/shared/directoryTemplateHelpers.d.ts.map +1 -0
- package/dist/generators/shared/directoryTemplateHelpers.js +12 -0
- package/dist/generators/shared/directoryTemplateHelpers.js.map +1 -0
- 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 +3 -1
- package/dist/generators/shared/index.js.map +1 -1
- package/dist/index.d.ts +6 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1300 -609
- package/dist/index.js.map +1 -1
- package/dist/utils/cliUI.d.ts +6 -4
- package/dist/utils/cliUI.d.ts.map +1 -1
- package/dist/utils/cliUI.js +71 -56
- package/dist/utils/cliUI.js.map +1 -1
- package/dist/utils/i18n.d.ts +181 -0
- package/dist/utils/i18n.d.ts.map +1 -0
- package/dist/utils/i18n.js +401 -0
- package/dist/utils/i18n.js.map +1 -0
- package/package.json +26 -23
- package/prompts/update_plan_prompt.md +42 -0
- package/prompts/update_scaffold_prompt.md +48 -0
- package/dist/generators/agentGenerator.d.ts +0 -23
- package/dist/generators/agentGenerator.d.ts.map +0 -1
- package/dist/generators/agentGenerator.js +0 -357
- package/dist/generators/agentGenerator.js.map +0 -1
- package/dist/generators/documentation/enhancedDocumentationGenerator.d.ts +0 -21
- package/dist/generators/documentation/enhancedDocumentationGenerator.d.ts.map +0 -1
- package/dist/generators/documentation/enhancedDocumentationGenerator.js +0 -216
- package/dist/generators/documentation/enhancedDocumentationGenerator.js.map +0 -1
- package/dist/generators/documentation/newDocumentationTemplates.d.ts +0 -19
- package/dist/generators/documentation/newDocumentationTemplates.d.ts.map +0 -1
- package/dist/generators/documentation/newDocumentationTemplates.js +0 -307
- package/dist/generators/documentation/newDocumentationTemplates.js.map +0 -1
- package/dist/generators/documentationGenerator.d.ts +0 -22
- package/dist/generators/documentationGenerator.d.ts.map +0 -1
- package/dist/generators/documentationGenerator.js +0 -235
- package/dist/generators/documentationGenerator.js.map +0 -1
- package/dist/generators/documentationTemplates.d.ts +0 -16
- package/dist/generators/documentationTemplates.d.ts.map +0 -1
- package/dist/generators/documentationTemplates.js +0 -326
- package/dist/generators/documentationTemplates.js.map +0 -1
- package/dist/generators/documentationUtils.d.ts +0 -7
- package/dist/generators/documentationUtils.d.ts.map +0 -1
- package/dist/generators/documentationUtils.js +0 -38
- package/dist/generators/documentationUtils.js.map +0 -1
- package/dist/generators/incrementalDocumentationGenerator.d.ts +0 -33
- package/dist/generators/incrementalDocumentationGenerator.d.ts.map +0 -1
- package/dist/generators/incrementalDocumentationGenerator.js +0 -400
- package/dist/generators/incrementalDocumentationGenerator.js.map +0 -1
|
@@ -1,235 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
-
var ownKeys = function(o) {
|
|
20
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
-
var ar = [];
|
|
22
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
-
return ar;
|
|
24
|
-
};
|
|
25
|
-
return ownKeys(o);
|
|
26
|
-
};
|
|
27
|
-
return function (mod) {
|
|
28
|
-
if (mod && mod.__esModule) return mod;
|
|
29
|
-
var result = {};
|
|
30
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
-
__setModuleDefault(result, mod);
|
|
32
|
-
return result;
|
|
33
|
-
};
|
|
34
|
-
})();
|
|
35
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
36
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
37
|
-
};
|
|
38
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.DocumentationGenerator = void 0;
|
|
40
|
-
const fs = __importStar(require("fs-extra"));
|
|
41
|
-
const path = __importStar(require("path"));
|
|
42
|
-
const chalk_1 = __importDefault(require("chalk"));
|
|
43
|
-
const moduleGrouper_1 = require("./moduleGrouper");
|
|
44
|
-
const documentationTemplates_1 = require("./documentationTemplates");
|
|
45
|
-
const documentationUtils_1 = require("./documentationUtils");
|
|
46
|
-
class DocumentationGenerator {
|
|
47
|
-
constructor(fileMapper, llmClient) {
|
|
48
|
-
this.fileMapper = fileMapper;
|
|
49
|
-
this.llmClient = llmClient;
|
|
50
|
-
this.moduleGrouper = new moduleGrouper_1.ModuleGrouper(fileMapper);
|
|
51
|
-
this.templates = new documentationTemplates_1.DocumentationTemplates(llmClient);
|
|
52
|
-
}
|
|
53
|
-
async generateDocumentation(repoStructure, outputDir, verbose = false) {
|
|
54
|
-
const docsDir = path.join(outputDir, 'docs');
|
|
55
|
-
await fs.ensureDir(docsDir);
|
|
56
|
-
if (verbose) {
|
|
57
|
-
console.log(chalk_1.default.blue(`📚 Generating documentation in: ${docsDir}`));
|
|
58
|
-
}
|
|
59
|
-
// Generate main documentation index
|
|
60
|
-
await this.generateMainIndex(repoStructure, docsDir, verbose);
|
|
61
|
-
// Generate overview documentation
|
|
62
|
-
await this.generateOverview(repoStructure, docsDir, verbose);
|
|
63
|
-
// Generate architecture documentation
|
|
64
|
-
await this.generateArchitectureDoc(repoStructure, docsDir, verbose);
|
|
65
|
-
// Generate module-based documentation
|
|
66
|
-
await this.generateModuleDocumentation(repoStructure, docsDir, verbose);
|
|
67
|
-
// Generate API reference
|
|
68
|
-
await this.generateAPIReference(repoStructure, docsDir, verbose);
|
|
69
|
-
// Generate configuration guide
|
|
70
|
-
await this.generateConfigurationGuide(repoStructure, docsDir, verbose);
|
|
71
|
-
// Generate development guide
|
|
72
|
-
await this.generateDevelopmentGuide(repoStructure, docsDir, verbose);
|
|
73
|
-
// Generate deployment guide
|
|
74
|
-
await this.generateDeploymentGuide(repoStructure, docsDir, verbose);
|
|
75
|
-
// Generate troubleshooting guide
|
|
76
|
-
await this.generateTroubleshootingGuide(repoStructure, docsDir, verbose);
|
|
77
|
-
}
|
|
78
|
-
async generateMainIndex(repoStructure, docsDir, verbose) {
|
|
79
|
-
const fileName = 'README.md';
|
|
80
|
-
if (verbose) {
|
|
81
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
82
|
-
}
|
|
83
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
84
|
-
const indexContent = this.templates.createMainIndex(repoStructure, moduleGroups);
|
|
85
|
-
const indexPath = path.join(docsDir, fileName);
|
|
86
|
-
await fs.writeFile(indexPath, indexContent);
|
|
87
|
-
if (verbose) {
|
|
88
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
async generateOverview(repoStructure, docsDir, verbose) {
|
|
92
|
-
const fileName = 'overview.md';
|
|
93
|
-
if (verbose) {
|
|
94
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
95
|
-
}
|
|
96
|
-
const overview = this.templates.createEnhancedProjectOverview(repoStructure);
|
|
97
|
-
const overviewPath = path.join(docsDir, fileName);
|
|
98
|
-
await fs.writeFile(overviewPath, overview);
|
|
99
|
-
if (verbose) {
|
|
100
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
async generateArchitectureDoc(repoStructure, docsDir, verbose) {
|
|
104
|
-
const fileName = 'architecture.md';
|
|
105
|
-
if (verbose) {
|
|
106
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
107
|
-
}
|
|
108
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
109
|
-
const architecture = this.templates.createArchitectureDocumentation(repoStructure, moduleGroups);
|
|
110
|
-
const archPath = path.join(docsDir, fileName);
|
|
111
|
-
await fs.writeFile(archPath, architecture);
|
|
112
|
-
if (verbose) {
|
|
113
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
async generateModuleDocumentation(repoStructure, docsDir, verbose) {
|
|
117
|
-
const modulesDir = path.join(docsDir, 'modules');
|
|
118
|
-
await fs.ensureDir(modulesDir);
|
|
119
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
120
|
-
if (verbose) {
|
|
121
|
-
console.log(chalk_1.default.yellow(`📦 Generating documentation for ${moduleGroups.length} modules...`));
|
|
122
|
-
}
|
|
123
|
-
for (const module of moduleGroups) {
|
|
124
|
-
try {
|
|
125
|
-
const moduleDoc = await this.createModuleDocumentation(module, repoStructure);
|
|
126
|
-
const modulePath = path.join(modulesDir, `${documentationUtils_1.DocumentationUtils.slugify(module.name)}.md`);
|
|
127
|
-
await fs.writeFile(modulePath, moduleDoc);
|
|
128
|
-
if (verbose) {
|
|
129
|
-
console.log(chalk_1.default.green(`✅ Module documentation generated: ${module.name}`));
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
catch (error) {
|
|
133
|
-
if (verbose) {
|
|
134
|
-
console.log(chalk_1.default.red(`❌ Error documenting module ${module.name}: ${error}`));
|
|
135
|
-
}
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
async generateAPIReference(repoStructure, docsDir, verbose) {
|
|
140
|
-
if (verbose) {
|
|
141
|
-
console.log(chalk_1.default.yellow('🔌 Generating API reference...'));
|
|
142
|
-
}
|
|
143
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
144
|
-
const apiRef = this.templates.createAPIReference(repoStructure, moduleGroups);
|
|
145
|
-
const apiPath = path.join(docsDir, 'api-reference.md');
|
|
146
|
-
await fs.writeFile(apiPath, apiRef);
|
|
147
|
-
if (verbose) {
|
|
148
|
-
console.log(chalk_1.default.green(`✅ API reference saved: ${apiPath}`));
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
async generateConfigurationGuide(repoStructure, docsDir, verbose) {
|
|
152
|
-
if (verbose) {
|
|
153
|
-
console.log(chalk_1.default.yellow('⚙️ Generating configuration guide...'));
|
|
154
|
-
}
|
|
155
|
-
const configGuide = this.templates.createConfigurationGuide(repoStructure);
|
|
156
|
-
const configPath = path.join(docsDir, 'configuration.md');
|
|
157
|
-
await fs.writeFile(configPath, configGuide);
|
|
158
|
-
if (verbose) {
|
|
159
|
-
console.log(chalk_1.default.green(`✅ Configuration guide saved: ${configPath}`));
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
async generateDevelopmentGuide(repoStructure, docsDir, verbose) {
|
|
163
|
-
const fileName = 'DEVELOPMENT.md';
|
|
164
|
-
if (verbose) {
|
|
165
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
166
|
-
}
|
|
167
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
168
|
-
const developmentGuide = await this.templates.createDevelopmentGuide(repoStructure, moduleGroups);
|
|
169
|
-
const devPath = path.join(docsDir, fileName);
|
|
170
|
-
await fs.writeFile(devPath, developmentGuide);
|
|
171
|
-
if (verbose) {
|
|
172
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
async generateDeploymentGuide(repoStructure, docsDir, verbose) {
|
|
176
|
-
const fileName = 'DEPLOYMENT.md';
|
|
177
|
-
if (verbose) {
|
|
178
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
179
|
-
}
|
|
180
|
-
const deploymentGuide = await this.templates.createDeploymentGuide(repoStructure);
|
|
181
|
-
const deployPath = path.join(docsDir, fileName);
|
|
182
|
-
await fs.writeFile(deployPath, deploymentGuide);
|
|
183
|
-
if (verbose) {
|
|
184
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
async generateTroubleshootingGuide(repoStructure, docsDir, verbose) {
|
|
188
|
-
const fileName = 'TROUBLESHOOTING.md';
|
|
189
|
-
if (verbose) {
|
|
190
|
-
console.log(chalk_1.default.blue(`📄 Creating ${fileName}...`));
|
|
191
|
-
}
|
|
192
|
-
const moduleGroups = this.moduleGrouper.getModuleGroups(repoStructure);
|
|
193
|
-
const troubleshootingGuide = await this.templates.createTroubleshootingGuide(repoStructure, moduleGroups);
|
|
194
|
-
const troublePath = path.join(docsDir, fileName);
|
|
195
|
-
await fs.writeFile(troublePath, troubleshootingGuide);
|
|
196
|
-
if (verbose) {
|
|
197
|
-
console.log(chalk_1.default.green(`✅ Created ${fileName}`));
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
async createModuleDocumentation(module, repoStructure) {
|
|
201
|
-
const fileContents = [];
|
|
202
|
-
for (const file of module.files.slice(0, 10)) { // Limit to prevent too large requests
|
|
203
|
-
const content = await this.fileMapper.readFileContent(file.path);
|
|
204
|
-
fileContents.push(`File: ${file.relativePath}\n${content.substring(0, 1000)}...`);
|
|
205
|
-
}
|
|
206
|
-
const moduleContext = `Module: ${module.name}
|
|
207
|
-
Description: ${module.description}
|
|
208
|
-
Files: ${module.files.map(f => f.relativePath).join(', ')}
|
|
209
|
-
|
|
210
|
-
Sample content from module files:
|
|
211
|
-
${fileContents.join('\n\n---\n\n')}`;
|
|
212
|
-
const documentation = await this.llmClient.generateText(`Generate comprehensive documentation for this module. Include:
|
|
213
|
-
1. Module overview and purpose
|
|
214
|
-
2. Key components and their responsibilities
|
|
215
|
-
3. Public APIs and interfaces
|
|
216
|
-
4. Usage examples
|
|
217
|
-
5. Dependencies and relationships
|
|
218
|
-
|
|
219
|
-
Module context:
|
|
220
|
-
${moduleContext}`, 'You are a technical documentation expert. Create clear, well-structured module documentation.');
|
|
221
|
-
return `# ${module.name}
|
|
222
|
-
|
|
223
|
-
${documentation}
|
|
224
|
-
|
|
225
|
-
## Files in this module
|
|
226
|
-
|
|
227
|
-
${module.files.map(file => `- \`${file.relativePath}\` - ${documentationUtils_1.DocumentationUtils.formatBytes(file.size)}`).join('\n')}
|
|
228
|
-
|
|
229
|
-
---
|
|
230
|
-
*Generated by AI Coders Context*
|
|
231
|
-
`;
|
|
232
|
-
}
|
|
233
|
-
}
|
|
234
|
-
exports.DocumentationGenerator = DocumentationGenerator;
|
|
235
|
-
//# sourceMappingURL=documentationGenerator.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationGenerator.js","sourceRoot":"","sources":["../../src/generators/documentationGenerator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAC/B,2CAA6B;AAI7B,kDAA0B;AAC1B,mDAA6D;AAC7D,qEAAkE;AAClE,6DAA0D;AAE1D,MAAa,sBAAsB;IAIjC,YACU,UAAsB,EACtB,SAAwB;QADxB,eAAU,GAAV,UAAU,CAAY;QACtB,cAAS,GAAT,SAAS,CAAe;QAEhC,IAAI,CAAC,aAAa,GAAG,IAAI,6BAAa,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,+CAAsB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,aAA4B,EAC5B,SAAiB,EACjB,UAAmB,KAAK;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7C,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5B,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,mCAAmC,OAAO,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC;QAED,oCAAoC;QACpC,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAE9D,kCAAkC;QAClC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAE7D,sCAAsC;QACtC,MAAM,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEpE,sCAAsC;QACtC,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAExE,yBAAyB;QACzB,MAAM,IAAI,CAAC,oBAAoB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEjE,+BAA+B;QAC/B,MAAM,IAAI,CAAC,0BAA0B,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEvE,6BAA6B;QAC7B,MAAM,IAAI,CAAC,wBAAwB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAErE,4BAA4B;QAC5B,MAAM,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEpE,iCAAiC;QACjC,MAAM,IAAI,CAAC,4BAA4B,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,WAAW,CAAC;QAC7B,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAEjF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC/C,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAE5C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC5B,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,aAAa,CAAC;QAC/B,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC,aAAa,CAAC,CAAC;QAC7E,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAE3C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,iBAAiB,CAAC;QACnC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QACjG,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC9C,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE3C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,2BAA2B,CACvC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAE/B,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAEvE,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,mCAAmC,YAAY,CAAC,MAAM,aAAa,CAAC,CAAC,CAAC;QACjG,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;gBAC9E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,uCAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1F,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;gBAE1C,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,qCAAqC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,8BAA8B,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;gBAChF,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC9E,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QACvD,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEpC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,0BAA0B,CACtC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,sCAAsC,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QAC1D,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAE5C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,gCAAgC,UAAU,EAAE,CAAC,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,gBAAgB,CAAC;QAClC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC7C,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAE9C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,eAAe,CAAC;QACjC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QAClF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAChD,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAEhD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,4BAA4B,CACxC,aAA4B,EAC5B,OAAe,EACf,OAAgB;QAEhB,MAAM,QAAQ,GAAG,oBAAoB,CAAC;QACtC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC1G,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAEtD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,yBAAyB,CACrC,MAAmB,EACnB,aAA4B;QAE5B,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,sCAAsC;YACpF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjE,YAAY,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,YAAY,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpF,CAAC;QAED,MAAM,aAAa,GAAG,WAAW,MAAM,CAAC,IAAI;eACjC,MAAM,CAAC,WAAW;SACxB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;EAGvD,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QAEjC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CACrD;;;;;;;;EAQJ,aAAa,EAAE,EACX,+FAA+F,CAChG,CAAC;QAEF,OAAO,KAAK,MAAM,CAAC,IAAI;;EAEzB,aAAa;;;;EAIb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,CAAC,YAAY,QAAQ,uCAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;CAIjH,CAAC;IACA,CAAC;CACF;AA1RD,wDA0RC"}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { RepoStructure } from '../types';
|
|
2
|
-
import { BaseLLMClient } from '../services/baseLLMClient';
|
|
3
|
-
import { ModuleGroup } from './moduleGrouper';
|
|
4
|
-
export declare class DocumentationTemplates {
|
|
5
|
-
private llmClient;
|
|
6
|
-
constructor(llmClient: BaseLLMClient);
|
|
7
|
-
createMainIndex(repoStructure: RepoStructure, moduleGroups: ModuleGroup[]): string;
|
|
8
|
-
createEnhancedProjectOverview(repoStructure: RepoStructure): string;
|
|
9
|
-
createArchitectureDocumentation(repoStructure: RepoStructure, moduleGroups: ModuleGroup[]): string;
|
|
10
|
-
createAPIReference(repoStructure: RepoStructure, moduleGroups: ModuleGroup[]): string;
|
|
11
|
-
createConfigurationGuide(repoStructure: RepoStructure): string;
|
|
12
|
-
createDevelopmentGuide(repoStructure: RepoStructure, moduleGroups: ModuleGroup[]): Promise<string>;
|
|
13
|
-
createDeploymentGuide(repoStructure: RepoStructure): Promise<string>;
|
|
14
|
-
createTroubleshootingGuide(repoStructure: RepoStructure, moduleGroups: ModuleGroup[]): Promise<string>;
|
|
15
|
-
}
|
|
16
|
-
//# sourceMappingURL=documentationTemplates.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationTemplates.d.ts","sourceRoot":"","sources":["../../src/generators/documentationTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAI9C,qBAAa,sBAAsB;IACrB,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAE5C,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM;IAsClF,6BAA6B,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM;IA8CnE,+BAA+B,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM;IA8ClG,kBAAkB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM;IAuDrF,wBAAwB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM;IAwExD,sBAAsB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IA+BlG,qBAAqB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAiCpE,0BAA0B,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CA8B7G"}
|
|
@@ -1,326 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DocumentationTemplates = void 0;
|
|
4
|
-
const projectAnalyzer_1 = require("./projectAnalyzer");
|
|
5
|
-
const documentationUtils_1 = require("./documentationUtils");
|
|
6
|
-
class DocumentationTemplates {
|
|
7
|
-
constructor(llmClient) {
|
|
8
|
-
this.llmClient = llmClient;
|
|
9
|
-
}
|
|
10
|
-
createMainIndex(repoStructure, moduleGroups) {
|
|
11
|
-
return `# Documentation Index
|
|
12
|
-
|
|
13
|
-
Welcome to the project documentation. This guide is organized into the following sections:
|
|
14
|
-
|
|
15
|
-
## 📚 Documentation Structure
|
|
16
|
-
|
|
17
|
-
### [Overview](./overview.md)
|
|
18
|
-
High-level project overview, statistics, and key components.
|
|
19
|
-
|
|
20
|
-
### [Architecture](./architecture.md)
|
|
21
|
-
System architecture, design patterns, and technical decisions.
|
|
22
|
-
|
|
23
|
-
### [Modules](./modules/)
|
|
24
|
-
Detailed documentation for each module/component:
|
|
25
|
-
${moduleGroups.map(group => `- [${group.name}](./modules/${documentationUtils_1.DocumentationUtils.slugify(group.name)}.md) - ${group.description}`).join('\n')}
|
|
26
|
-
|
|
27
|
-
### [API Reference](./api-reference.md)
|
|
28
|
-
Complete API documentation for all public interfaces.
|
|
29
|
-
|
|
30
|
-
### [Configuration](./configuration.md)
|
|
31
|
-
Configuration options, environment variables, and setup guides.
|
|
32
|
-
|
|
33
|
-
## 🚀 Quick Links
|
|
34
|
-
|
|
35
|
-
- [Getting Started](#getting-started)
|
|
36
|
-
- [Project Structure](./overview.md#project-structure)
|
|
37
|
-
- [Key Components](./architecture.md#key-components)
|
|
38
|
-
- [Contributing Guidelines](../CONTRIBUTING.md)
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
*Generated by AI Coders Context*
|
|
42
|
-
*Last updated: ${new Date().toISOString()}*
|
|
43
|
-
`;
|
|
44
|
-
}
|
|
45
|
-
createEnhancedProjectOverview(repoStructure) {
|
|
46
|
-
const { files, directories, totalFiles, totalSize } = repoStructure;
|
|
47
|
-
const extensions = new Map();
|
|
48
|
-
files.forEach(file => {
|
|
49
|
-
const ext = file.extension || 'no-extension';
|
|
50
|
-
extensions.set(ext, (extensions.get(ext) || 0) + 1);
|
|
51
|
-
});
|
|
52
|
-
const topExtensions = Array.from(extensions.entries())
|
|
53
|
-
.sort((a, b) => b[1] - a[1])
|
|
54
|
-
.slice(0, 10);
|
|
55
|
-
const projectType = projectAnalyzer_1.ProjectAnalyzer.identifyProjectType(repoStructure);
|
|
56
|
-
const techStack = projectAnalyzer_1.ProjectAnalyzer.identifyTechStack(repoStructure);
|
|
57
|
-
return `# Project Overview
|
|
58
|
-
|
|
59
|
-
## Project Information
|
|
60
|
-
- **Type**: ${projectType}
|
|
61
|
-
- **Technology Stack**: ${techStack.join(', ')}
|
|
62
|
-
- **Total Files**: ${totalFiles}
|
|
63
|
-
- **Total Size**: ${documentationUtils_1.DocumentationUtils.formatBytes(totalSize)}
|
|
64
|
-
|
|
65
|
-
## Project Structure
|
|
66
|
-
|
|
67
|
-
### Directory Overview
|
|
68
|
-
\`\`\`
|
|
69
|
-
${projectAnalyzer_1.ProjectAnalyzer.createSimplifiedTree(repoStructure)}
|
|
70
|
-
\`\`\`
|
|
71
|
-
|
|
72
|
-
### File Distribution
|
|
73
|
-
${topExtensions.map(([ext, count]) => `- **${ext}**: ${count} files (${((count / totalFiles) * 100).toFixed(1)}%)`).join('\n')}
|
|
74
|
-
|
|
75
|
-
## Key Files
|
|
76
|
-
${projectAnalyzer_1.ProjectAnalyzer.identifyKeyFiles(repoStructure).map(f => `- \`${f.relativePath}\` - ${f.description}`).join('\n')}
|
|
77
|
-
|
|
78
|
-
## Development Setup
|
|
79
|
-
|
|
80
|
-
Refer to the [Configuration Guide](./configuration.md) for detailed setup instructions.
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
*Generated by AI Coders Context*
|
|
84
|
-
`;
|
|
85
|
-
}
|
|
86
|
-
createArchitectureDocumentation(repoStructure, moduleGroups) {
|
|
87
|
-
const techStack = projectAnalyzer_1.ProjectAnalyzer.identifyTechStack(repoStructure);
|
|
88
|
-
return `# Architecture Documentation
|
|
89
|
-
|
|
90
|
-
## System Overview
|
|
91
|
-
|
|
92
|
-
This document describes the high-level architecture of the project.
|
|
93
|
-
|
|
94
|
-
## Technology Stack
|
|
95
|
-
|
|
96
|
-
${techStack.map(tech => `- **${tech}**`).join('\n')}
|
|
97
|
-
|
|
98
|
-
## Component Architecture
|
|
99
|
-
|
|
100
|
-
### Core Modules
|
|
101
|
-
|
|
102
|
-
${moduleGroups.map(module => `#### ${module.name}
|
|
103
|
-
- **Purpose**: ${module.description}
|
|
104
|
-
- **Files**: ${module.files.length}
|
|
105
|
-
- **Key Responsibilities**: [To be analyzed]
|
|
106
|
-
`).join('\n')}
|
|
107
|
-
|
|
108
|
-
## Design Patterns
|
|
109
|
-
|
|
110
|
-
Based on the codebase structure, the following patterns are identified:
|
|
111
|
-
- Command Pattern (CLI structure)
|
|
112
|
-
- Service Layer Pattern (services directory)
|
|
113
|
-
- Factory Pattern (generators)
|
|
114
|
-
|
|
115
|
-
## Data Flow
|
|
116
|
-
|
|
117
|
-
1. **Input Processing**: Command-line arguments are parsed
|
|
118
|
-
2. **File Analysis**: Repository structure is mapped
|
|
119
|
-
3. **Content Generation**: LLM-based documentation generation
|
|
120
|
-
4. **Output Generation**: Structured documentation output
|
|
121
|
-
|
|
122
|
-
## Dependencies
|
|
123
|
-
|
|
124
|
-
Analyze package.json for detailed dependency information.
|
|
125
|
-
|
|
126
|
-
---
|
|
127
|
-
*Generated by AI Coders Context*
|
|
128
|
-
`;
|
|
129
|
-
}
|
|
130
|
-
createAPIReference(repoStructure, moduleGroups) {
|
|
131
|
-
const apiFiles = repoStructure.files.filter(f => f.relativePath.includes('types') ||
|
|
132
|
-
f.relativePath.includes('index') ||
|
|
133
|
-
f.relativePath.endsWith('.ts'));
|
|
134
|
-
return `# API Reference
|
|
135
|
-
|
|
136
|
-
## Overview
|
|
137
|
-
|
|
138
|
-
This document provides a complete reference for all public APIs in the project.
|
|
139
|
-
|
|
140
|
-
## Core APIs
|
|
141
|
-
|
|
142
|
-
### CLI Commands
|
|
143
|
-
|
|
144
|
-
#### \`generate\`
|
|
145
|
-
Generate documentation and agent prompts for a repository.
|
|
146
|
-
|
|
147
|
-
**Usage:**
|
|
148
|
-
\`\`\`bash
|
|
149
|
-
ai-context generate <repo-path> [options]
|
|
150
|
-
\`\`\`
|
|
151
|
-
|
|
152
|
-
**Options:**
|
|
153
|
-
- \`-o, --output <dir>\`: Output directory
|
|
154
|
-
- \`-k, --api-key <key>\`: OpenRouter API key
|
|
155
|
-
- \`-m, --model <model>\`: LLM model to use
|
|
156
|
-
- \`--exclude <patterns...>\`: Patterns to exclude
|
|
157
|
-
- \`--include <patterns...>\`: Patterns to include
|
|
158
|
-
|
|
159
|
-
#### \`analyze\`
|
|
160
|
-
Analyze repository structure without generating content.
|
|
161
|
-
|
|
162
|
-
**Usage:**
|
|
163
|
-
\`\`\`bash
|
|
164
|
-
ai-context analyze <repo-path> [options]
|
|
165
|
-
\`\`\`
|
|
166
|
-
|
|
167
|
-
## Module APIs
|
|
168
|
-
|
|
169
|
-
${moduleGroups.map(module => `### ${module.name}\nSee [${module.name} Module Documentation](./modules/${documentationUtils_1.DocumentationUtils.slugify(module.name)}.md)`).join('\n\n')}
|
|
170
|
-
|
|
171
|
-
## Type Definitions
|
|
172
|
-
|
|
173
|
-
See the types module for detailed interface definitions.
|
|
174
|
-
|
|
175
|
-
---
|
|
176
|
-
*Generated by AI Coders Context*
|
|
177
|
-
`;
|
|
178
|
-
}
|
|
179
|
-
createConfigurationGuide(repoStructure) {
|
|
180
|
-
const configFiles = repoStructure.files.filter(f => f.relativePath.includes('config') ||
|
|
181
|
-
f.relativePath.includes('.json') ||
|
|
182
|
-
f.relativePath.includes('.env'));
|
|
183
|
-
return `# Configuration Guide
|
|
184
|
-
|
|
185
|
-
## Environment Variables
|
|
186
|
-
|
|
187
|
-
### Required Variables
|
|
188
|
-
|
|
189
|
-
- \`OPENROUTER_API_KEY\`: Your OpenRouter API key for LLM access
|
|
190
|
-
|
|
191
|
-
### Optional Variables
|
|
192
|
-
|
|
193
|
-
- \`OPENROUTER_MODEL\`: Override default model (default: \`google/gemini-2.5-flash-preview-05-20\`)
|
|
194
|
-
- \`OPENROUTER_BASE_URL\`: Custom API endpoint (rarely needed)
|
|
195
|
-
|
|
196
|
-
## Configuration Files
|
|
197
|
-
|
|
198
|
-
${configFiles.map(f => `### ${f.relativePath}
|
|
199
|
-
Configuration file for ${documentationUtils_1.DocumentationUtils.getConfigDescription(f.relativePath)}`).join('\n\n')}
|
|
200
|
-
|
|
201
|
-
## Setup Instructions
|
|
202
|
-
|
|
203
|
-
1. **Clone the repository**
|
|
204
|
-
\`\`\`bash
|
|
205
|
-
git clone https://github.com/vinilana/ai-coders-context.git
|
|
206
|
-
cd ai-coders-context
|
|
207
|
-
\`\`\`
|
|
208
|
-
|
|
209
|
-
2. **Install dependencies**
|
|
210
|
-
\`\`\`bash
|
|
211
|
-
npm install
|
|
212
|
-
\`\`\`
|
|
213
|
-
|
|
214
|
-
3. **Configure environment**
|
|
215
|
-
\`\`\`bash
|
|
216
|
-
cp .env.example .env
|
|
217
|
-
# Edit .env with your API key
|
|
218
|
-
\`\`\`
|
|
219
|
-
|
|
220
|
-
4. **Build the project**
|
|
221
|
-
\`\`\`bash
|
|
222
|
-
npm run build
|
|
223
|
-
\`\`\`
|
|
224
|
-
|
|
225
|
-
## Advanced Configuration
|
|
226
|
-
|
|
227
|
-
### Custom Model Selection
|
|
228
|
-
|
|
229
|
-
You can use any model available on OpenRouter:
|
|
230
|
-
- \`anthropic/claude-3-haiku\` - Fast and efficient
|
|
231
|
-
- \`anthropic/claude-3-sonnet\` - Balanced performance
|
|
232
|
-
- \`openai/gpt-4\` - High quality output
|
|
233
|
-
- \`google/gemini-2.5-flash-preview-05-20\` - Google's latest model
|
|
234
|
-
|
|
235
|
-
### Output Customization
|
|
236
|
-
|
|
237
|
-
Control what gets generated:
|
|
238
|
-
- \`--docs-only\`: Generate only documentation
|
|
239
|
-
- \`--agents-only\`: Generate only agent prompts
|
|
240
|
-
- \`--exclude\`: Exclude specific file patterns
|
|
241
|
-
- \`--include\`: Include only specific patterns
|
|
242
|
-
|
|
243
|
-
---
|
|
244
|
-
*Generated by AI Coders Context*
|
|
245
|
-
`;
|
|
246
|
-
}
|
|
247
|
-
async createDevelopmentGuide(repoStructure, moduleGroups) {
|
|
248
|
-
const configFiles = projectAnalyzer_1.ProjectAnalyzer.getConfigurationFiles(repoStructure);
|
|
249
|
-
const packageInfo = projectAnalyzer_1.ProjectAnalyzer.getPackageInfo(repoStructure);
|
|
250
|
-
const context = `Repository: ${repoStructure.rootPath}
|
|
251
|
-
Total Files: ${repoStructure.totalFiles}
|
|
252
|
-
Modules: ${moduleGroups.map(m => m.name).join(', ')}
|
|
253
|
-
Configuration Files: ${configFiles.map(f => f.relativePath.split('/').pop()).join(', ')}
|
|
254
|
-
Package Info: ${JSON.stringify(packageInfo, null, 2)}
|
|
255
|
-
|
|
256
|
-
Module Structure:
|
|
257
|
-
${moduleGroups.map(m => `- ${m.name}: ${m.description} (${m.files.length} files)`).join('\n')}`;
|
|
258
|
-
return await this.llmClient.generateText(`Create a comprehensive development guide for this project. Include:
|
|
259
|
-
|
|
260
|
-
1. Getting Started (setup instructions)
|
|
261
|
-
2. Development Environment Requirements
|
|
262
|
-
3. Project Structure Overview
|
|
263
|
-
4. Development Workflow
|
|
264
|
-
5. Code Style and Standards
|
|
265
|
-
6. Testing Guidelines
|
|
266
|
-
7. Debugging Tips
|
|
267
|
-
8. Build Process
|
|
268
|
-
9. Contributing Guidelines
|
|
269
|
-
|
|
270
|
-
Format as clean Markdown with proper headings and code blocks.`, context);
|
|
271
|
-
}
|
|
272
|
-
async createDeploymentGuide(repoStructure) {
|
|
273
|
-
const packageInfo = projectAnalyzer_1.ProjectAnalyzer.getPackageInfo(repoStructure);
|
|
274
|
-
const configFiles = projectAnalyzer_1.ProjectAnalyzer.getConfigurationFiles(repoStructure);
|
|
275
|
-
const hasDockerfile = repoStructure.files.some(f => f.relativePath.toLowerCase().includes('dockerfile'));
|
|
276
|
-
const hasKubernetes = repoStructure.files.some(f => f.relativePath.includes('k8s') || f.relativePath.includes('kubernetes'));
|
|
277
|
-
const context = `Repository: ${repoStructure.rootPath}
|
|
278
|
-
Package Info: ${JSON.stringify(packageInfo, null, 2)}
|
|
279
|
-
Configuration Files: ${configFiles.map(f => f.relativePath.split('/').pop()).join(', ')}
|
|
280
|
-
Has Dockerfile: ${hasDockerfile}
|
|
281
|
-
Has Kubernetes: ${hasKubernetes}
|
|
282
|
-
Project Type: ${projectAnalyzer_1.ProjectAnalyzer.detectProjectType(repoStructure)}`;
|
|
283
|
-
return await this.llmClient.generateText(`Create a comprehensive deployment guide for this project. Include:
|
|
284
|
-
|
|
285
|
-
1. Prerequisites and Dependencies
|
|
286
|
-
2. Environment Configuration
|
|
287
|
-
3. Build Process for Production
|
|
288
|
-
4. Deployment Options (based on project type)
|
|
289
|
-
5. Environment Variables and Secrets
|
|
290
|
-
6. Database Setup (if applicable)
|
|
291
|
-
7. Monitoring and Health Checks
|
|
292
|
-
8. Rollback Procedures
|
|
293
|
-
9. Security Considerations
|
|
294
|
-
10. Performance Optimization
|
|
295
|
-
|
|
296
|
-
Adapt the guide based on the project type and available configuration files.
|
|
297
|
-
Format as clean Markdown with proper headings and code blocks.`, context);
|
|
298
|
-
}
|
|
299
|
-
async createTroubleshootingGuide(repoStructure, moduleGroups) {
|
|
300
|
-
const packageInfo = projectAnalyzer_1.ProjectAnalyzer.getPackageInfo(repoStructure);
|
|
301
|
-
const projectType = projectAnalyzer_1.ProjectAnalyzer.detectProjectType(repoStructure);
|
|
302
|
-
const context = `Repository: ${repoStructure.rootPath}
|
|
303
|
-
Project Type: ${projectType}
|
|
304
|
-
Package Info: ${JSON.stringify(packageInfo, null, 2)}
|
|
305
|
-
Modules: ${moduleGroups.map(m => `${m.name} (${m.files.length} files)`).join(', ')}`;
|
|
306
|
-
return await this.llmClient.generateText(`Create a comprehensive troubleshooting guide for this ${projectType} project. Include:
|
|
307
|
-
|
|
308
|
-
1. Common Issues and Solutions
|
|
309
|
-
2. Development Environment Problems
|
|
310
|
-
3. Build and Compilation Errors
|
|
311
|
-
4. Runtime Errors and Debugging
|
|
312
|
-
5. Performance Issues
|
|
313
|
-
6. Dependency Problems
|
|
314
|
-
7. Configuration Issues
|
|
315
|
-
8. Testing Problems
|
|
316
|
-
9. Deployment Issues
|
|
317
|
-
10. Debugging Tools and Techniques
|
|
318
|
-
11. Log Analysis
|
|
319
|
-
12. FAQ Section
|
|
320
|
-
|
|
321
|
-
Focus on practical solutions and include code examples where helpful.
|
|
322
|
-
Format as clean Markdown with proper headings and code blocks.`, context);
|
|
323
|
-
}
|
|
324
|
-
}
|
|
325
|
-
exports.DocumentationTemplates = DocumentationTemplates;
|
|
326
|
-
//# sourceMappingURL=documentationTemplates.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationTemplates.js","sourceRoot":"","sources":["../../src/generators/documentationTemplates.ts"],"names":[],"mappings":";;;AAGA,uDAAoD;AACpD,6DAA0D;AAE1D,MAAa,sBAAsB;IACjC,YAAoB,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;IAAG,CAAC;IAEhD,eAAe,CAAC,aAA4B,EAAE,YAA2B;QACvE,OAAO;;;;;;;;;;;;;;EAcT,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CACzB,MAAM,KAAK,CAAC,IAAI,eAAe,uCAAkB,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,WAAW,EAAE,CACnG,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;iBAiBK,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;CACxC,CAAC;IACA,CAAC;IAED,6BAA6B,CAAC,aAA4B;QACxD,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC;QAEpE,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnB,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC;YAC7C,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;aACnD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3B,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAEhB,MAAM,WAAW,GAAG,iCAAe,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QACvE,MAAM,SAAS,GAAG,iCAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAEnE,OAAO;;;cAGG,WAAW;0BACC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;qBACzB,UAAU;oBACX,uCAAkB,CAAC,WAAW,CAAC,SAAS,CAAC;;;;;;EAM3D,iCAAe,CAAC,oBAAoB,CAAC,aAAa,CAAC;;;;EAInD,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,OAAO,KAAK,WAAW,CAAC,CAAC,KAAK,GAAC,UAAU,CAAC,GAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;EAGxH,iCAAe,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,YAAY,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;CAQlH,CAAC;IACA,CAAC;IAED,+BAA+B,CAAC,aAA4B,EAAE,YAA2B;QACvF,MAAM,SAAS,GAAG,iCAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAEnE,OAAO;;;;;;;;EAQT,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;EAMjD,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,MAAM,CAAC,IAAI;iBAC/B,MAAM,CAAC,WAAW;eACpB,MAAM,CAAC,KAAK,CAAC,MAAM;;CAEjC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;CAsBZ,CAAC;IACA,CAAC;IAED,kBAAkB,CAAC,aAA4B,EAAE,YAA2B;QAC1E,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAC9C,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAChC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAChC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAC/B,CAAC;QAEF,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmCT,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAC1B,OAAO,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,IAAI,oCAAoC,uCAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CACzH,CAAC,IAAI,CAAC,MAAM,CAAC;;;;;;;;CAQb,CAAC;IACA,CAAC;IAED,wBAAwB,CAAC,aAA4B;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CACjD,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACjC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAChC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAChC,CAAC;QAEF,OAAO;;;;;;;;;;;;;;;EAeT,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,YAAY;yBACnB,uCAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8C/F,CAAC;IACA,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,aAA4B,EAAE,YAA2B;QACpF,MAAM,WAAW,GAAG,iCAAe,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,WAAW,GAAG,iCAAe,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAElE,MAAM,OAAO,GAAG,eAAe,aAAa,CAAC,QAAQ;eAC1C,aAAa,CAAC,UAAU;WAC5B,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;uBAC5B,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBACvE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;;;EAGlD,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAE5F,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC;;;;;;;;;;;;+DAYyD,EACzD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,aAA4B;QACtD,MAAM,WAAW,GAAG,iCAAe,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,iCAAe,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QACzG,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QAE7H,MAAM,OAAO,GAAG,eAAe,aAAa,CAAC,QAAQ;gBACzC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;uBAC7B,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;kBACrE,aAAa;kBACb,aAAa;gBACf,iCAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,EAAE,CAAC;QAE/D,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC;;;;;;;;;;;;;;+DAcyD,EACzD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,aAA4B,EAAE,YAA2B;QACxF,MAAM,WAAW,GAAG,iCAAe,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,iCAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAErE,MAAM,OAAO,GAAG,eAAe,aAAa,CAAC,QAAQ;gBACzC,WAAW;gBACX,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;WACzC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAEjF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC,yDAAyD,WAAW;;;;;;;;;;;;;;;;+DAgBX,EACzD,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAlWD,wDAkWC"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
export declare class DocumentationUtils {
|
|
2
|
-
static slugify(text: string): string;
|
|
3
|
-
static formatBytes(bytes: number): string;
|
|
4
|
-
static formatModuleName(name: string): string;
|
|
5
|
-
static getConfigDescription(filePath: string): string;
|
|
6
|
-
}
|
|
7
|
-
//# sourceMappingURL=documentationUtils.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationUtils.d.ts","sourceRoot":"","sources":["../../src/generators/documentationUtils.ts"],"names":[],"mappings":"AAAA,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAOpC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAQzC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAO7C,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;CAYtD"}
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DocumentationUtils = void 0;
|
|
4
|
-
class DocumentationUtils {
|
|
5
|
-
static slugify(text) {
|
|
6
|
-
return text
|
|
7
|
-
.toLowerCase()
|
|
8
|
-
.replace(/\s+/g, '-')
|
|
9
|
-
.replace(/[^a-z0-9-]/g, '');
|
|
10
|
-
}
|
|
11
|
-
static formatBytes(bytes) {
|
|
12
|
-
if (bytes === 0)
|
|
13
|
-
return '0 Bytes';
|
|
14
|
-
const k = 1024;
|
|
15
|
-
const sizes = ['Bytes', 'KB', 'MB', 'GB'];
|
|
16
|
-
const i = Math.floor(Math.log(bytes) / Math.log(k));
|
|
17
|
-
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
|
|
18
|
-
}
|
|
19
|
-
static formatModuleName(name) {
|
|
20
|
-
return name
|
|
21
|
-
.split(/[-_]/)
|
|
22
|
-
.map(word => word.charAt(0).toUpperCase() + word.slice(1))
|
|
23
|
-
.join(' ');
|
|
24
|
-
}
|
|
25
|
-
static getConfigDescription(filePath) {
|
|
26
|
-
const descriptions = {
|
|
27
|
-
'package.json': 'Node.js dependencies and scripts',
|
|
28
|
-
'tsconfig.json': 'TypeScript compilation settings',
|
|
29
|
-
'.env': 'Environment variables',
|
|
30
|
-
'.env.example': 'Environment variable template',
|
|
31
|
-
'jest.config.js': 'Jest testing configuration'
|
|
32
|
-
};
|
|
33
|
-
const basename = filePath.split('/').pop() || filePath;
|
|
34
|
-
return descriptions[basename] || basename.replace(/\.[^.]+$/, '');
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
exports.DocumentationUtils = DocumentationUtils;
|
|
38
|
-
//# sourceMappingURL=documentationUtils.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"documentationUtils.js","sourceRoot":"","sources":["../../src/generators/documentationUtils.ts"],"names":[],"mappings":";;;AAAA,MAAa,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,IAAI;aACR,WAAW,EAAE;aACb,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;aACpB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,KAAa;QAC9B,IAAI,KAAK,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAClC,MAAM,CAAC,GAAG,IAAI,CAAC;QACf,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,OAAO,UAAU,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAClC,OAAO,IAAI;aACR,KAAK,CAAC,MAAM,CAAC;aACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACzD,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAED,MAAM,CAAC,oBAAoB,CAAC,QAAgB;QAC1C,MAAM,YAAY,GAA8B;YAC9C,cAAc,EAAE,kCAAkC;YAClD,eAAe,EAAE,iCAAiC;YAClD,MAAM,EAAE,uBAAuB;YAC/B,cAAc,EAAE,+BAA+B;YAC/C,gBAAgB,EAAE,4BAA4B;SAC/C,CAAC;QAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,QAAQ,CAAC;QACvD,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAnCD,gDAmCC"}
|