Flurix Developer

Flurix Developer es un paquete que genera documentación automáticamente a partir de comentarios JSDoc en archivos JavaScript, TypeScript, JSX y TSX. Este paquete utiliza un script en Python para extraer docstrings y generar archivos Markdown con la documentación del proyecto.

Requisitos

• Node.js y NPM instalados.
• Python 3.x instalado en el sistema (requerido para ejecutar el script de documentación).
• pip (gestor de paquetes de Python) para instalar las dependencias.

Instalación

Primero, instala el paquete flurix-developer en tu proyecto:

npm install flurix-developer

Uso

Una vez instalado, puedes generar la documentación usando el comando flurix-developer directamente. Este comando buscará archivos .js, .jsx, .ts, y .tsx en el directorio especificado y generará un archivo Markdown (.md) con la documentación extraída.

Ejemplo de Ejecución Manual

Para ejecutar el comando manualmente y generar documentación en el directorio docs:

npx flurix-developer <directorio-codigo> --output docs

• <directorio-codigo>: Ruta de la carpeta que contiene los archivos de código (por ejemplo, src).
• --output: Directorio de salida para la documentación generada. Si no se especifica, la documentación se generará en una carpeta llamada docusaurus por defecto.

Ejemplo:

npx flurix-developer src --output docs

Uso Automático con el Script build

Si deseas que la documentación se genere automáticamente cada vez que construyes tu proyecto, puedes agregar flurix-developer al script build de tu archivo package.json:

"scripts": {
  "build": "flurix-developer src --output docs && nest build"
}

Este ajuste asegura que cada vez que ejecutes npm run build, también se generará la documentación en el directorio docs.

Configuración del Script de Python

El paquete incluye un script en Python que extrae comentarios JSDoc y genera archivos Markdown. Si deseas instalar dependencias adicionales para el script, puedes hacerlo con pip:

pip install -r node_modules/flurix-developer/requirements.txt

Notas

• Ruta de Salida: Puedes personalizar la ruta de salida con el argumento --output.
• Archivos Soportados: Este script busca automáticamente archivos .js, .jsx, .ts, y .tsx.
• Formato Markdown: La documentación se generará en formato Markdown (.md) para su fácil visualización.

Autor

Elías Manríquez Muñoz

Licencia

Este proyecto está licenciado bajo la licencia MIT.