forjajs 1.3.2 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +5 -0
- package/CHANGELOG.md +74 -0
- package/README.en.md +1 -0
- package/README.md +11 -4
- package/boilerplates/06-clean-arch/WHEN-CLEAN-WHEN-LEAN.md +37 -8
- package/dist/lib/agent-topology.d.ts +38 -0
- package/dist/lib/agent-topology.js +65 -0
- package/dist/lib/code-context.d.ts +41 -0
- package/dist/lib/code-context.js +108 -0
- package/dist/lib/core/doc-graph.d.ts +13 -0
- package/dist/lib/core/doc-graph.js +47 -0
- package/dist/lib/core/gates.d.ts +36 -0
- package/dist/lib/core/gates.js +35 -0
- package/dist/lib/core/health.js +64 -1
- package/dist/lib/core/project-smoke.d.ts +46 -0
- package/dist/lib/core/project-smoke.js +248 -0
- package/dist/lib/core/registry.d.ts +30 -0
- package/dist/lib/core/registry.js +30 -0
- package/dist/lib/core/release.d.ts +30 -0
- package/dist/lib/generators/memory-generator.d.ts +1 -0
- package/dist/lib/generators/memory-generator.js +44 -0
- package/dist/lib/generators/readme-generator.js +1 -0
- package/dist/lib/memory-audit.d.ts +31 -0
- package/dist/lib/memory-audit.js +81 -0
- package/dist/lib/project-upgrade.d.ts +28 -0
- package/dist/lib/project-upgrade.js +74 -0
- package/dist/scripts/agent-router.js +1 -1
- package/dist/scripts/code-context.d.ts +12 -0
- package/dist/scripts/code-context.js +73 -0
- package/dist/scripts/gates.d.ts +10 -0
- package/dist/scripts/gates.js +44 -0
- package/dist/scripts/memory-audit.d.ts +11 -0
- package/dist/scripts/memory-audit.js +49 -0
- package/dist/scripts/project-smoke.d.ts +14 -0
- package/dist/scripts/project-smoke.js +44 -0
- package/dist/scripts/project-upgrade.d.ts +11 -0
- package/dist/scripts/project-upgrade.js +61 -0
- package/dist/scripts/token-economy.d.ts +20 -0
- package/dist/scripts/token-economy.js +140 -0
- package/memory/90-decisions/0025-coerencia-da-documentacao.md +10 -0
- package/memory/90-decisions/0026-migracao-typescript-runtime-duplo.md +66 -0
- package/memory/90-decisions/0027-clean-arch-calibrada.md +34 -3
- package/memory/90-decisions/0029-gate-do-projeto-gerado.md +59 -0
- package/memory/90-decisions/0030-projeto-gerado-herda-os-gates.md +53 -0
- package/package.json +1 -1
- package/specs/code-context/spec.md +56 -0
- package/specs/gates/spec.md +63 -0
- package/specs/memory-audit/spec.md +54 -0
- package/specs/orchestration-coherent/spec.md +95 -0
- package/specs/project-smoke/spec.md +96 -0
- package/specs/project-upgrade/spec.md +58 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Spec: orchestration-coherent
|
|
2
|
+
|
|
3
|
+
- **ID**: SPEC-019
|
|
4
|
+
- **Status**: done
|
|
5
|
+
- **Owner**: apk
|
|
6
|
+
- **ADRs relacionadas**: ADR-0021 (invariante > disciplina), ADR-0025 (coerência da doc — a mesma classe), ADR-0005 (handoff 7 campos), ADR-0020 (core/registry)
|
|
7
|
+
|
|
8
|
+
## 1. Problema
|
|
9
|
+
|
|
10
|
+
O nome do repositório é **orquestração multiagente** — e é a parte **menos harnessed** do framework.
|
|
11
|
+
A topologia de quem-orquestra-quem é descrita em **três lugares independentes**, e nada garante que
|
|
12
|
+
concordem:
|
|
13
|
+
|
|
14
|
+
1. `AGENTS.md` — a prosa: os papéis e a topologia.
|
|
15
|
+
2. `scripts/agent-router.ts` (`VALID_AGENTS`) — o código: para quem um handoff pode ser roteado.
|
|
16
|
+
3. `.claude/agents/*.md` — os sub-agents executáveis: quem, de fato, faz o trabalho.
|
|
17
|
+
|
|
18
|
+
Três descrições da mesma coisa divergem em silêncio. **E já divergem hoje** (medido antes de escrever
|
|
19
|
+
esta spec — a mesma prova que o `adr-refs` deu):
|
|
20
|
+
|
|
21
|
+
- **`worker`** está no `VALID_AGENTS` e no `AGENTS.md`, mas **não tem** `.claude/agent`. Um papel que
|
|
22
|
+
recebe handoff sem definição executável — prosa que o código não implementa.
|
|
23
|
+
- **`release-auditor`** é um sub-agent executável, mas **não está** no `VALID_AGENTS`. Um agente para
|
|
24
|
+
o qual o router não consegue rotear — implementação que a orquestração não alcança.
|
|
25
|
+
- **`architect`** (AGENTS.md) vs **`sdd-architect`** (router/agents) — o mesmo papel com dois nomes.
|
|
26
|
+
|
|
27
|
+
Pelo critério do ADR-0021, isto não é orquestração: é sugestão. A topologia vive por disciplina, e
|
|
28
|
+
está silenciosamente incoerente **agora**. Não é conhecimento que falta — é execução.
|
|
29
|
+
|
|
30
|
+
## 2. Proposta de valor
|
|
31
|
+
|
|
32
|
+
A topologia de agentes deixa de poder divergir em silêncio: **as três fontes de verdade
|
|
33
|
+
(AGENTS.md ↔ router ↔ .claude/agents) são conferidas por um gate**. Um papel sem agente executável,
|
|
34
|
+
um agente sem rota, um nome divergente — tudo reprova. A orquestração descrita passa a ser a
|
|
35
|
+
orquestração implementada.
|
|
36
|
+
|
|
37
|
+
## 3. User stories
|
|
38
|
+
|
|
39
|
+
- **Como** mantenedor, **quero** que um papel citado na topologia sem sub-agent executável **reprove**,
|
|
40
|
+
**para que** a orquestração não prometa um agente que não existe.
|
|
41
|
+
- **Como** mantenedor, **quero** que um sub-agent para o qual o router não roteia seja apontado,
|
|
42
|
+
**para que** eu não tenha implementação órfã que a orquestração nunca aciona.
|
|
43
|
+
- **Como** governança, **quero** rodar isso no `tools:doctor`, **para que** a coerência da topologia
|
|
44
|
+
seja um artefato verificável, não uma afirmação no README.
|
|
45
|
+
|
|
46
|
+
## 4. Critérios de aceite (Definition of Done)
|
|
47
|
+
|
|
48
|
+
- [ ] AC-1: Um check `agent-topology` (no catálogo do `tools:doctor`, via runner de `checks.ts`)
|
|
49
|
+
cruza as três fontes e **reprova** (ou avisa) quando divergem:
|
|
50
|
+
- papel roteável (`VALID_AGENTS`, menos `user`) **sem** `.claude/agents/<papel>.md` → o router
|
|
51
|
+
promete um destino que não tem executor;
|
|
52
|
+
- `.claude/agents/<x>.md` que **não** está em `VALID_AGENTS` → agente executável que ninguém roteia;
|
|
53
|
+
- papel citado no `AGENTS.md` que não bate com nenhuma das outras fontes → prosa órfã.
|
|
54
|
+
- [ ] AC-2: `user` é reconhecido como destino válido de handoff **sem** exigir um agent (é o humano —
|
|
55
|
+
não tem `.claude/agent`, e tudo bem).
|
|
56
|
+
- [ ] AC-3: O check roda no `tools:doctor` e reporta as divergências reais que já existem hoje
|
|
57
|
+
(`worker`, `release-auditor`, `architect`/`sdd-architect`) — a prova de que a fronteira estava
|
|
58
|
+
descoberta.
|
|
59
|
+
- [ ] AC-4: Fechada a incoerência: cada divergência resolvida (criar o agent, ajustar o router, ou
|
|
60
|
+
alinhar o nome) até o check ficar verde — decidido caso a caso, não no atacado.
|
|
61
|
+
- [ ] AC-5: Lógica pura e testável (extrai a topologia de fontes injetáveis; testes com fixtures).
|
|
62
|
+
|
|
63
|
+
## 5. Escopo
|
|
64
|
+
|
|
65
|
+
**Dentro**: conferir a **coerência estrutural** da topologia — os nomes de papéis/agentes batem entre
|
|
66
|
+
as três fontes.
|
|
67
|
+
|
|
68
|
+
**Fora** (explícito — a fronteira honesta):
|
|
69
|
+
- **Rodar os agentes de IA autonomamente.** O framework não executa um loop de IA; quem aciona os
|
|
70
|
+
sub-agents é o Claude Code, no uso. Este gate prova que a topologia é *coerente e acionável*, não
|
|
71
|
+
que a IA fez um bom trabalho. "Provar que a orquestração produz bom output" não é harness — é
|
|
72
|
+
julgamento, e fica fora.
|
|
73
|
+
- Validar o *conteúdo* de cada `.claude/agent` (o prompt está bom?) — é qualidade, não topologia.
|
|
74
|
+
- Um motor de execução de handoffs em cadeia (state machine que dirige o fluxo) — pode ser SPEC
|
|
75
|
+
futura; esta fecha a **coerência**, o pré-requisito de qualquer execução.
|
|
76
|
+
|
|
77
|
+
## 6. NFRs / restrições
|
|
78
|
+
|
|
79
|
+
- **Compatibilidade**: só lê as três fontes; não muda o comportamento do router nem dos agents.
|
|
80
|
+
- **Severidade honesta**: divergência que quebra a orquestração (papel roteável sem executor) =
|
|
81
|
+
provável `critical`/`warn` a decidir no plan; nome divergente = `warn`. A calibração fica para o
|
|
82
|
+
plan, à luz do que as divergências reais pedem.
|
|
83
|
+
|
|
84
|
+
## 7. Riscos e mitigação
|
|
85
|
+
|
|
86
|
+
| Risco | Prob. | Impacto | Mitigação |
|
|
87
|
+
|---|---|---|---|
|
|
88
|
+
| O check vira ruído (muitos avisos aceitáveis) | M | M | severidade calibrada no plan; `user` e casos legítimos isentos (AC-2) |
|
|
89
|
+
| Alinhar os nomes quebra referências em prosa | B | M | AC-4 resolve caso a caso, com o gate confirmando cada passo |
|
|
90
|
+
|
|
91
|
+
## 8. Métricas de sucesso
|
|
92
|
+
|
|
93
|
+
As três divergências de hoje (`worker`, `release-auditor`, `architect`/`sdd-architect`) resolvidas, o
|
|
94
|
+
`agent-topology` verde no `tools:doctor`, e uma futura divergência (um agent novo sem rota, um papel
|
|
95
|
+
renomeado) pega pelo gate antes do merge. A orquestração descrita = a orquestração implementada.
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Spec: project-smoke
|
|
2
|
+
|
|
3
|
+
- **ID**: SPEC-015
|
|
4
|
+
- **Status**: done
|
|
5
|
+
- **Owner**: apk
|
|
6
|
+
- **Criado em**: 2026-07-19
|
|
7
|
+
- **ADRs relacionadas**: [ADR-0024](../../memory/90-decisions/0024-release-gate.md) (gate do tarball — o padrão), [ADR-0023](../../memory/90-decisions/0023-doctor-como-gate-do-nucleo.md) (doctor), [ADR-0020](../../memory/90-decisions/0020-forja-core-cli-unica.md) (core/registry)
|
|
8
|
+
|
|
9
|
+
## 1. Problema
|
|
10
|
+
|
|
11
|
+
O `release:check` guarda uma fronteira: **o repositório mente sobre o pacote**. Existe a *mesma
|
|
12
|
+
classe de bug um nível acima*, e ela está **descoberta**: nada prova que `forja project:new` gera um
|
|
13
|
+
projeto que de fato **é coerente e roda**.
|
|
14
|
+
|
|
15
|
+
O gerador escreve arquivos a partir de templates (`{{FEATURE}}`, `{{ID}}`, blocos de `scripts`, configs
|
|
16
|
+
multi-IA). Cada um desses é uma oportunidade de mentira silenciosa:
|
|
17
|
+
|
|
18
|
+
- um placeholder `{{...}}` que vaza para o output porque o gerador esqueceu de substituir;
|
|
19
|
+
- um `package.json` gerado que não é JSON válido, ou sem os scripts que os docs prometem;
|
|
20
|
+
- a estrutura de memória incompleta (falta um diretório crítico que o resto assume);
|
|
21
|
+
- no limite: o projeto gerado simplesmente **não buildar**.
|
|
22
|
+
|
|
23
|
+
Hoje só descobrimos isso quando um usuário gera um projeto e ele quebra — exatamente o modo de falha
|
|
24
|
+
que o `release:check` existe para eliminar, só que na saída do gerador em vez do tarball. **Não é
|
|
25
|
+
conhecimento que falta** (o `structure-validator` já sabe validar estrutura). **É execução**: nada
|
|
26
|
+
roda o gerador de ponta a ponta e reprova.
|
|
27
|
+
|
|
28
|
+
## 2. Proposta de valor
|
|
29
|
+
|
|
30
|
+
Gerar um projeto deixa de ser um ato de fé: **nenhuma mudança no gerador passa sem prova de que o
|
|
31
|
+
projeto gerado é coerente**, e a prova é gerada pelo harness — não pela lembrança de quem tocou no
|
|
32
|
+
template.
|
|
33
|
+
|
|
34
|
+
## 3. User stories
|
|
35
|
+
|
|
36
|
+
- **Como** quem mantém o gerador, **quero** que uma mudança que quebra o output **reprove no CI**,
|
|
37
|
+
**para que** eu não descubra pela issue de um usuário.
|
|
38
|
+
- **Como** usuário do `forjajs`, **quero** que `forja project:new` me entregue um projeto sem
|
|
39
|
+
placeholders vazados nem `package.json` quebrado, **para que** eu não perca a primeira hora
|
|
40
|
+
depurando o scaffold em vez do meu produto.
|
|
41
|
+
- **Como** governança, **quero** a evidência de que o projeto gerado buildar **no log do CI**,
|
|
42
|
+
**para que** "o gerador funciona" seja um artefato verificável e não uma afirmação.
|
|
43
|
+
|
|
44
|
+
## 4. Critérios de aceite (Definition of Done)
|
|
45
|
+
|
|
46
|
+
- [ ] AC-1: Existe `forja project:smoke` (entrada no registry, ADR-0020) que **gera um projeto num
|
|
47
|
+
diretório temporário isolado** e reprova com exit ≠ 0 em qualquer falha abaixo. Limpa o tmp
|
|
48
|
+
sempre, inclusive quando um check lança.
|
|
49
|
+
- [ ] AC-2: **Zero placeholder vazado.** Nenhum arquivo gerado contém `{{...}}` não substituído.
|
|
50
|
+
É o bug mais barato de introduzir e o mais visível para o usuário.
|
|
51
|
+
- [ ] AC-3: **Todo `package.json` gerado é JSON válido** e contém os scripts que o gerador anuncia.
|
|
52
|
+
- [ ] AC-4: **Estrutura íntegra.** `validateProjectStructure` do projeto gerado passa (reusa o
|
|
53
|
+
`structure-validator` existente — uma máquina, não duas).
|
|
54
|
+
- [ ] AC-5: **Modo `--full` (opt-in): o projeto buildar de verdade.** `npm install` + `npm run build`
|
|
55
|
+
no backend gerado, num ambiente isolado. É o análogo do clean-install do `release:check`:
|
|
56
|
+
caro, roda antes de release, não a cada commit.
|
|
57
|
+
- [ ] AC-6: **Reusa o runner de `checks.mjs`.** O `project:smoke` é um catálogo novo consumido pelo
|
|
58
|
+
mesmo runner do doctor/release — mesma máquina de probes, `severity`, cascata por `dependsOn`.
|
|
59
|
+
- [ ] AC-7: O gate roda no CI (tier barato) e o `tools:doctor` **não** o executa (custo alto; é um
|
|
60
|
+
gate próprio, como o `release:check`).
|
|
61
|
+
|
|
62
|
+
## 5. Escopo
|
|
63
|
+
|
|
64
|
+
**Dentro**:
|
|
65
|
+
- Comando `project:smoke` + catálogo `lib/core/project-smoke.mjs`.
|
|
66
|
+
- Isolamento em tmp + limpeza garantida (padrão do `withCleanInstall`).
|
|
67
|
+
- Tier barato (placeholders, JSON, estrutura) no CI; tier `--full` (install+build) opt-in.
|
|
68
|
+
|
|
69
|
+
**Fora** (explícito):
|
|
70
|
+
- Rodar a suíte de testes do projeto gerado (`npm test`) — fica para uma iteração futura; build já
|
|
71
|
+
prova que os imports resolvem.
|
|
72
|
+
- Validar os boilerplates de stack individualmente (`api-rest`, `saas`, …) — este gate cobre o
|
|
73
|
+
caminho default do gerador; a matriz de stacks é escopo à parte.
|
|
74
|
+
- Publicar o projeto gerado em qualquer lugar.
|
|
75
|
+
|
|
76
|
+
## 6. NFRs / restrições
|
|
77
|
+
|
|
78
|
+
- **Compatibilidade**: não muda o comportamento de `init-project`/`create-memory-nest-kit` — só os
|
|
79
|
+
observa. O gerador não sabe que está sendo auditado.
|
|
80
|
+
- **Isolamento**: o tier `--full` roda `npm install` fora do repo, com o ambiente limpo (sem
|
|
81
|
+
`NODE_PATH`/`npm_config_*` herdados — a lição do `release:check`).
|
|
82
|
+
- **Custo**: o tier barato roda em segundos (sem rede); o `--full` é minutos (baixa NestJS).
|
|
83
|
+
|
|
84
|
+
## 7. Riscos e mitigação
|
|
85
|
+
|
|
86
|
+
| Risco | Probabilidade | Impacto | Mitigação |
|
|
87
|
+
|---|---|---|---|
|
|
88
|
+
| `--full` flaky por rede (npm registry) | M | M | tier barato é o gate de CI; `--full` é opt-in/pré-release, como o clean-install |
|
|
89
|
+
| Gerador tem efeitos colaterais fora do tmp | B | A | gerar sempre com destino explícito no tmp; o teste falha alto se escrever fora |
|
|
90
|
+
| Duplicar lógica de validação | B | M | reusar `structure-validator` e o runner de `checks.mjs` — AC-4/AC-6 |
|
|
91
|
+
|
|
92
|
+
## 8. Métricas de sucesso
|
|
93
|
+
|
|
94
|
+
30 dias após o release: **pelo menos uma regressão do gerador pega pelo gate antes do merge** (a
|
|
95
|
+
prova de que a fronteira estava mesmo descoberta), e **zero issue de usuário sobre scaffold quebrado**
|
|
96
|
+
(placeholder vazado, `package.json` inválido).
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Spec: project-upgrade
|
|
2
|
+
|
|
3
|
+
- **ID**: SPEC-018
|
|
4
|
+
- **Status**: done
|
|
5
|
+
- **Owner**: apk
|
|
6
|
+
- **ADRs relacionadas**: ADR-0020 (core/registry), ADR-0024 (isolamento em tmp — o padrão do gate)
|
|
7
|
+
|
|
8
|
+
## 1. Problema
|
|
9
|
+
|
|
10
|
+
O framework **gera** projetos, mas nunca soube **atualizar** um já gerado. Quando o Forja evolui —
|
|
11
|
+
uma pasta de memória nova (`70-summaries/`), um agent novo, um config multi-IA novo — quem gerou numa
|
|
12
|
+
versão antiga fica preso nela. A única saída era regerar (e perder o código) ou copiar peças na mão
|
|
13
|
+
(e esquecer quais). É a metade que falta de todo scaffolder.
|
|
14
|
+
|
|
15
|
+
## 2. Proposta de valor
|
|
16
|
+
|
|
17
|
+
Um projeto gerado consegue **incorporar as peças novas do scaffold** sem regerar e sem risco: o
|
|
18
|
+
comando traz o que falta, e **nunca** toca no que já existe (onde mora a edição do usuário).
|
|
19
|
+
|
|
20
|
+
## 3. User stories
|
|
21
|
+
|
|
22
|
+
- **Como** dono de um projeto gerado numa versão antiga, **quero** puxar as peças novas do framework,
|
|
23
|
+
**para que** eu não fique preso na versão em que gerei nem perca meu código regerando.
|
|
24
|
+
- **Como** dev cauteloso, **quero** um dry-run antes de qualquer escrita, **para que** eu veja
|
|
25
|
+
exatamente o que será adicionado.
|
|
26
|
+
|
|
27
|
+
## 4. Critérios de aceite (Definition of Done)
|
|
28
|
+
|
|
29
|
+
- [x] AC-1: `forja project:upgrade` gera um scaffold fresco num tmp isolado, faz o diff contra o
|
|
30
|
+
projeto e lista **só os arquivos que faltam** (dry-run por padrão).
|
|
31
|
+
- [x] AC-2: **Aditivo, nunca sobrescreve.** Um arquivo que já existe no projeto não é listado nem
|
|
32
|
+
tocado — é território do usuário. Provado em teste (edição preservada sob `--apply`).
|
|
33
|
+
- [x] AC-3: `--apply` copia as peças novas, criando diretórios; reporta quantas.
|
|
34
|
+
- [x] AC-4: `--project <path>` (default `cwd`); reprova cedo se o alvo não parece um projeto Forja
|
|
35
|
+
(sem `AGENTS.md`). Limpa o tmp sempre.
|
|
36
|
+
- [x] AC-5: Lógica pura e testável (`lib/project-upgrade.ts`), com fixtures.
|
|
37
|
+
|
|
38
|
+
## 5. Escopo
|
|
39
|
+
|
|
40
|
+
**Dentro**: adicionar arquivos de scaffold ausentes (memória, agents, prompts, skills, configs).
|
|
41
|
+
|
|
42
|
+
**Fora** (explícito — a fronteira de segurança):
|
|
43
|
+
- **Sobrescrever ou fazer merge de arquivos existentes.** É onde vive a edição do usuário; MVP nunca
|
|
44
|
+
toca. Um "upgrade com 3-way merge" é trabalho de outra spec, com muito mais risco.
|
|
45
|
+
- Migrar dados (memória indexada, `.context`) — são runtime, ficam de fora do diff.
|
|
46
|
+
- Atualizar `package.json`/dependências do backend — é código do usuário.
|
|
47
|
+
|
|
48
|
+
## 6. NFRs / restrições
|
|
49
|
+
|
|
50
|
+
- **Segurança acima de tudo**: additive-only é a invariante. `applyUpgrade` reconfere `existsSync`
|
|
51
|
+
antes de cada cópia (paranoia: jamais sobrescreve).
|
|
52
|
+
- **Isolamento**: o scaffold fresco nasce num tmp com ambiente limpo (`NODE_PATH`/`npm_config_*`
|
|
53
|
+
removidos — a lição do `release:check`), e o tmp é limpo sempre.
|
|
54
|
+
|
|
55
|
+
## 7. Métricas de sucesso
|
|
56
|
+
|
|
57
|
+
Um projeto gerado numa versão antiga incorpora as peças de uma versão nova sem perder nenhuma linha
|
|
58
|
+
de código do usuário — e o dono revê o diff antes de commitar.
|