oxe-cc 0.3.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/.cursor/commands/oxe-discuss.md +5 -0
- package/.cursor/commands/oxe-execute.md +5 -0
- package/.cursor/commands/oxe-help.md +5 -0
- package/.cursor/commands/oxe-next.md +5 -0
- package/.cursor/commands/oxe-plan.md +5 -0
- package/.cursor/commands/oxe-quick.md +5 -0
- package/.cursor/commands/oxe-scan.md +5 -0
- package/.cursor/commands/oxe-spec.md +5 -0
- package/.cursor/commands/oxe-verify.md +5 -0
- package/.cursor/rules/oxe-workflow.mdc +15 -0
- package/.github/copilot-instructions.md +37 -0
- package/.github/prompts/oxe-discuss.prompt.md +10 -0
- package/.github/prompts/oxe-execute.prompt.md +12 -0
- package/.github/prompts/oxe-help.prompt.md +9 -0
- package/.github/prompts/oxe-next.prompt.md +9 -0
- package/.github/prompts/oxe-plan.prompt.md +12 -0
- package/.github/prompts/oxe-quick.prompt.md +12 -0
- package/.github/prompts/oxe-scan.prompt.md +12 -0
- package/.github/prompts/oxe-spec.prompt.md +12 -0
- package/.github/prompts/oxe-verify.prompt.md +12 -0
- package/.github/workflows/ci.yml +18 -0
- package/AGENTS.md +11 -0
- package/LICENSE +674 -0
- package/README.md +206 -0
- package/bin/banner.txt +5 -0
- package/bin/oxe-cc.js +473 -0
- package/commands/oxe/discuss.md +16 -0
- package/commands/oxe/execute.md +16 -0
- package/commands/oxe/help.md +11 -0
- package/commands/oxe/next.md +12 -0
- package/commands/oxe/plan.md +15 -0
- package/commands/oxe/quick.md +16 -0
- package/commands/oxe/scan.md +16 -0
- package/commands/oxe/spec.md +14 -0
- package/commands/oxe/verify.md +15 -0
- package/oxe/templates/CONFIG.md +12 -0
- package/oxe/templates/PLAN.template.md +38 -0
- package/oxe/templates/SPEC.template.md +39 -0
- package/oxe/templates/STATE.md +30 -0
- package/oxe/templates/SUMMARY.template.md +20 -0
- package/oxe/templates/config.template.json +6 -0
- package/oxe/workflows/discuss.md +31 -0
- package/oxe/workflows/execute.md +28 -0
- package/oxe/workflows/help.md +50 -0
- package/oxe/workflows/next.md +22 -0
- package/oxe/workflows/plan.md +52 -0
- package/oxe/workflows/quick.md +32 -0
- package/oxe/workflows/scan.md +36 -0
- package/oxe/workflows/spec.md +37 -0
- package/oxe/workflows/verify.md +34 -0
- package/package.json +43 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: OXE — Cursor + Copilot; workflows em oxe/workflows/
|
|
3
|
+
alwaysApply: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# OXE neste repositório
|
|
7
|
+
|
|
8
|
+
Alvos principais: **Cursor** (slash em `.cursor/commands/`) e **GitHub Copilot** (`.github/copilot-instructions.md` + `.github/prompts/*.prompt.md`).
|
|
9
|
+
|
|
10
|
+
- **Fonte única dos passos:** `oxe/workflows/*.md` — ao mudar comportamento, edita primeiro aqui.
|
|
11
|
+
- **Comandos Cursor** (`/oxe-scan`, `/oxe-discuss`, `/oxe-quick`, `/oxe-execute`, …): delegam na leitura e execução integral do workflow homónimo em `oxe/workflows/`.
|
|
12
|
+
- **Artefatos no projeto alvo:** pasta `.oxe/` (STATE, codebase, SPEC, PLAN, VERIFY). Não misturar com `.planning/` do GSD sem decisão explícita.
|
|
13
|
+
- Antes de alterações grandes, preferir ler `.oxe/STATE.md` no repo de trabalho.
|
|
14
|
+
- Cada tarefa em `PLAN.md` deve manter o bloco **Verificar** (comando de teste ou checklist).
|
|
15
|
+
- Opcional: `.oxe/config.json` (template em `oxe/templates/config.template.json`, doc em `oxe/templates/CONFIG.md`).
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# OXE — fluxo spec-driven (Cursor + Copilot)
|
|
2
|
+
|
|
3
|
+
Este repositório define o **OXE**: artefatos em `.oxe/` na raiz do projeto alvo e workflows em `oxe/workflows/*.md`.
|
|
4
|
+
|
|
5
|
+
## Quando aplicar
|
|
6
|
+
|
|
7
|
+
Se o utilizador mencionar **OXE**, **oxe**, **/oxe-**, ou pedidos como “mapear o projeto”, “criar spec OXE”, “plano OXE com testes”, “verificar OXE”, trata como fluxo OXE e segue o ficheiro de workflow correspondente abaixo.
|
|
8
|
+
|
|
9
|
+
## Workflows (fonte única)
|
|
10
|
+
|
|
11
|
+
| Passo | Ficheiro | Gatilhos naturais (exemplos) |
|
|
12
|
+
|-------|----------|----------------------------|
|
|
13
|
+
| Scan | `oxe/workflows/scan.md` | “oxe scan”, “mapear o repo”, “atualizar codebase OXE” |
|
|
14
|
+
| Spec | `oxe/workflows/spec.md` | “oxe spec”, “escrever SPEC.md”, “requisitos OXE” |
|
|
15
|
+
| Discuss | `oxe/workflows/discuss.md` | “oxe discuss”, “perguntas antes do plano”, “DISCUSS.md” |
|
|
16
|
+
| Plan | `oxe/workflows/plan.md` | “oxe plan”, “PLAN.md”, “plano com testes por tarefa”, “replan” |
|
|
17
|
+
| Quick | `oxe/workflows/quick.md` | “oxe quick”, “fix rápido OXE”, “QUICK.md” |
|
|
18
|
+
| Execute | `oxe/workflows/execute.md` | “oxe execute”, “executar onda”, “onda 2 OXE” |
|
|
19
|
+
| Verify | `oxe/workflows/verify.md` | “oxe verify”, “validar plano OXE”, “VERIFY.md” |
|
|
20
|
+
| Next | `oxe/workflows/next.md` | “oxe next”, “próximo passo OXE” |
|
|
21
|
+
| Help | `oxe/workflows/help.md` | “oxe help”, “como usar OXE” |
|
|
22
|
+
|
|
23
|
+
**Regra:** lê o Markdown indicado e executa **todos** os passos e critérios de sucesso descritos nesse ficheiro. Não atalhes: cria ou atualiza os ficheiros em `.oxe/` conforme o workflow.
|
|
24
|
+
|
|
25
|
+
## Artefatos
|
|
26
|
+
|
|
27
|
+
- `.oxe/STATE.md`, `.oxe/config.json` (opcional), `.oxe/codebase/*.md`, `.oxe/SPEC.md`, `.oxe/DISCUSS.md` (opcional), `.oxe/PLAN.md`, `.oxe/VERIFY.md`, `.oxe/QUICK.md`, `.oxe/SUMMARY.md`
|
|
28
|
+
- Templates: `oxe/templates/`
|
|
29
|
+
|
|
30
|
+
## Cursor vs Copilot
|
|
31
|
+
|
|
32
|
+
- **Cursor:** slash commands em `.cursor/commands/oxe-*.md` apontam para os mesmos workflows.
|
|
33
|
+
- **Copilot:** prompt files em `.github/prompts/oxe-*.prompt.md`; cada um indica o workflow em `oxe/workflows/<passo>.md` na raiz do repo.
|
|
34
|
+
|
|
35
|
+
## Manutenção deste pacote (oxe-build)
|
|
36
|
+
|
|
37
|
+
Ao alterar comportamento OXE, edita primeiro `oxe/workflows/*.md`; mantém comandos Cursor e prompts Copilot alinhados com essa pasta.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-discuss
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Discussão antes do plano
|
|
5
|
+
argument-hint: "[contexto ou respostas]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE discuss** no repositório atual. Lê e aplica **integralmente** o ficheiro no workspace:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/discuss.md`
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-execute
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Executar onda do PLAN ou passos do QUICK
|
|
5
|
+
argument-hint: "[opcional: onda N ou Tn]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE execute** no repositório atual. Lê e aplica **integralmente** o ficheiro no workspace:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/execute.md`
|
|
11
|
+
|
|
12
|
+
Usa o texto adicional desta mensagem como foco (onda, tarefa Tn, ou confirmação de progresso).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-plan
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Gera .oxe/PLAN.md com verificação por tarefa
|
|
5
|
+
argument-hint: "[opcional: --replan]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE plan**. Lê e aplica **integralmente**:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/plan.md` (na raiz do repositório em contexto)
|
|
11
|
+
|
|
12
|
+
Se o utilizador pedir replanejamento, trata como `--replan` conforme o workflow.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-quick
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Modo rápido (.oxe/QUICK.md)
|
|
5
|
+
argument-hint: "[objetivo em texto livre]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE quick** no repositório atual. Lê e aplica **integralmente** o ficheiro no workspace:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/quick.md`
|
|
11
|
+
|
|
12
|
+
Usa o texto adicional desta mensagem como objetivo e contexto.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-scan
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Scan do repositório (.oxe/codebase/)
|
|
5
|
+
argument-hint: "[área opcional, ex. api]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE scan** no repositório atual. Lê e aplica **integralmente** o ficheiro:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/scan.md` (na raiz do repositório em contexto)
|
|
11
|
+
|
|
12
|
+
Usa o texto adicional desta mensagem como foco opcional de área (pastas/módulos).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-spec
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Cria ou atualiza .oxe/SPEC.md
|
|
5
|
+
argument-hint: "[pedido ou contexto da feature]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE spec**. Lê e aplica **integralmente**:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/spec.md` (na raiz do repositório em contexto)
|
|
11
|
+
|
|
12
|
+
Usa o resto desta mensagem e ficheiros anexados como entrada do utilizador.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oxe-verify
|
|
3
|
+
agent: agent
|
|
4
|
+
description: OXE — Valida implementação (.oxe/VERIFY.md)
|
|
5
|
+
argument-hint: "[opcional: Tn]"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Executa o workflow **OXE verify**. Lê e aplica **integralmente**:
|
|
9
|
+
|
|
10
|
+
`oxe/workflows/verify.md` (na raiz do repositório em contexto)
|
|
11
|
+
|
|
12
|
+
Se o utilizador indicar uma tarefa `Tn`, restringe a verificação a essa tarefa.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main, master]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main, master]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
test:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
- uses: actions/setup-node@v4
|
|
15
|
+
with:
|
|
16
|
+
node-version: '20'
|
|
17
|
+
- run: npm test
|
|
18
|
+
- run: npm run scan:assets
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# OXE — agentes (GitHub Copilot / compatível)
|
|
2
|
+
|
|
3
|
+
Este repositório empacota o fluxo **OXE** (spec-driven, artefatos em `.oxe/`).
|
|
4
|
+
|
|
5
|
+
- **npm:** o nome do pacote é **`oxe-cc`** (`npx oxe-cc@latest` quando estiver publicado; se `npm view oxe-cc` der 404, usar `npm link` a partir deste repo ou `node bin/oxe-cc.js`).
|
|
6
|
+
- **Instruções do repositório:** [.github/copilot-instructions.md](.github/copilot-instructions.md) — aplicadas automaticamente no Copilot Chat quando o repo está em contexto.
|
|
7
|
+
- **Workflows canónicos:** [oxe/workflows/](oxe/workflows/) — editar aqui primeiro; Cursor e Copilot apontam para estes ficheiros (inclui `quick.md`, `execute.md`).
|
|
8
|
+
- **CLI:** `oxe-cc` instala assets e bootstrap (`.oxe/STATE.md`, `config.json`, `codebase/`); `oxe-cc doctor` valida workflows, JSON de config e mapa scan; `oxe-cc init-oxe` só inicializa `.oxe/`.
|
|
9
|
+
- **Prompt files (Copilot / VS Code):** [.github/prompts/*.prompt.md](.github/prompts/) — invocar com `/` no chat (ex. `/oxe-scan`) após `chat.promptFiles` estar ativo.
|
|
10
|
+
|
|
11
|
+
Quando o utilizador pedir uma etapa OXE por linguagem natural, segue o ficheiro `oxe/workflows/<passo>.md` correspondente sem atalhar passos.
|