📂 tree-generate

tree-generate é uma ferramenta CLI que gera uma árvore de diretórios em estilo "tree", mostrando apenas pastas. Permite adicionar comentários em cada pasta usando arquivos aboutme.txt e respeita regras de .gitignore.

🚀 Instalação

Você pode instalar globalmente via npm:

npm install -g tree-generate

Ou rodar diretamente com npx:

npx tree-generate [diretório]

📌 Uso

tree-generate [diretório] [flags]

• [diretório] → caminho da pasta que será mapeada (padrão: .).
• [flags] → opções adicionais (veja abaixo).

📌 Flags

| Flag | Descrição | | --------- | ----------------------------------------------------------------- | | --help | Mostra esta ajuda. | | --force | Não ignora nada: inclui .git e pastas listadas no .gitignore. |

📌 Funcionalidades

• Gera árvore de pastas apenas, ignorando arquivos comuns.
• Ignora por padrão a pasta .git e todas as pastas listadas no .gitignore.
• Se uma pasta contiver um arquivo aboutme.txt, o conteúdo será mostrado como comentário na árvore.
• Você pode colocar um aboutme.txt na raiz da pasta, para gerar um comentário sobre a própria pasta raiz.

📌 Exemplos

tree-generate .
tree-generate ./src
tree-generate . --force

Exemplo de saída:

├── app/          # Páginas principais
├── pages/        # Rotas
└── utils/        # Funções utilitárias

Se existir um aboutme.txt dentro de pages/ com o conteúdo "Rotas de API", a saída será:

├── pages/        # Rotas de API

⚙️ Regras

• O script mostra somente pastas.
• Por padrão, ignora .git e itens listados no .gitignore.
• Arquivos aboutme.txt dentro das pastas serão comentários na árvore.

📝 Nota

Este projeto é ideal para:

• Documentar rapidamente a estrutura de projetos.
• Gerar seções de README ou documentação de forma automática.
• Integrar comentários descritivos por pasta usando aboutme.txt.