spec-first-copilot 0.4.0 → 0.5.0-beta.0

package/README.md

@@ -1,148 +1,156 @@
-# spec-first-copilot
-
-Kit completo para desenvolvimento **spec-first** com [GitHub Copilot](https://github.com/features/copilot). A IA segue um pipeline disciplinado — da especificacao ao codigo — com checkpoints humanos e rastreabilidade ponta a ponta.
-
-## O que e spec-first?
-
-Em vez de pedir pra IA "cria um CRUD de usuarios", voce fornece insumos brutos (docs, SQLs, rascunhos) e a IA:
-
-1. **Extrai** requisitos estruturados (PRD/TRD)
-2. **Espera sua aprovacao** (checkpoint humano)
-3. **Gera design tecnico** (SDD) — fonte unica de verdade
-4. **Planeja tasks** com dependencias e fases
-5. **Implementa** com agentes especializados por area + security review
-6. **Atualiza docs** automaticamente (delta specs)
-
-Resultado: codigo previsivel, seguro e rastreavel.
-
-## Pre-requisitos
-
-- **Node.js** 18+
-- **Git** instalado
-- **GitHub Copilot** com acesso a Copilot Chat
-
-### Windows (PowerShell)
-
-Se encontrar erro de script nao assinado ao rodar o CLI, execute:
-
-```powershell
-Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
-```
-
-## Instalacao
-
-```bash
-npm i -g spec-first-copilot
-```
-
-## Uso
-
-```bash
-spec-first-copilot init --name=MeuProjeto
-```
-
-Isso cria a pasta `MeuProjeto/` com toda a estrutura pronta:
-
-```
-MeuProjeto/
-├── .ai/memory/napkin.md              <- Memoria persistente do projeto
-├── .github/
-│   ├── copilot-instructions.md       <- Regras globais pro agente
-│   ├── instructions/                 <- Regras por contexto
-│   ├── skills/                       <- 9 skills do workflow
-│   │   ├── sf-setup-projeto/         <- Bootstrap do projeto
-│   │   ├── sf-feature/              <- Pipeline de feature
-│   │   ├── sf-discovery/            <- Analise profunda de insumos
-│   │   ├── sf-extract/              <- PM -> PRD/TRD
-│   │   ├── sf-design/              <- PRD/TRD -> SDD
-│   │   ├── sf-plan/                <- SDD -> tasks
-│   │   ├── sf-dev/                 <- Executa tasks
-│   │   ├── sf-merge-delta/         <- Atualiza docs globais
-│   │   └── sf-session-finish/     <- Encerra sessao
-│   └── agents/                      <- 7 agentes especializados
-│       ├── backend-coder.md         <- .NET 8 / C#
-│       ├── frontend-coder.md        <- React
-│       ├── db-coder.md              <- PostgreSQL
-│       ├── infra-coder.md           <- Docker
-│       ├── doc-writer.md            <- Documentacao
-│       ├── reviewer.md              <- Code review
-│       └── security-reviewer.md     <- Auditoria de seguranca
-├── docs/
-│   ├── PM/                          <- Jogue seus insumos aqui
-│   │   └── setup_projeto/           <- Insumos do bootstrap
-│   ├── _templates/                  <- 18 templates do workflow
-│   ├── Estrutura/                   <- Docs globais (gerados)
-│   └── Desenvolvimento/             <- Docs por feature (gerados)
-│       └── rules.md                 <- Regras de desenvolvimento
-└── .gitignore
-```
-
-## Como comecar
-
-1. Crie o projeto:
-   ```bash
-   spec-first-copilot init --name=MeuProjeto
-   cd MeuProjeto
-   ```
-
-2. Jogue seus insumos em `docs/PM/setup_projeto/` — qualquer formato:
-   - `.md`, `.txt` (descricoes, requisitos, decisoes)
-   - `.sql` (modelagem de banco)
-   - `.csv`, `.xml`, `.html` (dados, configs)
-   - `.png`, `.jpg`, `.pdf` (telas, diagramas)
-
-3. Abra o VS Code com Copilot Chat e rode:
-   ```
-   /sf-setup-projeto
-   ```
-
-4. O pipeline comeca. A IA vai:
-   - Extrair um TRD dos seus insumos
-   - Parar e pedir sua aprovacao
-   - Depois voce roda `/sf-design`, `/sf-plan`, `/sf-dev` na sequencia
-
-## Pipeline completo
-
-```
-docs/PM/ (seus arquivos)
-    |
-    v
-/sf-setup-projeto  -->  /sf-extract  -->  TRD (voce revisa e aprova)
-                                            |
-                                            v
-                                         /sf-design  -->  SDD + docs/Estrutura/
-                                                            |
-                                                            v
-                                                         /sf-plan  -->  tasks + Progresso.md
-                                                                          |
-                                                                          v
-                                                                       /sf-dev  -->  codigo nos repos
-                                                                                       |
-                                                                                       v
-                                                                                    (merge-delta automatico)
-```
-
-Para features (apos o setup):
-
-```
-/sf-feature nome  -->  /sf-extract  -->  PRD  -->  /sf-design  -->  /sf-plan  -->  /sf-dev (inclui merge-delta)
-```
-
-## Opcoes do CLI
-
-```
-spec-first-copilot init --name=<nome> [--target=<caminho>]
-```
-
-| Opcao | Descricao |
-|-------|-----------|
-| `--name` | Nome do projeto (obrigatorio) |
-| `--target` | Diretorio destino (default: `./<nome>`) |
-
-## Links
-
-- [Repositorio](https://github.com/gustavomaritan-labs/spec-first-workflow)
-
-## Licenca
-
-MIT
+# spec-first-copilot
+
+Kit completo para desenvolvimento **spec-first** com [GitHub Copilot](https://github.com/features/copilot). A IA segue um pipeline disciplinado — da especificacao ao codigo — com checkpoints humanos e rastreabilidade ponta a ponta.
+
+## O que e spec-first?
+
+Em vez de pedir pra IA "cria um CRUD de usuarios", voce fornece insumos brutos (docs, SQLs, rascunhos) e a IA:
+
+1. **Extrai** requisitos estruturados (PRD/TRD)
+2. **Espera sua aprovacao** (checkpoint humano)
+3. **Gera design tecnico** (SDD) — fonte unica de verdade
+4. **Planeja tasks** com dependencias e fases
+5. **Implementa** com agentes especializados por area + security review
+6. **Atualiza docs** automaticamente (delta specs)
+
+Resultado: codigo previsivel, seguro e rastreavel.
+
+## Pre-requisitos
+
+- **Node.js** 18+
+- **Git** instalado
+- **GitHub Copilot** com acesso a Copilot Chat
+
+### Windows (PowerShell)
+
+Se encontrar erro de script nao assinado ao rodar o CLI, execute:
+
+```powershell
+Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
+```
+
+## Instalacao
+
+```bash
+npm i -g spec-first-copilot
+```
+
+## Uso
+
+```bash
+spec-first-copilot init --name=MeuProjeto
+```
+
+Isso cria a pasta `MeuProjeto/` com toda a estrutura pronta:
+
+```
+MeuProjeto/
+├── .ai/memory/napkin.md              <- Memoria persistente do projeto
+├── .github/                          <- AI OPERATIONAL CONFIG
+│   ├── copilot-instructions.md       <- Regras globais pro agente
+│   ├── rules.md                      <- Regras de desenvolvimento
+│   ├── instructions/                 <- Regras por contexto
+│   ├── templates/                    <- 15 templates do workflow
+│   │   ├── feature/                  <- PRD, TRD, SDD, tasks, etc.
+│   │   ├── estrutura/                <- 5 templates de estado do sistema
+│   │   └── global/                   <- Progresso global
+│   ├── skills/                       <- 9 skills do workflow
+│   │   ├── sf-setup-projeto/
+│   │   ├── sf-feature/
+│   │   ├── sf-discovery/
+│   │   ├── sf-extract/
+│   │   ├── sf-design/
+│   │   ├── sf-plan/
+│   │   ├── sf-dev/
+│   │   ├── sf-merge-delta/
+│   │   └── sf-session-finish/
+│   └── agents/                       <- 7 agentes especializados
+│       ├── backend-coder.md          <- .NET 8 / C#
+│       ├── frontend-coder.md         <- React
+│       ├── db-coder.md               <- PostgreSQL
+│       ├── infra-coder.md            <- Docker
+│       ├── doc-writer.md             <- Documentacao
+│       ├── reviewer.md               <- Code review
+│       └── security-reviewer.md      <- Auditoria de seguranca
+├── docs/                             <- SYSTEM KNOWLEDGE (gerado pelo /sf-design)
+│   ├── architecture.md               <- Containers, stack, ambientes, deploy
+│   ├── domain.md                     <- Visao de negocio + modelo de dados
+│   ├── conventions.md                <- Auth, authz, LGPD, env vars, monitoramento
+│   ├── apiContracts.md               <- Rotas, paginacao, erros, catalogo de endpoints
+│   └── decisions.md                  <- ADRs
+├── workspace/                       <- TEAM CONTENT (futuro wiki)
+│   ├── Input/                        <- Jogue seus insumos aqui
+│   │   └── setup_projeto/            <- Insumos do bootstrap
+│   └── Output/                       <- Docs por feature (gerados)
+└── .gitignore
+```
+
+## Como comecar
+
+1. Crie o projeto:
+   ```bash
+   spec-first-copilot init --name=MeuProjeto
+   cd MeuProjeto
+   ```
+
+2. Jogue seus insumos em `workspace/Input/setup_projeto/` — qualquer formato:
+   - `.md`, `.txt` (descricoes, requisitos, decisoes)
+   - `.sql` (modelagem de banco)
+   - `.csv`, `.xml`, `.html` (dados, configs)
+   - `.png`, `.jpg`, `.pdf` (telas, diagramas)
+
+3. Abra o VS Code com Copilot Chat e rode:
+   ```
+   /sf-setup-projeto
+   ```
+
+4. O pipeline comeca. A IA vai:
+   - Extrair um TRD dos seus insumos
+   - Parar e pedir sua aprovacao
+   - Depois voce roda `/sf-design`, `/sf-plan`, `/sf-dev` na sequencia
+
+## Pipeline completo
+
+```
+workspace/Input/ (seus arquivos)
+    |
+    v
+/sf-setup-projeto  -->  /sf-extract  -->  TRD (voce revisa e aprova)
+                                            |
+                                            v
+                                         /sf-design  -->  SDD + docs/ (5 arquivos)
+                                                            |
+                                                            v
+                                                         /sf-plan  -->  tasks + Progresso.md
+                                                                          |
+                                                                          v
+                                                                       /sf-dev  -->  codigo nos repos
+                                                                                       |
+                                                                                       v
+                                                                                    (merge-delta automatico)
+```
+
+Para features (apos o setup):
+
+```
+/sf-feature nome  -->  /sf-extract  -->  PRD  -->  /sf-design  -->  /sf-plan  -->  /sf-dev (inclui merge-delta)
+```
+
+## Opcoes do CLI
+
+```
+spec-first-copilot init --name=<nome> [--target=<caminho>]
+```
+
+| Opcao | Descricao |
+|-------|-----------|
+| `--name` | Nome do projeto (obrigatorio) |
+| `--target` | Diretorio destino (default: `./<nome>`) |
+
+## Links
+
+- [Repositorio](https://github.com/gustavomaritan-labs/spec-first-workflow)
+
+## Licenca
+
+MIT

package/bin/cli.js

@@ -1,52 +1,52 @@
-#!/usr/bin/env node
-
-const path = require('path');
-const { init } = require('../lib/init');
-
-const args = process.argv.slice(2);
-const command = args[0];
-
-function printUsage() {
-  console.log('Usage: spec-first-copilot init --name=<project-name> [--target=<path>]');
-  console.log('');
-  console.log('Creates a new spec-first project configured for GitHub Copilot.');
-  console.log('');
-  console.log('Options:');
-  console.log('  --name=<name>    Project name (required)');
-  console.log('  --target=<path>  Target directory (defaults to ./<name>)');
-}
-
-function parseArgs(args) {
-  const parsed = {};
-  for (const arg of args) {
-    const match = arg.match(/^--(\w+)=(.+)$/);
-    if (match) {
-      parsed[match[1]] = match[2];
-    }
-  }
-  return parsed;
-}
-
-if (command === 'init') {
-  const opts = parseArgs(args.slice(1));
-
-  if (!opts.name) {
-    console.error('Error: --name is required.\n');
-    printUsage();
-    process.exit(1);
-  }
-
-  const templatesDir = path.join(__dirname, '..', 'templates');
-
-  init({
-    name: opts.name,
-    templatesDir,
-    targetDir: opts.target || undefined,
-  });
-} else {
-  printUsage();
-  if (command) {
-    console.error(`\nUnknown command: "${command}"`);
-  }
-  process.exit(command ? 1 : 0);
-}
+#!/usr/bin/env node
+
+const path = require('path');
+const { init } = require('../lib/init');
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+function printUsage() {
+  console.log('Usage: spec-first-copilot init --name=<project-name> [--target=<path>]');
+  console.log('');
+  console.log('Creates a new spec-first project configured for GitHub Copilot.');
+  console.log('');
+  console.log('Options:');
+  console.log('  --name=<name>    Project name (required)');
+  console.log('  --target=<path>  Target directory (defaults to ./<name>)');
+}
+
+function parseArgs(args) {
+  const parsed = {};
+  for (const arg of args) {
+    const match = arg.match(/^--(\w+)=(.+)$/);
+    if (match) {
+      parsed[match[1]] = match[2];
+    }
+  }
+  return parsed;
+}
+
+if (command === 'init') {
+  const opts = parseArgs(args.slice(1));
+
+  if (!opts.name) {
+    console.error('Error: --name is required.\n');
+    printUsage();
+    process.exit(1);
+  }
+
+  const templatesDir = path.join(__dirname, '..', 'templates');
+
+  init({
+    name: opts.name,
+    templatesDir,
+    targetDir: opts.target || undefined,
+  });
+} else {
+  printUsage();
+  if (command) {
+    console.error(`\nUnknown command: "${command}"`);
+  }
+  process.exit(command ? 1 : 0);
+}

package/lib/init.js

@@ -1,89 +1,89 @@
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-
-const PLACEHOLDER = '{{PROJECT_NAME}}';
-
-function copyDir(src, dest, replacements) {
-  fs.mkdirSync(dest, { recursive: true });
-  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-    if (entry.isDirectory()) {
-      copyDir(srcPath, destPath, replacements);
-    } else {
-      copyFile(srcPath, destPath, replacements);
-    }
-  }
-}
-
-function copyFile(src, dest, replacements) {
-  // Skip if file already exists (preserve user's files)
-  if (fs.existsSync(dest)) return;
-
-  const textExtensions = ['.md', '.yaml', '.yml', '.json', '.js', '.ts', '.gitignore', '.gitkeep', ''];
-  const ext = path.extname(src).toLowerCase();
-  const basename = path.basename(src);
-  const isText = textExtensions.includes(ext) || basename.startsWith('.');
-
-  if (isText) {
-    let content = fs.readFileSync(src, 'utf-8');
-    for (const [placeholder, value] of Object.entries(replacements)) {
-      content = content.split(placeholder).join(value);
-    }
-    fs.writeFileSync(dest, content, 'utf-8');
-  } else {
-    fs.copyFileSync(src, dest);
-  }
-}
-
-function init({ name, templatesDir, targetDir }) {
-  const dest = targetDir || path.resolve(process.cwd(), name);
-
-  const existed = fs.existsSync(dest);
-  console.log(`\n${existed ? 'Initializing' : 'Creating'} project "${name}" in ${dest}\n`);
-
-  const replacements = { [PLACEHOLDER]: name };
-  copyDir(templatesDir, dest, replacements);
-  patchProjectName(dest, name);
-
-  try {
-    execSync('git init', { cwd: dest, stdio: 'pipe' });
-    execSync('git add -A', { cwd: dest, stdio: 'pipe' });
-    execSync(`git commit -m "chore: init project ${name} via spec-first-workflow"`, {
-      cwd: dest,
-      stdio: 'pipe',
-    });
-    console.log('Git initialized with initial commit.');
-  } catch {
-    console.log('Git init skipped (git not available or error).');
-  }
-
-  console.log(`\nDone! Project "${name}" is ready.`);
-  console.log('\nNext steps:');
-  console.log(`  1. cd ${name}`);
-  console.log('  2. Add your input files to docs/PM/setup_projeto/');
-  console.log('  3. Run /setup-projeto to start the pipeline');
-  console.log('');
-}
-
-function patchProjectName(dest, name) {
-  const filesToPatch = [
-    path.join('.ai', 'memory', 'napkin.md'),
-    path.join('.github', 'copilot-instructions.md'),
-    'CLAUDE.md',
-  ];
-
-  for (const relPath of filesToPatch) {
-    const filePath = path.join(dest, relPath);
-    if (!fs.existsSync(filePath)) continue;
-
-    let content = fs.readFileSync(filePath, 'utf-8');
-    content = content.replace(/# Napkin Runbook\b/, `# Napkin Runbook — ${name}`);
-    content = content.replace(/# Copilot Instructions — Projeto\b/, `# Copilot Instructions — ${name}`);
-    content = content.replace(/# CLAUDE\.md — Projeto\b/, `# CLAUDE.md — ${name}`);
-    fs.writeFileSync(filePath, content, 'utf-8');
-  }
-}
-
-module.exports = { init };
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const PLACEHOLDER = '{{PROJECT_NAME}}';
+
+function copyDir(src, dest, replacements) {
+  fs.mkdirSync(dest, { recursive: true });
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath, replacements);
+    } else {
+      copyFile(srcPath, destPath, replacements);
+    }
+  }
+}
+
+function copyFile(src, dest, replacements) {
+  // Skip if file already exists (preserve user's files)
+  if (fs.existsSync(dest)) return;
+
+  const textExtensions = ['.md', '.yaml', '.yml', '.json', '.js', '.ts', '.gitignore', '.gitkeep', ''];
+  const ext = path.extname(src).toLowerCase();
+  const basename = path.basename(src);
+  const isText = textExtensions.includes(ext) || basename.startsWith('.');
+
+  if (isText) {
+    let content = fs.readFileSync(src, 'utf-8');
+    for (const [placeholder, value] of Object.entries(replacements)) {
+      content = content.split(placeholder).join(value);
+    }
+    fs.writeFileSync(dest, content, 'utf-8');
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+}
+
+function init({ name, templatesDir, targetDir }) {
+  const dest = targetDir || path.resolve(process.cwd(), name);
+
+  const existed = fs.existsSync(dest);
+  console.log(`\n${existed ? 'Initializing' : 'Creating'} project "${name}" in ${dest}\n`);
+
+  const replacements = { [PLACEHOLDER]: name };
+  copyDir(templatesDir, dest, replacements);
+  patchProjectName(dest, name);
+
+  try {
+    execSync('git init', { cwd: dest, stdio: 'pipe' });
+    execSync('git add -A', { cwd: dest, stdio: 'pipe' });
+    execSync(`git commit -m "chore: init project ${name} via spec-first-workflow"`, {
+      cwd: dest,
+      stdio: 'pipe',
+    });
+    console.log('Git initialized with initial commit.');
+  } catch {
+    console.log('Git init skipped (git not available or error).');
+  }
+
+  console.log(`\nDone! Project "${name}" is ready.`);
+  console.log('\nNext steps:');
+  console.log(`  1. cd ${name}`);
+  console.log('  2. Add your input files to workspace/Input/setup_projeto/');
+  console.log('  3. Run /sf-setup-projeto to start the pipeline');
+  console.log('');
+}
+
+function patchProjectName(dest, name) {
+  const filesToPatch = [
+    path.join('.ai', 'memory', 'napkin.md'),
+    path.join('.github', 'copilot-instructions.md'),
+    'CLAUDE.md',
+  ];
+
+  for (const relPath of filesToPatch) {
+    const filePath = path.join(dest, relPath);
+    if (!fs.existsSync(filePath)) continue;
+
+    let content = fs.readFileSync(filePath, 'utf-8');
+    content = content.replace(/# Napkin Runbook\b/, `# Napkin Runbook — ${name}`);
+    content = content.replace(/# Copilot Instructions — Projeto\b/, `# Copilot Instructions — ${name}`);
+    content = content.replace(/# CLAUDE\.md — Projeto\b/, `# CLAUDE.md — ${name}`);
+    fs.writeFileSync(filePath, content, 'utf-8');
+  }
+}
+
+module.exports = { init };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "spec-first-copilot",
-  "version": "0.4.0",
+  "version": "0.5.0-beta.0",
   "description": "Spec-first workflow kit for GitHub Copilot — AI-driven development with specs, not guesswork",
   "bin": {
-    "spec-first-copilot": "./bin/cli.js"
+    "spec-first-copilot": "bin/cli.js"
   },
   "files": [
     "bin/",
@@ -11,10 +11,17 @@
     "templates/"
   ],
   "author": "gustavomaritan",
-  "keywords": ["spec-first", "workflow", "ai", "copilot", "github", "scaffolding"],
+  "keywords": [
+    "spec-first",
+    "workflow",
+    "ai",
+    "copilot",
+    "github",
+    "scaffolding"
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/gustavomaritan-labs/spec-first-workflow",
+    "url": "git+https://github.com/gustavomaritan-labs/spec-first-workflow.git",
     "directory": "packages/spec-first-copilot"
   },
   "scripts": {