skelfolder

Lee la estructura de carpetas de tu proyecto y la muestra como un árbol ASCII en consola, la guarda en un archivo Markdown o genera carpetas/archivos desde un esquema en Markdown.

Instalación

Instala globalmente:

npm install -g skelfolder

O como dependencia de desarrollo:

npm install --save-dev skelfolder

Uso rápido

skelfolder read
skelfolder save
skelfolder generate estructura.md ./nuevo-proyecto

Comandos disponibles

• skelfolder read [directorio]
  Muestra en consola el árbol ASCII. Por defecto usa el directorio actual.

• skelfolder save [directorio]
  Genera STRUCTURE.md con el árbol en Markdown. Por defecto usa el directorio actual.

• skelfolder generate <archivo.md> [destino]
  Crea en [destino] (por defecto cwd) la estructura de carpetas y archivos definida en el bloque plaintext de <archivo.md>.

• skelfolder af <carpeta>
  Añade <carpeta> a la lista de carpetas ignoradas.

• skelfolder rf <carpeta>
  Elimina <carpeta> de la lista de carpetas ignoradas.

• skelfolder vf
  Muestra la lista de carpetas actualmente ignoradas.

• skelfolder ae <.ext>
  Añade la extensión <.ext> a la lista de archivos ignorados.

• skelfolder re <.ext>
  Elimina la extensión <.ext> de la lista de archivos ignorados.

• skelfolder ve
  Muestra la lista de extensiones de archivos actualmente ignoradas.

• skelfolder aa <archivo>
  Añade el nombre exacto de <archivo> a la lista de archivos ignorados.

• skelfolder ra <archivo>
  Elimina el nombre exacto de <archivo> de la lista de archivos ignorados.

• skelfolder va
  Muestra la lista de archivos específicos actualmente ignorados.

• skelfolder --help
  Muestra ayuda completa con todas las opciones y comandos disponibles.

Sintaxis de los comandos

Los comandos se forman con dos letras:

• Primera letra (acción):
  • a: add
  • r: remove
  • v: view
• Segunda letra (objetivo):
  • f: folder
  • e: extension
  • a: archive

| Comando | Acción | Objetivo | Descripción | Ejemplo | |---------|---------|------------|---------------------------------------------|----------------------------------------------| | af | add | folder | Añade una carpeta a la lista de ignoradas | skelfolder af build | | rf | remove | folder | Elimina una carpeta de la lista de ignoradas| skelfolder rf node_modules | | vf | view | folder(s) | Muestra las carpetas ignoradas | skelfolder vf | | ae | add | extension | Añade una extensión a la lista de ignores | skelfolder ae .log | | re | remove | extension | Elimina una extensión de la lista de ignores| skelfolder re .tmp | | ve | view | extension(s)| Muestra las extensiones ignoradas | skelfolder ve | | aa | add | archive | Añade un archivo específico a ignorar | skelfolder aa package-lock.json | | ra | remove | archive | Elimina un archivo específico de ignores | skelfolder ra package-lock.json | | va | view | archivo(s) | Muestra los archivos específicos ignorados | skelfolder va |

Configuración

Al ejecutar af, rf, ae, re, aa o ra, se crea o actualiza skelfolder.config.json en tu carpeta raíz con tres secciones:

{
  "ignoreFolders": [
    ".git",
    "node_modules",
    "build"
  ],
  "ignoreExtensions": [
    ".log",
    ".tmp"
  ],
  "ignoreFiles": [
    "package-lock.json",
    "yarn.lock"
  ]
}

• ignoreFolders: nombres de carpetas a omitir al leer o guardar.
• ignoreExtensions: extensiones de archivo a omitir (incluye el punto).
• ignoreFiles: nombres exactos de archivos a omitir.

Ejemplos de uso

# Mostrar árbol excluyendo .git y node_modules
skelfolder read

# Ignorar carpeta `build` y ver la lista de ignores
skelfolder af build
skelfolder vf

# Ignorar extensiones .log y verlas
skelfolder ae .log
skelfolder ve

# Ignorar un archivo específico y comprobarlo
skelfolder aa package-lock.json
skelfolder va

# Guardar estructura en Markdown
skelfolder save

# Generar un proyecto desde 'plantilla.md'
skelfolder generate plantilla.md ./nuevo-proyecto

Generar estructura desde Markdown

El comando generate espera un archivo Markdown con un bloque de código tipo plaintext que describe la estructura.
Ejemplo de bloque válido en estructura.md:

mi-proyecto
├── src
│   ├── index.js
│   └── utils.js
├── README.md
└── package.json

Troubleshooting

• Si ves errores de permisos, ejecuta el comando con permisos adecuados o revisa la ruta.
• Si el árbol no muestra lo esperado, revisa tu skelfolder.config.json.
• Si tienes problemas con rutas relativas, usa rutas absolutas.

Publicación

por si lo olvido :(

1. Iniciar sesión y verificar el usuario en npm:

   npm login
   npm whoami

2. Incrementar la versión según SemVer:

   npm version patch   # → 1.0.2
   npm version minor   # → 1.1.0
   npm version major   # → 2.0.0

3. Publicar en el registro público:

   npm publish --access public

4. Verificar la nueva versión instalada globalmente:

   npm install -g skelfolder
   skelfolder --version

Licencia

MIT © CoipoNorte