openplanr 3.1.0 → 3.2.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/CHANGELOG.md +56 -0
- package/README.md +1 -1
- package/dist/cli/commands/doctor.d.ts.map +1 -1
- package/dist/cli/commands/doctor.js +24 -1
- package/dist/cli/commands/doctor.js.map +1 -1
- package/dist/cli/commands/groups/delivery.d.ts.map +1 -1
- package/dist/cli/commands/groups/delivery.js +2 -0
- package/dist/cli/commands/groups/delivery.js.map +1 -1
- package/dist/cli/commands/planning-artifacts.d.ts.map +1 -1
- package/dist/cli/commands/planning-artifacts.js +22 -12
- package/dist/cli/commands/planning-artifacts.js.map +1 -1
- package/dist/cli/commands/ship.d.ts +3 -0
- package/dist/cli/commands/ship.d.ts.map +1 -0
- package/dist/cli/commands/ship.js +65 -0
- package/dist/cli/commands/ship.js.map +1 -0
- package/dist/dashboard/.vite/manifest.json +1 -1
- package/dist/dashboard/assets/{index-G7ygVDGg.js → index-L8qtwqv6.js} +2 -2
- package/dist/dashboard/assets/{index-G7ygVDGg.js.map → index-L8qtwqv6.js.map} +1 -1
- package/dist/dashboard/dashboard-manifest.json +8 -8
- package/dist/dashboard/index.html +1 -1
- package/dist/models/schema.d.ts +39 -23
- package/dist/models/schema.d.ts.map +1 -1
- package/dist/models/schema.js +19 -12
- package/dist/models/schema.js.map +1 -1
- package/dist/models/types.d.ts +6 -0
- package/dist/models/types.d.ts.map +1 -1
- package/dist/services/global-install-service.d.ts +24 -0
- package/dist/services/global-install-service.d.ts.map +1 -0
- package/dist/services/global-install-service.js +68 -0
- package/dist/services/global-install-service.js.map +1 -0
- package/dist/services/id-service.d.ts +1 -5
- package/dist/services/id-service.d.ts.map +1 -1
- package/dist/services/id-service.js +1 -34
- package/dist/services/id-service.js.map +1 -1
- package/dist/services/ship-checks/changes.d.ts +24 -0
- package/dist/services/ship-checks/changes.d.ts.map +1 -0
- package/dist/services/ship-checks/changes.js +135 -0
- package/dist/services/ship-checks/changes.js.map +1 -0
- package/dist/services/ship-checks/contract.d.ts +81 -0
- package/dist/services/ship-checks/contract.d.ts.map +1 -0
- package/dist/services/ship-checks/contract.js +7 -0
- package/dist/services/ship-checks/contract.js.map +1 -0
- package/dist/services/ship-checks/discover.d.ts +10 -0
- package/dist/services/ship-checks/discover.d.ts.map +1 -0
- package/dist/services/ship-checks/discover.js +250 -0
- package/dist/services/ship-checks/discover.js.map +1 -0
- package/dist/services/ship-checks/glob.d.ts +5 -0
- package/dist/services/ship-checks/glob.d.ts.map +1 -0
- package/dist/services/ship-checks/glob.js +39 -0
- package/dist/services/ship-checks/glob.js.map +1 -0
- package/dist/services/ship-checks/hooks.d.ts +7 -0
- package/dist/services/ship-checks/hooks.d.ts.map +1 -0
- package/dist/services/ship-checks/hooks.js +65 -0
- package/dist/services/ship-checks/hooks.js.map +1 -0
- package/dist/services/ship-checks/packages.d.ts +29 -0
- package/dist/services/ship-checks/packages.d.ts.map +1 -0
- package/dist/services/ship-checks/packages.js +197 -0
- package/dist/services/ship-checks/packages.js.map +1 -0
- package/dist/services/ship-checks/related-tests.d.ts +13 -0
- package/dist/services/ship-checks/related-tests.d.ts.map +1 -0
- package/dist/services/ship-checks/related-tests.js +73 -0
- package/dist/services/ship-checks/related-tests.js.map +1 -0
- package/dist/services/ship-checks/scope.d.ts +8 -0
- package/dist/services/ship-checks/scope.d.ts.map +1 -0
- package/dist/services/ship-checks/scope.js +66 -0
- package/dist/services/ship-checks/scope.js.map +1 -0
- package/dist/services/ship-checks/task-requirements.d.ts +14 -0
- package/dist/services/ship-checks/task-requirements.d.ts.map +1 -0
- package/dist/services/ship-checks/task-requirements.js +145 -0
- package/dist/services/ship-checks/task-requirements.js.map +1 -0
- package/dist/services/ship-checks/workflows.d.ts +21 -0
- package/dist/services/ship-checks/workflows.d.ts.map +1 -0
- package/dist/services/ship-checks/workflows.js +208 -0
- package/dist/services/ship-checks/workflows.js.map +1 -0
- package/dist/services/template-service.d.ts +2 -0
- package/dist/services/template-service.d.ts.map +1 -1
- package/dist/services/template-service.js +4 -0
- package/dist/services/template-service.js.map +1 -1
- package/dist/services/upgrade-service.d.ts +15 -1
- package/dist/services/upgrade-service.d.ts.map +1 -1
- package/dist/services/upgrade-service.js +102 -13
- package/dist/services/upgrade-service.js.map +1 -1
- package/dist/utils/slugify.d.ts +1 -8
- package/dist/utils/slugify.d.ts.map +1 -1
- package/dist/utils/slugify.js +1 -25
- package/dist/utils/slugify.js.map +1 -1
- package/docs/CLI.md +48 -1
- package/lib/backlog-item.d.mts +49 -0
- package/lib/backlog-item.mjs +339 -0
- package/lib/host-packages/adapter-registry.json +5 -5
- package/lib/host-packages/capability-map.json +1 -1
- package/lib/host-packages/claude/.claude-plugin/marketplace.json +2 -2
- package/lib/host-packages/claude/openplanr/.claude-plugin/plugin.json +1 -1
- package/lib/host-packages/claude/openplanr/.openplanr-content.json +126 -90
- package/lib/host-packages/claude/openplanr/CONNECTORS.md +4 -6
- package/lib/host-packages/claude/openplanr/README.md +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-artifact-shell.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-chunked-workspace-client.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-document.mjs +385 -79
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-handoff.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-resource-pack.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-review.mjs +45 -4
- package/lib/host-packages/{cursor/openplanr/runtime/design/scripts/design-runtime-support-e34c388a8e59.mjs → claude/openplanr/runtime/design/scripts/design-runtime-support-6774fd3d5d02.mjs} +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-share.mjs +8 -5
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-shared-artifact-support-dependencies-design-support-protocol-contracts-3d9b1a86.mjs +40 -7
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/{design-shared-protocol-contracts-31a760fc.mjs → design-shared-protocol-contracts-b5f28f94.mjs} +284 -45
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design-upload-spool.mjs +1 -1
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/design.mjs +215 -55
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/02-artifact-review-ui.js +23 -23
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/03-protocol-contracts.js +246 -45
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/06-artifact-review-ui.js +12 -12
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/08-artifact-review-ui.js +47 -14
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources.json +11 -10
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/package.json +4 -3
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.css +16 -11
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/01-module-runtime.js +7 -11
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/02-react.js +163 -274
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/03-react-dom-client-fiber-foundations.js +494 -967
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/04-react-dom-client-reconciliation-hooks.js +346 -678
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/05-react-dom-client-render-phases.js +382 -810
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/06-react-dom-client-commit-effects.js +406 -730
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/07-react-dom-client-work-loop-scheduling.js +259 -522
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/08-react-dom-client-dom-events-properties-hydration.js +585 -937
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/09-react-dom-client-public-roots.js +115 -240
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/10-react.js +7 -17
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/11-artifact-review-ui.js +3 -4
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-protocol-contracts.js +215 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-design-review-experience.js +2766 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-studio-shell.js +134 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-canvas-engine.js +2170 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/16-design-review-experience.js +16 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-studio-shell.js +8 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/18-interface-primitives.js +3883 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/19-interface-primitives.js +966 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/{16-studio-shell.js → 20-studio-shell.js} +122 -227
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/21-design-studio.js +1583 -0
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources.json +101 -47
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/{openai/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.9.0 → claude/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.20.0}/design-document.schema.json +78 -5
- package/lib/host-packages/claude/openplanr/runtime/plan/scripts/design-protocol-contracts.mjs +247 -45
- package/lib/host-packages/claude/openplanr/runtime/plan/scripts/design.mjs +45 -12
- package/lib/host-packages/claude/openplanr/runtime/plan/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/claude/openplanr/skills/connect/references/connectors.md +4 -6
- package/lib/host-packages/claude/openplanr/skills/design/SKILL.md +12 -0
- package/lib/host-packages/claude/openplanr/skills/design/references/craft.md +14 -3
- package/lib/host-packages/claude/openplanr/skills/design/references/design-system.md +33 -1
- package/lib/host-packages/claude/openplanr/skills/design/references/discovery.md +18 -4
- package/lib/host-packages/claude/openplanr/skills/design/references/generation.md +74 -1
- package/lib/host-packages/claude/openplanr/skills/design/references/hosted-canvas.md +62 -0
- package/lib/host-packages/claude/openplanr/skills/design/references/review.md +46 -1
- package/lib/host-packages/claude/openplanr/skills/design/references/utilities.md +6 -0
- package/lib/host-packages/claude/openplanr/skills/design/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/craft.md +14 -3
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/design-system.md +33 -1
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/discovery.md +18 -4
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/generation.md +74 -1
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/review.md +46 -1
- package/lib/host-packages/claude/openplanr/skills/design-loop/references/utilities.md +6 -0
- package/lib/host-packages/claude/openplanr/skills/design-loop/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/claude/openplanr/skills/design-review/references/craft.md +14 -3
- package/lib/host-packages/claude/openplanr/skills/design-review/references/design-system.md +33 -1
- package/lib/host-packages/claude/openplanr/skills/design-review/references/discovery.md +18 -4
- package/lib/host-packages/claude/openplanr/skills/design-review/references/generation.md +74 -1
- package/lib/host-packages/claude/openplanr/skills/design-review/references/review.md +46 -1
- package/lib/host-packages/claude/openplanr/skills/design-review/references/utilities.md +6 -0
- package/lib/host-packages/claude/openplanr/skills/design-review/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/claude/openplanr/skills/investigate/SKILL.md +10 -1
- package/lib/host-packages/claude/openplanr/skills/investigate/references/findings.md +92 -0
- package/lib/host-packages/claude/openplanr/skills/investigate/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/claude/openplanr/skills/plan/SKILL.md +3 -0
- package/lib/host-packages/claude/openplanr/skills/plan/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/claude/openplanr/skills/share/references/connectors.md +4 -6
- package/lib/host-packages/claude/openplanr/skills/ship/SKILL.md +15 -4
- package/lib/host-packages/claude/openplanr/skills/ship/references/findings.md +92 -0
- package/lib/host-packages/claude/openplanr/skills/ship/references/result-contract.md +3 -1
- package/lib/host-packages/claude/openplanr/skills/ship/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/claude/openplanr/skills/sprint/references/connectors.md +4 -6
- package/lib/host-packages/claude/openplanr/skills/status/references/connectors.md +4 -6
- package/lib/host-packages/claude/openplanr/skills/sync/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/.openplanr-content.json +125 -89
- package/lib/host-packages/cursor/openplanr/CONNECTORS.md +4 -6
- package/lib/host-packages/cursor/openplanr/manifest.json +1 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-connect/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/craft.md +14 -3
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/design-system.md +33 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/discovery.md +18 -4
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/generation.md +74 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/hosted-canvas.md +62 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/review.md +46 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design/references/utilities.md +6 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-design/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/craft.md +14 -3
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/design-system.md +33 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/discovery.md +18 -4
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/generation.md +74 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/review.md +46 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/references/utilities.md +6 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-design-loop/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/craft.md +14 -3
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/design-system.md +33 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/discovery.md +18 -4
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/generation.md +74 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/review.md +46 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/references/utilities.md +6 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-design-review/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/cursor/openplanr/rules/planr-design.mdc +12 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-investigate/references/findings.md +92 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-investigate/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-investigate.mdc +10 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-plan/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/cursor/openplanr/rules/planr-plan.mdc +3 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-share/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/rules/planr-ship/references/findings.md +92 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-ship/references/result-contract.md +3 -1
- package/lib/host-packages/cursor/openplanr/rules/planr-ship/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/cursor/openplanr/rules/planr-ship.mdc +15 -4
- package/lib/host-packages/cursor/openplanr/rules/planr-sprint/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/rules/planr-status/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/rules/planr-sync/references/connectors.md +4 -6
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-artifact-shell.mjs +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-chunked-workspace-client.mjs +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-document.mjs +385 -79
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-handoff.mjs +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-resource-pack.mjs +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-review.mjs +45 -4
- package/lib/host-packages/{openai/openplanr/runtime/design/scripts/design-runtime-support-e34c388a8e59.mjs → cursor/openplanr/runtime/design/scripts/design-runtime-support-6774fd3d5d02.mjs} +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-share.mjs +8 -5
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-shared-artifact-support-dependencies-design-support-protocol-contracts-3d9b1a86.mjs +40 -7
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs +1 -1
- package/lib/host-packages/{openai/openplanr/runtime/design/scripts/design-shared-protocol-contracts-31a760fc.mjs → cursor/openplanr/runtime/design/scripts/design-shared-protocol-contracts-b5f28f94.mjs} +284 -45
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design-upload-spool.mjs +1 -1
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/design.mjs +215 -55
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/02-artifact-review-ui.js +23 -23
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/03-protocol-contracts.js +246 -45
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/06-artifact-review-ui.js +12 -12
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/08-artifact-review-ui.js +47 -14
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources.json +11 -10
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/package.json +4 -3
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.css +16 -11
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/01-module-runtime.js +7 -11
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/02-react.js +163 -274
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/03-react-dom-client-fiber-foundations.js +494 -967
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/04-react-dom-client-reconciliation-hooks.js +346 -678
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/05-react-dom-client-render-phases.js +382 -810
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/06-react-dom-client-commit-effects.js +406 -730
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/07-react-dom-client-work-loop-scheduling.js +259 -522
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/08-react-dom-client-dom-events-properties-hydration.js +585 -937
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/09-react-dom-client-public-roots.js +115 -240
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/10-react.js +7 -17
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/11-artifact-review-ui.js +3 -4
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-protocol-contracts.js +215 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-design-review-experience.js +2766 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-studio-shell.js +134 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-canvas-engine.js +2170 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/16-design-review-experience.js +16 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-studio-shell.js +8 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/18-interface-primitives.js +3883 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/19-interface-primitives.js +966 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/{16-studio-shell.js → 20-studio-shell.js} +122 -227
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/21-design-studio.js +1583 -0
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources.json +101 -47
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/{claude/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.9.0 → cursor/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.20.0}/design-document.schema.json +78 -5
- package/lib/host-packages/cursor/openplanr/runtime/plan/scripts/design-protocol-contracts.mjs +247 -45
- package/lib/host-packages/cursor/openplanr/runtime/plan/scripts/design.mjs +45 -12
- package/lib/host-packages/cursor/openplanr/runtime/plan/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/openai/.claude-plugin/marketplace.json +2 -2
- package/lib/host-packages/openai/openplanr/.codex-plugin/plugin.json +1 -1
- package/lib/host-packages/openai/openplanr/.openplanr-content.json +128 -92
- package/lib/host-packages/openai/openplanr/CONNECTORS.md +4 -6
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-artifact-shell.mjs +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-chunked-workspace-client.mjs +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-document.mjs +385 -79
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-handoff.mjs +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-resource-pack.mjs +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-review.mjs +45 -4
- package/lib/host-packages/{claude/openplanr/runtime/design/scripts/design-runtime-support-e34c388a8e59.mjs → openai/openplanr/runtime/design/scripts/design-runtime-support-6774fd3d5d02.mjs} +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-share.mjs +8 -5
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-shared-artifact-support-dependencies-design-support-protocol-contracts-3d9b1a86.mjs +40 -7
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-shared-artifact-support-protocol-contracts-ea2cd15e.mjs +1 -1
- package/lib/host-packages/{cursor/openplanr/runtime/design/scripts/design-shared-protocol-contracts-31a760fc.mjs → openai/openplanr/runtime/design/scripts/design-shared-protocol-contracts-b5f28f94.mjs} +284 -45
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design-upload-spool.mjs +1 -1
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/design.mjs +215 -55
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/02-artifact-review-ui.js +23 -23
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/03-protocol-contracts.js +246 -45
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/06-artifact-review-ui.js +12 -12
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources/08-artifact-review-ui.js +47 -14
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/artifact/templates/artifact-review-stage.js.sources.json +11 -10
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/package.json +4 -3
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.css +16 -11
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/01-module-runtime.js +7 -11
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/02-react.js +163 -274
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/03-react-dom-client-fiber-foundations.js +494 -967
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/04-react-dom-client-reconciliation-hooks.js +346 -678
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/05-react-dom-client-render-phases.js +382 -810
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/06-react-dom-client-commit-effects.js +406 -730
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/07-react-dom-client-work-loop-scheduling.js +259 -522
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/08-react-dom-client-dom-events-properties-hydration.js +585 -937
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/09-react-dom-client-public-roots.js +115 -240
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/10-react.js +7 -17
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/11-artifact-review-ui.js +3 -4
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-protocol-contracts.js +215 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-design-review-experience.js +2766 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-studio-shell.js +134 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-canvas-engine.js +2170 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/16-design-review-experience.js +16 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-studio-shell.js +8 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/18-interface-primitives.js +3883 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/19-interface-primitives.js +966 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/{16-studio-shell.js → 20-studio-shell.js} +122 -227
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/21-design-studio.js +1583 -0
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources.json +101 -47
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/{cursor/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.9.0 → openai/openplanr/runtime/design/scripts/runtime/packages/protocol/schemas/v1.20.0}/design-document.schema.json +78 -5
- package/lib/host-packages/openai/openplanr/runtime/plan/scripts/design-protocol-contracts.mjs +247 -45
- package/lib/host-packages/openai/openplanr/runtime/plan/scripts/design.mjs +45 -12
- package/lib/host-packages/openai/openplanr/runtime/plan/scripts/runtime/packages/protocol/package.json +5 -1
- package/lib/host-packages/openai/openplanr/skills/connect/references/connectors.md +4 -6
- package/lib/host-packages/openai/openplanr/skills/design/SKILL.md +12 -0
- package/lib/host-packages/openai/openplanr/skills/design/openplanr.skill.json +11 -0
- package/lib/host-packages/openai/openplanr/skills/design/references/craft.md +14 -3
- package/lib/host-packages/openai/openplanr/skills/design/references/design-system.md +33 -1
- package/lib/host-packages/openai/openplanr/skills/design/references/discovery.md +18 -4
- package/lib/host-packages/openai/openplanr/skills/design/references/generation.md +74 -1
- package/lib/host-packages/openai/openplanr/skills/design/references/hosted-canvas.md +62 -0
- package/lib/host-packages/openai/openplanr/skills/design/references/review.md +46 -1
- package/lib/host-packages/openai/openplanr/skills/design/references/utilities.md +6 -0
- package/lib/host-packages/openai/openplanr/skills/design/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/craft.md +14 -3
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/design-system.md +33 -1
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/discovery.md +18 -4
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/generation.md +74 -1
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/review.md +46 -1
- package/lib/host-packages/openai/openplanr/skills/design-loop/references/utilities.md +6 -0
- package/lib/host-packages/openai/openplanr/skills/design-loop/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/openai/openplanr/skills/design-review/references/craft.md +14 -3
- package/lib/host-packages/openai/openplanr/skills/design-review/references/design-system.md +33 -1
- package/lib/host-packages/openai/openplanr/skills/design-review/references/discovery.md +18 -4
- package/lib/host-packages/openai/openplanr/skills/design-review/references/generation.md +74 -1
- package/lib/host-packages/openai/openplanr/skills/design-review/references/review.md +46 -1
- package/lib/host-packages/openai/openplanr/skills/design-review/references/utilities.md +6 -0
- package/lib/host-packages/openai/openplanr/skills/design-review/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/openai/openplanr/skills/investigate/SKILL.md +10 -1
- package/lib/host-packages/openai/openplanr/skills/investigate/openplanr.skill.json +22 -0
- package/lib/host-packages/openai/openplanr/skills/investigate/references/findings.md +92 -0
- package/lib/host-packages/openai/openplanr/skills/investigate/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/openai/openplanr/skills/plan/SKILL.md +3 -0
- package/lib/host-packages/openai/openplanr/skills/plan/schemas/design-document.schema.json +78 -5
- package/lib/host-packages/openai/openplanr/skills/share/references/connectors.md +4 -6
- package/lib/host-packages/openai/openplanr/skills/ship/SKILL.md +15 -4
- package/lib/host-packages/openai/openplanr/skills/ship/openplanr.skill.json +22 -0
- package/lib/host-packages/openai/openplanr/skills/ship/references/findings.md +92 -0
- package/lib/host-packages/openai/openplanr/skills/ship/references/result-contract.md +3 -1
- package/lib/host-packages/openai/openplanr/skills/ship/scripts/backlog-item.mjs +339 -0
- package/lib/host-packages/openai/openplanr/skills/sprint/references/connectors.md +4 -6
- package/lib/host-packages/openai/openplanr/skills/status/references/connectors.md +4 -6
- package/lib/host-packages/openai/openplanr/skills/sync/references/connectors.md +4 -6
- package/package.json +3 -3
- package/dist/templates/backlog/backlog-item.md.hbs +0 -40
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-design-review-experience.js +0 -3589
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-studio-shell.js +0 -184
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-interface-primitives.js +0 -5229
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-interface-primitives.js +0 -1733
- package/lib/host-packages/claude/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-design-studio.js +0 -1844
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-design-review-experience.js +0 -3589
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-studio-shell.js +0 -184
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-interface-primitives.js +0 -5229
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-interface-primitives.js +0 -1733
- package/lib/host-packages/cursor/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-design-studio.js +0 -1844
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/12-design-review-experience.js +0 -3589
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/13-studio-shell.js +0 -184
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/14-interface-primitives.js +0 -5229
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/15-interface-primitives.js +0 -1733
- package/lib/host-packages/openai/openplanr/runtime/design/scripts/runtime/packages/design/templates/studio/studio.js.sources/17-design-studio.js +0 -1844
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://openplanr.dev/schemas/v1.
|
|
3
|
+
"$id": "https://openplanr.dev/schemas/v1.20.0/design-document.schema.json",
|
|
4
4
|
"x-openplanr-contract": {
|
|
5
5
|
"id": "design-document",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.20.0"
|
|
7
7
|
},
|
|
8
8
|
"title": "OpenPlanr authored design document",
|
|
9
9
|
"type": "object",
|
|
@@ -118,9 +118,16 @@
|
|
|
118
118
|
"maximum": 16384
|
|
119
119
|
},
|
|
120
120
|
"height": {
|
|
121
|
-
"
|
|
122
|
-
|
|
123
|
-
|
|
121
|
+
"anyOf": [
|
|
122
|
+
{
|
|
123
|
+
"type": "integer",
|
|
124
|
+
"minimum": 1,
|
|
125
|
+
"maximum": 16384
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"const": "auto"
|
|
129
|
+
}
|
|
130
|
+
]
|
|
124
131
|
}
|
|
125
132
|
}
|
|
126
133
|
}
|
|
@@ -250,6 +257,67 @@
|
|
|
250
257
|
"prototype",
|
|
251
258
|
"walkthrough"
|
|
252
259
|
]
|
|
260
|
+
},
|
|
261
|
+
"layout": {
|
|
262
|
+
"type": "object",
|
|
263
|
+
"additionalProperties": false,
|
|
264
|
+
"properties": {
|
|
265
|
+
"boards": {
|
|
266
|
+
"type": "object",
|
|
267
|
+
"description": "Keys are screenId, screenId/frameId or screenId/frameId/variantId; each ID must exist in the document.",
|
|
268
|
+
"additionalProperties": {
|
|
269
|
+
"type": "object",
|
|
270
|
+
"additionalProperties": false,
|
|
271
|
+
"required": [
|
|
272
|
+
"x",
|
|
273
|
+
"y"
|
|
274
|
+
],
|
|
275
|
+
"properties": {
|
|
276
|
+
"x": {
|
|
277
|
+
"$ref": "#/$defs/coordinate"
|
|
278
|
+
},
|
|
279
|
+
"y": {
|
|
280
|
+
"$ref": "#/$defs/coordinate"
|
|
281
|
+
},
|
|
282
|
+
"title": {
|
|
283
|
+
"$ref": "#/$defs/text"
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
"sections": {
|
|
289
|
+
"type": "array",
|
|
290
|
+
"items": {
|
|
291
|
+
"type": "object",
|
|
292
|
+
"additionalProperties": false,
|
|
293
|
+
"required": [
|
|
294
|
+
"id",
|
|
295
|
+
"x",
|
|
296
|
+
"y",
|
|
297
|
+
"text"
|
|
298
|
+
],
|
|
299
|
+
"properties": {
|
|
300
|
+
"id": {
|
|
301
|
+
"$ref": "#/$defs/id"
|
|
302
|
+
},
|
|
303
|
+
"x": {
|
|
304
|
+
"$ref": "#/$defs/coordinate"
|
|
305
|
+
},
|
|
306
|
+
"y": {
|
|
307
|
+
"$ref": "#/$defs/coordinate"
|
|
308
|
+
},
|
|
309
|
+
"text": {
|
|
310
|
+
"$ref": "#/$defs/text"
|
|
311
|
+
},
|
|
312
|
+
"maxW": {
|
|
313
|
+
"type": "integer",
|
|
314
|
+
"minimum": 1,
|
|
315
|
+
"maximum": 16384
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
}
|
|
253
321
|
}
|
|
254
322
|
},
|
|
255
323
|
"$defs": {
|
|
@@ -301,6 +369,11 @@
|
|
|
301
369
|
"$ref": "#/$defs/paths"
|
|
302
370
|
}
|
|
303
371
|
}
|
|
372
|
+
},
|
|
373
|
+
"coordinate": {
|
|
374
|
+
"type": "number",
|
|
375
|
+
"minimum": -10000000,
|
|
376
|
+
"maximum": 10000000
|
|
304
377
|
}
|
|
305
378
|
}
|
|
306
379
|
}
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
OpenPlanr skills name a kind of service, such as `~~chat`, instead of a product. Connect
|
|
4
4
|
the product your team uses through your host: the vendor publishes the connector, and
|
|
5
5
|
you sign in through the host. OpenPlanr bundles no connectors; they and their credentials
|
|
6
|
-
live in your host.
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
you sign in to.
|
|
11
|
-
`openplanr company logout` removes company tokens.
|
|
6
|
+
live in your host. One optional feature needs a token: Linear sync (`openplanr linear`).
|
|
7
|
+
Only when you use it does OpenPlanr store a token, in your OS keychain, or in an encrypted
|
|
8
|
+
file at `~/.planr/credentials.enc` if you set `PLANR_CREDENTIAL_FILE_PASSPHRASE`. The token
|
|
9
|
+
is sent only to Linear.
|
|
12
10
|
Every skill also works with nothing connected and reports any remote step it skipped.
|
|
13
11
|
|
|
14
12
|
| Category | Placeholder | Products |
|
|
@@ -61,10 +61,15 @@ Discover checks in this order:
|
|
|
61
61
|
3. package and task-runner scripts;
|
|
62
62
|
4. applicable CI and pre-commit configuration.
|
|
63
63
|
|
|
64
|
-
|
|
65
|
-
|
|
64
|
+
Run `openplanr ship checks --json --task <task-path>` (omit `--task` for a direct
|
|
65
|
+
request; add `--tier story` or `--tier push` before pushing) and run its `checks`
|
|
66
|
+
from each `cwd`. The command never executes checks or writes files. When
|
|
67
|
+
`complete` is `false`, report its error diagnostics and treat the check set as
|
|
68
|
+
incomplete: a pass is not CI-equivalent. Without the CLI, the packaged read-only
|
|
69
|
+
[verification discovery helper](scripts/discover-verification.mjs) may list
|
|
70
|
+
candidates. Resolve it relative to this `SKILL.md` and run
|
|
66
71
|
`node <helper> --project <repository-root> --task <task-path>`; omit `--task` for a
|
|
67
|
-
direct request. It never executes checks or writes files. If
|
|
72
|
+
direct request. It never executes checks or writes files. If both are unavailable,
|
|
68
73
|
inspect those four sources directly. Missing commands are diagnostics, not a
|
|
69
74
|
reason to invent or skip all verification.
|
|
70
75
|
|
|
@@ -74,6 +79,11 @@ it by its own exit code; to shorten output, write it to a log and read the tail.
|
|
|
74
79
|
Fix failures caused by the change and rerun affected checks.
|
|
75
80
|
Read [the result contract](references/result-contract.md) before reporting.
|
|
76
81
|
|
|
82
|
+
Report defects you notice outside the task as [findings](references/findings.md),
|
|
83
|
+
and never fix them in this change unless they block it. The packaged
|
|
84
|
+
[backlog helper](scripts/backlog-item.mjs) lists and files backlog items when no
|
|
85
|
+
CLI is installed; resolve it relative to this `SKILL.md`.
|
|
86
|
+
|
|
77
87
|
Do not write progress into an approved design package. The studio derives
|
|
78
88
|
approved, planned, implementing, and verified state from canonical planning and
|
|
79
89
|
Ship artifacts after this separate invocation.
|
|
@@ -89,7 +99,8 @@ results instead of reproducing them in chat.
|
|
|
89
99
|
- **Task:** task ID and path, or `direct-request`.
|
|
90
100
|
- **Changed:** material paths grouped by purpose.
|
|
91
101
|
- **Checks:** command, `passed`, `failed`, or `not-run`, plus a concise result.
|
|
92
|
-
- **Issues:** problem, impact, and next action, or `none
|
|
102
|
+
- **Issues:** blockers with problem, impact, and next action, or `none`; then
|
|
103
|
+
findings outside the task, each with its disposition.
|
|
93
104
|
|
|
94
105
|
Keep the five machine fields unchanged. A human summary may omit empty or unavailable fields,
|
|
95
106
|
but must make partial, blocked or unverified work clear and give the smallest
|
|
@@ -54,6 +54,28 @@
|
|
|
54
54
|
"cursor"
|
|
55
55
|
],
|
|
56
56
|
"executable": true
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"path": "references/findings.md",
|
|
60
|
+
"kind": "reference",
|
|
61
|
+
"hosts": [
|
|
62
|
+
"claude-code",
|
|
63
|
+
"codex",
|
|
64
|
+
"chatgpt",
|
|
65
|
+
"cursor"
|
|
66
|
+
],
|
|
67
|
+
"executable": false
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"path": "scripts/backlog-item.mjs",
|
|
71
|
+
"kind": "script",
|
|
72
|
+
"hosts": [
|
|
73
|
+
"claude-code",
|
|
74
|
+
"codex",
|
|
75
|
+
"chatgpt",
|
|
76
|
+
"cursor"
|
|
77
|
+
],
|
|
78
|
+
"executable": true
|
|
57
79
|
}
|
|
58
80
|
]
|
|
59
81
|
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Findings outside the task
|
|
2
|
+
|
|
3
|
+
A finding is a defect or bad practice you observed outside the task: a wrong
|
|
4
|
+
value, the same bug elsewhere, a flaky check. It needs evidence you saw: a
|
|
5
|
+
repo-relative `file:line`, or a command and its output line. A suspicion without
|
|
6
|
+
evidence is not a finding. A problem that stops this task is a blocker, not a
|
|
7
|
+
finding.
|
|
8
|
+
|
|
9
|
+
## Never fix a finding here
|
|
10
|
+
|
|
11
|
+
Do not change code for a finding in this run. The one exception is a defect that
|
|
12
|
+
blocks this task's own definition of done: it becomes a blocker, you fix it, and
|
|
13
|
+
**Changed** says it was pre-existing and why it could not wait.
|
|
14
|
+
|
|
15
|
+
## Shape
|
|
16
|
+
|
|
17
|
+
`issues` holds two lists. `blockers`: problem, impact, next action.
|
|
18
|
+
`findings`, each with:
|
|
19
|
+
|
|
20
|
+
- `title`: one plain line stating the defect; it is also the backlog title.
|
|
21
|
+
- `severity`: `critical`, `high`, `medium` or `low`; it becomes the backlog priority.
|
|
22
|
+
- `evidence`: `file:line`, or the command and the output line.
|
|
23
|
+
- `proposed`: the backlog entry: title, priority, tags, and a `description` in
|
|
24
|
+
Markdown with Problem, Why it matters ("no consequence yet" when that is the
|
|
25
|
+
honest answer), Evidence, and Fix shape. Label unverified parts as unverified.
|
|
26
|
+
- `disposition`: `filed`, `tracked`, `declined` or `reported`, plus `{ id, path }`
|
|
27
|
+
when filed or tracked.
|
|
28
|
+
|
|
29
|
+
Merge duplicates within the run. Sort by severity, highest first, and number from
|
|
30
|
+
1. Show at most 5 in full and summarise the rest as "+N more".
|
|
31
|
+
|
|
32
|
+
## Check what is already tracked
|
|
33
|
+
|
|
34
|
+
Before showing findings, list open backlog items with the backlog helper
|
|
35
|
+
linked from SKILL.md, resolved relative to that file: `node <helper> list
|
|
36
|
+
--project <repository-root> --open`. A finding about the same problem as an open item,
|
|
37
|
+
normally the same evidence file and an equivalent title, is `tracked`. Never file
|
|
38
|
+
it again and never edit the existing item.
|
|
39
|
+
|
|
40
|
+
## Decide, then ask at most once
|
|
41
|
+
|
|
42
|
+
After checks, and only when at least one finding is untracked, take the first
|
|
43
|
+
rule that applies. File only what it allows.
|
|
44
|
+
|
|
45
|
+
1. The request says to file findings, or not to: do that.
|
|
46
|
+
2. **Attended run**, the user can answer now: ask one question with the host's
|
|
47
|
+
structured question tool: "File N findings as backlog items?" with the options
|
|
48
|
+
"File all N (Recommended)" and "Don't file", and free text for numbers such as
|
|
49
|
+
"1 3". Without such a tool, ask in one chat line: `File these as backlog items?
|
|
50
|
+
Reply "all", "none", or the numbers, e.g. "1 3".` File what the answer names.
|
|
51
|
+
3. **Unattended run**, nobody can answer: the host cannot ask and wait (for
|
|
52
|
+
example a print or exec mode), another skill or a delegate runner started this
|
|
53
|
+
run, or the user said not to ask. Read `findings.unattended` in
|
|
54
|
+
`.planr/config.json`. Only `file` files every untracked finding. With
|
|
55
|
+
`report`, or no setting, do not run `add` at all: mark the findings `reported`.
|
|
56
|
+
|
|
57
|
+
Never ask per finding, never ask mid-run, and never file or drop a finding
|
|
58
|
+
silently.
|
|
59
|
+
|
|
60
|
+
## File
|
|
61
|
+
|
|
62
|
+
Send each item as one JSON object (`title`, `priority`, `tags`, `description`)
|
|
63
|
+
on stdin. Never pass `acceptanceCriteria`.
|
|
64
|
+
|
|
65
|
+
- When an `openplanr` CLI resolves (the project's `node_modules/.bin`, then
|
|
66
|
+
`PATH`; never `npx`): `openplanr --project-dir <repository-root> backlog add
|
|
67
|
+
--data - --json`.
|
|
68
|
+
- Otherwise: `node <helper> add --project <repository-root> --data -`. Its
|
|
69
|
+
result can carry `cliHint`; end the result with that line, word for word,
|
|
70
|
+
once. Install only if the user says yes then, by running exactly the command in
|
|
71
|
+
the line. If the result says `templateOverrideIgnored`, say the default format
|
|
72
|
+
was used.
|
|
73
|
+
|
|
74
|
+
If filing fails, report the command and its error, and leave the finding
|
|
75
|
+
`reported`.
|
|
76
|
+
|
|
77
|
+
## Report
|
|
78
|
+
|
|
79
|
+
Under **Issues**, write the blockers, or `none for this task.` when only findings
|
|
80
|
+
remain. Then:
|
|
81
|
+
|
|
82
|
+
```text
|
|
83
|
+
Found outside this task (not changed)
|
|
84
|
+
1. medium · /import has no rate limit · src/routes/import.ts:41
|
|
85
|
+
Filed BL-431 · .planr/backlog/BL-431-import-endpoint-has-no-rate-limit.md
|
|
86
|
+
2. low · tests/session.test.ts timed out once, passed on rerun · npm test, first run
|
|
87
|
+
Already tracked as BL-212 · .planr/backlog/BL-212-session-test-times-out.md
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Unfiled findings say why in the heading, for example `(not changed, not filed:
|
|
91
|
+
unattended default is "report")`, and end with: `To file them, reply "file 1 2".` In an unattended run, add: `To file automatically in unattended runs, set "findings": { "unattended": "file" } in .planr/config.json.`
|
|
92
|
+
Paths are always repo-relative.
|
|
@@ -7,7 +7,9 @@ Return one concise human rendering backed by these five machine fields:
|
|
|
7
7
|
3. `changed`: material files grouped by purpose.
|
|
8
8
|
4. `checks`: each executed or applicable check with `passed`, `failed`, or
|
|
9
9
|
`not-run` and a concise result.
|
|
10
|
-
5. `issues`:
|
|
10
|
+
5. `issues`: `blockers` for this task, each with problem, impact, and next
|
|
11
|
+
action, and `findings` outside the task, shaped as `findings.md` describes;
|
|
12
|
+
use `none` when both are empty.
|
|
11
13
|
|
|
12
14
|
Do not add receipts, digests, proof ledgers, fixed review loops, or approval
|
|
13
15
|
narration. Mention evidence only when it is the natural result of a command or
|
|
@@ -0,0 +1,339 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// @ts-check
|
|
3
|
+
// The one backlog item writer: the CLI imports it, and skills run it when no CLI is installed.
|
|
4
|
+
|
|
5
|
+
import { mkdir, readdir, readFile, writeFile } from 'node:fs/promises';
|
|
6
|
+
import { join, relative, resolve, sep } from 'node:path';
|
|
7
|
+
import { fileURLToPath } from 'node:url';
|
|
8
|
+
|
|
9
|
+
/** Holds one empty file per issued ID, so the ID of a removed artifact is never issued again. */
|
|
10
|
+
const ISSUED_IDS_DIR = '.issued-ids';
|
|
11
|
+
const CLOSED_STATUSES = new Set(['closed', 'done']);
|
|
12
|
+
|
|
13
|
+
/** @type {typeof import('./backlog-item.d.mts').CLI_INSTALL_COMMAND} */
|
|
14
|
+
export const CLI_INSTALL_COMMAND = 'npm install -g openplanr';
|
|
15
|
+
/** @type {typeof import('./backlog-item.d.mts').CLI_HINT} */
|
|
16
|
+
export const CLI_HINT = `Install the OpenPlanr CLI to manage these items: ${CLI_INSTALL_COMMAND}`;
|
|
17
|
+
|
|
18
|
+
/** @type {typeof import('./backlog-item.d.mts').reserveNextId} */
|
|
19
|
+
export async function reserveNextId(dir, prefix) {
|
|
20
|
+
const issuedDir = join(dir, ISSUED_IDS_DIR);
|
|
21
|
+
await mkdir(issuedDir, { recursive: true });
|
|
22
|
+
const pattern = new RegExp(`^${prefix.replace(/[.*+?^${}()|[\]\\]/gu, '\\$&')}-(\\d{3,})`, 'u');
|
|
23
|
+
let next = 1;
|
|
24
|
+
for (const directory of [dir, issuedDir]) {
|
|
25
|
+
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
|
26
|
+
const match = entry.isDirectory() ? null : pattern.exec(entry.name);
|
|
27
|
+
if (match) next = Math.max(next, Number.parseInt(match[1], 10) + 1);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
for (; ; next++) {
|
|
31
|
+
const id = `${prefix}-${String(next).padStart(3, '0')}`;
|
|
32
|
+
try {
|
|
33
|
+
await writeFile(join(issuedDir, id), '', { flag: 'wx' });
|
|
34
|
+
return id;
|
|
35
|
+
} catch (error) {
|
|
36
|
+
if (/** @type {NodeJS.ErrnoException} */ (error).code !== 'EEXIST') throw error;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** @type {typeof import('./backlog-item.d.mts').slugify} */
|
|
42
|
+
export function slugify(text, maxLength = 80) {
|
|
43
|
+
let slug = text
|
|
44
|
+
.toLowerCase()
|
|
45
|
+
.trim()
|
|
46
|
+
.replace(/[^\w\s-]/g, '')
|
|
47
|
+
.replace(/[\s_]+/g, '-')
|
|
48
|
+
.replace(/-+/g, '-')
|
|
49
|
+
.replace(/^-+|-+$/g, '');
|
|
50
|
+
if (slug.length > maxLength) {
|
|
51
|
+
slug = slug.slice(0, maxLength);
|
|
52
|
+
// Trim at the last whole-word boundary to avoid cut-off words.
|
|
53
|
+
const lastDash = slug.lastIndexOf('-');
|
|
54
|
+
if (lastDash > 0) slug = slug.slice(0, lastDash);
|
|
55
|
+
}
|
|
56
|
+
return slug;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/** @param {unknown} value */
|
|
60
|
+
function strings(value) {
|
|
61
|
+
if (Array.isArray(value)) return value.map(String).filter(Boolean);
|
|
62
|
+
if (typeof value === 'string')
|
|
63
|
+
return value
|
|
64
|
+
.split(',')
|
|
65
|
+
.map((item) => item.trim())
|
|
66
|
+
.filter(Boolean);
|
|
67
|
+
return [];
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** @param {unknown} value */
|
|
71
|
+
function optionalText(value) {
|
|
72
|
+
return value === undefined || value === null || value === '' ? undefined : value;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
const PRIORITIES = Object.freeze(['critical', 'high', 'medium', 'low']);
|
|
76
|
+
|
|
77
|
+
/** Bad backlog input; the code lets the CLI report it as an input error, not a crash. */
|
|
78
|
+
class BacklogInputError extends Error {
|
|
79
|
+
/** @param {string} message */
|
|
80
|
+
constructor(message) {
|
|
81
|
+
super(message);
|
|
82
|
+
this.name = 'BacklogInputError';
|
|
83
|
+
this.code = 'E_BACKLOG_INVALID';
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** @type {typeof import('./backlog-item.d.mts').backlogFields} */
|
|
88
|
+
export function backlogFields(input) {
|
|
89
|
+
const title = String(input.title ?? input.name ?? '').trim();
|
|
90
|
+
if (!title) throw new BacklogInputError('A backlog item needs a non-empty title.');
|
|
91
|
+
const priority = String(input.priority ?? 'medium');
|
|
92
|
+
if (!PRIORITIES.includes(priority))
|
|
93
|
+
throw new BacklogInputError(
|
|
94
|
+
`Backlog priority ${JSON.stringify(priority)} is not valid; use one of ${PRIORITIES.join(', ')}.`,
|
|
95
|
+
);
|
|
96
|
+
const criteria = optionalText(input.acceptanceCriteria);
|
|
97
|
+
const notes = optionalText(input.notes);
|
|
98
|
+
const epicId = optionalText(input.epicId);
|
|
99
|
+
return {
|
|
100
|
+
title,
|
|
101
|
+
priority,
|
|
102
|
+
tags: strings(input.tags),
|
|
103
|
+
description: String(input.description ?? title),
|
|
104
|
+
...(criteria === undefined
|
|
105
|
+
? {}
|
|
106
|
+
: { acceptanceCriteria: Array.isArray(criteria) ? criteria.map(String) : String(criteria) }),
|
|
107
|
+
...(notes === undefined ? {} : { notes: String(notes) }),
|
|
108
|
+
...(epicId === undefined ? {} : { epicId: String(epicId) }),
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/** @type {typeof import('./backlog-item.d.mts').renderBacklogItem} */
|
|
113
|
+
export function renderBacklogItem(id, fields, date) {
|
|
114
|
+
const quote = JSON.stringify;
|
|
115
|
+
const lines = [
|
|
116
|
+
'---',
|
|
117
|
+
`id: ${quote(id)}`,
|
|
118
|
+
`title: ${quote(fields.title)}`,
|
|
119
|
+
`priority: ${quote(fields.priority)}`,
|
|
120
|
+
`tags: [${fields.tags.map((tag) => quote(tag)).join(', ')}]`,
|
|
121
|
+
'status: "open"',
|
|
122
|
+
`created: ${quote(date)}`,
|
|
123
|
+
`updated: ${quote(date)}`,
|
|
124
|
+
...(fields.epicId ? [`epicId: ${quote(fields.epicId)}`] : []),
|
|
125
|
+
'---',
|
|
126
|
+
'',
|
|
127
|
+
`# ${id}: ${fields.title}`,
|
|
128
|
+
'',
|
|
129
|
+
];
|
|
130
|
+
/** @param {string} heading @param {string} body @param {boolean} [spaced] */
|
|
131
|
+
const section = (heading, body, spaced = false) =>
|
|
132
|
+
lines.push(`## ${heading}`, ...(spaced ? [''] : []), body, '');
|
|
133
|
+
if (fields.tags.length > 0)
|
|
134
|
+
section('Tags', fields.tags.map((tag) => `- ${tag}`).join('\n'), true);
|
|
135
|
+
// A description with its own sections stands alone instead of nesting under another heading.
|
|
136
|
+
if (/^## /u.test(fields.description)) lines.push(fields.description, '');
|
|
137
|
+
else if (fields.description !== fields.title) section('Description', fields.description);
|
|
138
|
+
if (fields.acceptanceCriteria !== undefined && fields.acceptanceCriteria.length > 0)
|
|
139
|
+
section(
|
|
140
|
+
'Acceptance Criteria',
|
|
141
|
+
Array.isArray(fields.acceptanceCriteria)
|
|
142
|
+
? fields.acceptanceCriteria.map((criterion) => `- ${criterion}`).join('\n')
|
|
143
|
+
: fields.acceptanceCriteria,
|
|
144
|
+
);
|
|
145
|
+
if (fields.notes) section('Notes', fields.notes);
|
|
146
|
+
lines.push('---', `_Close when done: \`openplanr backlog update ${id} --status closed\`_`, '');
|
|
147
|
+
return lines.join('\n');
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/** @type {typeof import('./backlog-item.d.mts').writeBacklogItem} */
|
|
151
|
+
export async function writeBacklogItem(backlogDir, prefix, fields, date) {
|
|
152
|
+
await mkdir(backlogDir, { recursive: true });
|
|
153
|
+
const id = await reserveNextId(backlogDir, prefix);
|
|
154
|
+
const filePath = join(backlogDir, `${id}-${slugify(fields.title)}.md`);
|
|
155
|
+
await writeFile(filePath, renderBacklogItem(id, fields, date));
|
|
156
|
+
return { id, filePath };
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
/** @param {string} projectDir */
|
|
160
|
+
async function projectConfig(projectDir) {
|
|
161
|
+
const configPath = join(projectDir, '.planr', 'config.json');
|
|
162
|
+
let raw;
|
|
163
|
+
try {
|
|
164
|
+
raw = await readFile(configPath, 'utf8');
|
|
165
|
+
} catch (error) {
|
|
166
|
+
if (/** @type {NodeJS.ErrnoException} */ (error).code === 'ENOENT')
|
|
167
|
+
throw new Error(
|
|
168
|
+
`No OpenPlanr project at ${projectDir}: ${configPath} is missing. Run \`openplanr init\` or pass the project root.`,
|
|
169
|
+
);
|
|
170
|
+
throw error;
|
|
171
|
+
}
|
|
172
|
+
let config;
|
|
173
|
+
try {
|
|
174
|
+
config = JSON.parse(raw);
|
|
175
|
+
} catch (error) {
|
|
176
|
+
throw new Error(`${configPath} is not valid JSON: ${/** @type {Error} */ (error).message}`);
|
|
177
|
+
}
|
|
178
|
+
return { configPath, raw, config };
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/** @param {string} projectDir */
|
|
182
|
+
async function projectBacklog(projectDir) {
|
|
183
|
+
const { config } = await projectConfig(projectDir);
|
|
184
|
+
const agile = String(config.outputPaths?.agile ?? '.planr').replaceAll('\\', '/');
|
|
185
|
+
return {
|
|
186
|
+
backlogDir: resolve(projectDir, agile, 'backlog'),
|
|
187
|
+
prefix: String(config.idPrefix?.backlog ?? 'BL'),
|
|
188
|
+
templateOverrides:
|
|
189
|
+
typeof config.templateOverrides === 'string' ? config.templateOverrides : undefined,
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/** @param {string} projectDir @param {string} filePath */
|
|
194
|
+
const relativePath = (projectDir, filePath) => relative(projectDir, filePath).split(sep).join('/');
|
|
195
|
+
|
|
196
|
+
/** @type {typeof import('./backlog-item.d.mts').createBacklogItem} */
|
|
197
|
+
export async function createBacklogItem(
|
|
198
|
+
projectDir,
|
|
199
|
+
input,
|
|
200
|
+
date = new Date().toISOString().split('T')[0],
|
|
201
|
+
) {
|
|
202
|
+
const { backlogDir, prefix } = await projectBacklog(projectDir);
|
|
203
|
+
const fields = backlogFields(input);
|
|
204
|
+
const { id, filePath } = await writeBacklogItem(backlogDir, prefix, fields, date);
|
|
205
|
+
return { id, title: fields.title, artifactPath: relativePath(projectDir, filePath) };
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Top-level scalar frontmatter fields; double-quoted values are read as JSON strings.
|
|
210
|
+
* @param {string} text
|
|
211
|
+
* @param {string} filePath
|
|
212
|
+
*/
|
|
213
|
+
function frontmatter(text, filePath) {
|
|
214
|
+
const block = /^---\n([\s\S]*?)\n---/u.exec(text.replace(/\r\n/gu, '\n'))?.[1] ?? '';
|
|
215
|
+
/** @type {Record<string, string>} */
|
|
216
|
+
const fields = {};
|
|
217
|
+
for (const line of block.split('\n')) {
|
|
218
|
+
const match = /^(\w+):\s*(.*)$/u.exec(line);
|
|
219
|
+
if (!match) continue;
|
|
220
|
+
const value = match[2].trim();
|
|
221
|
+
if (!value.startsWith('"')) {
|
|
222
|
+
fields[match[1]] = value.replace(/^'(.*)'$/u, '$1');
|
|
223
|
+
continue;
|
|
224
|
+
}
|
|
225
|
+
try {
|
|
226
|
+
fields[match[1]] = String(JSON.parse(value));
|
|
227
|
+
} catch (error) {
|
|
228
|
+
throw new Error(
|
|
229
|
+
`${filePath}: frontmatter field "${match[1]}" is not a valid quoted string: ${/** @type {Error} */ (error).message}`,
|
|
230
|
+
);
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
return fields;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
/** @type {typeof import('./backlog-item.d.mts').listOpenBacklog} */
|
|
237
|
+
export async function listOpenBacklog(projectDir) {
|
|
238
|
+
const { backlogDir } = await projectBacklog(projectDir);
|
|
239
|
+
let names;
|
|
240
|
+
try {
|
|
241
|
+
names = await readdir(backlogDir);
|
|
242
|
+
} catch (error) {
|
|
243
|
+
if (/** @type {NodeJS.ErrnoException} */ (error).code === 'ENOENT') return [];
|
|
244
|
+
throw error;
|
|
245
|
+
}
|
|
246
|
+
const items = [];
|
|
247
|
+
for (const name of names.sort((a, b) => a.localeCompare(b, undefined, { numeric: true }))) {
|
|
248
|
+
const match = /^([A-Z]+-\d{3,})-.+\.md$/u.exec(name);
|
|
249
|
+
if (!match) continue;
|
|
250
|
+
const filePath = join(backlogDir, name);
|
|
251
|
+
const fields = frontmatter(await readFile(filePath, 'utf8'), filePath);
|
|
252
|
+
const status = fields.status ?? 'open';
|
|
253
|
+
if (CLOSED_STATUSES.has(status)) continue;
|
|
254
|
+
items.push({
|
|
255
|
+
id: fields.id ?? match[1],
|
|
256
|
+
title: fields.title ?? name.slice(match[1].length + 1, -3).replace(/-/g, ' '),
|
|
257
|
+
status,
|
|
258
|
+
path: relativePath(projectDir, filePath),
|
|
259
|
+
});
|
|
260
|
+
}
|
|
261
|
+
return items;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/** @type {typeof import('./backlog-item.d.mts').takeCliHint} */
|
|
265
|
+
export async function takeCliHint(projectDir) {
|
|
266
|
+
const { configPath, raw, config } = await projectConfig(projectDir);
|
|
267
|
+
if (config.findings?.cliHintShown === true) return null;
|
|
268
|
+
const next = { ...config, findings: { ...config.findings, cliHintShown: true } };
|
|
269
|
+
const indent = /\n(\t| +)"/u.exec(raw)?.[1] ?? ' ';
|
|
270
|
+
await writeFile(configPath, `${JSON.stringify(next, null, indent)}\n`);
|
|
271
|
+
return CLI_HINT;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/** @param {string} source */
|
|
275
|
+
async function readInput(source) {
|
|
276
|
+
const text =
|
|
277
|
+
source === '-'
|
|
278
|
+
? await new Promise((done, fail) => {
|
|
279
|
+
let value = '';
|
|
280
|
+
process.stdin.setEncoding('utf8');
|
|
281
|
+
process.stdin.on('data', (chunk) => {
|
|
282
|
+
value += chunk;
|
|
283
|
+
});
|
|
284
|
+
process.stdin.on('end', () => done(value));
|
|
285
|
+
process.stdin.on('error', fail);
|
|
286
|
+
})
|
|
287
|
+
: await readFile(resolve(source), 'utf8');
|
|
288
|
+
const parsed = JSON.parse(String(text));
|
|
289
|
+
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed))
|
|
290
|
+
throw new Error('Backlog input must be one JSON object with at least a title.');
|
|
291
|
+
return parsed;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
const USAGE =
|
|
295
|
+
'Usage: backlog-item.mjs add --project <dir> --data <file|->\n backlog-item.mjs list --project <dir> --open\n';
|
|
296
|
+
|
|
297
|
+
/** @param {string[]} argv */
|
|
298
|
+
async function main(argv) {
|
|
299
|
+
const [command, ...rest] = argv;
|
|
300
|
+
/** @type {Record<string, string | boolean>} */
|
|
301
|
+
const options = {};
|
|
302
|
+
for (let index = 0; index < rest.length; index += 1) {
|
|
303
|
+
const flag = rest[index];
|
|
304
|
+
if (flag === '--open') options.open = true;
|
|
305
|
+
else if (flag === '--project' || flag === '--data')
|
|
306
|
+
options[flag.slice(2)] = rest[++index] ?? '';
|
|
307
|
+
else throw new Error(`Unknown argument: ${flag}\n${USAGE}`);
|
|
308
|
+
}
|
|
309
|
+
const projectDir = resolve(String(options.project ?? '.'));
|
|
310
|
+
if (command === 'add') {
|
|
311
|
+
if (typeof options.data !== 'string' || !options.data)
|
|
312
|
+
throw new Error(`add needs --data.\n${USAGE}`);
|
|
313
|
+
const { templateOverrides } = await projectBacklog(projectDir);
|
|
314
|
+
const result = await createBacklogItem(projectDir, await readInput(options.data));
|
|
315
|
+
const cliHint = await takeCliHint(projectDir);
|
|
316
|
+
process.stdout.write(
|
|
317
|
+
`${JSON.stringify({
|
|
318
|
+
ok: true,
|
|
319
|
+
action: 'backlog.created',
|
|
320
|
+
...result,
|
|
321
|
+
...(templateOverrides ? { templateOverrideIgnored: true } : {}),
|
|
322
|
+
...(cliHint ? { cliHint } : {}),
|
|
323
|
+
})}\n`,
|
|
324
|
+
);
|
|
325
|
+
return;
|
|
326
|
+
}
|
|
327
|
+
if (command === 'list' && options.open) {
|
|
328
|
+
process.stdout.write(`${JSON.stringify({ items: await listOpenBacklog(projectDir) })}\n`);
|
|
329
|
+
return;
|
|
330
|
+
}
|
|
331
|
+
throw new Error(USAGE);
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
if (process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
|
|
335
|
+
main(process.argv.slice(2)).catch((error) => {
|
|
336
|
+
process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
337
|
+
process.exit(1);
|
|
338
|
+
});
|
|
339
|
+
}
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
OpenPlanr skills name a kind of service, such as `~~chat`, instead of a product. Connect
|
|
4
4
|
the product your team uses through your host: the vendor publishes the connector, and
|
|
5
5
|
you sign in through the host. OpenPlanr bundles no connectors; they and their credentials
|
|
6
|
-
live in your host.
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
you sign in to.
|
|
11
|
-
`openplanr company logout` removes company tokens.
|
|
6
|
+
live in your host. One optional feature needs a token: Linear sync (`openplanr linear`).
|
|
7
|
+
Only when you use it does OpenPlanr store a token, in your OS keychain, or in an encrypted
|
|
8
|
+
file at `~/.planr/credentials.enc` if you set `PLANR_CREDENTIAL_FILE_PASSPHRASE`. The token
|
|
9
|
+
is sent only to Linear.
|
|
12
10
|
Every skill also works with nothing connected and reports any remote step it skipped.
|
|
13
11
|
|
|
14
12
|
| Category | Placeholder | Products |
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
OpenPlanr skills name a kind of service, such as `~~chat`, instead of a product. Connect
|
|
4
4
|
the product your team uses through your host: the vendor publishes the connector, and
|
|
5
5
|
you sign in through the host. OpenPlanr bundles no connectors; they and their credentials
|
|
6
|
-
live in your host.
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
you sign in to.
|
|
11
|
-
`openplanr company logout` removes company tokens.
|
|
6
|
+
live in your host. One optional feature needs a token: Linear sync (`openplanr linear`).
|
|
7
|
+
Only when you use it does OpenPlanr store a token, in your OS keychain, or in an encrypted
|
|
8
|
+
file at `~/.planr/credentials.enc` if you set `PLANR_CREDENTIAL_FILE_PASSPHRASE`. The token
|
|
9
|
+
is sent only to Linear.
|
|
12
10
|
Every skill also works with nothing connected and reports any remote step it skipped.
|
|
13
11
|
|
|
14
12
|
| Category | Placeholder | Products |
|