blas/openapi-clean-arch-gen
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects 1 Releases 6 Wiki Activity

feat: add Prettier and ESLint configuration for code formatting and linting

Browse Source 
- Create .prettierrc for Prettier configuration
- Add eslint.config.js for ESLint setup with TypeScript support
- Update package.json to include linting and formatting scripts
- Refactor generate.ts and generate.js for improved readability and error handling
- Enhance QUICKSTART.md and README.md with formatting and clarity improvements
This commit is contained in:
didavila
2026-03-23 17:23:06 +01:00
parent cd00eb39ca
commit cebadbfbcc
7 changed files with 422 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
dist/generate.js vendored
View File

@@ -11,7 +11,9 @@ const js_yaml_1 = __importDefault(require("js-yaml"));
const mustache_1 = __importDefault(require("mustache"));
const commander_1 = require("commander");
// Desactivar escape HTML para que los literales < y > generen tipos genéricos válidos de TS.
mustache_1.default.escape = function (text) { return text; };
mustache_1.default.escape = function (text) {
return text;
};
// Colores para console (sin dependencias externas)
const colors = {
reset: '\x1b[0m',
@@ -58,7 +60,7 @@ function checkOpenApiGenerator() {
(0, child_process_1.execSync)('openapi-generator-cli version', { stdio: 'ignore' });
return true;
}
catch (error) {
catch (_error) {
return false;
}
}
@@ -69,7 +71,7 @@ function installOpenApiGenerator() {
(0, child_process_1.execSync)('npm install -g @openapitools/openapi-generator-cli', { stdio: 'inherit' });
logSuccess('OpenAPI Generator CLI instalado correctamente');
}
catch (error) {
catch (_error) {
logError('Error al instalar OpenAPI Generator CLI');
process.exit(1);
}
@@ -86,7 +88,7 @@ function createDirectoryStructure(baseDir) {
path_1.default.join(baseDir, 'di/use-cases'),
path_1.default.join(baseDir, 'entities/models')
];
dirs.forEach(dir => {
dirs.forEach((dir) => {
fs_extra_1.default.ensureDirSync(dir);
});
logSuccess('Estructura de directorios creada');
@@ -97,17 +99,19 @@ function analyzeSwagger(swaggerFile) {
try {
const fileContent = fs_extra_1.default.readFileSync(swaggerFile, 'utf8');
const swagger = js_yaml_1.default.load(fileContent);
const tags = swagger.tags || [];
const tags = Array.isArray(swagger.tags) ? swagger.tags : [];
const paths = swagger.paths || {};
logInfo(`Encontrados ${tags.length} tags en el API`);
logInfo(`Encontrados ${Object.keys(paths).length} endpoints`);
tags.forEach((tag) => {
logInfo(` - ${tag.name}: ${tag.description || 'Sin descripción'}`);
const t = tag;
logInfo(` - ${t.name}: ${t.description || 'Sin descripción'}`);
});
return { tags, paths, swagger };
}
catch (error) {
logError(`Error al leer el archivo Swagger: ${error.message}`);
const err = error;
logError(`Error al leer el archivo Swagger: ${err.message}`);
process.exit(1);
}
}
@@ -131,7 +135,7 @@ function generateCode(swaggerFile, templatesDir) {
logSuccess('Código generado correctamente');
return tempDir;
}
catch (error) {
catch (_error) {
logError('Error al generar código');
if (fs_extra_1.default.existsSync(tempDir)) {
fs_extra_1.default.removeSync(tempDir);
@@ -147,8 +151,8 @@ function organizeFiles(tempDir, outputDir) {
let filesMoved = 0;
if (fs_extra_1.default.existsSync(sourceDir)) {
fs_extra_1.default.ensureDirSync(destDir);
const files = fs_extra_1.default.readdirSync(sourceDir).filter(file => file.endsWith('.dto.ts'));
files.forEach(file => {
const files = fs_extra_1.default.readdirSync(sourceDir).filter((file) => file.endsWith('.dto.ts'));
files.forEach((file) => {
const sourcePath = path_1.default.join(sourceDir, file);
const destPath = path_1.default.join(destDir, file);
fs_extra_1.default.copySync(sourcePath, destPath);
@@ -160,33 +164,43 @@ function organizeFiles(tempDir, outputDir) {
}
// Utilidad para mapear tipos OpenAPI elementales a TypeScript
function mapSwaggerTypeToTs(type) {
if (!type)
return 'unknown';
const typeMap = {
'integer': 'number',
'string': 'string',
'boolean': 'boolean',
'number': 'number',
'array': 'Array<any>',
'object': 'any'
integer: 'number',
string: 'string',
boolean: 'boolean',
number: 'number',
array: 'Array<unknown>',
object: 'unknown'
};
return typeMap[type] || 'any';
return typeMap[type] || 'unknown';
}
// Generar Clean Architecture con Mustache
function generateCleanArchitecture(analysis, outputDir, templatesDir) {
logStep('Generando artefactos de Clean Architecture usando Mustache...');
let generatedCount = { models: 0, repositories: 0, mappers: 0, useCases: 0, providers: 0 };
const schemas = analysis.swagger.components?.schemas || {};
const generatedCount = {
models: 0,
repositories: 0,
mappers: 0,
useCases: 0,
providers: 0
};
const schemas = analysis.swagger.components
?.schemas || {};
// 1. Generar Modelos, Entidades y Mappers a partir de Schemas
Object.keys(schemas).forEach(schemaName => {
Object.keys(schemas).forEach((schemaName) => {
// Sanitizar nombres base para que coincidan con cómo OpenAPI los emite (sin Dto duplicado)
const baseName = schemaName.replace(/Dto$/, '');
// variables para model
const rawProperties = schemas[schemaName].properties || {};
const requiredProps = schemas[schemaName].required || [];
const varsMap = Object.keys(rawProperties).map(k => {
const schemaObj = schemas[schemaName];
const rawProperties = schemaObj.properties || {};
const requiredProps = schemaObj.required || [];
const varsMap = Object.keys(rawProperties).map((k) => {
let tsType = mapSwaggerTypeToTs(rawProperties[k].type);
if (rawProperties[k].$ref) {
// Simple extración del tipo de la ref
tsType = rawProperties[k].$ref.split('/').pop() || 'any';
tsType = rawProperties[k].$ref.split('/').pop() || 'unknown';
}
else if (rawProperties[k].type === 'array' && rawProperties[k].items?.$ref) {
tsType = `Array<${rawProperties[k].items.$ref.split('/').pop()}>`;
@@ -199,15 +213,17 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
};
});
const modelViewData = {
models: [{
models: [
{
model: {
classname: baseName,
classFilename: baseName.toLowerCase(),
classVarName: baseName.charAt(0).toLowerCase() + baseName.slice(1),
description: schemas[schemaName].description || '',
description: schemaObj.description || '',
vars: varsMap
}
}],
}
],
// Para plantillas que esperan allModels o importaciones (mapper)
allModels: [{ model: { vars: varsMap } }]
};
@@ -215,13 +231,15 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
const mapperViewData = {
...modelViewData,
apiInfo: {
apis: [{
apis: [
{
operations: {
classname: baseName,
classFilename: baseName.toLowerCase(),
classVarName: baseName.charAt(0).toLowerCase() + baseName.slice(1),
classVarName: baseName.charAt(0).toLowerCase() + baseName.slice(1)
}
}]
}
]
}
};
// Model (Entities)
@@ -247,9 +265,9 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
// 2. Generar Casos de Uso y Repositorios a partir de Paths/Tags
const tagsMap = {};
// Agrupar operaciones por Tag
Object.keys(analysis.paths).forEach(pathKey => {
Object.keys(analysis.paths).forEach((pathKey) => {
const pathObj = analysis.paths[pathKey];
Object.keys(pathObj).forEach(method => {
Object.keys(pathObj).forEach((method) => {
const op = pathObj[method];
if (op.tags && op.tags.length > 0) {
const tag = op.tags[0]; // Usamos el primer tag
@@ -258,17 +276,17 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
// Parsear parámetros
const allParams = (op.parameters || []).map((p) => ({
paramName: p.name,
dataType: mapSwaggerTypeToTs(p.schema?.type),
dataType: mapSwaggerTypeToTs(p.schema?.type || ''),
description: p.description || '',
required: p.required
}));
// Añadir body como parámetro si existe
if (op.requestBody) {
let bodyType = 'any';
let bodyType = 'unknown';
const content = op.requestBody.content?.['application/json']?.schema;
if (content) {
if (content.$ref)
bodyType = content.$ref.split('/').pop() || 'any';
bodyType = content.$ref.split('/').pop() || 'unknown';
else if (content.type)
bodyType = mapSwaggerTypeToTs(content.type);
}
@@ -286,11 +304,11 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
const responseSchema = op.responses?.['200']?.content?.['application/json']?.schema;
if (responseSchema) {
if (responseSchema.$ref) {
returnType = responseSchema.$ref.split('/').pop() || 'any';
returnType = responseSchema.$ref.split('/').pop() || 'unknown';
returnBaseType = returnType;
}
else if (responseSchema.type === 'array' && responseSchema.items?.$ref) {
returnBaseType = responseSchema.items.$ref.split('/').pop() || 'any';
returnBaseType = responseSchema.items.$ref.split('/').pop() || 'unknown';
returnType = `Array<${returnBaseType}>`;
isListContainer = true;
}
@@ -303,7 +321,12 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
path: pathKey,
allParams: allParams.map((p, i) => ({ ...p, '-last': i === allParams.length - 1 })),
hasQueryParams: (op.parameters || []).some((p) => p.in === 'query'),
queryParams: (op.parameters || []).filter((p) => p.in === 'query').map((p, i, arr) => ({ paramName: p.name, '-last': i === arr.length - 1 })),
queryParams: (op.parameters || [])
.filter((p) => p.in === 'query')
.map((p, i, arr) => ({
paramName: p.name,
'-last': i === arr.length - 1
})),
hasBodyParam: !!op.requestBody,
bodyParam: 'body',
returnType: returnType !== 'void' ? returnType : false,
@@ -315,18 +338,23 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
});
});
// Generar por cada Tag
Object.keys(tagsMap).forEach(tag => {
Object.keys(tagsMap).forEach((tag) => {
// Buscar si ese tag cruza con alguna entidad para importarla
const imports = [];
Object.keys(schemas).forEach(s => {
Object.keys(schemas).forEach((s) => {
// Import heurístico burdo
if (tagsMap[tag].some((op) => op.returnType === s || op.returnType === `Array<${s}>`)) {
imports.push({ classname: s, classFilename: s.toLowerCase(), classVarName: s.charAt(0).toLowerCase() + s.slice(1) });
imports.push({
classname: s,
classFilename: s.toLowerCase(),
classVarName: s.charAt(0).toLowerCase() + s.slice(1)
});
}
});
const apiViewData = {
apiInfo: {
apis: [{
apis: [
{
operations: {
classname: tag,
classFilename: tag.toLowerCase(),
@@ -334,7 +362,8 @@ function generateCleanArchitecture(analysis, outputDir, templatesDir) {
operation: tagsMap[tag],
imports: imports
}
}]
}
]
}
};
// Use Case Contract
@@ -415,7 +444,8 @@ function generateReport(outputDir, analysis) {
repositories: fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'data/repositories')).length,
mappers: fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'data/mappers')).length,
useCases: fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'domain/use-cases')).length,
providers: fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'di/repositories')).length + fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'di/use-cases')).length
providers: fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'di/repositories')).length +
fs_extra_1.default.readdirSync(path_1.default.join(outputDir, 'di/use-cases')).length
}
};
const reportPath = path_1.default.join(process.cwd(), 'generation-report.json');
@@ -486,7 +516,8 @@ async function main() {
}
// Ejecutar
main().catch((error) => {
logError(`Error fatal: ${error.message}`);
const err = error;
logError(`Error fatal: ${err.message}`);
console.error(error);
process.exit(1);
});