forjajs 1.1.6 → 1.2.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.
Files changed (60) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.en.md +28 -5
  3. package/README.md +30 -4
  4. package/bin/forja.mjs +3 -3
  5. package/boilerplates/06-clean-arch/README.md +48 -0
  6. package/boilerplates/06-clean-arch/WHEN-CLEAN-WHEN-LEAN.md +42 -0
  7. package/boilerplates/06-clean-arch/backend/package.json +43 -0
  8. package/boilerplates/06-clean-arch/backend/src/app.module.ts +20 -0
  9. package/boilerplates/06-clean-arch/backend/src/main.ts +10 -0
  10. package/boilerplates/06-clean-arch/backend/src/modules/orders/application/place-order.usecase.ts +47 -0
  11. package/boilerplates/06-clean-arch/backend/src/modules/orders/application/ship-order.usecase.ts +28 -0
  12. package/boilerplates/06-clean-arch/backend/src/modules/orders/domain/money.vo.ts +30 -0
  13. package/boilerplates/06-clean-arch/backend/src/modules/orders/domain/order-status.vo.ts +36 -0
  14. package/boilerplates/06-clean-arch/backend/src/modules/orders/domain/order.entity.ts +85 -0
  15. package/boilerplates/06-clean-arch/backend/src/modules/orders/domain/order.repository.ts +17 -0
  16. package/boilerplates/06-clean-arch/backend/src/modules/orders/infrastructure/order.orm-entity.ts +24 -0
  17. package/boilerplates/06-clean-arch/backend/src/modules/orders/infrastructure/typeorm-order.repository.ts +57 -0
  18. package/boilerplates/06-clean-arch/backend/src/modules/orders/orders.module.ts +28 -0
  19. package/boilerplates/06-clean-arch/backend/src/modules/orders/presentation/orders.controller.ts +31 -0
  20. package/boilerplates/06-clean-arch/backend/src/modules/orders/presentation/orders.http.dto.ts +30 -0
  21. package/boilerplates/06-clean-arch/backend/src/modules/products/product.entity.ts +20 -0
  22. package/boilerplates/06-clean-arch/backend/src/modules/products/products.controller.ts +43 -0
  23. package/boilerplates/06-clean-arch/backend/src/modules/products/products.module.ts +11 -0
  24. package/boilerplates/06-clean-arch/backend/src/shared/result.ts +32 -0
  25. package/boilerplates/06-clean-arch/backend/test/orders/place-order.spec.ts +46 -0
  26. package/boilerplates/06-clean-arch/backend/tsconfig.json +16 -0
  27. package/boilerplates/06-clean-arch/boilerplate.manifest.json +43 -0
  28. package/boilerplates/06-clean-arch/memory/30-domains/orders/context.md +39 -0
  29. package/boilerplates/06-clean-arch/memory/30-domains/products/context.md +23 -0
  30. package/boilerplates/README.md +20 -0
  31. package/docs/personas/architect/README.md +4 -4
  32. package/docs/personas/developer/README.md +3 -3
  33. package/docs/personas/qa/README.md +3 -3
  34. package/docs/quick-reference.md +9 -9
  35. package/docs/structure.md +3 -3
  36. package/lib/core/checks.mjs +20 -3
  37. package/lib/core/doc-graph.mjs +231 -0
  38. package/lib/core/health.mjs +131 -29
  39. package/lib/core/registry.mjs +23 -0
  40. package/lib/core/release.mjs +48 -8
  41. package/lib/templates/harness/code-intel.mjs +2 -2
  42. package/memory/90-decisions/0025-coerencia-da-documentacao.md +95 -0
  43. package/memory/90-decisions/0027-clean-arch-calibrada.md +96 -0
  44. package/package.json +7 -1
  45. package/scripts/agent-harness.mjs +7 -5
  46. package/scripts/context-ops.mjs +7 -4
  47. package/scripts/dev.mjs +2 -2
  48. package/scripts/hook-guard-paths.mjs +1 -0
  49. package/scripts/hook-user-prompt.mjs +1 -1
  50. package/scripts/spec-cli.mjs +4 -3
  51. package/scripts/tools-doctor.mjs +1 -1
  52. package/specs/clean-arch-boilerplate/plan.md +137 -0
  53. package/specs/clean-arch-boilerplate/spec.md +121 -0
  54. package/specs/clean-arch-boilerplate/tasks.md +70 -0
  55. package/specs/coerencia-do-sistema/plan.md +155 -0
  56. package/specs/coerencia-do-sistema/spec.md +15 -14
  57. package/specs/coerencia-do-sistema/tasks.md +115 -0
  58. package/specs/ts-migration/plan.md +188 -0
  59. package/specs/ts-migration/spec.md +119 -0
  60. package/specs/ts-migration/tasks.md +110 -0
