@spec-wave/cli 0.26.0 → 0.28.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/package.json +1 -1
- package/src/api/github-rest.mjs +52 -0
- package/src/cli.mjs +12 -0
- package/src/commands/decompose.mjs +166 -39
- package/src/commands/doctor.mjs +214 -3
- package/src/commands/generate-bug.mjs +22 -16
- package/src/commands/generate-plan.mjs +72 -23
- package/src/commands/generate-spec.mjs +19 -15
- package/src/commands/implement.mjs +47 -22
- package/src/commands/install-skill.mjs +18 -8
- package/src/commands/preflight.mjs +322 -0
- package/src/commands/run.mjs +51 -30
- package/src/commands/update.mjs +143 -12
- package/src/commands/validate.mjs +84 -17
- package/src/config.mjs +18 -0
- package/src/lib/artifact-pr.mjs +272 -0
- package/src/lib/artifact-publish.mjs +169 -0
- package/src/lib/doc-availability.mjs +23 -1
- package/src/lib/doc-source.mjs +162 -0
- package/src/lib/flow-run.mjs +9 -218
- package/src/lib/next-step.mjs +27 -4
- package/src/lib/pr-branch.mjs +106 -7
- package/src/lib/repo-links.mjs +8 -2
- package/src/plugin/.claude-plugin/plugin.json +1 -1
- package/src/plugin/README.md +5 -0
- package/src/plugin/skills/bug/SKILL.md +2 -2
- package/src/plugin/skills/decompose/SKILL.md +4 -4
- package/src/plugin/skills/plan/SKILL.md +1 -1
- package/src/plugin/skills/preparar-feature/SKILL.md +245 -0
- package/src/plugin/skills/preparar-feature/reference/critica.md +88 -0
- package/src/plugin/skills/preparar-specs/SKILL.md +171 -0
- package/src/plugin/skills/preparar-specs/reference/armadilhas.md +209 -0
- package/src/plugin/skills/preparar-specs/reference/revisao.md +107 -0
- package/src/plugin/skills/run/SKILL.md +3 -1
- package/src/plugin/skills/spec/SKILL.md +4 -4
- package/src/plugin/skills/update/SKILL.md +10 -4
- package/src/plugin/skills/workflow/SKILL.md +8 -3
- package/src/templates/skill/SKILL.md +13 -10
- package/src/templates/workflows/code-review.yml +13 -2
- package/src/templates/workflows/critique.yml +1 -1
- package/src/templates/workflows/decompose.yml +13 -2
- package/src/templates/workflows/generate-bug.yml +17 -6
- package/src/templates/workflows/generate-plan.yml +20 -7
- package/src/templates/workflows/generate-spec.yml +20 -7
- package/src/templates/workflows/qa.yml +13 -0
package/src/lib/flow-run.mjs
CHANGED
|
@@ -9,26 +9,17 @@
|
|
|
9
9
|
// O modo é detectado pelo ambiente (`GITHUB_ACTIONS`), não por flag: um
|
|
10
10
|
// comando com dois nomes para a mesma coisa envelhece mal.
|
|
11
11
|
//
|
|
12
|
-
// **O comportamento é
|
|
13
|
-
//
|
|
14
|
-
//
|
|
15
|
-
// local que não sincronizasse o board deixaria o próximo passo do fluxo cego.
|
|
12
|
+
// **O comportamento é IDÊNTICO nos dois modos** — gera, publica em Pull Request,
|
|
13
|
+
// comenta na issue e avança a Etapa. O board é a fonte de verdade do RFC-001
|
|
14
|
+
// independentemente de onde a geração rodou.
|
|
16
15
|
//
|
|
17
|
-
//
|
|
18
|
-
//
|
|
19
|
-
//
|
|
20
|
-
//
|
|
21
|
-
//
|
|
22
|
-
//
|
|
23
|
-
// 2. FALHA DE PUSH. No Action, não conseguir publicar é falha do job. Local, o
|
|
24
|
-
// arquivo já está gerado e commitado — perder isso porque o remoto andou
|
|
25
|
-
// seria pior que avisar e deixar você resolver o push. Antes de chegar
|
|
26
|
-
// nessa bifurcação, os dois modos repetem pull+push enquanto a rejeição for
|
|
27
|
-
// disputa com outro run — ver §publicação concorrente.
|
|
16
|
+
// Este módulo já carregou as DUAS exceções que sobravam dessa promessa
|
|
17
|
+
// (identidade do git e falha de push), junto com o commit direto na branch
|
|
18
|
+
// default, o laço de pull+rebase+push e a classificação de corrida. Nada disso
|
|
19
|
+
// existe mais: a publicação passou a ser via API, em branch própria por
|
|
20
|
+
// documento, e mora em lib/artifact-publish.mjs. As duas exceções eram
|
|
21
|
+
// consequência de mexer em git local — some a causa, somem elas.
|
|
28
22
|
|
|
29
|
-
import { execSync } from 'node:child_process';
|
|
30
|
-
import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
|
|
31
|
-
import path from 'node:path';
|
|
32
23
|
import { resolveRepoContext } from './project-root.mjs';
|
|
33
24
|
import { CONFIG_FILE } from '../config.mjs';
|
|
34
25
|
|
|
@@ -72,203 +63,3 @@ export function resolveFlowContext({ cwd = process.cwd(), command = 'este comand
|
|
|
72
63
|
}
|
|
73
64
|
return { owner, repo, root, config, mode };
|
|
74
65
|
}
|
|
75
|
-
|
|
76
|
-
// --- publicação concorrente -------------------------------------------------
|
|
77
|
-
//
|
|
78
|
-
// `pull --rebase` seguido de `push` NÃO é atômico. Entre os dois cabe o push de
|
|
79
|
-
// outro run: dois `generate-spec` de issues DIFERENTES disparados juntos rodam
|
|
80
|
-
// em paralelo (a `concurrency` dos workflows é por issue, e é por issue que ela
|
|
81
|
-
// tem que ser — serializar o repositório inteiro mataria a vazão), terminam
|
|
82
|
-
// juntos e disputam a ponta da branch. O perdedor levava non-fast-forward,
|
|
83
|
-
// falhava o job e PERDIA o documento recém-gerado — com a chamada de IA já
|
|
84
|
-
// paga. Repetir pull+push resolve: o rebase reaplica o commit sobre a ponta
|
|
85
|
-
// nova e o segundo push passa.
|
|
86
|
-
|
|
87
|
-
export const PUSH_ATTEMPTS = 5;
|
|
88
|
-
const PUSH_BASE_MS = 500;
|
|
89
|
-
|
|
90
|
-
// Rejeição por CORRIDA: o remoto andou, e reaplicar por cima resolve.
|
|
91
|
-
const RACE_PATTERNS = /non-fast-forward|fetch first|Updates were rejected|cannot lock ref|failed to lock/i;
|
|
92
|
-
|
|
93
|
-
// Recusa DELIBERADA do remoto. Compartilha a linha genérica "failed to push
|
|
94
|
-
// some refs" com a corrida, então precisa ser testada ANTES: repetir aqui só
|
|
95
|
-
// atrasa a mensagem que o usuário precisa ler. Mesma filosofia de
|
|
96
|
-
// `isTransientProviderError` (lib/claude.mjs).
|
|
97
|
-
const REFUSED_PATTERNS = /GH006|protected branch|pre-receive hook declined|permission to .* denied|403 Forbidden|Authentication failed|could not read Username|Repository not found/i;
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* A saída do git indica disputa pela ponta da branch? (função PURA)
|
|
101
|
-
*
|
|
102
|
-
* @param {string} output stdout+stderr do comando que falhou
|
|
103
|
-
* @returns {boolean}
|
|
104
|
-
*/
|
|
105
|
-
export function isRacePushError(output) {
|
|
106
|
-
const text = String(output || '');
|
|
107
|
-
if (!text) return false;
|
|
108
|
-
if (REFUSED_PATTERNS.test(text)) return false;
|
|
109
|
-
return RACE_PATTERNS.test(text);
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* Espera antes da próxima tentativa (função PURA).
|
|
114
|
-
*
|
|
115
|
-
* Exponencial COM jitter: sem o jitter, dois runs que colidiram uma vez voltam
|
|
116
|
-
* a colidir no mesmo instante — o backoff determinístico os mantém em fase.
|
|
117
|
-
*
|
|
118
|
-
* @param {number} attempt tentativa que acabou de falhar (1-based)
|
|
119
|
-
* @param {object} [opts]
|
|
120
|
-
* @param {number} [opts.baseMs]
|
|
121
|
-
* @param {() => number} [opts.random] injetável para o teste
|
|
122
|
-
* @returns {number} milissegundos
|
|
123
|
-
*/
|
|
124
|
-
export function pushBackoffMs(attempt, { baseMs = PUSH_BASE_MS, random = Math.random } = {}) {
|
|
125
|
-
const teto = baseMs * 2 ** (attempt - 1); // 500ms, 1s, 2s, 4s…
|
|
126
|
-
return Math.round(teto * (1 + random())); // [teto, 2*teto)
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
// Sleep BLOQUEANTE de propósito: `commitGenerated` é síncrona de ponta a ponta
|
|
130
|
-
// (execSync), e um único `await` no meio obrigaria os três comandos chamadores
|
|
131
|
-
// e a suíte inteira a virarem async para nada — nada mais roda nesta thread
|
|
132
|
-
// enquanto o git trabalha.
|
|
133
|
-
function sleepSync(ms) {
|
|
134
|
-
if (ms > 0) Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, ms);
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Roda um comando git capturando a saída, e a devolve anexada ao erro.
|
|
139
|
-
*
|
|
140
|
-
* Com `stdio: 'inherit'` o texto do git vai para o log mas NÃO chega ao
|
|
141
|
-
* processo: `err.message` é só "Command failed: git push", e não dá para
|
|
142
|
-
* distinguir corrida de branch protegida. Capturando, o log continua igual
|
|
143
|
-
* (reemitimos) e a classificação passa a ser possível.
|
|
144
|
-
*/
|
|
145
|
-
function gitCaptured(cmd) {
|
|
146
|
-
try {
|
|
147
|
-
const out = execSync(cmd, { stdio: ['ignore', 'pipe', 'pipe'] });
|
|
148
|
-
if (out?.length) process.stdout.write(out);
|
|
149
|
-
return;
|
|
150
|
-
} catch (err) {
|
|
151
|
-
const detail = [err.stdout, err.stderr].map(b => b?.toString() || '').join('').trim();
|
|
152
|
-
if (detail) process.stderr.write(`${detail}\n`);
|
|
153
|
-
const resumo = detail.split('\n').find(l => l.trim()) || err.message;
|
|
154
|
-
const erro = new Error(`${cmd} falhou: ${resumo}`);
|
|
155
|
-
erro.gitOutput = detail;
|
|
156
|
-
throw erro;
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
// Rebase interrompido (conflito, ou pull abortado no meio) deixa o repositório
|
|
161
|
-
// EM rebase. No runner descartável tanto faz; no clone do usuário, sair assim
|
|
162
|
-
// é deixar um estado que ele não pediu e talvez nem perceba.
|
|
163
|
-
function abortRebaseIfAny() {
|
|
164
|
-
try {
|
|
165
|
-
const dir = execSync('git rev-parse --git-path rebase-merge', { stdio: 'pipe' }).toString().trim();
|
|
166
|
-
const dirApply = execSync('git rev-parse --git-path rebase-apply', { stdio: 'pipe' }).toString().trim();
|
|
167
|
-
if (!existsSync(dir) && !existsSync(dirApply)) return;
|
|
168
|
-
execSync('git rebase --abort', { stdio: 'pipe' });
|
|
169
|
-
} catch {
|
|
170
|
-
// Melhor esforço: se nem abortar dá, o erro original é o que importa.
|
|
171
|
-
}
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* pull --rebase + push, repetindo enquanto a falha for disputa pela branch.
|
|
176
|
-
*
|
|
177
|
-
* @returns {{attempts: number}}
|
|
178
|
-
* @throws o erro do git quando não é corrida, ou quando as tentativas acabam
|
|
179
|
-
*/
|
|
180
|
-
function publishWithRetry({ attempts, baseMs }) {
|
|
181
|
-
for (let attempt = 1; ; attempt++) {
|
|
182
|
-
try {
|
|
183
|
-
gitCaptured('git pull --rebase');
|
|
184
|
-
gitCaptured('git push');
|
|
185
|
-
return { attempts: attempt };
|
|
186
|
-
} catch (err) {
|
|
187
|
-
abortRebaseIfAny();
|
|
188
|
-
if (attempt >= attempts || !isRacePushError(err.gitOutput || err.message)) throw err;
|
|
189
|
-
const espera = pushBackoffMs(attempt, { baseMs });
|
|
190
|
-
console.warn(
|
|
191
|
-
`Publicação disputada por outro run (tentativa ${attempt}/${attempts}) — ` +
|
|
192
|
-
`repetindo em ${(espera / 1000).toFixed(1)}s.`
|
|
193
|
-
);
|
|
194
|
-
sleepSync(espera);
|
|
195
|
-
}
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* Grava um arquivo gerado e o publica: commit + pull --rebase + push.
|
|
201
|
-
*
|
|
202
|
-
* Era o mesmo bloco copiado em `generate-spec`, `generate-plan` e `decompose`,
|
|
203
|
-
* com a identidade do bot embutida. Centralizado aqui para que a diferença
|
|
204
|
-
* entre os modos exista num lugar só.
|
|
205
|
-
*
|
|
206
|
-
* O commit é escopado ao caminho (`git commit -- <arquivo>`): sem isso, qualquer
|
|
207
|
-
* coisa que você já tivesse no index entraria junto no commit do spec-wave —
|
|
208
|
-
* irrelevante num runner limpo, nada irrelevante no seu clone.
|
|
209
|
-
*
|
|
210
|
-
* @param {object} params
|
|
211
|
-
* @param {string} params.filePath caminho absoluto do arquivo
|
|
212
|
-
* @param {string} params.content
|
|
213
|
-
* @param {string} params.message mensagem de commit
|
|
214
|
-
* @param {'actions'|'local'} params.mode
|
|
215
|
-
* @param {{attempts?: number, baseMs?: number}} [params.retry] ajuste do laço de
|
|
216
|
-
* publicação — existe para o teste não dormir o backoff real
|
|
217
|
-
* @returns {{committed: boolean, pushed: boolean, warning: string|null}}
|
|
218
|
-
*/
|
|
219
|
-
export function commitGenerated({ filePath, content, message, mode, retry = {} }) {
|
|
220
|
-
mkdirSync(path.dirname(filePath), { recursive: true });
|
|
221
|
-
writeFileSync(filePath, content, 'utf-8');
|
|
222
|
-
|
|
223
|
-
const git = (cmd, opts = {}) => execSync(cmd, { stdio: 'inherit', ...opts });
|
|
224
|
-
const gitQuiet = (cmd) => execSync(cmd, { stdio: 'pipe' }).toString().trim();
|
|
225
|
-
|
|
226
|
-
if (mode === 'actions') {
|
|
227
|
-
// Runner descartável: identidade do bot é o que se quer no histórico.
|
|
228
|
-
git('git config user.email "spec-wave[bot]@github.com"');
|
|
229
|
-
git('git config user.name "spec-wave[bot]"');
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
git(`git add "${filePath}"`);
|
|
233
|
-
|
|
234
|
-
// Nada mudou (regerar conteúdo idêntico) → `git commit` sairia 1 e derrubaria
|
|
235
|
-
// o comando depois de o trabalho estar feito.
|
|
236
|
-
let hasChanges = true;
|
|
237
|
-
try {
|
|
238
|
-
execSync(`git diff --cached --quiet -- "${filePath}"`, { stdio: 'pipe' });
|
|
239
|
-
hasChanges = false;
|
|
240
|
-
} catch {
|
|
241
|
-
hasChanges = true;
|
|
242
|
-
}
|
|
243
|
-
if (!hasChanges) {
|
|
244
|
-
return { committed: false, pushed: false, warning: 'conteúdo idêntico ao já versionado — nada a commitar' };
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
git(`git commit -m "${message}" -- "${filePath}"`);
|
|
248
|
-
|
|
249
|
-
try {
|
|
250
|
-
publishWithRetry({
|
|
251
|
-
attempts: retry.attempts ?? PUSH_ATTEMPTS,
|
|
252
|
-
baseMs: retry.baseMs ?? PUSH_BASE_MS,
|
|
253
|
-
});
|
|
254
|
-
return { committed: true, pushed: true, warning: null };
|
|
255
|
-
} catch (err) {
|
|
256
|
-
if (mode === 'actions') throw err;
|
|
257
|
-
// Local: o arquivo está gerado e commitado. Derrubar o comando aqui
|
|
258
|
-
// esconderia esse fato atrás de um erro de rede/divergência.
|
|
259
|
-
const branch = (() => {
|
|
260
|
-
try {
|
|
261
|
-
return gitQuiet('git rev-parse --abbrev-ref HEAD');
|
|
262
|
-
} catch {
|
|
263
|
-
return 'seu branch';
|
|
264
|
-
}
|
|
265
|
-
})();
|
|
266
|
-
return {
|
|
267
|
-
committed: true,
|
|
268
|
-
pushed: false,
|
|
269
|
-
warning:
|
|
270
|
-
`commit feito em ${branch}, mas o push falhou (${err.message.split('\n')[0]}). ` +
|
|
271
|
-
'O arquivo está salvo e versionado — publique quando resolver.',
|
|
272
|
-
};
|
|
273
|
-
}
|
|
274
|
-
}
|
package/src/lib/next-step.mjs
CHANGED
|
@@ -19,9 +19,11 @@ import {
|
|
|
19
19
|
LABEL_CRITIQUE_FAILED, LABEL_NEEDS_HUMAN, LABEL_PLAN_APPROVED, LABEL_TRIAGED,
|
|
20
20
|
LABEL_DUPLICATE, LABEL_WONT_FIX, LABEL_READY, labelNames,
|
|
21
21
|
} from '../config.mjs';
|
|
22
|
+
import { awaitingMergeBlock } from './artifact-pr.mjs';
|
|
23
|
+
import { isAwaitingMerge } from './doc-source.mjs';
|
|
22
24
|
|
|
23
25
|
/**
|
|
24
|
-
* @typedef {'local'|'remote'|'missing'|'unknown'} DocState
|
|
26
|
+
* @typedef {'local'|'remote'|'pending-pr'|'missing'|'unknown'} DocState
|
|
25
27
|
* @typedef {'generate-spec'|'generate-plan'|'critique'|'validate'|'decompose'
|
|
26
28
|
* |'decompose-apply'|'generate-bug'|'triage'|'implement'|'none'} StepAction
|
|
27
29
|
*/
|
|
@@ -211,6 +213,8 @@ export function resolveForcedStep(step, { type }) {
|
|
|
211
213
|
* @param {'open'|'closed'} [params.state]
|
|
212
214
|
* @param {Array<string|{name:string}>} [params.labels]
|
|
213
215
|
* @param {Record<string, DocState>} [params.docs] estado de spec/plan/decomposition/bug
|
|
216
|
+
* @param {Record<string, object>} [params.docPrs] PR aberto de cada documento em
|
|
217
|
+
* `pending-pr` — só para a mensagem
|
|
214
218
|
* @param {Record<string, string>} [params.docPaths] caminhos relativos (só para as mensagens)
|
|
215
219
|
* @param {StepAction|null} [params.forcedStep] resultado de resolveForcedStep
|
|
216
220
|
* @param {boolean} [params.confirmed] `--yes`/`--apply` já dados
|
|
@@ -220,7 +224,7 @@ export function resolveForcedStep(step, { type }) {
|
|
|
220
224
|
* blocked: null|{code: string, message: string, unblock: string}}}
|
|
221
225
|
*/
|
|
222
226
|
export function nextStep({
|
|
223
|
-
type, issueNumber, state = 'open', labels = [], docs = {}, docPaths = {},
|
|
227
|
+
type, issueNumber, state = 'open', labels = [], docs = {}, docPaths = {}, docPrs = {},
|
|
224
228
|
forcedStep = null, confirmed = false, boardReady = true, force = false,
|
|
225
229
|
} = {}) {
|
|
226
230
|
const params = { issueNumber };
|
|
@@ -285,6 +289,25 @@ export function nextStep({
|
|
|
285
289
|
}
|
|
286
290
|
}
|
|
287
291
|
|
|
292
|
+
// G5.5 — documento gerado e esperando merge. Precisa vir ANTES do
|
|
293
|
+
// `pipelineStep`: para ele, um documento que não está na base "não existe", e
|
|
294
|
+
// a resposta seria REGERAR — pagando a chamada de IA outra vez, a cada
|
|
295
|
+
// execução, e descartando o que o revisor já editou dentro do PR.
|
|
296
|
+
//
|
|
297
|
+
// Antes do `forcedStep` também, de propósito: `--step spec --yes` é
|
|
298
|
+
// exatamente o comando que alguém impaciente rodaria aqui, e ele passaria por
|
|
299
|
+
// cima da revisão em curso.
|
|
300
|
+
for (const doc of docsOfType) {
|
|
301
|
+
const estado = docState(docs, doc);
|
|
302
|
+
if (isAwaitingMerge(estado)) {
|
|
303
|
+
const info = docPrs[doc] || {};
|
|
304
|
+
return decided('none', `\`${pathOf(doc)}\` foi gerado e ainda não está na base.`, params,
|
|
305
|
+
awaitingMergeBlock({
|
|
306
|
+
pathRel: pathOf(doc), state: estado, pr: info.pr || null, branch: info.branch || null,
|
|
307
|
+
}));
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
|
|
288
311
|
const action = forcedStep || pipelineStep({ type, docs, has });
|
|
289
312
|
if (action === 'none') {
|
|
290
313
|
return decided('none', nothingPendingReason({ type, has }), params);
|
|
@@ -299,8 +322,8 @@ export function nextStep({
|
|
|
299
322
|
`Rode \`${stepCommand(action, params)}\` quando decidir.`));
|
|
300
323
|
}
|
|
301
324
|
|
|
302
|
-
// G6 — documento que o passo lê ou escreve existe só
|
|
303
|
-
//
|
|
325
|
+
// G6 — documento que o passo lê ou escreve existe só na branch base. Gerar por
|
|
326
|
+
// cima publicaria um Pull Request que desfaz o documento bom.
|
|
304
327
|
for (const doc of stepDocs(action, type)) {
|
|
305
328
|
if (docState(docs, doc) === 'remote') {
|
|
306
329
|
return decided(action, `\`${pathOf(doc)}\` existe no repositório mas não no seu clone.`, params,
|
package/src/lib/pr-branch.mjs
CHANGED
|
@@ -130,7 +130,11 @@ export function buildCommitMessage({ version = CLI_VERSION, files = [] } = {}) {
|
|
|
130
130
|
* @param {{created: string[], updated: string[], removed: string[]}|null} [a.labels]
|
|
131
131
|
* labels EFETIVAMENTE aplicadas (não o diff detectado — o corpo não pode
|
|
132
132
|
* prometer o que falhou)
|
|
133
|
-
* @param {string[]} [a.skill]
|
|
133
|
+
* @param {string[]|{inPr?: string[], local?: string[]}} [a.skill] agentes cuja
|
|
134
|
+
* skill foi atualizada: `inPr` os que entraram no commit (a cópia da skill
|
|
135
|
+
* É versionada na base) e `local` os que ficaram só na máquina. Um array
|
|
136
|
+
* simples é lido como `local` — a forma antiga, de quando a skill nunca
|
|
137
|
+
* entrava no PR.
|
|
134
138
|
* @returns {string} markdown
|
|
135
139
|
*/
|
|
136
140
|
export function composePrBody({
|
|
@@ -173,14 +177,31 @@ export function composePrBody({
|
|
|
173
177
|
if (labels.removed.length) l.push(`- removidas (descontinuadas): ${labels.removed.map(n => `\`${n}\``).join(', ')}`);
|
|
174
178
|
}
|
|
175
179
|
|
|
176
|
-
|
|
180
|
+
// A skill não é mais declarada "fora do repositório" por premissa: quem chama
|
|
181
|
+
// consultou a base arquivo a arquivo (decideSkillInPr) e diz aqui o que
|
|
182
|
+
// realmente aconteceu. Afirmar "não faz parte do repositório" para um repo que
|
|
183
|
+
// versiona `.claude/skills/spec-wave/SKILL.md` mandava o revisor aprovar um PR
|
|
184
|
+
// incompleto — e deixava o repositório distribuindo a skill da versão anterior.
|
|
185
|
+
const skillInPr = Array.isArray(skill) ? [] : (skill?.inPr ?? []);
|
|
186
|
+
const skillLocal = Array.isArray(skill) ? skill : (skill?.local ?? []);
|
|
187
|
+
if (skillInPr.length || skillLocal.length) {
|
|
177
188
|
l.push('');
|
|
178
|
-
l.push('## Skill dos agentes
|
|
189
|
+
l.push('## Skill dos agentes');
|
|
179
190
|
l.push('');
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
191
|
+
if (skillInPr.length) {
|
|
192
|
+
l.push(
|
|
193
|
+
`Incluída neste PR, nos arquivos listados acima: ${skillInPr.map(n => `\`${n}\``).join(', ')}. ` +
|
|
194
|
+
`Esta cópia da skill é conteúdo do repositório — o merge em \`${base}\` é o que a ` +
|
|
195
|
+
'entrega a quem clonar.'
|
|
196
|
+
);
|
|
197
|
+
}
|
|
198
|
+
if (skillLocal.length) {
|
|
199
|
+
if (skillInPr.length) l.push('');
|
|
200
|
+
l.push(
|
|
201
|
+
`Atualizada só na máquina local: ${skillLocal.map(n => `\`${n}\``).join(', ')}. ` +
|
|
202
|
+
'Esta cópia não é versionada no repositório e não faz parte deste PR.'
|
|
203
|
+
);
|
|
204
|
+
}
|
|
184
205
|
}
|
|
185
206
|
|
|
186
207
|
l.push('');
|
|
@@ -235,6 +256,74 @@ export function decideConfigInPr({ remote, desired, willRegenerate = false, forc
|
|
|
235
256
|
return { included: true, reason: 'versionado na base e divergente do local' };
|
|
236
257
|
}
|
|
237
258
|
|
|
259
|
+
/**
|
|
260
|
+
* Uma cópia da skill entra no PR? (função PURA)
|
|
261
|
+
*
|
|
262
|
+
* MESMA regra do .spec-wave.json, pelo mesmo motivo: onde o arquivo mora é
|
|
263
|
+
* decisão do projeto, e o update não pode mudá-la sozinho — nem passando a
|
|
264
|
+
* versionar o que ninguém commitou, nem deixando de atualizar o que o repositório
|
|
265
|
+
* já distribui. A diferença é que aqui não existe `willRegenerate`: o conteúdo
|
|
266
|
+
* desejado da skill é renderizado do pacote e já está pronto na hora de decidir.
|
|
267
|
+
*
|
|
268
|
+
* Vale por ARQUIVO, não por agente: o destino do Codex (`.agents/skills/`) são 20+
|
|
269
|
+
* arquivos, e nada garante que o repositório versione todos.
|
|
270
|
+
*
|
|
271
|
+
* @param {object} [a]
|
|
272
|
+
* @param {string|null|undefined} [a.remote] conteúdo do arquivo na base (null/undefined = não versionado)
|
|
273
|
+
* @param {string|null} [a.desired] conteúdo que a instalação local grava
|
|
274
|
+
* @param {boolean|undefined} [a.force] undefined | true (--skill-in-pr) | false (--no-skill-in-pr)
|
|
275
|
+
* @returns {{ included: boolean, reason: string }}
|
|
276
|
+
*/
|
|
277
|
+
export function decideSkillInPr({ remote, desired, force } = {}) {
|
|
278
|
+
const versioned = remote !== null && remote !== undefined;
|
|
279
|
+
if (force === false) return { included: false, reason: '--no-skill-in-pr' };
|
|
280
|
+
if (!desired) return { included: false, reason: 'sem conteúdo local para enviar' };
|
|
281
|
+
if (force === true) {
|
|
282
|
+
return versioned
|
|
283
|
+
? { included: true, reason: '--skill-in-pr' }
|
|
284
|
+
: { included: true, reason: '--skill-in-pr (passa a versionar a skill)' };
|
|
285
|
+
}
|
|
286
|
+
if (!versioned) {
|
|
287
|
+
return {
|
|
288
|
+
included: false,
|
|
289
|
+
reason: 'não está versionada na base, segue apenas local ' +
|
|
290
|
+
'(use --skill-in-pr para versioná-la)',
|
|
291
|
+
};
|
|
292
|
+
}
|
|
293
|
+
if (remote === desired) return { included: false, reason: 'já idêntica na base' };
|
|
294
|
+
return { included: true, reason: 'versionada na base e divergente do local' };
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Dica para descartar a cópia local de um arquivo que também foi no PR (PURA).
|
|
299
|
+
*
|
|
300
|
+
* `git checkout -- <arquivo>` restaura a versão do ÍNDICE, isto é, a do HEAD da
|
|
301
|
+
* branch que está no checkout. Ele só descarta uma cópia redundante quando o
|
|
302
|
+
* clone está na base; rodado de uma branch de trabalho, faz o oposto do que a
|
|
303
|
+
* mensagem promete — reverte o arquivo para a versão antiga daquela branch. A
|
|
304
|
+
* dica, portanto, depende da branch corrente, que a CLI já sabe consultar.
|
|
305
|
+
*
|
|
306
|
+
* @param {object} [a]
|
|
307
|
+
* @param {string} [a.file] caminho do arquivo, relativo à raiz
|
|
308
|
+
* @param {string} [a.base] branch base do Pull Request
|
|
309
|
+
* @param {string|null} [a.current] branch do clone local (null = detached/fora de git)
|
|
310
|
+
* @returns {string} frase única, para o `outro` do comando
|
|
311
|
+
*/
|
|
312
|
+
export function composeConfigCleanupHint({ file = CONFIG_FILE, base = 'main', current = null } = {}) {
|
|
313
|
+
const cabeca = `O ${file} local ficou igual ao do PR`;
|
|
314
|
+
if (current === base) {
|
|
315
|
+
return `${cabeca} — depois do merge, descarte a cópia local com ` +
|
|
316
|
+
`\`git checkout -- ${file}\` antes do \`git pull\`.`;
|
|
317
|
+
}
|
|
318
|
+
const onde = current
|
|
319
|
+
? `o checkout está em "${current}", e \`git checkout -- ${file}\` ali restauraria a ` +
|
|
320
|
+
'versão antiga dessa branch'
|
|
321
|
+
: `o checkout não está numa branch, e \`git checkout -- ${file}\` ali restauraria a ` +
|
|
322
|
+
'versão antiga do HEAD atual';
|
|
323
|
+
return `${cabeca} — ${onde}. Depois do merge, descarte a cópia local na base: ` +
|
|
324
|
+
`\`git switch ${base} && git checkout -- ${file}\`.`;
|
|
325
|
+
}
|
|
326
|
+
|
|
238
327
|
/**
|
|
239
328
|
* Traduz o erro cru da Git Data API para uma dica acionável (função PURA).
|
|
240
329
|
*
|
|
@@ -251,6 +340,16 @@ export function explainGitWriteError(err) {
|
|
|
251
340
|
case 401:
|
|
252
341
|
return `${msg} — token inválido ou expirado.`;
|
|
253
342
|
case 403:
|
|
343
|
+
// O GitHub Actions recusa a criação de PR com uma mensagem própria, e ela
|
|
344
|
+
// é a falha MAIS provável deste fluxo: a opção "Allow GitHub Actions to
|
|
345
|
+
// create and approve pull requests" vem desligada em muitas organizações.
|
|
346
|
+
// Sem este ramo, o usuário lê "permissão de escrita" e vai mexer em
|
|
347
|
+
// escopo de token, que não é o problema.
|
|
348
|
+
if (/not permitted to create or approve pull requests/i.test(msg)) {
|
|
349
|
+
return `${msg} — o GITHUB_TOKEN está proibido de abrir Pull Requests neste ` +
|
|
350
|
+
'repositório. Ligue Settings → Actions → General → "Allow GitHub Actions to ' +
|
|
351
|
+
'create and approve pull requests", ou forneça um PAT no secret `GH_PR_TOKEN`.';
|
|
352
|
+
}
|
|
254
353
|
return `${msg} — o token não tem permissão de escrita. Precisa de "Contents: write" e ` +
|
|
255
354
|
'"Pull requests: write" (fine-grained) ou do escopo `repo` (classic).';
|
|
256
355
|
case 404:
|
package/src/lib/repo-links.mjs
CHANGED
|
@@ -26,7 +26,7 @@ export function blobUrl({ owner, repo, ref, pathRel }) {
|
|
|
26
26
|
* Qual ref o link deve citar (função PURA).
|
|
27
27
|
*
|
|
28
28
|
* No Actions, `GITHUB_REF_NAME` é a branch do evento. Localmente, a branch
|
|
29
|
-
* corrente é a que
|
|
29
|
+
* corrente é a que o usuário está usando. `main` é o último
|
|
30
30
|
* recurso — o mesmo valor que estava hardcoded, então nunca piora.
|
|
31
31
|
*
|
|
32
32
|
* @param {object} params
|
|
@@ -71,9 +71,15 @@ export function currentGitBranch(cwd = process.cwd()) {
|
|
|
71
71
|
* @param {'actions'|'local'} params.mode
|
|
72
72
|
* @param {string|null} [params.root] raiz do repo (para ler a branch corrente)
|
|
73
73
|
* @param {object|null} [params.config]
|
|
74
|
+
* @param {string|null} [params.ref] ref EXPLÍCITA, com precedência sobre tudo.
|
|
75
|
+
* Com a publicação por Pull Request, quem gerou o documento sabe exatamente em
|
|
76
|
+
* que branch ele está — e a inferência abaixo erraria: num evento
|
|
77
|
+
* `issues: labeled` o `GITHUB_REF_NAME` é a branch DEFAULT, onde o documento
|
|
78
|
+
* ainda não existe, então todo link nasceria 404 até o merge.
|
|
74
79
|
* @returns {string}
|
|
75
80
|
*/
|
|
76
|
-
export function docBlobUrl({ owner, repo, pathRel, mode, root = null, config = null }) {
|
|
81
|
+
export function docBlobUrl({ owner, repo, pathRel, mode, root = null, config = null, ref: refExplicita = null }) {
|
|
82
|
+
if (refExplicita) return blobUrl({ owner, repo, ref: refExplicita, pathRel });
|
|
77
83
|
const ref = resolveDocRef({
|
|
78
84
|
mode,
|
|
79
85
|
env: process.env,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "spec-wave",
|
|
3
3
|
"displayName": "Spec Wave",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.28.0",
|
|
5
5
|
"description": "Fluxo spec-driven no GitHub (RFC-001): Projects v2, labels de gatilho, spec/plan gerados por Action, decomposição em duas etapas e implementação orientada a Stories/Tasks.",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Astratech",
|
package/src/plugin/README.md
CHANGED
|
@@ -18,6 +18,11 @@ carrega só a sua instrução.
|
|
|
18
18
|
| `plan` | Gera `plan.md` (2º documento) + `tech_context.yml` |
|
|
19
19
|
| `ready` | Valida spec + plan |
|
|
20
20
|
| `decompose` | Rascunho revisável → Stories/Tasks |
|
|
21
|
+
| `preparar-feature` | Orquestra: da spec até ✅ Ready, com Stories e Tasks criadas |
|
|
22
|
+
| `preparar-specs` | Orquestra: as specs de uma milestone inteira |
|
|
23
|
+
| `run` | Executa o próximo passo localmente (`run`/`mode`) |
|
|
24
|
+
| `bug` | Fluxo do Bug: `bug.md`, triagem, correção |
|
|
25
|
+
| `triage` | Tria um Bug: accept / reject / duplicate |
|
|
21
26
|
| `order` | Ordem topológica das Stories |
|
|
22
27
|
| `implement` | Etapa 🚧 Desenvolvimento |
|
|
23
28
|
| `task` | `start` / `done` de uma Task |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: spec-wave-bug
|
|
3
|
-
description: "Use para gerar o bug.md de um defeito do spec-wave — reprodução, causa raiz, escopo do fix e teste de regressão. Aplica a label spec-wave:bug e deixa o GitHub Action gerar
|
|
3
|
+
description: "Use para gerar o bug.md de um defeito do spec-wave — reprodução, causa raiz, escopo do fix e teste de regressão. Aplica a label spec-wave:bug e deixa o GitHub Action gerar o arquivo em docs/bugs/<slug>/ e abrir um Pull Request. Gatilhos: 'gerar o bug.md da issue 42', 'documentar a causa raiz do bug', 'rodar o spec-wave:bug'. Só vale para issues do tipo Bug — Feature usa spec/plan."
|
|
4
4
|
allowed-tools:
|
|
5
5
|
- Bash(gh issue *)
|
|
6
6
|
- Bash(npx @spec-wave/cli@latest *)
|
|
@@ -9,7 +9,7 @@ allowed-tools:
|
|
|
9
9
|
|
|
10
10
|
# spec-wave bug — o documento do defeito
|
|
11
11
|
|
|
12
|
-
> **Regra fundamental: nunca escreva o `bug.md` você mesmo.** Aplique a label e deixe o Action gerar — é isso que garante que o arquivo
|
|
12
|
+
> **Regra fundamental: nunca escreva o `bug.md` você mesmo.** Aplique a label e deixe o Action gerar — é isso que garante que o arquivo chegue à main por Pull Request e seja referenciado na issue. Exceção: revisar/melhorar um `bug.md` já gerado (aí sim use Edit no arquivo local).
|
|
13
13
|
|
|
14
14
|
**Contexto:** leia `.spec-wave.json` (Read). Ausente → skill **setup**.
|
|
15
15
|
|
|
@@ -24,7 +24,7 @@ Para qualquer outro tipo (Spike, Bug, Story, Task…) o Action **recusa** e come
|
|
|
24
24
|
|
|
25
25
|
```
|
|
26
26
|
spec-wave:decompose
|
|
27
|
-
├─ decomposition.md ausente → gera via IA →
|
|
27
|
+
├─ decomposition.md ausente → gera via IA → abre Pull Request → critica
|
|
28
28
|
└─ decomposition.md presente → critica o arquivo COMO ESTÁ (preserva suas edições)
|
|
29
29
|
├─ grave → +critique-failed, comentário citando Story N / Task N.M, exit 1
|
|
30
30
|
└─ limpo → +decompose-ready, comentário "revise e aplique"
|
|
@@ -45,14 +45,14 @@ spec-wave:decompose-apply
|
|
|
45
45
|
# ou Action — assíncrono
|
|
46
46
|
gh issue edit <número> --add-label "spec-wave:decompose"
|
|
47
47
|
```
|
|
48
|
-
Informe: "Rascunho iniciado — vai
|
|
48
|
+
Informe: "Rascunho iniciado — vai abrir um Pull Request com o `decomposition.md` e passar pela crítica. **Nenhuma issue é criada nesta etapa.**"
|
|
49
49
|
|
|
50
50
|
3. **Leia o resultado** quando o Action terminar:
|
|
51
51
|
|
|
52
52
|
| Label resultante | O que fazer |
|
|
53
53
|
|------------------|-------------|
|
|
54
54
|
| `spec-wave:decompose-ready` | Passou na crítica. **Leia o `decomposition.md`** e mostre ao usuário o que será criado (Stories, Tasks, dependências). Ofereça editar antes de aplicar. |
|
|
55
|
-
| `spec-wave:critique-failed` | O Action **falhou (exit 1)** e nada foi criado. Os achados citam `Story N` / `Task N.M`. **Corrija o `decomposition.md`** — não o `plan.md` —
|
|
55
|
+
| `spec-wave:critique-failed` | O Action **falhou (exit 1)** e nada foi criado. Os achados citam `Story N` / `Task N.M`. **Corrija o `decomposition.md`** — não o `plan.md` — **no Pull Request** e reaplique `spec-wave:decompose` (o arquivo é criticado como está, sem ser regerado, venha ele do PR ou da base). |
|
|
56
56
|
| `spec-wave:needs-human` | A crítica esgotou as tentativas. **Pare** e envolva o usuário: as duas labels precisam sair à mão. |
|
|
57
57
|
|
|
58
58
|
4. **Etapa 2 — aplicar o rascunho aprovado**, só depois da revisão:
|
|
@@ -95,7 +95,7 @@ Corpo técnico.
|
|
|
95
95
|
- a **posição** manda, não o número escrito — inserir uma Story no meio sem renumerar funciona
|
|
96
96
|
- `**Depende de:**` aceita **irmãs** (`Story 1, Story 3`, 1-based, só para trás — apontar para si mesma ou para frente é **erro**, não filtro silencioso) e **issues de outras Features** (`#412`, que precisam JÁ existir); as duas formas convivem na mesma linha (`Story 1, #412`), e `—` significa nenhuma
|
|
97
97
|
- o corpo aceita markdown livre (`## Backend`, cercas de código) — só `## Story N` e `### Task N.M` são estrutura
|
|
98
|
-
- **para gerar outro rascunho do zero:** apague o arquivo e reaplique `spec-wave:decompose`
|
|
98
|
+
- **para gerar outro rascunho do zero:** feche o Pull Request e apague a branch `spec-wave/<n>-decompose` (ou apague o arquivo, se já foi mergeado) e reaplique `spec-wave:decompose`
|
|
99
99
|
|
|
100
100
|
> ⚠️ O slug vem do **título**. Renomear a Feature entre o rascunho e o apply muda o diretório e órfã o `decomposition.md` — o apply reclama que não achou o rascunho.
|
|
101
101
|
|
|
@@ -14,7 +14,7 @@ allowed-tools:
|
|
|
14
14
|
|
|
15
15
|
> **Regra fundamental: nunca escreva o `plan.md` à mão.** Quem gera é o spec-wave — pelo Action ou pela CLI local. Exceção: revisar/melhorar um plano já gerado.
|
|
16
16
|
|
|
17
|
-
**Dois modos, mesmo resultado.** `npx @spec-wave/cli@latest generate-plan --issue-number <n>` roda **agora**, nesta sessão; a label `spec-wave:plan` roda no Action. O modo é detectado pelo ambiente. Ambos geram,
|
|
17
|
+
**Dois modos, mesmo resultado.** `npx @spec-wave/cli@latest generate-plan --issue-number <n>` roda **agora**, nesta sessão; a label `spec-wave:plan` roda no Action. O modo é detectado pelo ambiente. Ambos geram, abrem um **Pull Request**, criticam e comentam na issue. Local exige a chave de IA no seu ambiente. Veja a skill **spec** para a tabela completa.
|
|
18
18
|
|
|
19
19
|
**Contexto:** leia `.spec-wave.json` (Read). Ausente → skill **setup**.
|
|
20
20
|
|