Merge pull request 'feat: add tag/endpoint selection mechanism' (#35) from feat/#11 into main
Reviewed-on: #35 Reviewed-by: didavila <diego.davilafreitas@gmail.com>
This commit was merged in pull request #35.
This commit is contained in:
23
main.ts
23
main.ts
@@ -10,10 +10,11 @@ import { checkOpenApiGenerator, installOpenApiGenerator } from './src/utils/open
|
|||||||
import { createDirectoryStructure, cleanup } from './src/utils/filesystem';
|
import { createDirectoryStructure, cleanup } from './src/utils/filesystem';
|
||||||
import { analyzeSwagger } from './src/swagger/analyzer';
|
import { analyzeSwagger } from './src/swagger/analyzer';
|
||||||
import { generateCode, organizeFiles, addDtoImports } from './src/generators/dto.generator';
|
import { generateCode, organizeFiles, addDtoImports } from './src/generators/dto.generator';
|
||||||
import { generateCleanArchitecture, extractTagsFromAnalysis } from './src/generators/clean-arch.generator';
|
import { generateCleanArchitecture, extractTagsWithOperations } from './src/generators/clean-arch.generator';
|
||||||
import { generateReport } from './src/generators/report.generator';
|
import { generateReport } from './src/generators/report.generator';
|
||||||
import { findEnvironmentFile, parseApiKeys } from './src/utils/environment-finder';
|
import { findEnvironmentFile, parseApiKeys } from './src/utils/environment-finder';
|
||||||
import { askApiKeysForTags } from './src/utils/prompt';
|
import { askApiKeysForTags, askSelectionFilter } from './src/utils/prompt';
|
||||||
|
import type { SelectionFilter } from './src/types';
|
||||||
import type { CliOptions } from './src/types';
|
import type { CliOptions } from './src/types';
|
||||||
import packageJson from './package.json';
|
import packageJson from './package.json';
|
||||||
|
|
||||||
@@ -37,6 +38,7 @@ program
|
|||||||
)
|
)
|
||||||
.option('--skip-install', 'No instalar dependencias')
|
.option('--skip-install', 'No instalar dependencias')
|
||||||
.option('--dry-run', 'Simular sin generar archivos')
|
.option('--dry-run', 'Simular sin generar archivos')
|
||||||
|
.option('-s, --select-endpoints', 'Seleccionar interactivamente qué tags y endpoints generar')
|
||||||
.parse(process.argv);
|
.parse(process.argv);
|
||||||
|
|
||||||
const options = program.opts<CliOptions>();
|
const options = program.opts<CliOptions>();
|
||||||
@@ -85,8 +87,19 @@ async function main(): Promise<void> {
|
|||||||
|
|
||||||
createDirectoryStructure(options.output);
|
createDirectoryStructure(options.output);
|
||||||
|
|
||||||
|
// ── SELECTION: tags and endpoints ─────────────────────────────────────────
|
||||||
|
const tagSummaries = extractTagsWithOperations(analysis);
|
||||||
|
let selectionFilter: SelectionFilter = {};
|
||||||
|
|
||||||
|
if (options.selectEndpoints) {
|
||||||
|
selectionFilter = await askSelectionFilter(tagSummaries);
|
||||||
|
}
|
||||||
|
|
||||||
|
const selectedTags = options.selectEndpoints
|
||||||
|
? Object.keys(selectionFilter)
|
||||||
|
: tagSummaries.map((t) => t.tag);
|
||||||
|
|
||||||
// ── ENVIRONMENT API KEY SELECTION ──────────────────────────────────────────
|
// ── ENVIRONMENT API KEY SELECTION ──────────────────────────────────────────
|
||||||
const tags = extractTagsFromAnalysis(analysis);
|
|
||||||
const envFile = findEnvironmentFile(process.cwd());
|
const envFile = findEnvironmentFile(process.cwd());
|
||||||
let apiKeys: ReturnType<typeof parseApiKeys> = [];
|
let apiKeys: ReturnType<typeof parseApiKeys> = [];
|
||||||
|
|
||||||
@@ -103,13 +116,13 @@ async function main(): Promise<void> {
|
|||||||
logWarning('No se encontró environment.ts. Se solicitará la clave manualmente por repositorio.');
|
logWarning('No se encontró environment.ts. Se solicitará la clave manualmente por repositorio.');
|
||||||
}
|
}
|
||||||
|
|
||||||
const tagApiKeyMap = await askApiKeysForTags(tags, apiKeys);
|
const tagApiKeyMap = await askApiKeysForTags(selectedTags, apiKeys);
|
||||||
// ──────────────────────────────────────────────────────────────────────────
|
// ──────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
const tempDir = generateCode(options.input, options.templates);
|
const tempDir = generateCode(options.input, options.templates);
|
||||||
organizeFiles(tempDir, options.output);
|
organizeFiles(tempDir, options.output);
|
||||||
addDtoImports(options.output);
|
addDtoImports(options.output);
|
||||||
generateCleanArchitecture(analysis, options.output, options.templates, tagApiKeyMap);
|
generateCleanArchitecture(analysis, options.output, options.templates, tagApiKeyMap, selectionFilter);
|
||||||
cleanup(tempDir);
|
cleanup(tempDir);
|
||||||
|
|
||||||
const report = generateReport(options.output, analysis);
|
const report = generateReport(options.output, analysis);
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ import type {
|
|||||||
OpenApiSchema,
|
OpenApiSchema,
|
||||||
OpenApiOperation,
|
OpenApiOperation,
|
||||||
TagOperation,
|
TagOperation,
|
||||||
|
TagSummary,
|
||||||
|
SelectionFilter,
|
||||||
GeneratedCount
|
GeneratedCount
|
||||||
} from '../types';
|
} from '../types';
|
||||||
|
|
||||||
@@ -34,12 +36,35 @@ export function extractTagsFromAnalysis(analysis: SwaggerAnalysis): string[] {
|
|||||||
return tags;
|
return tags;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extracts all tags with their operations summary for the interactive selection screen.
|
||||||
|
*/
|
||||||
|
export function extractTagsWithOperations(analysis: SwaggerAnalysis): TagSummary[] {
|
||||||
|
const map = new Map<string, TagSummary>();
|
||||||
|
Object.entries(analysis.paths).forEach(([pathKey, pathObj]) => {
|
||||||
|
Object.entries(pathObj as Record<string, unknown>).forEach(([method, opRaw]) => {
|
||||||
|
const op = opRaw as OpenApiOperation;
|
||||||
|
if (!op.tags?.length) return;
|
||||||
|
const tag = op.tags[0];
|
||||||
|
if (!map.has(tag)) map.set(tag, { tag, operations: [] });
|
||||||
|
map.get(tag)!.operations.push({
|
||||||
|
nickname: op.operationId || `${method}${pathKey.replace(/\//g, '_')}`,
|
||||||
|
method: method.toUpperCase(),
|
||||||
|
path: pathKey,
|
||||||
|
summary: op.summary || ''
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
return [...map.values()];
|
||||||
|
}
|
||||||
|
|
||||||
/** Genera todos los artefactos de Clean Architecture (modelos, mappers, repos, use cases, providers) usando Mustache. */
|
/** Genera todos los artefactos de Clean Architecture (modelos, mappers, repos, use cases, providers) usando Mustache. */
|
||||||
export function generateCleanArchitecture(
|
export function generateCleanArchitecture(
|
||||||
analysis: SwaggerAnalysis,
|
analysis: SwaggerAnalysis,
|
||||||
outputDir: string,
|
outputDir: string,
|
||||||
templatesDir: string,
|
templatesDir: string,
|
||||||
tagApiKeyMap: Record<string, string> = {}
|
tagApiKeyMap: Record<string, string> = {},
|
||||||
|
selectionFilter: SelectionFilter = {}
|
||||||
): GeneratedCount {
|
): GeneratedCount {
|
||||||
logStep('Generando artefactos de Clean Architecture usando Mustache...');
|
logStep('Generando artefactos de Clean Architecture usando Mustache...');
|
||||||
const generatedCount: GeneratedCount = {
|
const generatedCount: GeneratedCount = {
|
||||||
@@ -221,6 +246,17 @@ export function generateCleanArchitecture(
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (Object.keys(selectionFilter).length > 0) {
|
||||||
|
Object.keys(tagsMap).forEach((tag) => {
|
||||||
|
if (!selectionFilter[tag]) {
|
||||||
|
delete tagsMap[tag];
|
||||||
|
} else {
|
||||||
|
tagsMap[tag] = tagsMap[tag].filter((op) => selectionFilter[tag].includes(op.nickname));
|
||||||
|
if (tagsMap[tag].length === 0) delete tagsMap[tag];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Generar por cada Tag
|
// Generar por cada Tag
|
||||||
Object.keys(tagsMap).forEach((tag) => {
|
Object.keys(tagsMap).forEach((tag) => {
|
||||||
const returnImports: { classname: string; classFilename: string; classVarName: string }[] = [];
|
const returnImports: { classname: string; classFilename: string; classVarName: string }[] = [];
|
||||||
|
|||||||
@@ -8,4 +8,5 @@ export interface CliOptions {
|
|||||||
templates: string;
|
templates: string;
|
||||||
skipInstall?: boolean;
|
skipInstall?: boolean;
|
||||||
dryRun?: boolean;
|
dryRun?: boolean;
|
||||||
|
selectEndpoints?: boolean;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,26 @@
|
|||||||
|
/**
|
||||||
|
* Resumen de un endpoint para mostrar en la pantalla de selección interactiva.
|
||||||
|
*/
|
||||||
|
export interface OperationSummary {
|
||||||
|
nickname: string;
|
||||||
|
method: string;
|
||||||
|
path: string;
|
||||||
|
summary: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tag con sus endpoints resumidos, para la pantalla de selección interactiva.
|
||||||
|
*/
|
||||||
|
export interface TagSummary {
|
||||||
|
tag: string;
|
||||||
|
operations: OperationSummary[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mapa de filtro de selección: tag → array de nicknames de operaciones seleccionadas.
|
||||||
|
*/
|
||||||
|
export type SelectionFilter = Record<string, string[]>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Representación simplificada de un schema de componente OpenAPI.
|
* Representación simplificada de un schema de componente OpenAPI.
|
||||||
* Se utiliza para generar modelos (entidades) y mappers.
|
* Se utiliza para generar modelos (entidades) y mappers.
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import prompts from 'prompts';
|
import prompts from 'prompts';
|
||||||
import { ApiKeyInfo } from './environment-finder';
|
import { ApiKeyInfo } from './environment-finder';
|
||||||
import { colors } from './logger';
|
import { colors } from './logger';
|
||||||
|
import type { TagSummary, SelectionFilter } from '../types';
|
||||||
|
|
||||||
function clearScreen(): void {
|
function clearScreen(): void {
|
||||||
process.stdout.write('\x1Bc');
|
process.stdout.write('\x1Bc');
|
||||||
@@ -26,6 +27,70 @@ function printSummary(tags: string[], result: Record<string, string>): void {
|
|||||||
console.log(` ${'─'.repeat(54)}\n`);
|
console.log(` ${'─'.repeat(54)}\n`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interactively asks the user which tags and endpoints to generate.
|
||||||
|
* Returns a SelectionFilter map of tag → selected operation nicknames.
|
||||||
|
*/
|
||||||
|
export async function askSelectionFilter(tagSummaries: TagSummary[]): Promise<SelectionFilter> {
|
||||||
|
if (tagSummaries.length === 0) return {};
|
||||||
|
|
||||||
|
clearScreen();
|
||||||
|
console.log(`\n ${colors.bright}📋 Selección de tags y endpoints${colors.reset}`);
|
||||||
|
console.log(` ${'─'.repeat(54)}\n`);
|
||||||
|
|
||||||
|
// Step 1: select tags
|
||||||
|
const tagResponse = await prompts({
|
||||||
|
type: 'multiselect',
|
||||||
|
name: 'tags',
|
||||||
|
message: 'Tags a generar',
|
||||||
|
choices: tagSummaries.map((t) => ({
|
||||||
|
title: `${colors.bright}${t.tag}${colors.reset} ${colors.cyan}(${t.operations.length} endpoint${t.operations.length !== 1 ? 's' : ''})${colors.reset}`,
|
||||||
|
value: t.tag,
|
||||||
|
selected: true
|
||||||
|
})),
|
||||||
|
min: 1,
|
||||||
|
hint: 'Espacio para marcar/desmarcar, Enter para confirmar'
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!tagResponse.tags?.length) process.exit(0);
|
||||||
|
|
||||||
|
const selectedTags: string[] = tagResponse.tags;
|
||||||
|
const filter: SelectionFilter = {};
|
||||||
|
|
||||||
|
// Step 2: for each selected tag, select endpoints
|
||||||
|
for (let i = 0; i < selectedTags.length; i++) {
|
||||||
|
const tag = selectedTags[i];
|
||||||
|
const summary = tagSummaries.find((t) => t.tag === tag)!;
|
||||||
|
|
||||||
|
clearScreen();
|
||||||
|
console.log(
|
||||||
|
`\n ${colors.bright}📋 Endpoints a generar${colors.reset} [${colors.cyan}${i + 1}${colors.reset} de ${colors.cyan}${selectedTags.length}${colors.reset}]`
|
||||||
|
);
|
||||||
|
console.log(` ${'─'.repeat(54)}\n`);
|
||||||
|
|
||||||
|
const opResponse = await prompts({
|
||||||
|
type: 'multiselect',
|
||||||
|
name: 'ops',
|
||||||
|
message: `Tag ${colors.bright}${tag}${colors.reset}`,
|
||||||
|
choices: summary.operations.map((op) => ({
|
||||||
|
title:
|
||||||
|
`${colors.bright}${op.method.padEnd(6)}${colors.reset} ${op.path}` +
|
||||||
|
(op.summary ? ` ${colors.cyan}${op.summary}${colors.reset}` : ''),
|
||||||
|
value: op.nickname,
|
||||||
|
selected: true
|
||||||
|
})),
|
||||||
|
min: 1,
|
||||||
|
hint: 'Espacio para marcar/desmarcar, Enter para confirmar'
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!opResponse.ops?.length) process.exit(0);
|
||||||
|
|
||||||
|
filter[tag] = opResponse.ops;
|
||||||
|
}
|
||||||
|
|
||||||
|
return filter;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interactively asks the user which environment API key to use for each tag,
|
* Interactively asks the user which environment API key to use for each tag,
|
||||||
* using arrow-key selection. The last option always allows typing manually.
|
* using arrow-key selection. The last option always allows typing manually.
|
||||||
|
|||||||
Reference in New Issue
Block a user