@@ -0,0 +1,119 @@
1
+ # Spec: ts-migration
2
+
3
+ - **ID**: SPEC-012
4
+ - **Status**: approved
5
+ - **Owner**: apk
6
+ - **Criado em**: 2026-07-18
7
+ - **Sprint alvo**: S?
8
+ - **ADRs relacionadas**: [ADR-0024](../../memory/90-decisions/0024-gate-do-tarball.md) (gate do tarball), [ADR-0023](../../memory/90-decisions/0023-doctor-como-gate-do-nucleo.md) (gate do núcleo), [ADR-0021](../../memory/90-decisions/0021-guardrails-de-harness.md) (guardrails), [ADR-0020](../../memory/90-decisions/0020-forja-core-cli-unica.md) (registry)
9
+
10
+ ## 1. Problema
11
+
12
+ O framework tem ~8.500 LOC em 38 arquivos, e **os contratos que o sustentam são convenção, não
13
+ código**. A forma de um check (`{ id, severity, probe, fix }`), o handoff de 7 campos (ADR-0005), o
14
+ `Env` injetável, as entradas do registry — nada disso é verificado até rodar. Nesta sessão, três
15
+ frentes seguidas (ADR-0023/0024/0025) fizeram o mesmo movimento: converter conhecimento que vivia em
16
+ prosa num invariante executável. **A migração para TypeScript é esse movimento aplicado aos
17
+ contratos do próprio código** — drift de contrato deixa de ser surpresa em runtime e vira erro de
18
+ compilação.
19
+
20
+ Já há 9 arquivos com `@typedef` de JSDoc: a tipagem manual já começou, só não é verificada. E o repo
21
+ está a meio caminho de `.js → .mjs` (21 vs 16), então já se mexe na camada de módulos.
22
+
23
+ **A tensão que a migração precisa respeitar.** Um princípio carrega o framework desde o ADR-0021: o
24
+ `tools:doctor` e o hook `SessionStart` rodam **sem build e sem `node_modules`**. Foi isso que tornou
25
+ a morte da memória (ABI) sobrevivível e o hook resiliente. Uma migração ingênua ("compila pra
26
+ `dist/`, roda `dist/`") fritaria esse princípio — e pior, reintroduziria a classe que passamos a
27
+ sessão matando: **um `dist/` que mente sobre o `src/`.**
28
+
29
+ ## 2. Proposta de valor
30
+
31
+ TypeScript de verdade — tipos exportáveis para quem consome o `forjajs` — **sem** perder o "roda sem
32
+ build" que faz o Forja resiliente, e **sem** deixar o artefato compilado divergir da fonte.
33
+
34
+ ## 3. User stories
35
+
36
+ - **Como** quem mantém o framework, **quero** que um `probe` que devolve a forma errada seja **erro
37
+ de compilação**, não bug silencioso, **para que** o contrato dos checks pare de ser convenção.
38
+ - **Como** quem instala `forjajs`, **quero** tipos (`.d.ts`) no pacote, **para que** meu editor
39
+ saiba a forma da API.
40
+ - **Como** agente rodando o hook `SessionStart`, **quero** que ele funcione **sem build e sem
41
+ `node_modules`**, **para que** o diagnóstico sobreviva ao ambiente quebrado (ADR-0021).
42
+ - **Como** quem publica, **quero** que `dist/` desatualizado **reprove** o `release:check`, **para
43
+ que** o pacote publicado nunca minta sobre a fonte.
44
+
45
+ ## 4. Critérios de aceite (Definition of Done)
46
+
47
+ - [ ] AC-1: **Runtime duplo.** Em dev e nos hooks, o Forja roda a fonte `.ts` via type-stripping do
48
+ Node (confirmado: Node 26 executa `.ts` nativo). **Zero build em dev.** O pacote publicado
49
+ embarca `dist/` compilado por `tsc`, para o piso `engines.node >= 20`.
50
+ - [ ] AC-2: **`build-fresh` no catálogo `RELEASE_CHECKS`** (ADR-0024): recompila e compara com o
51
+ `dist/` versionado; se `src/` mudou e `dist/` não, **reprova** com `fix: "npm run build"`. O
52
+ artefato compilado não pode ser publicado defasado.
53
+ - [ ] AC-3: **On-ramp por `checkJs` antes de renomear.** `tsconfig` com `checkJs: true, strict: true,
54
+ noEmit` roda sobre os `.mjs` atuais; os erros de tipo são corrigidos **antes** de qualquer
55
+ renomeação. `types:check` vira **npm script** (como `test`) e step do CI — **fora do registry
56
+ publicado**, porque precisa do devDep `typescript` e seria comando quebrado numa instalação
57
+ `forjajs` (a classe da v1.1.3). *(Correção de rota da Fase 0.)*
58
+ - [ ] AC-4: **Contratos tipados.** `Check`, `Probe`, `Result`, `Env`, `Command` (registry) e o
59
+ handoff de 7 campos (ADR-0005) viram tipos reais, não `@typedef` de convenção.
60
+ - [ ] AC-5: `tsc` emite `.d.ts` no `dist/`; o `package.json` aponta `types`/`exports` para eles.
61
+ - [ ] AC-6: **`release:check` cobre o build.** O gate compila antes de empacotar; `prepublishOnly`
62
+ roda build → gate (ordem correta, sem recursão — o gate não dispara `prepack`, ADR-0024).
63
+ - [ ] AC-7: Suíte verde em cada passo da renomeação (leaf-first). O `node --test` roda sobre `.ts`.
64
+ **É a rede de segurança da migração**: se todos os testes passam sem edição de semântica, a
65
+ renomeação não mudou nada.
66
+ - [ ] AC-8: `tools:doctor`, `release:check` e `spec:check` verdes ao final; instalação limpa do
67
+ tarball funciona (o próprio `release:check` prova).
68
+ - [ ] AC-9: ADR-0026 registrando a decisão (runtime duplo, `build-fresh`, `tsc`).
69
+
70
+ ## 5. Escopo
71
+
72
+ **Dentro**:
73
+ - `tsconfig.json` + `checkJs` on-ramp; migração `.mjs/.js → .ts` leaf-first.
74
+ - `tsc` como toolchain (build → `dist/`, emite `.d.ts`).
75
+ - `build-fresh` em `lib/core/release`; `types:check` no registry; steps no CI.
76
+ - `package.json`: `main`/`types`/`exports`/`bin` → `dist/`; `build`; `prepublishOnly` build→gate.
77
+ - ADR-0026 + ajustes de teste.
78
+
79
+ **Fora** (explícito):
80
+ - **Bumpar o piso de Node.** Fica em `>= 20`; por isso publicamos `dist/` compilado. Dev usa Node
81
+ novo (strip nativo), mas o usuário final não é obrigado.
82
+ - **Geradores como template string.** A fragilidade real (o `@nestjs` falso-positivo, o
83
+ `stripTemplateLiterals`) é separável e ganha spec própria — misturá-la aqui explode o escopo.
84
+ - **Reescrever lógica.** É migração de tipos, não refator de comportamento. Todo teste existente
85
+ passa sem mudança de semântica.
86
+ - **Consolidar o scanner duplicado** (`IMPORT_RE` em `health` e `release`). Vale, mas é refactor —
87
+ e misturá-lo à migração polui o sinal "todos os testes passam sem mudança de semântica", que é a
88
+ rede de segurança da migração inteira (AC-7). Vira fast-follow, spec própria.
89
+ - **esbuild/swc.** `tsc` basta — é framework, não hot path; e precisamos do type-check de qualquer
90
+ forma.
91
+
92
+ ## 6. NFRs / restrições
93
+
94
+ - **"Roda sem build" preservado (inegociável).** O `SessionStart` e o `tools:doctor` nunca podem
95
+ depender de `dist/` nem de `node_modules` para funcionar em dev. É o NFR que mata ou aprova o
96
+ design (AC-1).
97
+ - **`dist/` nunca mente.** Coberto pelo `build-fresh` (AC-2). Sem esse check, a migração reintroduz
98
+ a classe do ADR-0021 — e aí não vale a pena.
99
+ - **Verde contínuo.** Renomeação leaf-first, suíte verde a cada arquivo. Nada de big-bang.
100
+ - **Zero dependência de runtime nova.** `typescript` é `devDependency` (só o build a usa); o pacote
101
+ publicado continua com uma dependência de runtime (`better-sqlite3`).
102
+
103
+ ## 7. Riscos e mitigação
104
+
105
+ | Risco | Prob | Impacto | Mitigação |
106
+ |---|---|---|---|
107
+ | `dist/` publicado defasado da fonte | M | **A** | `build-fresh` no `release:check` (AC-2) — a classe do ADR-0021, fechada |
108
+ | Hook passa a exigir build/`dist` em dev | M | A | Runtime duplo: dev roda `.ts` nativo; `dist/` só no tarball (AC-1). NFR de bloqueio |
109
+ | `bin` aponta pra `dist/` e dev roda sem build | M | M | Dev usa `node bin/forja.ts` / script; `bin` do published → `dist/` |
110
+ | Migração big-bang quebra tudo de uma vez | M | A | `checkJs` primeiro, renomeia leaf-first, verde a cada passo (AC-3, AC-8) |
111
+ | `node --test` não roda `.ts` | B | A | Confirmar cedo; Node novo roda `.ts` de teste nativo (mesmo strip) |
112
+ | `strict` acusa centenas de erros de uma vez | M | M | On-ramp `checkJs` isola os erros antes da renomeação; corrige incremental |
113
+
114
+ ## 8. Métricas de sucesso
115
+
116
+ - Um `probe` com a forma errada **não compila** — o contrato dos checks deixou de ser convenção.
117
+ - `dist/` publicado é sempre igual ao `src/` compilado, provado pelo `build-fresh` a cada release.
118
+ - O `tools:doctor` e o `SessionStart` seguem rodando **sem build** em dev — o NFR inegociável, medido.
119
+ - Consumidores do `forjajs` recebem `.d.ts` — a API deixa de ser adivinhação.
@@ -0,0 +1,110 @@
1
+ # Tasks: ts-migration
2
+
3
+ - **Spec**: ./spec.md
4
+ - **Plan**: ./plan.md
5
+ - **Status**: approved
6
+ - **Criado em**: 2026-07-18
7
+
8
+ > Decomposição executável. Cada task tem dono claro, critério de done e referência a arquivos.
9
+
10
+ Ordem das fases do plano §7. As Fases 0 e 1 (T1-T2) são o destravador de menor risco: provam a
11
+ arquitetura **sem** renomear nada. A renomeação (T3) só começa com elas verdes.
12
+
13
+ ---
14
+
15
+ ## T1 — Fase 0: on-ramp `checkJs`
16
+ - **Owner**: Worker
17
+ - **Estimativa**: M
18
+ - **Depende de**: —
19
+ - **Paths**: `tsconfig.json`, `lib/core/registry.mjs`, `package.json`, `.github/workflows/ci.yml`
20
+ - **Escopo**: liga o type-check sobre os `.mjs` atuais. **Nada é renomeado.** Mede o tamanho real
21
+ do problema de tipos antes de comprometer a migração.
22
+ - **Done quando**:
23
+ - [ ] `tsconfig.json`: `allowJs, checkJs, strict, noEmit, module/moduleResolution` nodenext
24
+ - [ ] `typescript` em `devDependencies` (≥ 5.7, por D6)
25
+ - [ ] `types:check` no registry (`tsc --noEmit`) e como step do CI
26
+ - [ ] Os erros de tipo apontados são **corrigidos com os arquivos ainda `.mjs`** (ou anotados com
27
+ `@ts-expect-error` pontual se `strict` for poço sem fundo — kill criteria §8)
28
+ - [ ] `npm test` verde, `types:check` verde
29
+
30
+ ## T2 — Fase 1: resolver extension-agnostic
31
+ - **Owner**: Worker
32
+ - **Estimativa**: M
33
+ - **Depende de**: T1
34
+ - **Paths**: `lib/core/registry.mjs`, `bin/forja.mjs`, `lib/core/release.mjs`, `test/forja-core.test.js`
35
+ - **Escopo**: a **única** mudança de comportamento da migração, isolada e **ainda em `.mjs`**. Se
36
+ algo quebrar aqui, é o resolver — não a renomeação.
37
+ - **Done quando**:
38
+ - [ ] Registry: `node:` sem extensão (`scripts/tools-doctor`, não `.mjs`) — D2
39
+ - [ ] Dispatch (`bin/forja.mjs`): resolve `cmd.node` tentando `.ts → .js → .mjs`, a 1ª que existe
40
+ - [ ] `registry-scripts` (release.mjs) resolve extension-agnostic também — hoje casa a extensão
41
+ - [ ] `smoke-commands` (release.mjs) usa o campo `bin` do package.json, não path fixo — D7
42
+ - [ ] Teste: um comando roda com o registry sem extensão; `test/forja-core.test.js` verde
43
+ - [ ] `npm test` + `tools:doctor` + `release:check` verdes
44
+
45
+ ## T3 — Fase 2: renomear leaf-first
46
+ - **Owner**: Worker
47
+ - **Estimativa**: G
48
+ - **Depende de**: T2
49
+ - **Paths**: `lib/`, `scripts/`, `bin/`, `.claude/settings.json`
50
+ - **Escopo**: renomear `.mjs/.js → .ts` na ordem de dependência, **verde a cada arquivo**. Migração
51
+ de tipos, não de lógica: nenhum teste muda de semântica (a rede de segurança, AC-7).
52
+ - **Ordem** (D5): `workspace → checks → registry → doc-graph → health → release → scripts/* → hooks
53
+ → bin/forja → generators`.
54
+ - **Done quando**:
55
+ - [ ] Cada módulo renomeado com imports `./x.ts` (D6); `npm test` verde após cada um
56
+ - [ ] `Check`/`Probe`/`Result`/`Env`/`Command` e o handoff de 7 campos viram tipos reais (AC-4)
57
+ - [ ] Hooks do `.claude/settings.json` apontam para `.ts` (dev roda nativo)
58
+ - [ ] Geradores: assinatura tipada; o conteúdo template-string permanece string
59
+ - [ ] Ao final: `npm test`, `tools:doctor`, `spec:check` verdes; nenhum `.mjs`/`.js` de código
60
+ remanescente em `lib`/`scripts`/`bin`
61
+
62
+ ## T4 — Fase 3: build + dist + build-fresh
63
+ - **Owner**: Worker
64
+ - **Estimativa**: M
65
+ - **Depende de**: T3
66
+ - **Paths**: `tsconfig.json`, `package.json`, `lib/core/release.ts`, `.gitignore`, CI
67
+ - **Done quando**:
68
+ - [ ] `tsconfig`: `outDir: dist`, `rootDir: .`, `declaration: true`, `rewriteRelativeImportExtensions`
69
+ - [ ] `scripts.build` = `tsc`; `dist/` espelha a árvore (`dist/bin`, `dist/lib`, `dist/scripts`)
70
+ - [ ] `package.json`: `bin`/`main`/`types`/`exports` → `dist/`; `files[]` troca código por `dist/`
71
+ - [ ] **`build-fresh`** no `RELEASE_CHECKS` (D4): recompila num temp, faz diff com `dist/` commitado,
72
+ reprova defasado com `fix: npm run build`
73
+ - [ ] `prepublishOnly` = `npm run build && release:check -- --publish` (ordem, sem recursão — D7/ADR-0024)
74
+ - [ ] Decidir e registrar: `dist/` versionado (commitado) vs gerado no publish. Se versionado, o
75
+ `build-fresh` o guarda; se gerado, o `prepublishOnly` o produz. **Um ou outro, não os dois**
76
+ - [ ] `release:check --publish` aprova; `npm publish --dry-run` monta o tarball com `dist/`
77
+
78
+ ## T5 — ADR-0026 e docs
79
+ - **Owner**: SDD Architect + Worker
80
+ - **Estimativa**: P
81
+ - **Depende de**: T2, T4
82
+ - **Paths**: `memory/90-decisions/0026-*.md`, `docs/`, `CONTRIBUTING.md`, `CLAUDE.md`
83
+ - **Done quando**:
84
+ - [ ] ADR-0026 registra D2 (registry sem extensão), D3 (runtime duplo) e D4 (`build-fresh`);
85
+ referencia ADR-0021 (NFR "roda sem build" + classe "dist mente") e ADR-0024
86
+ - [ ] `CONTRIBUTING`/`docs`: "dev roda `.ts` nativo (Node novo); publicado roda `dist/`"
87
+ - [ ] `CLAUDE.md`: comando de dev atualizado se mudou (`node bin/forja.ts`)
88
+
89
+ ## T6 — Prova final (Governance)
90
+ - **Owner**: Governance
91
+ - **Estimativa**: P
92
+ - **Depende de**: T4, T5
93
+ - **Done quando**:
94
+ - [ ] `release:check --publish` aprova o tarball com `dist/` fresco
95
+ - [ ] **Reintroduzir um `dist/` defasado** (editar `src`, não rebuildar) e confirmar que o
96
+ `build-fresh` **reprova** — o gate que nunca viu a falha que promete pegar não está testado
97
+ - [ ] O hook `SessionStart` roda **sem `dist/` e sem build** em dev (o NFR inegociável, medido)
98
+ - [ ] `npm test`, `project:check`, `tools:doctor`, `gitleaks` verdes; spec → `done`
99
+
100
+ ---
101
+
102
+ ## Nota de sequência
103
+ As Fases 0-1 (T1-T2) podem ir num PR próprio — provam a arquitetura (checkJs + resolver) sem tocar
104
+ em extensão de arquivo, e são revertíveis com baixo custo. A renomeação (T3) é o commit grande; vale
105
+ PR separado. T4 (build/publish) é o de maior risco de release — vai por último, com o `build-fresh`
106
+ como rede.
107
+
108
+ ## Handoffs entre agentes
109
+ Worker (T1-T4), SDD Architect (T5), Governance (T6). Handoff a cada fronteira via `forja agent:route`
110
+ — 7 campos (ADR-0005).