Script bash que consolida arquivos de especificação distribuídos em múltiplas pastas de features em arquivos únicos por tipo.
projeto/
├── documentor.sh
└── specs/
├── feature-a/
│ ├── research.md
│ ├── spec.md
│ ├── data-model.md
│ └── contracts/
│ ├── create-user.md
│ └── update-user.md
├── feature-b/
│ ├── research.md
│ ├── spec.md
│ └── contracts/
│ └── list-items.md
└── feature-c/
└── spec.md
O script consolida os arquivos na raiz do projeto:
| Arquivo de saída | Origem |
|---|---|
research-final.md |
specs/*/research.md |
specs-final.md |
specs/*/spec.md |
data-models-final.md |
specs/*/data-model.md |
contracts-final.md |
specs/*/contracts/**/* |
Cada seção é precedida por um cabeçalho ## Feature: <nome-da-pasta> para identificar a origem do conteúdo.
# Tornar o script executável (primeira vez)
chmod +x documentor.sh
# Executar
./documentor.shdocumentor — merging spec files
================================
[done] research-final.md — 3 file(s) merged
[done] specs-final.md — 3 file(s) merged
[skip] no files found for data-models-final.md
[done] contracts-final.md — 4 file(s) merged
Output files written to: /caminho/do/projeto
- bash 4+
- macOS ou Linux