@jeffersonfabriciodev/sdd-kit 1.0.1 → 1.0.2
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/README.md
CHANGED
|
@@ -1,16 +1,53 @@
|
|
|
1
1
|
# SDD Kit
|
|
2
2
|
|
|
3
|
-
>
|
|
4
|
-
|
|
5
|
-
## Uso rápido
|
|
3
|
+
> Framework operacional que estrutura o desenvolvimento assistido por IA em fases com artefatos persistidos — **Discovery → Spec → Test → Code** — para **Claude Code**, **Cursor** e **GitHub Copilot**.
|
|
6
4
|
|
|
7
5
|
```bash
|
|
8
6
|
npx @jeffersonfabriciodev/sdd-kit@latest init
|
|
9
7
|
```
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
## Por que existe
|
|
10
|
+
|
|
11
|
+
Mandar uma descrição no chat e colar o código gerado é rápido para protótipos, mas em projeto real vira dívida: sem descoberta do problema, sem spec, sem testes, sem decisões registradas, e contexto perdido a cada sessão.
|
|
12
|
+
|
|
13
|
+
O SDD Kit transforma a interação com IA em um processo disciplinado: cada fase produz um **artefato** que a próxima consome. Nada existe só na conversa — a spec é o contrato, o teste é a evidência, o ADR é a memória.
|
|
14
|
+
|
|
15
|
+
## Princípios
|
|
16
|
+
|
|
17
|
+
Seis princípios guiam o kit — três **disciplinas de processo** (a ordem do trabalho) e três **princípios de código** (como escrever).
|
|
18
|
+
|
|
19
|
+
### Disciplinas de processo
|
|
20
|
+
|
|
21
|
+
- **SDD** — *Spec-Driven Development*: a spec é o contrato. Código que diverge da spec é código errado — nenhuma linha antes da spec BDD aprovada.
|
|
22
|
+
- **BDD** — *Behavior-Driven Development*: requisitos como cenários `Given / When / Then`, escritos colaborativamente na **Roda de Spec** (produto + design + QA) — não na cabeça do engenheiro.
|
|
23
|
+
- **TDD** — *Test-Driven Development*: ciclo `RED → GREEN → REFACTOR`, um cenário por vez. O teste vem antes da implementação; não se avança sem o anterior verde.
|
|
24
|
+
|
|
25
|
+
### Princípios de código
|
|
26
|
+
|
|
27
|
+
- **YAGNI** — *You Aren't Gonna Need It*: não construa o que ainda não é necessário. "E se no futuro…" não é justificativa.
|
|
28
|
+
- **KISS** — *Keep It Simple*: a solução mais simples que atende à spec.
|
|
29
|
+
- **DRY** — *Don't Repeat Yourself*: regra de três — primeira vez escreva, segunda anote, terceira extraia.
|
|
30
|
+
|
|
31
|
+
> **Ordem de aplicação:** YAGNI filtra o escopo → KISS guia a primeira implementação → **SOLID** estrutura no refactor → DRY quando o padrão estabiliza.
|
|
32
|
+
|
|
33
|
+
Segurança não é uma fase separada — é uma **dimensão de cada cenário BDD** implementado (OWASP, secrets, PII).
|
|
34
|
+
|
|
35
|
+
## O ciclo de trabalho
|
|
36
|
+
|
|
37
|
+
```text
|
|
38
|
+
Produto & Design Engineer & QA
|
|
39
|
+
──────────────── ─────────────────
|
|
40
|
+
/discover → problema → decisão /implement → TDD por cenário (RED→GREEN→REFACTOR)
|
|
41
|
+
/spec → BDD + blueprint /review → qualidade (KISS/SOLID/DRY, anti-patterns)
|
|
42
|
+
+ tasks /security-review → OWASP, secrets, PII
|
|
43
|
+
/sync → mantém spec ↔ código alinhados
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
A spec aprovada é o contrato de entrega: **Produto & Design** define o *o quê*; **Engineer & QA** garante o *como*, a qualidade e a segurança.
|
|
47
|
+
|
|
48
|
+
## Uso
|
|
12
49
|
|
|
13
|
-
|
|
50
|
+
O `init` é interativo: escolhe a pasta, a ferramenta de IA e a política de memória, e gera a estrutura do SDD Kit no projeto — constituição, playbook, templates de spec/BDD, subagents, hooks (sensores) e os slash commands.
|
|
14
51
|
|
|
15
52
|
```bash
|
|
16
53
|
# Interativo (default)
|
|
@@ -26,11 +63,11 @@ npx @jeffersonfabriciodev/sdd-kit@latest init --tool cursor --dry-run
|
|
|
26
63
|
npx @jeffersonfabriciodev/sdd-kit@latest version
|
|
27
64
|
```
|
|
28
65
|
|
|
29
|
-
Ferramentas suportadas: `claude`, `cursor`, `copilot`.
|
|
66
|
+
Ferramentas suportadas: `claude`, `cursor`, `copilot`. A instalação é **não-destrutiva**: preserva sua memória de projeto e arquivos próprios; só atualiza os artefatos do framework.
|
|
30
67
|
|
|
31
68
|
## Como funciona
|
|
32
69
|
|
|
33
|
-
O pacote embute os binários do SDD Kit para todas as plataformas
|
|
70
|
+
O pacote embute os binários do SDD Kit para todas as plataformas (Linux, macOS, Windows × amd64/arm64). O `npx`/`npm` instala o pacote e o shim executa o binário da sua plataforma — **sem download em runtime, sem rede, funciona offline**.
|
|
34
71
|
|
|
35
72
|
- Node.js ≥ 18
|
|
36
73
|
|
package/bin/sdd-kit-darwin-amd64
CHANGED
|
Binary file
|
package/bin/sdd-kit-darwin-arm64
CHANGED
|
Binary file
|
package/bin/sdd-kit-linux-amd64
CHANGED
|
Binary file
|
package/bin/sdd-kit-linux-arm64
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jeffersonfabriciodev/sdd-kit",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "CLI que instala o framework SDD Kit (Spec-Driven Development) em qualquer projeto — Claude Code, Cursor ou GitHub Copilot",
|
|
5
5
|
"homepage": "https://github.com/JeffersonFabricio/sdd-kit#readme",
|
|
6
6
|
"repository": {
|