@workflow-cannon/workspace-kit 0.15.0 → 0.16.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.
Files changed (22) hide show
  1. package/README.md +55 -106
  2. package/dist/modules/approvals/review-runtime.js +3 -11
  3. package/dist/modules/improvement/generate-recommendations-runtime.js +3 -11
  4. package/dist/modules/task-engine/index.d.ts +2 -0
  5. package/dist/modules/task-engine/index.js +44 -46
  6. package/dist/modules/task-engine/migrate-task-persistence-runtime.d.ts +2 -0
  7. package/dist/modules/task-engine/migrate-task-persistence-runtime.js +192 -0
  8. package/dist/modules/task-engine/planning-config.d.ts +10 -0
  9. package/dist/modules/task-engine/planning-config.js +37 -0
  10. package/dist/modules/task-engine/planning-open.d.ts +16 -0
  11. package/dist/modules/task-engine/planning-open.js +34 -0
  12. package/dist/modules/task-engine/sqlite-dual-planning.d.ts +21 -0
  13. package/dist/modules/task-engine/sqlite-dual-planning.js +137 -0
  14. package/dist/modules/task-engine/store.d.ts +12 -3
  15. package/dist/modules/task-engine/store.js +62 -38
  16. package/dist/modules/task-engine/wishlist-store.d.ts +12 -3
  17. package/dist/modules/task-engine/wishlist-store.js +62 -40
  18. package/package.json +11 -2
  19. package/src/modules/documentation/README.md +1 -0
  20. package/src/modules/documentation/instructions/document-project.md +1 -0
  21. package/src/modules/documentation/instructions/generate-document.md +1 -0
  22. package/src/modules/documentation/templates/README.md +89 -0
package/src/modules/documentation/templates/README.md ADDED
@@ -0,0 +1,89 @@
1
+ <!--
2
+ Human output path: docs/maintainers/README.md (image uses ../title_image.png from that location).
3
+ Root README.md: mirror this body but use title_image.png and keep the agent notice line at the very top.
4
+ Audience: developers cloning the repo or adding @workflow-cannon/workspace-kit to a project who want to run something useful in minutes.
5
+ -->
6
+
7
+ <div align="center">
8
+ <img src="../title_image.png" alt="Workflow Cannon" width="720" />
9
+ </div>
10
+
11
+ # Workflow Cannon
12
+
13
+ **[`@workflow-cannon/workspace-kit`](https://www.npmjs.com/package/@workflow-cannon/workspace-kit)** — CLI, task engine, and workflow contracts for repos that want deterministic, policy-governed automation with clear evidence.
14
+
15
+ ## Quick start (clone this repo)
16
+
17
+ **Needs:** Node.js **22+** (see CI), **pnpm 10** (see `packageManager` in `package.json`).
18
+
19
+ ```bash
20
+ git clone https://github.com/NJLaPrell/workflow-cannon.git
21
+ cd workflow-cannon
22
+ pnpm install
23
+ pnpm run build
24
+ ```
25
+
26
+ Verify the kit sees your workspace:
27
+
28
+ ```bash
29
+ node dist/cli.js doctor
30
+ node dist/cli.js --help
31
+ ```
32
+
33
+ Try **read-only** task-engine queries:
34
+
35
+ ```bash
36
+ node dist/cli.js run list-tasks '{}'
37
+ node dist/cli.js run get-next-actions '{}'
38
+ ```
39
+
40
+ **Developing:** after edits, `pnpm run build` then `pnpm test` (or `pnpm run phase5-gates` before larger changes). If `workspace-kit` is not on your `PATH`, use `node dist/cli.js …` from the repo root (same as above).
41
+
42
+ ## Quick start (use the package in another project)
43
+
44
+ ```bash
45
+ npm install @workflow-cannon/workspace-kit
46
+ npx workspace-kit --help
47
+ ```
48
+
49
+ Or with pnpm: `pnpm add @workflow-cannon/workspace-kit` then `pnpm exec workspace-kit --help`.
50
+
51
+ ## What this repo contains
52
+
53
+ | Area | What |
54
+ | --- | --- |
55
+ | **CLI** | `workspace-kit` — `doctor`, `config`, `run <module-command>` (see `workspace-kit run` with no args for the list). |
56
+ | **Task engine** | Canonical queue in `.workspace-kit/tasks/state.json`; lifecycle via `run-transition`. Wishlist ideation uses ids `W###` (see maintainer runbooks). |
57
+ | **Docs** | Maintainer process, roadmap, and changelog under `docs/maintainers/`. |
58
+ | **Cursor extension** (optional) | Thin UI in `extensions/cursor-workflow-cannon/` — build with `pnpm run ui:prepare`. |
59
+
60
+ There is **no** built-in IDE slash command like `/qt` from this package; editor integrations are **your** config (e.g. `.cursor/commands/`), while **`workspace-kit`** is the supported CLI.
61
+
62
+ ## Policy and approvals (read this before mutating state)
63
+
64
+ Sensitive `workspace-kit run` commands require JSON **`policyApproval`** in the third CLI argument. Chat approval is not enough. Env-based approval applies to `init` / `upgrade` / `config`, not the `run` path.
65
+
66
+ - **Human guide:** [`docs/maintainers/POLICY-APPROVAL.md`](POLICY-APPROVAL.md)
67
+ - **Copy-paste table:** [`docs/maintainers/AGENT-CLI-MAP.md`](AGENT-CLI-MAP.md)
68
+
69
+ ## Project status and roadmap
70
+
71
+ Release cadence, phase history, and strategic decisions: [`docs/maintainers/ROADMAP.md`](ROADMAP.md). **Live execution queue:** `.workspace-kit/tasks/state.json` (`status` and `id` are authoritative — not this README’s milestone bullets).
72
+
73
+ Snapshot: [`docs/maintainers/data/workspace-kit-status.yaml`](data/workspace-kit-status.yaml).
74
+
75
+ ## Where to go next
76
+
77
+ | Goal | Start here |
78
+ | --- | --- |
79
+ | Goals, trade-offs, gates | [`.ai/PRINCIPLES.md`](../.ai/PRINCIPLES.md) |
80
+ | Roadmap & versions | [`ROADMAP.md`](ROADMAP.md) |
81
+ | Changelog | [`CHANGELOG.md`](CHANGELOG.md) |
82
+ | Release process | [`RELEASING.md`](RELEASING.md) |
83
+ | Glossary | [`TERMS.md`](TERMS.md) |
84
+ | Architecture | [`ARCHITECTURE.md`](ARCHITECTURE.md) |
85
+ | Agent/CLI execution | [`AGENTS.md`](AGENTS.md) |
86
+
87
+ ## License
88
+
89
+ MIT. See [`LICENSE`](../LICENSE) at the repository root.