mddd-cli 1.0.0 → 1.0.1
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/package.json +3 -3
- package/readme.md +42 -3
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mddd-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "CLI oficial para Mermaid Diagram Driven Development (MDDD) modular, colocalizado e versionado.",
|
|
5
5
|
"main": "bin/cli.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
8
|
-
"md": "
|
|
8
|
+
"md": "bin/cli.js"
|
|
9
9
|
},
|
|
10
10
|
"files": [
|
|
11
11
|
"bin/"
|
|
@@ -40,4 +40,4 @@
|
|
|
40
40
|
"commander": "^12.0.0",
|
|
41
41
|
"picocolors": "^1.0.0"
|
|
42
42
|
}
|
|
43
|
-
}
|
|
43
|
+
}
|
package/readme.md
CHANGED
|
@@ -17,11 +17,47 @@ No **Mermaid Diagram Driven Development**, invertemos o ciclo tradicional de des
|
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## 📥 Instalação
|
|
21
21
|
|
|
22
|
+
Como o pacote está publicado no NPM, a instalação é global e simples:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Instalação global
|
|
26
|
+
npm install -g mddd-cli
|
|
27
|
+
Nota: Certifique-se de ter o Node.js v18 ou superior instalado em sua máquina.
|
|
28
|
+
|
|
29
|
+
🚀 Guia de Uso Rápido
|
|
30
|
+
O fluxo MDDD é baseado em comandos de CLI para gerenciar a estrutura e comandos de barra (/) para orquestrar a IA no chat.
|
|
31
|
+
|
|
32
|
+
1. Inicialize seu projeto
|
|
33
|
+
Na raiz do seu projeto, execute: md init
|
|
34
|
+
Isso criará o arquivo system_prompt.md na raiz, contendo as instruções globais que guiarão a IA no entendimento da metodologia MDDD.
|
|
35
|
+
|
|
36
|
+
2. Crie uma nova especificação (Feature)
|
|
37
|
+
Ao iniciar uma nova funcionalidade, crie o contrato visual dela:
|
|
38
|
+
# Para uma funcionalidade simples (micro)
|
|
39
|
+
md new src/feature-name
|
|
40
|
+
|
|
41
|
+
# Para um módulo completo (macro)
|
|
42
|
+
md new src/feature-name --macro
|
|
43
|
+
|
|
44
|
+
Isso gerará o arquivo feature-name.spec.md com a estrutura de Mermaid, Matriz de Decisão e Versionamento.
|
|
45
|
+
|
|
46
|
+
3. Auditoria de Legado
|
|
47
|
+
Precisa refatorar um código existente? Audite-o:
|
|
48
|
+
md audit src/path/to/legacy-file.dart
|
|
49
|
+
|
|
50
|
+
🤖 Comandos de Barra (Gatilhos para IAs)
|
|
51
|
+
Após rodar o md init, a sua IA passará a entender estes atalhos quando você os digitar no chat:
|
|
52
|
+
Comando Descrição
|
|
53
|
+
/md-new Inicia o modo de desenho para nova feature (gera diagrama e tabela).
|
|
54
|
+
/md-edit Solicita alteração em um .spec.md existente (incrementa versão semântica).
|
|
55
|
+
/md-audit Analisa código legado e propõe refatoração visual (Mermaid).
|
|
56
|
+
/md-impl Gera código e testes baseando-se estritamente no diagrama do .spec.md.
|
|
57
|
+
|
|
58
|
+
🏗️ Arquitetura de Especificação Colocalizada (Co-location)
|
|
22
59
|
As especificações visuais não ficam centralizadas em pastas distantes. Elas vivem no mesmo diretório do componente, tela ou feature que descrevem.
|
|
23
60
|
|
|
24
|
-
```text
|
|
25
61
|
src/
|
|
26
62
|
└── home/
|
|
27
63
|
├── home.spec.md # 🌎 MACRO: Visão global do módulo (stateDiagram-v2)
|
|
@@ -29,4 +65,7 @@ src/
|
|
|
29
65
|
│ ├── guest.spec.md # 🔬 MICRO: Fluxo de tela (graph LR) + Matriz de Decisão
|
|
30
66
|
│ └── guest_page.dart # 💻 Código produtivo gerado pela IA
|
|
31
67
|
└── consumer/
|
|
32
|
-
└── consumer.spec.md # 🔬 MICRO: Fluxo de tela (graph LR) + Matriz de Decisão
|
|
68
|
+
└── consumer.spec.md # 🔬 MICRO: Fluxo de tela (graph LR) + Matriz de Decisão
|
|
69
|
+
|
|
70
|
+
💬 Precisa de ajuda?
|
|
71
|
+
Se encontrar qualquer problema, abra uma Issue no GitHub.
|