Introducción a Glastor ReadmeGen
Glastor ReadmeGen (@glastor-dev/readmegen) es una herramienta de ingeniería de software desarrollada en Deno y TypeScript diseñada para automatizar el análisis estático de repositorios y la generación de archivos README.md profesionales y listos para producción.
🎯 El Problema
Mantener la documentación y los archivos README.md actualizados en proyectos de código abierto o comerciales suele ser una tarea manual propensa a errores y desactualizaciones:
- Badges de CI/CD rotos o apuntando a ramas erróneas.
- Dependencias obsoletas que no coinciden con
deno.jsonoimport_map.json. - Ejemplos de código desfasados respecto a la API real.
- Tablas de contenido (TOC) desincronizadas con los encabezados.
💡 La Solución: Glastor ReadmeGen
ReadmeGen resuelve este problema mediante introspección estática automatizada:
- Inspección de configuración: Analiza
deno.json,deno.lockeimport_map.jsonpara extraer versiones, scripts y dependencias. - Análisis de código fuente (AST): Utiliza parsers de TypeScript para extraer interfaces, funciones públicas, tipos y documentación JSDoc.
- Detección de CI/CD y Calidad: Examina workflows de GitHub Actions (
.github/workflows/), linters y tests configurados. - Motor de renderizado flexible: Inyecta la información en plantillas modulares (
minimal,modern,detailed) o preserva plantillas de perfil personalizadas (README.profile.md).
🚀 Principales Características
| Característica | Descripción |
|---|---|
| Detección Automática | Extrae metadatos directamente del código sin configuración obligatoria. |
| Parser AST de TypeScript | Genera tablas de API con firmas de métodos, parámetros y tipos de retorno. |
| Badges Dinámicos | Insignias de versión de Deno, estado de GitHub Actions, licencias y sponsors. |
| Generador de TOC | Crea tablas de contenido navegables de forma automática. |
| Asistente CLI Interactivo | Comando init guiado para crear archivos de configuración .readmegen.json. |
| Soporte de GitHub Actions | Diseñado para ejecutarse en pipelines de CI/CD para mantener el README siempre al día. |
📚 Estructura de esta Documentación
En las siguientes secciones encontrarás el detalle completo de cómo se construyó la herramienta y cómo utilizarla:
- Cómo se realizó: Visión general del proceso de desarrollo y diseño.
- Arquitectura del Sistema: Diagramas y desglose de capas y módulos.
- Análisis de Proyectos y AST: Cómo funciona la extracción de datos y el parseo de código.
- Motor de Plantillas: El sistema de inyección y limpieza de Markdown.
- Guía de Instalación: Requisitos y pasos para instalar el CLI.
- Uso del CLI: Comandos, argumentos y modos de uso.
- Configuración: Opciones avanzadas de
.readmegen.json. - Referencia de la API: Uso programático mediante
generateReadmeyanalyzeProject.