@luanpdd/kit-mcp 0.2.1 → 0.4.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/CHANGELOG.md +43 -1
- package/README.md +35 -18
- package/kit/COMANDOS.md +123 -0
- package/kit/agents/advisor-researcher.md +121 -0
- package/kit/agents/assumptions-analyzer.md +122 -0
- package/kit/agents/codebase-mapper.md +787 -0
- package/kit/agents/debugger.md +796 -0
- package/kit/agents/executor.md +516 -0
- package/kit/agents/integration-checker.md +217 -0
- package/kit/agents/nyquist-auditor.md +195 -0
- package/kit/agents/phase-researcher.md +715 -0
- package/kit/agents/plan-checker.md +289 -0
- package/kit/agents/planner.md +1373 -0
- package/kit/agents/project-researcher.md +671 -0
- package/kit/agents/research-synthesizer.md +259 -0
- package/kit/agents/roadmapper.md +696 -0
- package/kit/agents/ui-auditor.md +458 -0
- package/kit/agents/ui-checker.md +319 -0
- package/kit/agents/ui-researcher.md +374 -0
- package/kit/agents/user-profiler.md +183 -0
- package/kit/agents/verifier.md +719 -0
- package/kit/commands/adicionar-backlog.md +76 -0
- package/kit/commands/adicionar-fase.md +43 -0
- package/kit/commands/adicionar-tarefa.md +47 -0
- package/kit/commands/adicionar-testes.md +41 -0
- package/kit/commands/ajuda.md +22 -0
- package/kit/commands/atualizar.md +37 -0
- package/kit/commands/auditar-marco.md +36 -0
- package/kit/commands/auditar-uat.md +24 -0
- package/kit/commands/autonomo.md +41 -0
- package/kit/commands/branch-pr.md +25 -0
- package/kit/commands/concluir-marco.md +136 -0
- package/kit/commands/configuracoes.md +36 -0
- package/kit/commands/definir-perfil.md +12 -0
- package/kit/commands/depurar.md +173 -0
- package/kit/commands/discutir-fase.md +64 -0
- package/kit/commands/entrar-discord.md +18 -0
- package/kit/commands/estatisticas.md +18 -0
- package/kit/commands/executar-fase.md +59 -0
- package/kit/commands/expresso.md +47 -0
- package/kit/commands/fase-ui.md +34 -0
- package/kit/commands/fazer.md +30 -0
- package/kit/commands/fio.md +126 -0
- package/kit/commands/fluxos-trabalho.md +64 -0
- package/kit/commands/forense.md +56 -0
- package/kit/commands/gerenciador.md +39 -0
- package/kit/commands/inserir-fase.md +32 -0
- package/kit/commands/limpeza.md +18 -0
- package/kit/commands/listar-hipoteses-fase.md +46 -0
- package/kit/commands/listar-workspaces.md +19 -0
- package/kit/commands/mapear-codebase.md +71 -0
- package/kit/commands/nota.md +34 -0
- package/kit/commands/novo-marco.md +44 -0
- package/kit/commands/novo-projeto.md +42 -0
- package/kit/commands/novo-workspace.md +44 -0
- package/kit/commands/pausar-trabalho.md +38 -0
- package/kit/commands/perfil-usuario.md +46 -0
- package/kit/commands/pesquisar-fase.md +195 -0
- package/kit/commands/planejar-fase.md +47 -0
- package/kit/commands/planejar-lacunas.md +34 -0
- package/kit/commands/plantar-ideia.md +26 -0
- package/kit/commands/progresso.md +24 -0
- package/kit/commands/proximo.md +24 -0
- package/kit/commands/publicar.md +370 -0
- package/kit/commands/rapido.md +30 -0
- package/kit/commands/reaplicar-patches.md +124 -0
- package/kit/commands/relatorio-sessao.md +19 -0
- package/kit/commands/remover-fase.md +31 -0
- package/kit/commands/remover-workspace.md +26 -0
- package/kit/commands/resumo-marco.md +51 -0
- package/kit/commands/retomar-trabalho.md +40 -0
- package/kit/commands/revisar-backlog.md +60 -0
- package/kit/commands/revisar-ui.md +32 -0
- package/kit/commands/revisar.md +37 -0
- package/kit/commands/saude.md +22 -0
- package/kit/commands/setup-notion.md +93 -0
- package/kit/commands/sync-main.md +68 -0
- package/kit/commands/validar-fase.md +35 -0
- package/kit/commands/verificar-tarefas.md +45 -0
- package/kit/commands/verificar-trabalho.md +38 -0
- package/kit/file-manifest.json +219 -0
- package/kit/framework/VERSION +1 -0
- package/kit/framework/bin/lib/commands.cjs +959 -0
- package/kit/framework/bin/lib/config.cjs +442 -0
- package/kit/framework/bin/lib/core.cjs +1230 -0
- package/kit/framework/bin/lib/frontmatter.cjs +336 -0
- package/kit/framework/bin/lib/init.cjs +1442 -0
- package/kit/framework/bin/lib/milestone.cjs +252 -0
- package/kit/framework/bin/lib/model-profiles.cjs +68 -0
- package/kit/framework/bin/lib/phase.cjs +888 -0
- package/kit/framework/bin/lib/profile-output.cjs +952 -0
- package/kit/framework/bin/lib/profile-pipeline.cjs +539 -0
- package/kit/framework/bin/lib/roadmap.cjs +329 -0
- package/kit/framework/bin/lib/security.cjs +382 -0
- package/kit/framework/bin/lib/state.cjs +1031 -0
- package/kit/framework/bin/lib/template.cjs +222 -0
- package/kit/framework/bin/lib/uat.cjs +282 -0
- package/kit/framework/bin/lib/verify.cjs +888 -0
- package/kit/framework/bin/lib/workstream.cjs +491 -0
- package/kit/framework/bin/tools.cjs +918 -0
- package/kit/framework/commands/workstreams.md +63 -0
- package/kit/framework/references/checkpoints.md +778 -0
- package/kit/framework/references/continuation-format.md +249 -0
- package/kit/framework/references/decimal-phase-calculation.md +64 -0
- package/kit/framework/references/git-integration.md +295 -0
- package/kit/framework/references/git-planning-commit.md +38 -0
- package/kit/framework/references/model-profile-resolution.md +36 -0
- package/kit/framework/references/model-profiles.md +139 -0
- package/kit/framework/references/phase-argument-parsing.md +61 -0
- package/kit/framework/references/planning-config.md +202 -0
- package/kit/framework/references/questioning.md +162 -0
- package/kit/framework/references/tdd.md +263 -0
- package/kit/framework/references/ui-brand.md +160 -0
- package/kit/framework/references/user-profiling.md +657 -0
- package/kit/framework/references/verification-patterns.md +612 -0
- package/kit/framework/references/workstream-flag.md +58 -0
- package/kit/framework/templates/DEBUG.md +164 -0
- package/kit/framework/templates/UAT.md +265 -0
- package/kit/framework/templates/UI-SPEC.md +100 -0
- package/kit/framework/templates/VALIDATION.md +76 -0
- package/kit/framework/templates/claude-md.md +122 -0
- package/kit/framework/templates/codebase/architecture.md +185 -0
- package/kit/framework/templates/codebase/concerns.md +205 -0
- package/kit/framework/templates/codebase/conventions.md +204 -0
- package/kit/framework/templates/codebase/integrations.md +192 -0
- package/kit/framework/templates/codebase/stack.md +158 -0
- package/kit/framework/templates/codebase/structure.md +199 -0
- package/kit/framework/templates/codebase/testing.md +301 -0
- package/kit/framework/templates/config.json +44 -0
- package/kit/framework/templates/context.md +352 -0
- package/kit/framework/templates/continue-here.md +78 -0
- package/kit/framework/templates/copilot-instructions.md +7 -0
- package/kit/framework/templates/debug-subagent-prompt.md +91 -0
- package/kit/framework/templates/dev-preferences.md +20 -0
- package/kit/framework/templates/discovery.md +146 -0
- package/kit/framework/templates/discussion-log.md +63 -0
- package/kit/framework/templates/milestone-archive.md +123 -0
- package/kit/framework/templates/milestone.md +115 -0
- package/kit/framework/templates/phase-prompt.md +610 -0
- package/kit/framework/templates/planner-subagent-prompt.md +117 -0
- package/kit/framework/templates/project.md +186 -0
- package/kit/framework/templates/requirements.md +231 -0
- package/kit/framework/templates/research-project/ARCHITECTURE.md +204 -0
- package/kit/framework/templates/research-project/FEATURES.md +147 -0
- package/kit/framework/templates/research-project/PITFALLS.md +200 -0
- package/kit/framework/templates/research-project/STACK.md +120 -0
- package/kit/framework/templates/research-project/SUMMARY.md +170 -0
- package/kit/framework/templates/research.md +419 -0
- package/kit/framework/templates/retrospective.md +54 -0
- package/kit/framework/templates/roadmap.md +202 -0
- package/kit/framework/templates/state.md +176 -0
- package/kit/framework/templates/summary-complex.md +59 -0
- package/kit/framework/templates/summary-minimal.md +41 -0
- package/kit/framework/templates/summary-standard.md +48 -0
- package/kit/framework/templates/summary.md +209 -0
- package/kit/framework/templates/user-profile.md +146 -0
- package/kit/framework/templates/user-setup.md +256 -0
- package/kit/framework/templates/verification-report.md +258 -0
- package/kit/framework/workflows/add-phase.md +112 -0
- package/kit/framework/workflows/add-tests.md +351 -0
- package/kit/framework/workflows/add-todo.md +158 -0
- package/kit/framework/workflows/audit-milestone.md +340 -0
- package/kit/framework/workflows/audit-uat.md +109 -0
- package/kit/framework/workflows/autonomous.md +891 -0
- package/kit/framework/workflows/check-todos.md +177 -0
- package/kit/framework/workflows/cleanup.md +152 -0
- package/kit/framework/workflows/complete-milestone.md +696 -0
- package/kit/framework/workflows/diagnose-issues.md +231 -0
- package/kit/framework/workflows/discovery-phase.md +289 -0
- package/kit/framework/workflows/discuss-phase-assumptions.md +653 -0
- package/kit/framework/workflows/discuss-phase.md +1049 -0
- package/kit/framework/workflows/do.md +104 -0
- package/kit/framework/workflows/execute-phase.md +838 -0
- package/kit/framework/workflows/execute-plan.md +510 -0
- package/kit/framework/workflows/fast.md +102 -0
- package/kit/framework/workflows/forensics.md +265 -0
- package/kit/framework/workflows/health.md +181 -0
- package/kit/framework/workflows/help.md +606 -0
- package/kit/framework/workflows/insert-phase.md +130 -0
- package/kit/framework/workflows/list-phase-assumptions.md +178 -0
- package/kit/framework/workflows/list-workspaces.md +56 -0
- package/kit/framework/workflows/manager.md +362 -0
- package/kit/framework/workflows/map-codebase.md +377 -0
- package/kit/framework/workflows/milestone-summary.md +223 -0
- package/kit/framework/workflows/new-milestone.md +486 -0
- package/kit/framework/workflows/new-project.md +1250 -0
- package/kit/framework/workflows/new-workspace.md +237 -0
- package/kit/framework/workflows/next.md +97 -0
- package/kit/framework/workflows/node-repair.md +92 -0
- package/kit/framework/workflows/note.md +156 -0
- package/kit/framework/workflows/pause-work.md +176 -0
- package/kit/framework/workflows/plan-milestone-gaps.md +273 -0
- package/kit/framework/workflows/plan-phase.md +859 -0
- package/kit/framework/workflows/plant-seed.md +169 -0
- package/kit/framework/workflows/pr-branch.md +129 -0
- package/kit/framework/workflows/profile-user.md +450 -0
- package/kit/framework/workflows/progress.md +507 -0
- package/kit/framework/workflows/quick.md +757 -0
- package/kit/framework/workflows/remove-phase.md +155 -0
- package/kit/framework/workflows/remove-workspace.md +90 -0
- package/kit/framework/workflows/research-phase.md +82 -0
- package/kit/framework/workflows/resume-project.md +326 -0
- package/kit/framework/workflows/review.md +228 -0
- package/kit/framework/workflows/session-report.md +146 -0
- package/kit/framework/workflows/settings.md +283 -0
- package/kit/framework/workflows/ship.md +228 -0
- package/kit/framework/workflows/stats.md +60 -0
- package/kit/framework/workflows/transition.md +671 -0
- package/kit/framework/workflows/ui-phase.md +302 -0
- package/kit/framework/workflows/ui-review.md +165 -0
- package/kit/framework/workflows/update.md +323 -0
- package/kit/framework/workflows/validate-phase.md +174 -0
- package/kit/framework/workflows/verify-phase.md +252 -0
- package/kit/framework/workflows/verify-work.md +637 -0
- package/kit/hooks/check-update.js +114 -0
- package/kit/hooks/context-monitor.js +156 -0
- package/kit/hooks/prompt-guard.js +96 -0
- package/kit/hooks/statusline.js +119 -0
- package/kit/hooks/workflow-guard.js +94 -0
- package/kit/settings.json +45 -0
- package/package.json +1 -1
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Template CLAUDE.md
|
|
2
|
+
|
|
3
|
+
Template para `CLAUDE.md` na raiz do projeto — gerado automaticamente por `tools generate-claude-md`.
|
|
4
|
+
|
|
5
|
+
Contém 6 seções delimitadas por marcadores. Cada seção é atualizável independentemente.
|
|
6
|
+
O subcomando `generate-claude-md` gerencia 5 seções (project, stack, conventions, architecture, workflow enforcement).
|
|
7
|
+
A seção de perfil é gerenciada exclusivamente por `generate-claude-profile`.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Templates de Seção
|
|
12
|
+
|
|
13
|
+
### Seção Project
|
|
14
|
+
```
|
|
15
|
+
<!-- framework:project-start source:PROJECT.md -->
|
|
16
|
+
## Project
|
|
17
|
+
|
|
18
|
+
{{project_content}}
|
|
19
|
+
<!-- framework:project-end -->
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Texto de fallback:**
|
|
23
|
+
```
|
|
24
|
+
Project not yet initialized. Run /novo-projeto to set up.
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Seção Stack
|
|
28
|
+
```
|
|
29
|
+
<!-- framework:stack-start source:STACK.md -->
|
|
30
|
+
## Technology Stack
|
|
31
|
+
|
|
32
|
+
{{stack_content}}
|
|
33
|
+
<!-- framework:stack-end -->
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Texto de fallback:**
|
|
37
|
+
```
|
|
38
|
+
Technology stack not yet documented. Will populate after codebase mapping or first phase.
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Seção Conventions
|
|
42
|
+
```
|
|
43
|
+
<!-- framework:conventions-start source:CONVENTIONS.md -->
|
|
44
|
+
## Conventions
|
|
45
|
+
|
|
46
|
+
{{conventions_content}}
|
|
47
|
+
<!-- framework:conventions-end -->
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**Texto de fallback:**
|
|
51
|
+
```
|
|
52
|
+
Conventions not yet established. Will populate as patterns emerge during development.
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Seção Architecture
|
|
56
|
+
```
|
|
57
|
+
<!-- framework:architecture-start source:ARCHITECTURE.md -->
|
|
58
|
+
## Architecture
|
|
59
|
+
|
|
60
|
+
{{architecture_content}}
|
|
61
|
+
<!-- framework:architecture-end -->
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Texto de fallback:**
|
|
65
|
+
```
|
|
66
|
+
Architecture not yet mapped. Follow existing patterns found in the codebase.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Seção Workflow Enforcement
|
|
70
|
+
```
|
|
71
|
+
<!-- framework:workflow-start source:framework defaults -->
|
|
72
|
+
## framework Workflow Enforcement
|
|
73
|
+
|
|
74
|
+
Before using Edit, Write, or other file-changing tools, start work through a framework command so planning artifacts and execution context stay in sync.
|
|
75
|
+
|
|
76
|
+
Use these entry points:
|
|
77
|
+
- `/quick` for small fixes, doc updates, and ad-hoc tasks
|
|
78
|
+
- `/debug` for investigation and bug fixing
|
|
79
|
+
- `/executar-fase` for planned phase work
|
|
80
|
+
|
|
81
|
+
Do not make direct repo edits outside a framework workflow unless the user explicitly asks to bypass it.
|
|
82
|
+
<!-- framework:workflow-end -->
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Seção Profile (Apenas Placeholder)
|
|
86
|
+
```
|
|
87
|
+
<!-- framework:profile-start -->
|
|
88
|
+
## Developer Profile
|
|
89
|
+
|
|
90
|
+
> Profile not yet configured. Run `/profile-user` to generate your developer profile.
|
|
91
|
+
> This section is managed by `generate-claude-profile` — do not edit manually.
|
|
92
|
+
<!-- framework:profile-end -->
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
**Nota:** Esta seção NÃO é gerenciada por `generate-claude-md`. É gerenciada exclusivamente
|
|
96
|
+
por `generate-claude-profile`. O placeholder acima é usado apenas ao criar um novo
|
|
97
|
+
arquivo CLAUDE.md quando ainda não existe seção de perfil.
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Ordem das Seções
|
|
102
|
+
|
|
103
|
+
1. **Project** — Identidade e propósito (o que é este projeto)
|
|
104
|
+
2. **Stack** — Escolhas de tecnologia (quais ferramentas são usadas)
|
|
105
|
+
3. **Conventions** — Padrões de código e regras (como o código é escrito)
|
|
106
|
+
4. **Architecture** — Estrutura do sistema (como os componentes se encaixam)
|
|
107
|
+
5. **Workflow Enforcement** — Pontos de entrada framework padrão para trabalho que altera arquivos
|
|
108
|
+
6. **Profile** — Preferências comportamentais do desenvolvedor (como interagir)
|
|
109
|
+
|
|
110
|
+
## Formato dos Marcadores
|
|
111
|
+
|
|
112
|
+
- Início: `<!-- framework:{name}-start source:{file} -->`
|
|
113
|
+
- Fim: `<!-- framework:{name}-end -->`
|
|
114
|
+
- Atributo source permite atualizações direcionadas quando arquivos fonte mudam
|
|
115
|
+
- Correspondência parcial no marcador de início (sem `-->` de fechamento) para detecção
|
|
116
|
+
|
|
117
|
+
## Comportamento de Fallback
|
|
118
|
+
|
|
119
|
+
Quando um arquivo fonte está faltando, o texto de fallback fornece orientação acionável para o Claude:
|
|
120
|
+
- Orienta o comportamento do Claude na ausência de dados
|
|
121
|
+
- Não são avisos de "faltando" ou placeholders
|
|
122
|
+
- Cada fallback diz ao Claude o que fazer, não apenas o que está ausente
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# Template de Arquitetura
|
|
2
|
+
|
|
3
|
+
Template para `.planning/codebase/ARCHITECTURE.md` - captura a organização conceitual do código.
|
|
4
|
+
|
|
5
|
+
**Propósito:** Documentar como o código está organizado em nível conceitual. Complementa STRUCTURE.md (que mostra localizações físicas de arquivos).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Template do Arquivo
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Arquitetura
|
|
13
|
+
|
|
14
|
+
**Data da Análise:** [AAAA-MM-DD]
|
|
15
|
+
|
|
16
|
+
## Visão Geral do Padrão
|
|
17
|
+
|
|
18
|
+
**Geral:** [Nome do padrão: ex.: "CLI Monolítico", "API Serverless", "MVC Full-stack"]
|
|
19
|
+
|
|
20
|
+
**Características Chave:**
|
|
21
|
+
- [Característica 1: ex.: "Executável único"]
|
|
22
|
+
- [Característica 2: ex.: "Tratamento de requisições stateless"]
|
|
23
|
+
- [Característica 3: ex.: "Orientado a eventos"]
|
|
24
|
+
|
|
25
|
+
## Camadas
|
|
26
|
+
|
|
27
|
+
[Descreva as camadas conceituais e suas responsabilidades]
|
|
28
|
+
|
|
29
|
+
**[Nome da Camada]:**
|
|
30
|
+
- Propósito: [O que esta camada faz]
|
|
31
|
+
- Contém: [Tipos de código: ex.: "route handlers", "lógica de negócio"]
|
|
32
|
+
- Depende de: [O que usa: ex.: "apenas camada de dados"]
|
|
33
|
+
- Usado por: [O que o usa: ex.: "rotas da API"]
|
|
34
|
+
|
|
35
|
+
**[Nome da Camada]:**
|
|
36
|
+
- Propósito: [O que esta camada faz]
|
|
37
|
+
- Contém: [Tipos de código]
|
|
38
|
+
- Depende de: [O que usa]
|
|
39
|
+
- Usado por: [O que o usa]
|
|
40
|
+
|
|
41
|
+
## Fluxo de Dados
|
|
42
|
+
|
|
43
|
+
[Descreva o ciclo de vida típico de requisição/execução]
|
|
44
|
+
|
|
45
|
+
**[Nome do Fluxo] (ex.: "Requisição HTTP", "Comando CLI", "Processamento de Evento"):**
|
|
46
|
+
|
|
47
|
+
1. [Ponto de entrada: ex.: "Usuário executa comando"]
|
|
48
|
+
2. [Etapa de processamento: ex.: "Router corresponde ao caminho"]
|
|
49
|
+
3. [Etapa de processamento: ex.: "Controller valida entrada"]
|
|
50
|
+
4. [Etapa de processamento: ex.: "Service executa lógica"]
|
|
51
|
+
5. [Saída: ex.: "Resposta retornada"]
|
|
52
|
+
|
|
53
|
+
**Gerenciamento de Estado:**
|
|
54
|
+
- [Como o estado é tratado: ex.: "Stateless - sem estado persistente", "Banco por requisição", "Cache em memória"]
|
|
55
|
+
|
|
56
|
+
## Abstrações Chave
|
|
57
|
+
|
|
58
|
+
[Conceitos/padrões centrais usados em todo o codebase]
|
|
59
|
+
|
|
60
|
+
**[Nome da Abstração]:**
|
|
61
|
+
- Propósito: [O que representa]
|
|
62
|
+
- Exemplos: [ex.: "UserService, ProjectService"]
|
|
63
|
+
- Padrão: [ex.: "Singleton", "Factory", "Repository"]
|
|
64
|
+
|
|
65
|
+
**[Nome da Abstração]:**
|
|
66
|
+
- Propósito: [O que representa]
|
|
67
|
+
- Exemplos: [Exemplos concretos]
|
|
68
|
+
- Padrão: [Padrão usado]
|
|
69
|
+
|
|
70
|
+
## Pontos de Entrada
|
|
71
|
+
|
|
72
|
+
[Onde a execução começa]
|
|
73
|
+
|
|
74
|
+
**[Ponto de Entrada]:**
|
|
75
|
+
- Localização: [Breve: ex.: "src/index.ts", "API Gateway triggers"]
|
|
76
|
+
- Gatilhos: [O que o invoca: ex.: "invocação CLI", "requisição HTTP"]
|
|
77
|
+
- Responsabilidades: [O que faz: ex.: "Analisar args, rotear para comando"]
|
|
78
|
+
|
|
79
|
+
## Tratamento de Erros
|
|
80
|
+
|
|
81
|
+
**Estratégia:** [Como erros são tratados: ex.: "Exception bubbling para handler de nível superior", "Middleware de erro por rota"]
|
|
82
|
+
|
|
83
|
+
**Padrões:**
|
|
84
|
+
- [Padrão: ex.: "try/catch no nível do controller"]
|
|
85
|
+
- [Padrão: ex.: "Códigos de erro retornados ao usuário"]
|
|
86
|
+
|
|
87
|
+
## Preocupações Transversais
|
|
88
|
+
|
|
89
|
+
[Aspectos que afetam múltiplas camadas]
|
|
90
|
+
|
|
91
|
+
**Logging:**
|
|
92
|
+
- [Abordagem: ex.: "Winston logger, injetado por requisição"]
|
|
93
|
+
|
|
94
|
+
**Validação:**
|
|
95
|
+
- [Abordagem: ex.: "Schemas Zod no limite da API"]
|
|
96
|
+
|
|
97
|
+
**Autenticação:**
|
|
98
|
+
- [Abordagem: ex.: "Middleware JWT em rotas protegidas"]
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
*Análise de arquitetura: [data]*
|
|
103
|
+
*Atualizar quando padrões principais mudarem*
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
<good_examples>
|
|
107
|
+
```markdown
|
|
108
|
+
# Architecture
|
|
109
|
+
|
|
110
|
+
**Analysis Date:** 2025-01-20
|
|
111
|
+
|
|
112
|
+
## Pattern Overview
|
|
113
|
+
|
|
114
|
+
**Overall:** CLI Application with Plugin System
|
|
115
|
+
|
|
116
|
+
**Key Characteristics:**
|
|
117
|
+
- Single executable with subcommands
|
|
118
|
+
- Plugin-based extensibility
|
|
119
|
+
- File-based state (no database)
|
|
120
|
+
- Synchronous execution model
|
|
121
|
+
|
|
122
|
+
## Layers
|
|
123
|
+
|
|
124
|
+
**Command Layer:**
|
|
125
|
+
- Purpose: Parse user input and route to appropriate handler
|
|
126
|
+
- Contains: Command definitions, argument parsing, help text
|
|
127
|
+
- Location: `src/commands/*.ts`
|
|
128
|
+
- Depends on: Service layer for business logic
|
|
129
|
+
- Used by: CLI entry point (`src/index.ts`)
|
|
130
|
+
|
|
131
|
+
**Service Layer:**
|
|
132
|
+
- Purpose: Core business logic
|
|
133
|
+
- Contains: FileService, TemplateService, InstallService
|
|
134
|
+
- Location: `src/services/*.ts`
|
|
135
|
+
- Depends on: File system utilities, external tools
|
|
136
|
+
- Used by: Command handlers
|
|
137
|
+
|
|
138
|
+
## Error Handling
|
|
139
|
+
|
|
140
|
+
**Strategy:** Throw exceptions, catch at command level, log and exit
|
|
141
|
+
|
|
142
|
+
**Patterns:**
|
|
143
|
+
- Services throw Error with descriptive messages
|
|
144
|
+
- Command handlers catch, log error to stderr, exit(1)
|
|
145
|
+
- Validation errors shown before execution (fail fast)
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
*Architecture analysis: 2025-01-20*
|
|
150
|
+
*Update when major patterns change*
|
|
151
|
+
```
|
|
152
|
+
</good_examples>
|
|
153
|
+
|
|
154
|
+
<guidelines>
|
|
155
|
+
**O que pertence ao ARCHITECTURE.md:**
|
|
156
|
+
- Padrão arquitetural geral (monolito, microsserviços, em camadas, etc.)
|
|
157
|
+
- Camadas conceituais e seus relacionamentos
|
|
158
|
+
- Fluxo de dados / ciclo de vida da requisição
|
|
159
|
+
- Abstrações e padrões chave
|
|
160
|
+
- Pontos de entrada
|
|
161
|
+
- Estratégia de tratamento de erros
|
|
162
|
+
- Preocupações transversais (logging, auth, validação)
|
|
163
|
+
|
|
164
|
+
**O que NÃO pertence aqui:**
|
|
165
|
+
- Listas exaustivas de arquivos (isso é STRUCTURE.md)
|
|
166
|
+
- Escolhas tecnológicas (isso é STACK.md)
|
|
167
|
+
- Percurso linha a linha do código (diferir para leitura do código)
|
|
168
|
+
- Detalhes de implementação de funcionalidades específicas
|
|
169
|
+
|
|
170
|
+
**Caminhos de arquivo SÃO bem-vindos:**
|
|
171
|
+
Inclua caminhos de arquivo como exemplos concretos de abstrações. Use formatação backtick: `src/services/user.ts`. Isso torna o documento de arquitetura acionável para o Claude durante o planejamento.
|
|
172
|
+
|
|
173
|
+
**Ao preencher este template:**
|
|
174
|
+
- Ler os principais pontos de entrada (index, server, main)
|
|
175
|
+
- Identificar camadas lendo imports/dependências
|
|
176
|
+
- Rastrear uma execução típica de requisição/comando
|
|
177
|
+
- Notar padrões recorrentes (services, controllers, repositories)
|
|
178
|
+
- Manter descrições conceituais, não mecânicas
|
|
179
|
+
|
|
180
|
+
**Útil para planejamento de fases quando:**
|
|
181
|
+
- Adicionando novas funcionalidades (onde se encaixa nas camadas?)
|
|
182
|
+
- Refatorando (entendendo padrões atuais)
|
|
183
|
+
- Identificando onde adicionar código (qual camada trata X?)
|
|
184
|
+
- Entendendo dependências entre componentes
|
|
185
|
+
</guidelines>
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
# Template de Preocupações do Codebase
|
|
2
|
+
|
|
3
|
+
Template para `.planning/codebase/CONCERNS.md` - captura problemas conhecidos e áreas que requerem cuidado.
|
|
4
|
+
|
|
5
|
+
**Propósito:** Apresentar avisos acionáveis sobre o codebase. Focado em "o que observar ao fazer mudanças."
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Template do Arquivo
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Preocupações do Codebase
|
|
13
|
+
|
|
14
|
+
**Data da Análise:** [AAAA-MM-DD]
|
|
15
|
+
|
|
16
|
+
## Dívida Técnica
|
|
17
|
+
|
|
18
|
+
**[Área/Componente]:**
|
|
19
|
+
- Problema: [Qual é o atalho/solução paliativa]
|
|
20
|
+
- Por quê: [Por que foi feito assim]
|
|
21
|
+
- Impacto: [O que quebra ou degrada por causa disso]
|
|
22
|
+
- Abordagem de correção: [Como endereçar adequadamente]
|
|
23
|
+
|
|
24
|
+
**[Área/Componente]:**
|
|
25
|
+
- Problema: [Qual é o atalho/solução paliativa]
|
|
26
|
+
- Por quê: [Por que foi feito assim]
|
|
27
|
+
- Impacto: [O que quebra ou degrada por causa disso]
|
|
28
|
+
- Abordagem de correção: [Como endereçar adequadamente]
|
|
29
|
+
|
|
30
|
+
## Bugs Conhecidos
|
|
31
|
+
|
|
32
|
+
**[Descrição do bug]:**
|
|
33
|
+
- Sintomas: [O que acontece]
|
|
34
|
+
- Gatilho: [Como reproduzir]
|
|
35
|
+
- Contorno: [Mitigação temporária, se houver]
|
|
36
|
+
- Causa raiz: [Se conhecida]
|
|
37
|
+
- Bloqueado por: [Se aguardando algo]
|
|
38
|
+
|
|
39
|
+
**[Descrição do bug]:**
|
|
40
|
+
- Sintomas: [O que acontece]
|
|
41
|
+
- Gatilho: [Como reproduzir]
|
|
42
|
+
- Contorno: [Mitigação temporária, se houver]
|
|
43
|
+
- Causa raiz: [Se conhecida]
|
|
44
|
+
|
|
45
|
+
## Considerações de Segurança
|
|
46
|
+
|
|
47
|
+
**[Área que requer cuidado de segurança]:**
|
|
48
|
+
- Risco: [O que pode dar errado]
|
|
49
|
+
- Mitigação atual: [O que está implementado agora]
|
|
50
|
+
- Recomendações: [O que deveria ser adicionado]
|
|
51
|
+
|
|
52
|
+
**[Área que requer cuidado de segurança]:**
|
|
53
|
+
- Risco: [O que pode dar errado]
|
|
54
|
+
- Mitigação atual: [O que está implementado agora]
|
|
55
|
+
- Recomendações: [O que deveria ser adicionado]
|
|
56
|
+
|
|
57
|
+
## Gargalos de Performance
|
|
58
|
+
|
|
59
|
+
**[Operação/endpoint lento]:**
|
|
60
|
+
- Problema: [O que está lento]
|
|
61
|
+
- Medição: [Números reais: "500ms p95", "2s de carregamento"]
|
|
62
|
+
- Causa: [Por que está lento]
|
|
63
|
+
- Caminho de melhoria: [Como acelerar]
|
|
64
|
+
|
|
65
|
+
**[Operação/endpoint lento]:**
|
|
66
|
+
- Problema: [O que está lento]
|
|
67
|
+
- Medição: [Números reais]
|
|
68
|
+
- Causa: [Por que está lento]
|
|
69
|
+
- Caminho de melhoria: [Como acelerar]
|
|
70
|
+
|
|
71
|
+
## Áreas Frágeis
|
|
72
|
+
|
|
73
|
+
**[Componente/Módulo]:**
|
|
74
|
+
- Por que é frágil: [O que o faz quebrar facilmente]
|
|
75
|
+
- Falhas comuns: [O que tipicamente dá errado]
|
|
76
|
+
- Modificação segura: [Como mudar sem quebrar]
|
|
77
|
+
- Cobertura de testes: [Está testado? Lacunas?]
|
|
78
|
+
|
|
79
|
+
**[Componente/Módulo]:**
|
|
80
|
+
- Por que é frágil: [O que o faz quebrar facilmente]
|
|
81
|
+
- Falhas comuns: [O que tipicamente dá errado]
|
|
82
|
+
- Modificação segura: [Como mudar sem quebrar]
|
|
83
|
+
- Cobertura de testes: [Está testado? Lacunas?]
|
|
84
|
+
|
|
85
|
+
## Limites de Escalabilidade
|
|
86
|
+
|
|
87
|
+
**[Recurso/Sistema]:**
|
|
88
|
+
- Capacidade atual: [Números: "100 req/seg", "10k usuários"]
|
|
89
|
+
- Limite: [Onde quebra]
|
|
90
|
+
- Sintomas no limite: [O que acontece]
|
|
91
|
+
- Caminho de escalabilidade: [Como aumentar a capacidade]
|
|
92
|
+
|
|
93
|
+
## Dependências em Risco
|
|
94
|
+
|
|
95
|
+
**[Pacote/Serviço]:**
|
|
96
|
+
- Risco: [ex.: "deprecado", "sem manutenção", "mudanças breaking chegando"]
|
|
97
|
+
- Impacto: [O que quebra se falhar]
|
|
98
|
+
- Plano de migração: [Alternativa ou caminho de upgrade]
|
|
99
|
+
|
|
100
|
+
## Funcionalidades Críticas Ausentes
|
|
101
|
+
|
|
102
|
+
**[Lacuna de funcionalidade]:**
|
|
103
|
+
- Problema: [O que está faltando]
|
|
104
|
+
- Contorno atual: [Como os usuários lidam]
|
|
105
|
+
- Bloqueia: [O que não pode ser feito sem isso]
|
|
106
|
+
- Complexidade de implementação: [Estimativa aproximada de esforço]
|
|
107
|
+
|
|
108
|
+
## Lacunas de Cobertura de Testes
|
|
109
|
+
|
|
110
|
+
**[Área não testada]:**
|
|
111
|
+
- O que não está testado: [Funcionalidade específica]
|
|
112
|
+
- Risco: [O que poderia quebrar despercebido]
|
|
113
|
+
- Prioridade: [Alta/Média/Baixa]
|
|
114
|
+
- Dificuldade de testar: [Por que ainda não está testado]
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
*Auditoria de preocupações: [data]*
|
|
119
|
+
*Atualizar conforme problemas são corrigidos ou novos descobertos*
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
<good_examples>
|
|
123
|
+
```markdown
|
|
124
|
+
# Codebase Concerns
|
|
125
|
+
|
|
126
|
+
**Analysis Date:** 2025-01-20
|
|
127
|
+
|
|
128
|
+
## Tech Debt
|
|
129
|
+
|
|
130
|
+
**Database queries in React components:**
|
|
131
|
+
- Issue: Direct Supabase queries in 15+ page components instead of server actions
|
|
132
|
+
- Files: `app/dashboard/page.tsx`, `app/profile/page.tsx`, `app/courses/[id]/page.tsx`
|
|
133
|
+
- Why: Rapid prototyping during MVP phase
|
|
134
|
+
- Impact: Can't implement RLS properly, exposes DB structure to client
|
|
135
|
+
- Fix approach: Move all queries to server actions in `app/actions/`, add proper RLS policies
|
|
136
|
+
|
|
137
|
+
## Known Bugs
|
|
138
|
+
|
|
139
|
+
**Race condition in subscription updates:**
|
|
140
|
+
- Symptoms: User shows as "free" tier for 5-10 seconds after successful payment
|
|
141
|
+
- Trigger: Fast navigation after Stripe checkout redirect, before webhook processes
|
|
142
|
+
- Workaround: Stripe webhook eventually updates status (self-heals)
|
|
143
|
+
- Root cause: Webhook processing slower than user navigation, no optimistic UI update
|
|
144
|
+
|
|
145
|
+
## Security Considerations
|
|
146
|
+
|
|
147
|
+
**Admin role check client-side only:**
|
|
148
|
+
- Risk: Admin dashboard pages check isAdmin from Supabase client, no server verification
|
|
149
|
+
- Current mitigation: None (relying on UI hiding)
|
|
150
|
+
- Recommendations: Add middleware to admin routes in `middleware.ts`, verify role server-side
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
*Concerns audit: 2025-01-20*
|
|
155
|
+
*Update as issues are fixed or new ones discovered*
|
|
156
|
+
```
|
|
157
|
+
</good_examples>
|
|
158
|
+
|
|
159
|
+
<guidelines>
|
|
160
|
+
**O que pertence ao CONCERNS.md:**
|
|
161
|
+
- Dívida técnica com impacto claro e abordagem de correção
|
|
162
|
+
- Bugs conhecidos com etapas de reprodução
|
|
163
|
+
- Lacunas de segurança e recomendações de mitigação
|
|
164
|
+
- Gargalos de performance com medições
|
|
165
|
+
- Código frágil que quebra facilmente
|
|
166
|
+
- Limites de escalabilidade com números
|
|
167
|
+
- Dependências que precisam de atenção
|
|
168
|
+
- Funcionalidades ausentes que bloqueiam workflows
|
|
169
|
+
- Lacunas de cobertura de testes
|
|
170
|
+
|
|
171
|
+
**O que NÃO pertence aqui:**
|
|
172
|
+
- Opiniões sem evidência ("código está bagunçado")
|
|
173
|
+
- Reclamações sem soluções ("auth está ruim")
|
|
174
|
+
- Ideias de funcionalidades futuras (isso é para planejamento de produto)
|
|
175
|
+
- TODOs normais (esses vivem em comentários de código)
|
|
176
|
+
- Decisões arquiteturais que estão funcionando bem
|
|
177
|
+
- Problemas menores de estilo de código
|
|
178
|
+
|
|
179
|
+
**Ao preencher este template:**
|
|
180
|
+
- **Sempre incluir caminhos de arquivo** — Preocupações sem localização não são acionáveis. Use backticks: `src/file.ts`
|
|
181
|
+
- Ser específico com medições ("500ms p95" não "lento")
|
|
182
|
+
- Incluir etapas de reprodução para bugs
|
|
183
|
+
- Sugerir abordagens de correção, não apenas problemas
|
|
184
|
+
- Focar em itens acionáveis
|
|
185
|
+
- Priorizar por risco/impacto
|
|
186
|
+
- Atualizar conforme problemas são resolvidos
|
|
187
|
+
- Adicionar novas preocupações conforme descobertas
|
|
188
|
+
|
|
189
|
+
**Diretrizes de tom:**
|
|
190
|
+
- Profissional, não emocional ("padrão N+1 de query" não "queries terríveis")
|
|
191
|
+
- Orientado a soluções ("Correção: adicionar índice" não "precisa de correção")
|
|
192
|
+
- Focado em risco ("Poderia expor dados do usuário" não "segurança está ruim")
|
|
193
|
+
- Factual ("3,5s de tempo de carregamento" não "muito lento")
|
|
194
|
+
|
|
195
|
+
**Útil para planejamento de fases quando:**
|
|
196
|
+
- Decidindo no que trabalhar a seguir
|
|
197
|
+
- Estimando risco de mudanças
|
|
198
|
+
- Entendendo onde ter cuidado
|
|
199
|
+
- Priorizando melhorias
|
|
200
|
+
- Integrando novos contextos Claude
|
|
201
|
+
- Planejando trabalho de refatoração
|
|
202
|
+
|
|
203
|
+
**Como isso é populado:**
|
|
204
|
+
Agentes Explore detectam esses durante o mapeamento do codebase. Adições manuais são bem-vindas para problemas descobertos por humanos. Esta é documentação viva, não uma lista de reclamações.
|
|
205
|
+
</guidelines>
|