forjajs 1.1.3 → 1.1.4

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.
@@ -0,0 +1,122 @@
1
+ # Spec: release-gate
2
+
3
+ - **ID**: SPEC-010
4
+ - **Status**: done
5
+ - **Owner**: apk
6
+ - **Criado em**: 2026-07-13
7
+ - **Sprint alvo**: S?
8
+ - **ADRs relacionadas**: [ADR-0023](../../memory/90-decisions/0023-doctor-como-gate-do-nucleo.md) (doctor como gate do núcleo), [ADR-0021](../../memory/90-decisions/0021-guardrails-de-harness.md) (guardrails de harness), [ADR-0020](../../memory/90-decisions/0020-forja-core-cli-unica.md) (core/registry), [ADR-0018](../../memory/90-decisions/0018-ferramentas-de-processo.md) (ferramentas de processo)
9
+
10
+ ## 1. Problema
11
+
12
+ **O repositório mente sobre o pacote.** No repo tudo resolve: `node_modules` tem as devDeps, todo
13
+ arquivo está presente, o `cwd` é a raiz. Nada disso vale para quem roda `npm i -g forjajs`. Entre o
14
+ repo e o tarball existe uma fronteira que nenhum teste atravessa — e ela já cedeu **três vezes**:
15
+
16
+ | Versão | O que foi publicado | Consequência |
17
+ |---|---|---|
18
+ | ADR-0021 §2 | `better-sqlite3` como `devDependency` | Dez comandos estouravam com `ERR_MODULE_NOT_FOUND` numa instalação limpa. O `forja` sem argumentos funcionava — o help não carrega os scripts — o que mascarava a quebra. |
19
+ | v1.1.1 | `otplib` e `qrcode` no tarball, **sem jamais existirem no git** | `npm publish` empacota o *disco*, não o commit. Um `npm install` casual entre a auditoria e o publish reescreveu o `package.json`. |
20
+ | v1.1.3 | `docs/dashboard.md` e o script `npm run dashboard`, sem a pasta `dashboard/` | Quem instalava recebia a documentação e o comando, sem o código. |
21
+
22
+ Três ocorrências, uma classe: **o que é publicado não é o que o repositório promete.** Todas
23
+ descobertas *depois* do publish, na máquina de quem instalou.
24
+
25
+ O agente `.claude/agents/release-auditor.md` descreve essa classe com precisão cirúrgica — as
26
+ quatro variantes, o procedimento, os comandos. Mas ele é **um agente**: prosa, opt-in, invocado por
27
+ quem lembrar. Pelo critério do próprio ADR-0021 — *"uma regra que depende de memória não é uma
28
+ regra; é uma sugestão"* — isto não é gate. É a última fronteira do framework que ainda funciona por
29
+ disciplina em vez de por harness.
30
+
31
+ Não é conhecimento que falta. É **execução**.
32
+
33
+ ## 2. Proposta de valor
34
+
35
+ Publicar deixa de ser um ato de fé: **nenhuma versão sai sem prova de que uma instalação limpa
36
+ funciona**, e a prova é gerada pelo harness, não pela lembrança de quem publica.
37
+
38
+ ## 3. User stories
39
+
40
+ - **Como** quem publica, **quero** que o `npm publish` seja **bloqueado** quando o tarball está
41
+ quebrado, **para que** eu não descubra pela issue de um usuário.
42
+ - **Como** quem publica, **quero** que árvore suja reprove antes de qualquer outra checagem,
43
+ **para que** não se repita a v1.1.1 — auditar um tarball que não é o que será publicado é
44
+ auditar ficção.
45
+ - **Como** usuário do `forjajs`, **quero** que todo comando anunciado exista de verdade no pacote,
46
+ **para que** `npm i -g forjajs` não me entregue documentação sem código.
47
+ - **Como** governança, **quero** a evidência da instalação limpa **no log do CI**, **para que**
48
+ "testado" seja um artefato verificável e não uma afirmação.
49
+
50
+ ## 4. Critérios de aceite (Definition of Done)
51
+
52
+ - [ ] AC-1: Existe `npm run release:check` (entrada no registry, ADR-0020) que empacota, instala num
53
+ diretório temporário isolado e **reprova com exit ≠ 0** em qualquer uma das falhas abaixo.
54
+ - [ ] AC-2: **Árvore limpa é pré-condição.** Qualquer saída de `git status --short` reprova
55
+ imediatamente, antes de empacotar. Foi a falha da v1.1.1, e nenhuma instalação a pega.
56
+ - [ ] AC-3: **Instalação limpa real**: `npm pack` → `npm i <tgz>` fora do repo, sem devDeps.
57
+ - [ ] AC-4: **Comandos são executados, não listados.** O `forja` sem argumentos passa mesmo com tudo
58
+ quebrado (o help não carrega os scripts). O gate roda os comandos sem efeito colateral
59
+ (`tools:doctor`, `code:status`, `query:universal`, help) e reprova em `ERR_MODULE_NOT_FOUND`.
60
+ - [ ] AC-5: **Todo comando do registry tem seu script no tarball.** Hoje são 41/41 — o gate torna
61
+ isso permanente, em vez de verdade acidental.
62
+ - [ ] AC-6: **Fronteira deps/devDeps nos dois sentidos**: todo pacote importado por código sob
63
+ `files[]` está em `dependencies`; e toda `dependency` declarada é importada por alguém — peso
64
+ morto viaja no tarball de todo usuário.
65
+ - [ ] AC-7: **Imports em template literal não contam.** Os geradores contêm código NestJS que eles
66
+ *escrevem*, não que *executam*. Contá-los produz falso positivo.
67
+ - [ ] AC-8: `release:check` roda como **`prepublishOnly`** e como **step do CI**. Um gate que só roda
68
+ quando alguém lembra é o problema, não a solução.
69
+ - [ ] AC-9: `tools:doctor` também vira step do CI — o gate do ADR-0023 existe e hoje nada o executa
70
+ automaticamente.
71
+ - [ ] AC-10: O agente `release-auditor` passa a **consumir o gate**, em vez de manter procedimento
72
+ próprio em prosa. Deixa de ser a fonte da verdade e passa a interpretá-la.
73
+ - [ ] AC-11: `runtime-deps` (ADR-0023) endurecido contra o falso positivo do AC-7. Hoje ele passa
74
+ **por sorte**: `@nestjs/*` não está nas devDeps. No dia em que estiver, ele trava o gate.
75
+ - [ ] AC-12: Testes cobrindo cada reprovação com tarball de fixture deliberadamente quebrado.
76
+
77
+ ## 5. Escopo
78
+
79
+ **Dentro**:
80
+ - `lib/core/release.mjs` — as checagens como dados, no mesmo formato de `lib/core/health.mjs`
81
+ (`{ id, severity, probe, fix }`). Mesma filosofia, fronteira diferente.
82
+ - `scripts/release-check.mjs` — superfície de apresentação + exit code.
83
+ - `package.json` (`prepublishOnly`) e `.github/workflows/` (steps de `release:check` e `tools:doctor`).
84
+ - `lib/core/health.mjs` — endurecer `runtime-deps` (AC-11).
85
+ - `.claude/agents/release-auditor.md` — reescrito para consumir o gate.
86
+
87
+ **Fora** (explícito):
88
+ - **Publicar automaticamente.** O gate autoriza; quem publica é humano. Automatizar o `npm publish`
89
+ é a classe de risco oposta à que esta spec fecha.
90
+ - Mudar o conteúdo de `files[]` — o gate *verifica* o que está lá; não decide o que deveria estar.
91
+ - Assinatura/proveniência de pacote (npm provenance) — vale a pena, mas é outra spec.
92
+ - Testar os projetos **gerados** pelos boilerplates. É uma fronteira real e descoberta, mas grande
93
+ demais para entrar aqui de carona.
94
+
95
+ ## 6. NFRs / restrições
96
+
97
+ - **Honestidade acima de velocidade**: o gate instala de verdade. Vai levar dezenas de segundos, e
98
+ tudo bem — roda antes de publicar e no CI, não a cada commit.
99
+ - **Isolamento**: a instalação acontece fora do repo, em diretório temporário, sem herdar
100
+ `node_modules` nem `NODE_PATH`. Um gate que enxerga o repo não prova nada.
101
+ - **Zero falso positivo crítico**: melhor deixar passar um caso duvidoso do que reprovar um release
102
+ saudável. Análise estática ambígua vira `warn`, nunca `fail`.
103
+ - **Compatibilidade**: não altera nenhum comando existente. `release:check` é aditivo.
104
+
105
+ ## 7. Riscos e mitigação
106
+
107
+ | Risco | Probabilidade | Impacto | Mitigação |
108
+ |---|---|---|---|
109
+ | Gate lento e as pessoas o contornam | M | A | Só em `prepublishOnly` e CI; nunca no pre-commit |
110
+ | Falso positivo por template literal nos geradores | **A** | A | AC-7 e AC-11; ambíguo vira `warn`. **Já observado em campo** |
111
+ | Instalação "vaza" para o repo (cache, `NODE_PATH`) e o gate mente verde | M | A | Diretório temporário + `npm init` próprio; teste que injeta tarball quebrado e **exige** reprovação |
112
+ | `prepublishOnly` não roda em todos os fluxos de publish | B | A | Duplicado como step de CI — duas portas, não uma |
113
+ | Escopo escorrega para "testar os projetos gerados" | M | M | Explicitamente fora |
114
+
115
+ ## 8. Métricas de sucesso
116
+
117
+ - **Zero** bugs da classe "publicado ≠ repositório" nos 90 dias após a 1.1.4. Foram três em três
118
+ releases; a régua é chegar a zero — e provar.
119
+ - A evidência da instalação limpa passa a existir **no log do CI de cada release**, em vez de na
120
+ memória de quem publicou.
121
+ - Os três bugs históricos viram fixture: cada um, reintroduzido, **reprova** o gate. Um gate que
122
+ nunca viu a falha que promete pegar não está testado — está escrito.
@@ -0,0 +1,183 @@
1
+ # Tasks: release-gate
2
+
3
+ - **Spec**: ./spec.md
4
+ - **Plan**: ./plan.md
5
+ - **Status**: done
6
+ - **Criado em**: 2026-07-14
7
+
8
+ > Decomposição executável. Cada task tem dono claro, critério de done e referência a arquivos.
9
+
10
+ Ordem do plano §7: refactor puro primeiro (nada muda de comportamento), depois o catálogo, depois
11
+ as superfícies. O `prepublishOnly` vai **por último** — é a única peça que, com falso positivo,
12
+ impede publicar qualquer coisa.
13
+
14
+ ---
15
+
16
+ ## T1 — Extrair o runner para `lib/core/checks.mjs`
17
+ - **Owner**: Worker
18
+ - **Estimativa**: P
19
+ - **Depende de**: —
20
+ - **Paths**: `lib/core/checks.mjs`, `lib/core/health.mjs`, `test/health.test.js`
21
+ - **Escopo**: refactor puro. Nenhum comportamento muda; a suíte existente é o teste.
22
+ - **Done quando**:
23
+ - [ ] `runChecks` e `worstStatus` saem de `health.mjs` para `checks.mjs`, sem alteração de lógica
24
+ - [ ] `health.mjs` **re-exporta** ambos — `tools-doctor` e `hook-session-start` não mudam uma linha
25
+ - [ ] Os 36 testes de `test/health.test.js` passam **sem edição** (se precisarem mudar, não foi
26
+ refactor puro — foi mudança de comportamento disfarçada)
27
+ - [ ] Suíte completa verde
28
+
29
+ ## T2 — `withCleanInstall`: empacotar e instalar isolado
30
+ - **Owner**: Worker
31
+ - **Estimativa**: M
32
+ - **Depende de**: T1
33
+ - **Paths**: `lib/core/release.mjs`, `test/release.test.js`
34
+ - **Escopo**: a fundação do gate. Sem instalação real, nada aqui prova nada (D2).
35
+ - **Done quando**:
36
+ - [ ] `npm pack` → diretório temporário fora do repo; `npm init -y` + `npm i <tgz>`
37
+ - [ ] **Isolamento**: sem herdar `NODE_PATH` nem o `node_modules` do repo. Um gate que enxerga o
38
+ repo mente verde (NFR)
39
+ - [ ] Limpa o temporário **sempre**, inclusive em erro (`finally`)
40
+ - [ ] Teste: o diretório temporário some depois da execução, mesmo quando o callback lança
41
+
42
+ ## T3 — Checks do tarball: `registry-scripts`, `imports-resolve`
43
+ - **Owner**: Worker
44
+ - **Estimativa**: M
45
+ - **Depende de**: T2
46
+ - **Paths**: `lib/core/release.mjs`, `test/release.test.js`
47
+ - **Done quando**:
48
+ - [ ] `registry-scripts` (critical): todo comando do registry tem seu `node:` presente no tarball.
49
+ Hoje são 41/41 — o gate torna permanente o que hoje é verdade acidental (AC-5)
50
+ - [ ] `imports-resolve` (critical): todo import **relativo** de script publicado resolve dentro do
51
+ tarball (AC-6)
52
+ - [ ] **Template literals apagados antes do parse** (D3): os geradores contêm código NestJS que
53
+ eles *escrevem*, não que executam. Sem isso o check acusa `./app.module` como quebrado —
54
+ já observado em campo
55
+ - [ ] Fixture: tarball com arquivo fora do `files[]` **reprova** (bug real da v1.1.3)
56
+
57
+ ## T4 — Checks de dependência: `deps-declared`, `deps-unused`
58
+ - **Owner**: Worker
59
+ - **Estimativa**: M
60
+ - **Depende de**: T2
61
+ - **Paths**: `lib/core/release.mjs`, `test/release.test.js`
62
+ - **Done quando**:
63
+ - [ ] `deps-declared` (critical): todo pacote importado por código sob `files[]` está em
64
+ `dependencies` (AC-6)
65
+ - [ ] `deps-unused` (**warn**, D7): `dependency` que ninguém importa é peso morto no tarball de
66
+ todo usuário — incomoda, não quebra
67
+ - [ ] Template literals apagados antes do parse, aqui também. Sem isso, `@nestjs/core` aparece
68
+ como dependência não declarada
69
+ - [ ] Fixture: `better-sqlite3` movido para `devDependencies` **reprova** (bug real do ADR-0021)
70
+
71
+ ## T5 — `smoke-commands`: executar, não listar
72
+ - **Owner**: Worker
73
+ - **Estimativa**: M
74
+ - **Depende de**: T2
75
+ - **Paths**: `lib/core/release.mjs`, `test/release.test.js`
76
+ - **Escopo**: o check mais importante e o mais fácil de errar. O `forja` sem argumentos passa mesmo
77
+ com tudo quebrado — o help não carrega os scripts. Foi assim que a quebra do ADR-0021 se escondeu.
78
+ - **Done quando**:
79
+ - [ ] Executa comandos sem efeito colateral na instalação limpa: help, `tools:doctor`,
80
+ `code:status`, `query:universal` (AC-4)
81
+ - [ ] **Reprova por assinatura no stderr, nunca por exit code** (D8): `ERR_MODULE_NOT_FOUND`,
82
+ `ERR_DLOPEN_FAILED`, `Cannot find module`. Numa instalação limpa não há workspace nem
83
+ `universal.db`, então exit ≠ 0 é o pacote **funcionando** — reprovar ali seria repetir a
84
+ armadilha do `memory-db` na SPEC-009
85
+ - [ ] Teste: comando que sai ≠ 0 por falta de workspace **passa**; comando com
86
+ `ERR_MODULE_NOT_FOUND` **reprova**
87
+
88
+ ## T6 — `tree-clean` e os dois modos
89
+ - **Owner**: Worker
90
+ - **Estimativa**: P
91
+ - **Depende de**: T2
92
+ - **Paths**: `lib/core/release.mjs`, `test/release.test.js`
93
+ - **Done quando**:
94
+ - [ ] `git status --short` com qualquer saída: `fail` sob `--publish`, `warn` sem ele (D4)
95
+ - [ ] Roda **antes** de empacotar: auditar um tarball que não é o que será publicado é auditar
96
+ ficção
97
+ - [ ] **Reconferido ao final** (D5): a aprovação é perecível. Um `npm install` entre o check e o
98
+ publish invalida tudo — foi exatamente a causa da v1.1.1
99
+ - [ ] Fixture: árvore suja + `--publish` **reprova** (bug real da v1.1.1)
100
+
101
+ ## T7 — `release:check` (CLI + registry)
102
+ - **Owner**: Worker
103
+ - **Estimativa**: P
104
+ - **Depende de**: T3, T4, T5, T6
105
+ - **Paths**: `scripts/release-check.mjs`, `lib/core/registry.mjs`, `package.json`
106
+ - **Done quando**:
107
+ - [ ] Saída com o mesmo vocabulário do `tools:doctor` (OK/AVISO/FALHA + correção ao lado)
108
+ - [ ] `exit 1` se e somente se algum `critical` falhar (AC-1)
109
+ - [ ] Entrada no registry (ADR-0020); `test/forja-core.test.js` verde
110
+ - [ ] Flag `--publish` documentada no help
111
+
112
+ ## T8 — Endurecer `runtime-deps` (dívida do ADR-0023)
113
+ - **Owner**: Worker
114
+ - **Estimativa**: P
115
+ - **Depende de**: T1
116
+ - **Paths**: `lib/core/health.mjs`, `test/health.test.js`
117
+ - **Contexto**: o check que entregamos na SPEC-009 passa **por sorte**. Os geradores contêm
118
+ `import { Module } from '@nestjs/common'` em template string; hoje não quebra porque `@nestjs/*`
119
+ não está nas devDeps. No dia em que estiver, ele trava o gate com falso positivo crítico.
120
+ - **Done quando**:
121
+ - [ ] Template literals apagados antes do parse, como em T3/T4 (AC-11)
122
+ - [ ] Teste com um gerador contendo `import` de devDependency **dentro de crases**: não reprova
123
+ - [ ] Teste com import real de devDependency fora de crases: continua reprovando
124
+
125
+ ## T9 — CI: `tools:doctor` e `release:check` como steps
126
+ - **Owner**: Worker
127
+ - **Estimativa**: P
128
+ - **Depende de**: T7
129
+ - **Paths**: `.github/workflows/ci.yml`
130
+ - **Done quando**:
131
+ - [ ] `tools:doctor` vira step (AC-9) — o gate do ADR-0023 existe e hoje **nada o executa**
132
+ - [ ] `release:check` vira step. Roda uma vez (não na matriz inteira): o custo é o `npm i`
133
+ compilando o `better-sqlite3` do zero, e três vezes não prova mais que uma
134
+ - [ ] O CI verde vira a **evidência** do release, no log, em vez de na memória de quem publicou
135
+
136
+ ## T10 — ADR-0024 e documentação
137
+ - **Owner**: SDD Architect
138
+ - **Estimativa**: P
139
+ - **Depende de**: T7
140
+ - **Paths**: `memory/90-decisions/0024-*.md`, `docs/publishing.md`, `CLAUDE.md`
141
+ - **Done quando**:
142
+ - [ ] ADR-0024 registra D1 (runner extraído), D8 (stderr, não exit code) e D9 (`prepublishOnly`,
143
+ nunca `prepack`), referenciando ADR-0023 e ADR-0021
144
+ - [ ] Os três bugs históricos citados como evidência — são o argumento da decisão
145
+ - [ ] `docs/publishing.md` passa a mandar rodar o gate, não a confiar no ritual
146
+
147
+ ## T11 — `release-auditor` consome o gate
148
+ - **Owner**: Worker
149
+ - **Estimativa**: P
150
+ - **Depende de**: T7
151
+ - **Paths**: `.claude/agents/release-auditor.md`
152
+ - **Done quando**:
153
+ - [ ] O agente **roda `release:check`** e interpreta o resultado, em vez de reimplementar o
154
+ procedimento em prosa (AC-10)
155
+ - [ ] Some o passo-a-passo manual de `npm pack`/`grep`: virou código, e código não esquece
156
+ - [ ] Permanece o que só um agente faz: julgar o que o gate não sabe julgar, e recomendar
157
+
158
+ ## T12 — `prepublishOnly` (por último)
159
+ - **Owner**: Governance
160
+ - **Estimativa**: P
161
+ - **Depende de**: T9 verde por um ciclo
162
+ - **Paths**: `package.json`
163
+ - **Escopo**: a peça de risco alto. Com falso positivo aqui, **ninguém publica nada**.
164
+ - **Done quando**:
165
+ - [ ] `"prepublishOnly": "npm run release:check -- --publish"` (AC-8)
166
+ - [ ] Comentário no `package.json`: **nunca** amarrar ao `prepack` — o gate roda `npm pack`, e
167
+ isso seria recursão infinita (D9)
168
+ - [ ] Validado com `npm publish --dry-run`
169
+ - [ ] Só entra **depois** de o gate rodar verde no CI por um ciclo (plano §7)
170
+
171
+ ---
172
+
173
+ ## Validação final (Governance)
174
+ - [ ] Os **três bugs históricos**, reintroduzidos um a um, reprovam o gate: `better-sqlite3` em
175
+ devDeps (ADR-0021), arquivo fora do `files[]` (v1.1.3), árvore suja no publish (v1.1.1).
176
+ Um gate que nunca viu a falha que promete pegar não está testado — está escrito.
177
+ - [ ] `npm test`, `project:check`, `tools:doctor` e `gitleaks` verdes
178
+ - [ ] Suíte completa verde; spec → `done`
179
+
180
+ ## Handoffs entre agentes
181
+
182
+ Worker (T1-T9, T11), SDD Architect (T10), Governance (T12 + validação). Handoff a cada fronteira
183
+ via `npm run agent:route` — 7 campos (ADR-0005).