@caiqueoak/flow 0.3.1 → 0.3.3
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/README.md +3 -3
- package/package.json +1 -1
- package/skills/flow/SKILL.md +2 -1
- package/skills/flow/references/graph.md +62 -0
- package/src/cli.mjs +64 -27
package/README.md
CHANGED
|
@@ -38,7 +38,7 @@ Flow internally loads only the guidance needed for discovery, planning, build, r
|
|
|
38
38
|
|
|
39
39
|
When authorized, Flow keeps a concise artifact model: product truth in `PRD.md`, engineering truth in `ENGINEERING.md`, decisions in `DECISIONS.md`, execution context in `STATE.md`, the canonical work-item DAG in `BACKLOG.yaml`, and a human-readable derived projection in `GRAPH.md`. Work items use `SPEC.md` plus `TASKS.yaml`. `SUMMARY.md` is not part of the model.
|
|
40
40
|
|
|
41
|
-
In `GRAPH.md`, work-item states are consistent: complete is green, in progress is blue, blocked is red when unfinished dependencies remain, and pending is yellow when all dependencies are complete and the item is ready to execute.
|
|
41
|
+
In `GRAPH.md`, work-item states are consistent: complete is green, in progress is blue, blocked is red when unfinished dependencies remain, and pending is yellow when all dependencies are complete and the item is ready to execute. Each Mermaid card contains only the work-item ID and canonical title. Every dependency arrow goes from dependency to dependent item and uses the color and line style of its source card.
|
|
42
42
|
|
|
43
43
|
## Update
|
|
44
44
|
|
|
@@ -48,9 +48,9 @@ Updates are explicit:
|
|
|
48
48
|
flow update
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
`flow update`
|
|
51
|
+
`flow update` updates the installation that provides the active CLI: the global package for `flow update`, or the project dependency for `npx flow update`. It uses npm's update operation and refreshes `/flow` for every coding agent configured in `.flow/config.yaml` without modifying canonical project state. If the project lockfile and the package on disk disagree, Flow safely reinstalls only its own package before updating.
|
|
52
52
|
|
|
53
|
-
On Windows, npm is invoked through
|
|
53
|
+
On Windows, npm is invoked through `cmd.exe` without Node's `shell: true` option, so `npm.cmd` executes without the `DEP0190` warning. When Flow is installed as a project dependency, `npx flow update` is equivalent.
|
|
54
54
|
|
|
55
55
|
There is no background update check or automatic update mechanism.
|
|
56
56
|
|
package/package.json
CHANGED
package/skills/flow/SKILL.md
CHANGED
|
@@ -47,7 +47,7 @@ Graph/control data is YAML:
|
|
|
47
47
|
|
|
48
48
|
Do not create `SUMMARY.md`, completion logs, ad-hoc progress documents, handoff documents, reports, or any other new project artifact unless the developer explicitly requests or authorizes them. Completed `SPEC.md` files retain concise Overview and Validation sections.
|
|
49
49
|
|
|
50
|
-
`GRAPH.md` is derived only. It must never become an independent source of truth and must be reconciled whenever work-item existence, dependencies, or status change.
|
|
50
|
+
`GRAPH.md` is derived only. It must never become an independent source of truth and must be reconciled whenever work-item existence, title, dependencies, or status change. Before creating or changing it, read `references/graph.md` and follow that contract exactly; do not preserve an established style that conflicts with it.
|
|
51
51
|
|
|
52
52
|
## Work item model
|
|
53
53
|
|
|
@@ -121,6 +121,7 @@ Load only the reference needed for current state:
|
|
|
121
121
|
- Ready planned tasks: `references/build.md`
|
|
122
122
|
- Completed implementation awaiting validation: `references/review.md`
|
|
123
123
|
- Decision impact or inconsistent artifacts: `references/reconcile.md`
|
|
124
|
+
- Creating or updating `GRAPH.md`: additionally load `references/graph.md`
|
|
124
125
|
|
|
125
126
|
## Orchestration loop
|
|
126
127
|
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# `GRAPH.md` Rules
|
|
2
|
+
|
|
3
|
+
Every Flow `GRAPH.md` must be a derived, human-readable projection of
|
|
4
|
+
`.flow/BACKLOG.yaml`. It never becomes an independent source of truth.
|
|
5
|
+
|
|
6
|
+
## Card content
|
|
7
|
+
|
|
8
|
+
Each Mermaid card contains exactly two lines:
|
|
9
|
+
|
|
10
|
+
```text
|
|
11
|
+
<work-item ID>
|
|
12
|
+
<work-item title>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Do not include status, priority, folder, dependency lists, or explanatory
|
|
16
|
+
prose inside a card. The title is the canonical `title` value from
|
|
17
|
+
`BACKLOG.yaml`.
|
|
18
|
+
|
|
19
|
+
## Status derivation and colors
|
|
20
|
+
|
|
21
|
+
Derive status from the backlog and dependencies after every meaningful state
|
|
22
|
+
transition.
|
|
23
|
+
|
|
24
|
+
| Status | Meaning | Card color | Outgoing arrow style |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| Complete | Work item is accepted and complete. | Green (`#16a34a`) | Solid green |
|
|
27
|
+
| In progress | Work item has active execution. | Blue (`#2563eb`) | Solid blue, thicker |
|
|
28
|
+
| Pending | Every dependency is complete and the item is ready to start. | Yellow (`#d97706`) | Dashed yellow |
|
|
29
|
+
| Blocked | The item is neither complete nor in progress and one or more dependencies are incomplete. | Red (`#dc2626`) | Dotted red |
|
|
30
|
+
|
|
31
|
+
Use matching fill, stroke, and readable text colors for cards. Every graph
|
|
32
|
+
must include a titled status legend using these colors.
|
|
33
|
+
|
|
34
|
+
## Dependencies and arrows
|
|
35
|
+
|
|
36
|
+
- Draw one arrow for every `depends_on` relationship in `BACKLOG.yaml`.
|
|
37
|
+
- The arrow goes from dependency to dependent item.
|
|
38
|
+
- Every outgoing arrow inherits the color and line style of its source card.
|
|
39
|
+
- Recalculate Mermaid `linkStyle` indexes whenever edges change; do not leave
|
|
40
|
+
a stale style assignment behind.
|
|
41
|
+
- Do not add visual-only dependency edges to force layout.
|
|
42
|
+
|
|
43
|
+
## Parallelism and layout
|
|
44
|
+
|
|
45
|
+
- Items on the same vertical rank must have no dependency on one another and
|
|
46
|
+
are candidates for parallel work.
|
|
47
|
+
- Keep independent, ready items on the same vertical rank where Mermaid can
|
|
48
|
+
represent the real dependency graph without artificial edges.
|
|
49
|
+
- Do not represent blocked items as pending merely because they are planned;
|
|
50
|
+
dependency readiness determines their graph status.
|
|
51
|
+
|
|
52
|
+
## Synchronization checklist
|
|
53
|
+
|
|
54
|
+
When work-item state, existence, title, or dependencies change:
|
|
55
|
+
|
|
56
|
+
1. Update `BACKLOG.yaml` first.
|
|
57
|
+
2. Recompute derived statuses using the definitions above.
|
|
58
|
+
3. Update `GRAPH.md`, including cards, arrows, styles, legend, and parallel
|
|
59
|
+
layout.
|
|
60
|
+
4. Update `STATE.md` when the active path or next ready work changes.
|
|
61
|
+
5. Verify that every backlog item appears exactly once and every dependency
|
|
62
|
+
appears exactly once in the graph.
|
package/src/cli.mjs
CHANGED
|
@@ -54,9 +54,11 @@ function question(rl, message) {
|
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
function runNpm(npmArgs, options = {}) {
|
|
57
|
+
if (process.platform === 'win32') {
|
|
58
|
+
return execFileSync(process.env.ComSpec || 'cmd.exe', ['/d', '/s', '/c', npmCommand(), ...npmArgs], options);
|
|
59
|
+
}
|
|
57
60
|
return execFileSync(npmCommand(), npmArgs, {
|
|
58
|
-
...options
|
|
59
|
-
shell: process.platform === 'win32'
|
|
61
|
+
...options
|
|
60
62
|
});
|
|
61
63
|
}
|
|
62
64
|
|
|
@@ -190,17 +192,6 @@ async function initProject() {
|
|
|
190
192
|
else { info(); info('Flow is ready. Open a configured coding agent and invoke /flow.'); }
|
|
191
193
|
}
|
|
192
194
|
|
|
193
|
-
function dependencySection(root) {
|
|
194
|
-
const file = path.join(root, 'package.json');
|
|
195
|
-
if (!fs.existsSync(file)) return '--save-dev';
|
|
196
|
-
try {
|
|
197
|
-
const pkg = JSON.parse(fs.readFileSync(file, 'utf8'));
|
|
198
|
-
if (pkg.dependencies?.[PACKAGE_NAME]) return '--save';
|
|
199
|
-
if (pkg.optionalDependencies?.[PACKAGE_NAME]) return '--save-optional';
|
|
200
|
-
} catch { /* use default */ }
|
|
201
|
-
return '--save-dev';
|
|
202
|
-
}
|
|
203
|
-
|
|
204
195
|
function containingNodeModules(packageRoot) {
|
|
205
196
|
let current = path.resolve(packageRoot);
|
|
206
197
|
while (true) {
|
|
@@ -211,44 +202,88 @@ function containingNodeModules(packageRoot) {
|
|
|
211
202
|
}
|
|
212
203
|
}
|
|
213
204
|
|
|
214
|
-
function
|
|
215
|
-
const
|
|
216
|
-
if (fs.existsSync(
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
cwd: root,
|
|
220
|
-
packageRoot: projectPackageRoot,
|
|
221
|
-
mode: 'project'
|
|
222
|
-
};
|
|
223
|
-
}
|
|
205
|
+
function installedPackageVersion(packageRoot) {
|
|
206
|
+
const manifest = path.join(packageRoot, 'package.json');
|
|
207
|
+
if (!fs.existsSync(manifest)) return null;
|
|
208
|
+
return JSON.parse(fs.readFileSync(manifest, 'utf8')).version || null;
|
|
209
|
+
}
|
|
224
210
|
|
|
211
|
+
function lockedPackageVersion(root) {
|
|
212
|
+
const lockfile = path.join(root, 'package-lock.json');
|
|
213
|
+
if (!fs.existsSync(lockfile)) return null;
|
|
214
|
+
try {
|
|
215
|
+
return JSON.parse(fs.readFileSync(lockfile, 'utf8')).packages?.[`node_modules/${PACKAGE_NAME}`]?.version || null;
|
|
216
|
+
} catch { return null; }
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function globalUpdatePlan(root) {
|
|
225
220
|
try {
|
|
226
221
|
const globalNodeModules = path.resolve(runNpm(['root', '--global'], { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim());
|
|
227
222
|
const globalPackageRoot = path.join(globalNodeModules, '@caiqueoak', 'flow');
|
|
228
223
|
if (path.resolve(ROOT).startsWith(`${globalNodeModules}${path.sep}`) && fs.existsSync(path.join(globalPackageRoot, 'package.json'))) {
|
|
229
224
|
return {
|
|
230
|
-
npmArgs: ['
|
|
225
|
+
npmArgs: ['update', '--global', PACKAGE_NAME],
|
|
231
226
|
cwd: root,
|
|
232
227
|
packageRoot: globalPackageRoot,
|
|
233
228
|
mode: 'global'
|
|
234
229
|
};
|
|
235
230
|
}
|
|
236
231
|
} catch { /* fall through to local installation detection */ }
|
|
232
|
+
return null;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function updatePlan(root) {
|
|
236
|
+
const global = globalUpdatePlan(root);
|
|
237
|
+
if (global) return global;
|
|
237
238
|
|
|
238
239
|
const nodeModules = containingNodeModules(ROOT);
|
|
239
240
|
if (nodeModules) {
|
|
240
241
|
const installRoot = path.dirname(nodeModules);
|
|
241
242
|
return {
|
|
242
|
-
npmArgs: ['
|
|
243
|
+
npmArgs: ['update', PACKAGE_NAME],
|
|
243
244
|
cwd: installRoot,
|
|
244
245
|
packageRoot: ROOT,
|
|
245
246
|
mode: 'local'
|
|
246
247
|
};
|
|
247
248
|
}
|
|
248
249
|
|
|
250
|
+
const projectPackageRoot = packagePath(root);
|
|
251
|
+
if (fs.existsSync(path.join(projectPackageRoot, 'package.json'))) {
|
|
252
|
+
return {
|
|
253
|
+
npmArgs: ['update', PACKAGE_NAME],
|
|
254
|
+
cwd: root,
|
|
255
|
+
packageRoot: projectPackageRoot,
|
|
256
|
+
mode: 'project'
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
|
|
249
260
|
fail('cannot determine how this Flow CLI was installed. Reinstall @caiqueoak/flow with npm, then run flow update again.');
|
|
250
261
|
}
|
|
251
262
|
|
|
263
|
+
function repairDivergentProjectInstall(plan) {
|
|
264
|
+
if (plan.mode === 'global') return;
|
|
265
|
+
const expected = lockedPackageVersion(plan.cwd);
|
|
266
|
+
const actual = installedPackageVersion(plan.packageRoot);
|
|
267
|
+
if (!expected || !actual || expected === actual) return;
|
|
268
|
+
|
|
269
|
+
const backup = path.join(plan.cwd, `.flow-update-backup-${process.pid}-${Date.now()}`);
|
|
270
|
+
info(`Repairing divergent ${PACKAGE_NAME} installation (${actual} on disk, ${expected} in package-lock.json)...`);
|
|
271
|
+
fs.renameSync(plan.packageRoot, backup);
|
|
272
|
+
try {
|
|
273
|
+
runNpm(['install'], { cwd: plan.cwd, stdio: 'inherit' });
|
|
274
|
+
if (installedPackageVersion(plan.packageRoot) !== expected) {
|
|
275
|
+
throw new Error(`npm install did not restore ${PACKAGE_NAME}@${expected}.`);
|
|
276
|
+
}
|
|
277
|
+
fs.rmSync(backup, { recursive: true, force: true });
|
|
278
|
+
} catch (error) {
|
|
279
|
+
try {
|
|
280
|
+
fs.rmSync(plan.packageRoot, { recursive: true, force: true });
|
|
281
|
+
fs.renameSync(backup, plan.packageRoot);
|
|
282
|
+
} catch { /* preserve the original npm error below */ }
|
|
283
|
+
throw error;
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
|
|
252
287
|
function update() {
|
|
253
288
|
const root = projectRoot();
|
|
254
289
|
const config = readConfig(root);
|
|
@@ -257,8 +292,10 @@ function update() {
|
|
|
257
292
|
|
|
258
293
|
const plan = updatePlan(root);
|
|
259
294
|
info(`Updating ${PACKAGE_NAME} (${plan.mode} installation)...`);
|
|
260
|
-
try {
|
|
261
|
-
|
|
295
|
+
try {
|
|
296
|
+
repairDivergentProjectInstall(plan);
|
|
297
|
+
runNpm(plan.npmArgs, { cwd: plan.cwd, stdio: 'inherit' });
|
|
298
|
+
} catch { fail('npm update failed. Existing project state and installed skills were not intentionally removed.'); }
|
|
262
299
|
|
|
263
300
|
if (!fs.existsSync(path.join(plan.packageRoot, 'package.json'))) fail(`updated package not found at ${plan.packageRoot}.`);
|
|
264
301
|
const latest = JSON.parse(fs.readFileSync(path.join(plan.packageRoot, 'package.json'), 'utf8'));
|