oxe-cc 0.3.4 → 0.3.6
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 +4 -2
- package/.cursor/commands/oxe-execute.md +6 -2
- package/.cursor/commands/oxe-help.md +7 -5
- package/.cursor/commands/oxe-next.md +7 -5
- package/.cursor/commands/oxe-plan.md +9 -5
- package/.cursor/commands/oxe-quick.md +6 -2
- package/.cursor/commands/oxe-review-pr.md +9 -0
- package/.cursor/commands/oxe-scan.md +9 -5
- package/.cursor/commands/oxe-spec.md +9 -5
- package/.cursor/commands/oxe-update.md +9 -0
- package/.cursor/commands/oxe-verify.md +9 -5
- package/.github/copilot-instructions.md +29 -11
- package/.github/prompts/oxe-help.prompt.md +1 -1
- package/.github/prompts/oxe-update.prompt.md +11 -0
- package/.github/workflows/ci.yml +20 -18
- package/AGENTS.md +8 -6
- package/README.md +445 -258
- package/assets/oxe-ciclo-por-trilha.png +0 -0
- package/assets/readme-banner.svg +19 -19
- package/bin/banner.txt +1 -1
- package/bin/lib/oxe-agent-install.cjs +511 -0
- package/bin/lib/oxe-install-resolve.cjs +93 -0
- package/bin/lib/oxe-manifest.cjs +1 -1
- package/bin/lib/oxe-npm-version.cjs +64 -0
- package/bin/lib/oxe-project-health.cjs +81 -1
- package/bin/lib/oxe-workflows.cjs +145 -0
- package/bin/oxe-cc.js +898 -125
- package/lib/sdk/README.md +54 -0
- package/lib/sdk/index.cjs +242 -0
- package/lib/sdk/index.d.ts +89 -0
- package/oxe/templates/CONFIG.md +44 -17
- package/oxe/templates/DOCS_BROWNFIELD_LAYOUT.md +55 -0
- package/oxe/templates/SPEC.template.md +18 -0
- package/oxe/templates/WORKFLOW_AUTHORING.md +75 -0
- package/oxe/templates/config.template.json +18 -11
- package/oxe/workflows/discuss.md +31 -31
- package/oxe/workflows/execute.md +37 -36
- package/oxe/workflows/help.md +55 -16
- package/oxe/workflows/next.md +7 -0
- package/oxe/workflows/plan.md +4 -0
- package/oxe/workflows/quick.md +45 -45
- package/oxe/workflows/references/legacy-brownfield.md +136 -0
- package/oxe/workflows/review-pr.md +2 -2
- package/oxe/workflows/scan.md +5 -3
- package/oxe/workflows/spec.md +2 -0
- package/oxe/workflows/update.md +33 -0
- package/oxe/workflows/verify.md +1 -0
- package/oxe/workflows/workflow-authoring.md +34 -0
- package/package.json +42 -4
- package/.cursor/rules/oxe-workflow.mdc +0 -15
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# OXE — Workflow: workflow-authoring (revisão de um passo)
|
|
2
|
+
|
|
3
|
+
<objective>
|
|
4
|
+
Rever **um** ficheiro de workflow indicado pelo utilizador (caminho explícito ou relativo ao repo) contra o guia **`oxe/templates/WORKFLOW_AUTHORING.md`** (ou `.oxe/templates/` após instalação). Produzir feedback acionável: cortes, outcomes mais claros, divisão em `references/` ou templates, alinhamento de tags — **sem** gerar código de terceiros nem copiar conteúdo de outros ecossistemas.
|
|
5
|
+
</objective>
|
|
6
|
+
|
|
7
|
+
<context>
|
|
8
|
+
- O guia canónico no pacote é **`oxe/templates/WORKFLOW_AUTHORING.md`**; no projeto pode estar em **`.oxe/templates/WORKFLOW_AUTHORING.md`** (layout aninhado).
|
|
9
|
+
- Se o utilizador não der path, pedir o ficheiro alvo (ex.: `oxe/workflows/spec.md` ou `.oxe/workflows/plan.md`).
|
|
10
|
+
- Não alterar ficheiros no disco **a menos que** o utilizador peça explicitamente aplicação das alterações.
|
|
11
|
+
</context>
|
|
12
|
+
|
|
13
|
+
<process>
|
|
14
|
+
1. Ler o guia `WORKFLOW_AUTHORING.md` (resumo mental das secções: outcome-first, tags, progressive disclosure, frontmatter, script vs agente, `.oxe/`).
|
|
15
|
+
2. Ler o workflow alvo na íntegra.
|
|
16
|
+
3. Avaliar:
|
|
17
|
+
- **Outcome-first:** parágrafos redundantes ou que não melhoram o resultado em `.oxe/` ou na resposta do passo.
|
|
18
|
+
- **Estrutura:** presença e ordem de `<objective>`, `<context>`, `<process>`; critérios em `<success_criteria>` ou equivalente documentado (`<success>`, `<output>` em `help.md`, `<format_plan>` em `plan.md`).
|
|
19
|
+
- **Tamanho:** se justifica extração para `oxe/workflows/references/` ou reutilização em `oxe/templates/`.
|
|
20
|
+
- **Verificação:** o que poderia ser comando/CI em vez de instrução vaga ao modelo.
|
|
21
|
+
4. Responder com secções fixas:
|
|
22
|
+
- **Resumo** (2–4 frases).
|
|
23
|
+
- **Pontos fortes** (lista curta).
|
|
24
|
+
- **Sugestões** (numeradas, cada uma com *o quê* e *por quê*).
|
|
25
|
+
- **Proposta opcional de estrutura** (outline de ficheiros se dividir).
|
|
26
|
+
5. Se o ficheiro violar só convenções leves (ex.: falta de checklist), referir que `oxe-cc doctor` / SDK podem avisar com `WORKFLOW_SHAPE` quando configurado no projeto.
|
|
27
|
+
</process>
|
|
28
|
+
|
|
29
|
+
<success_criteria>
|
|
30
|
+
- [ ] O path do workflow revisto foi confirmado ou pedido ao utilizador.
|
|
31
|
+
- [ ] O feedback referencia explicitamente pelo menos um critério do guia (outcome-first, tags, progressive disclosure ou script vs agente).
|
|
32
|
+
- [ ] Nenhuma sugestão copia texto ou estrutura proprietária de produtos externos; só práticas genéricas e o guia OXE.
|
|
33
|
+
- [ ] A saída é acionável (o autor sabe o que editar a seguir).
|
|
34
|
+
</success_criteria>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oxe-cc",
|
|
3
|
-
"version": "0.3.
|
|
4
|
-
"description": "OXE — spec-driven workflows
|
|
3
|
+
"version": "0.3.6",
|
|
4
|
+
"description": "OXE — spec-driven workflows in .oxe/; integrates with Cursor, GitHub Copilot, Claude, OpenCode, Gemini, Codex, Windsurf, Antigravity (npx)",
|
|
5
5
|
"license": "GPL-3.0",
|
|
6
6
|
"author": "",
|
|
7
7
|
"homepage": "https://www.npmjs.com/package/oxe-cc",
|
|
@@ -16,18 +16,33 @@
|
|
|
16
16
|
"cursor",
|
|
17
17
|
"github-copilot",
|
|
18
18
|
"copilot",
|
|
19
|
+
"claude",
|
|
20
|
+
"claude-code",
|
|
21
|
+
"opencode",
|
|
22
|
+
"gemini-cli",
|
|
23
|
+
"codex",
|
|
24
|
+
"windsurf",
|
|
25
|
+
"antigravity",
|
|
19
26
|
"spec-driven",
|
|
20
27
|
"context-engineering",
|
|
28
|
+
"ai-agents",
|
|
21
29
|
"oxe"
|
|
22
30
|
],
|
|
23
31
|
"engines": {
|
|
24
32
|
"node": ">=18.0.0"
|
|
25
33
|
},
|
|
34
|
+
"main": "lib/sdk/index.cjs",
|
|
35
|
+
"exports": {
|
|
36
|
+
".": "./lib/sdk/index.cjs",
|
|
37
|
+
"./package.json": "./package.json"
|
|
38
|
+
},
|
|
39
|
+
"types": "lib/sdk/index.d.ts",
|
|
26
40
|
"bin": {
|
|
27
41
|
"oxe-cc": "bin/oxe-cc.js"
|
|
28
42
|
},
|
|
29
43
|
"files": [
|
|
30
44
|
"bin",
|
|
45
|
+
"lib",
|
|
31
46
|
"oxe",
|
|
32
47
|
"assets",
|
|
33
48
|
".cursor",
|
|
@@ -37,8 +52,31 @@
|
|
|
37
52
|
"README.md"
|
|
38
53
|
],
|
|
39
54
|
"scripts": {
|
|
40
|
-
"
|
|
55
|
+
"sync:cursor": "node scripts/sync-cursor-from-prompts.cjs",
|
|
56
|
+
"test": "node --test tests/install.test.cjs tests/oxe-project-health.test.cjs tests/oxe-sdk.test.cjs tests/oxe-manifest.test.cjs tests/oxe-agent-install.test.cjs tests/oxe-install-resolve-full.test.cjs tests/oxe-health-extended.test.cjs tests/oxe-workflows-edge.test.cjs tests/oxe-sdk-edge.test.cjs tests/oxe-cli-edge.test.cjs tests/oxe-npm-version.test.cjs tests/oxe-scripts.test.cjs",
|
|
57
|
+
"test:coverage": "c8 --check-coverage --lines 82 --functions 85 --branches 58 --statements 82 npm test",
|
|
41
58
|
"scan:assets": "node scripts/oxe-assets-scan.cjs",
|
|
42
|
-
"prepublishOnly": "node
|
|
59
|
+
"prepublishOnly": "node scripts/sync-cursor-from-prompts.cjs && npm test && npm run scan:assets && node bin/oxe-cc.js --version"
|
|
60
|
+
},
|
|
61
|
+
"c8": {
|
|
62
|
+
"all": true,
|
|
63
|
+
"include": [
|
|
64
|
+
"bin/oxe-cc.js",
|
|
65
|
+
"bin/lib/**/*.cjs",
|
|
66
|
+
"lib/**/*.cjs",
|
|
67
|
+
"scripts/**/*.cjs"
|
|
68
|
+
],
|
|
69
|
+
"exclude": [
|
|
70
|
+
"**/node_modules/**"
|
|
71
|
+
],
|
|
72
|
+
"reporter": [
|
|
73
|
+
"text-summary"
|
|
74
|
+
]
|
|
75
|
+
},
|
|
76
|
+
"devDependencies": {
|
|
77
|
+
"c8": "^11.0.0"
|
|
78
|
+
},
|
|
79
|
+
"dependencies": {
|
|
80
|
+
"semver": "^7.7.4"
|
|
43
81
|
}
|
|
44
82
|
}
|
|
@@ -1,15 +0,0 @@
|
|
|
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`).
|