Cómo generar un árbol de carpetas en formato README.md con tree-extended
Publicado en Desarrollo Web, NodeJs por pirulug.
En muchos proyectos es útil documentar la estructura de carpetas y archivos dentro del archivo README.md. Esto ayuda a otros desarrolladores a comprender mejor la organización del código.
Una forma práctica de hacerlo es utilizando la librería tree-extended, que permite generar automáticamente un árbol de directorios en formato Markdown.
Requisitos previos
- Tener instalado Node.js ≥ 6.x
- Acceso a la terminal o línea de comandos
Instalación de tree-extended
Para instalar la librería de forma global en tu sistema, ejecuta:
npm install -g tree-extended
Más información en su repositorio oficial: tree-extended en GitHub
Generar el árbol de carpetas
Ubícate en la carpeta raíz de tu proyecto y ejecuta:
tree-extended
Esto generará automáticamente la estructura de carpetas y archivos en formato Markdown, lista para agregar a tu README.md.
Omitir carpetas específicas
Si deseas ignorar ciertas carpetas (por ejemplo, node_modules o .git), puedes hacerlo con la opción -ignore:
tree-extended -ignore="node_modules"
También puedes excluir varias carpetas al mismo tiempo:
tree-extended -ignore="node_modules, .git, dist" -charset=utf8-icons
Conclusión
La librería tree-extended es una herramienta muy útil para documentar la estructura de proyectos en archivos README.md. Con un solo comando puedes generar una vista clara de las carpetas y archivos, además de personalizarla excluyendo directorios que no sean relevantes.
No hay comentarios aun. ¡Se el primero en comentar!