@yss123/cage-cli 0.3.1 → 0.3.2
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 +7 -3
- package/dist/capabilities.js +40 -40
- package/dist/capabilities.js.map +1 -1
- package/dist/main.js +1 -1
- package/dist/main.js.map +1 -1
- package/dist/project-structure.js +2 -2
- package/dist/project-structure.js.map +1 -1
- package/dist/sync.d.ts +1 -1
- package/dist/sync.js +25 -108
- package/dist/sync.js.map +1 -1
- package/package.json +6 -6
- package/templates/app/.agents/skills/cage-development/SKILL.md +10 -0
- package/templates/app/AGENTS.md +39 -122
- package/templates/app/CLAUDE.md +6 -0
- package/templates/app/README.md +4 -4
- package/templates/app/apps/api/package.json +2 -2
- package/templates/app/apps/web/package.json +1 -1
- package/templates/app/docs/README.md +11 -0
- package/templates/app/docs/development/README.md +64 -0
- package/templates/app/docs/development/examples/note/note-detail-page.tsx +106 -0
- package/templates/app/docs/development/examples/note/note.ts +67 -0
- package/templates/app/docs/development/examples/note/notes-page.tsx +87 -0
- package/templates/{blank/docs/ai → app/docs/development/examples}/purchase-example.md +5 -5
- package/templates/{blank/docs/ai → app/docs/development/getting-started}/architecture.md +4 -4
- package/templates/app/docs/development/getting-started/first-feature.md +66 -0
- package/templates/app/docs/{ai → development/getting-started}/workflow.md +13 -12
- package/templates/app/docs/{ai → development/guides}/approvals.md +16 -6
- package/templates/app/docs/development/guides/business-collaboration.md +63 -0
- package/templates/{blank/docs/ai → app/docs/development/guides}/files.md +5 -1
- package/templates/app/docs/{ai → development/guides}/intelligence.md +4 -4
- package/templates/app/docs/{ai → development/guides}/recipes.md +31 -11
- package/templates/app/docs/{ai → development/guides}/relations.md +2 -2
- package/templates/{blank/docs/ai → app/docs/development/guides}/routing.md +1 -1
- package/templates/app/docs/{ai → development/guides}/transfers.md +1 -1
- package/templates/{blank/docs/ai → app/docs/development/reference}/commenting.md +1 -1
- package/templates/app/docs/{ai → development/reference}/primitives.md +8 -62
- package/templates/app/docs/{ai → development/reference}/project-structure.md +2 -2
- package/templates/app/docs/development/skills/cage-development/SKILL.md +134 -0
- package/templates/{blank/docs/ai → app/docs/development/tools}/diagnostics.md +3 -3
- package/templates/{blank/docs/ai → app/docs/development/tools}/ontology-context.md +3 -3
- package/templates/app/docs/{ai → development/tools}/troubleshooting.md +7 -1
- package/templates/app/docs/errors/CAGE-AI-001.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-001.md +2 -2
- package/templates/app/docs/errors/CAGE-APPR-002.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-003.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-004.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-005.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-006.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-007.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-010.md +1 -1
- package/templates/app/docs/errors/CAGE-AUDIT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-AUTH-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BIZ-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BIZ-002.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-002.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CMD-002.md +1 -1
- package/templates/app/docs/errors/CAGE-CMD-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-001.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-002.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-004.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-005.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-006.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-007.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-008.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-009.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-010.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-011.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-012.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-013.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-014.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-015.md +1 -1
- package/templates/app/docs/errors/CAGE-CREATE-001.md +2 -2
- package/templates/app/docs/errors/CAGE-DECL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-002.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-003.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-004.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-002.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-003.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-004.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-005.md +1 -1
- package/templates/app/docs/errors/CAGE-DIAG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DLQ-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-002.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-003.md +1 -1
- package/templates/app/docs/errors/CAGE-EVENT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-EVENT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-001.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-002.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-003.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-004.md +1 -1
- package/templates/app/docs/errors/CAGE-FILE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-001.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-002.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-003.md +1 -1
- package/templates/app/docs/errors/CAGE-GRANT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-GRANT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-GRANT-003.md +1 -1
- package/templates/app/docs/errors/CAGE-IMPACT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-IMPACT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-003.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-004.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-005.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-001.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-002.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-003.md +1 -1
- package/templates/app/docs/errors/CAGE-LINT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-002.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-005.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-001.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-002.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-003.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-004.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-005.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-006.md +1 -1
- package/templates/app/docs/errors/CAGE-ORG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-PAIR-002.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-001.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-002.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-003.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-003.md +1 -1
- package/templates/app/docs/errors/CAGE-READS-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-002.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-003.md +1 -1
- package/templates/app/docs/errors/CAGE-REL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ROUTE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SCOPE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SCOPE-002.md +1 -1
- package/templates/app/docs/errors/CAGE-SECRET-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SECRET-002.md +1 -1
- package/templates/app/docs/errors/CAGE-SENS-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SQL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SQL-002.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-002.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-003.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-004.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-005.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-010.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-011.md +1 -1
- package/templates/app/docs/errors/CAGE-STRUCT-001.md +4 -4
- package/templates/app/docs/errors/CAGE-STRUCT-002.md +3 -3
- package/templates/app/docs/errors/CAGE-SYNC-001.md +4 -4
- package/templates/app/docs/errors/CAGE-TEST-001.md +1 -1
- package/templates/app/docs/errors/CAGE-TEST-002.md +1 -1
- package/templates/app/docs/errors/CAGE-TEST-003.md +1 -1
- package/templates/app/docs/errors/CAGE-UNSAFE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-UPGRADE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-001.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-002.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-003.md +1 -1
- package/templates/app/docs/errors/README.md +1 -1
- package/templates/app/docs/errors/runtime.md +1 -1
- package/templates/app/package.json +3 -3
- package/templates/app/packages/contracts/package.json +1 -1
- package/templates/app/packages/domain/package.json +5 -5
- package/templates/blank/.agents/skills/cage-development/SKILL.md +10 -0
- package/templates/blank/AGENTS.md +39 -122
- package/templates/blank/CLAUDE.md +6 -0
- package/templates/blank/README.md +3 -3
- package/templates/blank/apps/api/package.json +1 -1
- package/templates/blank/apps/web/package.json +1 -1
- package/templates/blank/docs/README.md +11 -0
- package/templates/blank/docs/development/README.md +64 -0
- package/templates/blank/docs/development/examples/note/note-detail-page.tsx +106 -0
- package/templates/blank/docs/development/examples/note/note.ts +67 -0
- package/templates/blank/docs/development/examples/note/notes-page.tsx +87 -0
- package/templates/{app/docs/ai → blank/docs/development/examples}/purchase-example.md +5 -5
- package/templates/{app/docs/ai → blank/docs/development/getting-started}/architecture.md +4 -4
- package/templates/blank/docs/development/getting-started/first-feature.md +66 -0
- package/templates/blank/docs/{ai → development/getting-started}/workflow.md +13 -12
- package/templates/blank/docs/{ai → development/guides}/approvals.md +16 -6
- package/templates/blank/docs/development/guides/business-collaboration.md +63 -0
- package/templates/{app/docs/ai → blank/docs/development/guides}/files.md +5 -1
- package/templates/blank/docs/{ai → development/guides}/intelligence.md +4 -4
- package/templates/blank/docs/{ai → development/guides}/recipes.md +31 -11
- package/templates/blank/docs/{ai → development/guides}/relations.md +2 -2
- package/templates/{app/docs/ai → blank/docs/development/guides}/routing.md +1 -1
- package/templates/blank/docs/{ai → development/guides}/transfers.md +1 -1
- package/templates/{app/docs/ai → blank/docs/development/reference}/commenting.md +1 -1
- package/templates/blank/docs/{ai → development/reference}/primitives.md +8 -62
- package/templates/blank/docs/{ai → development/reference}/project-structure.md +2 -2
- package/templates/blank/docs/development/skills/cage-development/SKILL.md +134 -0
- package/templates/{app/docs/ai → blank/docs/development/tools}/diagnostics.md +3 -3
- package/templates/{app/docs/ai → blank/docs/development/tools}/ontology-context.md +3 -3
- package/templates/blank/docs/{ai → development/tools}/troubleshooting.md +7 -1
- package/templates/blank/docs/errors/CAGE-AI-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-001.md +2 -2
- package/templates/blank/docs/errors/CAGE-APPR-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-007.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-AUDIT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-AUTH-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BIZ-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BIZ-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CMD-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-CMD-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-007.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-008.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-009.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-011.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-012.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-013.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-014.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-015.md +1 -1
- package/templates/blank/docs/errors/CAGE-CREATE-001.md +2 -2
- package/templates/blank/docs/errors/CAGE-DECL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-DIAG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DLQ-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-EVENT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-EVENT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-FILE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-GRANT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-GRANT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-GRANT-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-IMPACT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-IMPACT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-LINT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-ORG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-PAIR-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-READS-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-REL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ROUTE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SCOPE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SCOPE-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-SECRET-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SECRET-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-SENS-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SQL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SQL-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-011.md +1 -1
- package/templates/blank/docs/errors/CAGE-STRUCT-001.md +4 -4
- package/templates/blank/docs/errors/CAGE-STRUCT-002.md +3 -3
- package/templates/blank/docs/errors/CAGE-SYNC-001.md +4 -4
- package/templates/blank/docs/errors/CAGE-TEST-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-TEST-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-TEST-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-UNSAFE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-UPGRADE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-003.md +1 -1
- package/templates/blank/docs/errors/README.md +1 -1
- package/templates/blank/docs/errors/runtime.md +1 -1
- package/templates/blank/docs/examples/purchase-admin/README.md +1 -1
- package/templates/blank/package.json +3 -3
- package/templates/blank/packages/contracts/package.json +1 -1
- package/templates/blank/packages/domain/package.json +5 -5
- package/templates/app/docs/ai/README.md +0 -103
- package/templates/blank/docs/ai/README.md +0 -103
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# 本地框架文档
|
|
2
|
+
|
|
3
|
+
从 [框架学习入口](development/README.md) 或 [Cage 开发 Skill](development/skills/cage-development/SKILL.md) 开始。
|
|
4
|
+
|
|
5
|
+
- `development/getting-started`:运行模型、完整入门课和开发步骤。
|
|
6
|
+
- `development/guides`:[业务澄清与共同设计](development/guides/business-collaboration.md)、能力选择与各专题接入。
|
|
7
|
+
- `development/reference`:原语与工程规范。
|
|
8
|
+
- `development/tools`:诊断、本体查询和排错。
|
|
9
|
+
- `development/examples`:教学源码与采购导读。
|
|
10
|
+
- `development/skills`:框架开发方法。
|
|
11
|
+
- [错误码册](errors/README.md):按实际错误定位原因。
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Cage 框架学习入口
|
|
2
|
+
|
|
3
|
+
本目录是开发者与编程 Agent 共用的 Cage 应用开发教材,帮助你理解框架并把业务需求落实为可运行的应用。开发方法的统一入口是 [cage-development Skill](skills/cage-development/SKILL.md)。教材由框架维护,随脚手架分发;读取教材无需额外服务、模型或向量索引。
|
|
4
|
+
|
|
5
|
+
模型接入、智能助理和 AI 审批属于框架的原生 AI 能力,具体接入见[原生 AI 专题](guides/intelligence.md)。
|
|
6
|
+
|
|
7
|
+
## 按当前阶段阅读
|
|
8
|
+
|
|
9
|
+
| 你现在需要什么 | 从哪里开始 | 应得到什么 |
|
|
10
|
+
| --- | --- | --- |
|
|
11
|
+
| 第一次使用 Cage | [Skill 的运行模型](skills/cage-development/SKILL.md#先建立正确的运行模型) → [第一条完整业务链](getting-started/first-feature.md) | 理解声明、导出、生成、授权、契约与持久读写如何连接 |
|
|
12
|
+
| 用户描述或文档不清楚 | [业务澄清与共同设计](guides/business-collaboration.md) | 主动提出疑问、可行选项与建议,与用户选择业务规则,再落实到实现和验收 |
|
|
13
|
+
| 把需求转成设计 | [业务设计与能力选择](guides/recipes.md) | 确定聚合边界、命令、范围、关系和一致性要求 |
|
|
14
|
+
| 实现或修改功能 | [Skill 的实施流程](skills/cage-development/SKILL.md#4-沿一条真实链路实施再扩展) → [开发步骤](getting-started/workflow.md) | 沿实际调用链完成受影响的功能,并取得验证证据 |
|
|
15
|
+
| 已有功能不正常 | [排错方法](tools/troubleshooting.md) → [诊断工具](tools/diagnostics.md) / [错误码册](../errors/README.md) | 找到第一个失败边界,修复原因并复验 |
|
|
16
|
+
| 查询一个能力的用法 | 下方专题表,必要时本地搜索术语 | 找到当前任务的 API、接入前提与限制 |
|
|
17
|
+
|
|
18
|
+
已经熟悉框架时不必每次重读课程。不要将所有专题一次加载,也不要把参考业务注册到客户应用。
|
|
19
|
+
|
|
20
|
+
## 按资料用途查找
|
|
21
|
+
|
|
22
|
+
| 目录 | 内容与入口 |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `getting-started/` 入门 | [运行模型](getting-started/architecture.md)、[完整入门课](getting-started/first-feature.md)、[开发步骤](getting-started/workflow.md) |
|
|
25
|
+
| `guides/` 专题指南 | [业务澄清](guides/business-collaboration.md)、[能力选择](guides/recipes.md)、[审批](guides/approvals.md)、[文件](guides/files.md)、[关系](guides/relations.md)、[路由](guides/routing.md)、[数据传输](guides/transfers.md)、[原生 AI](guides/intelligence.md) |
|
|
26
|
+
| `reference/` 参考规范 | [原语](reference/primitives.md)、[目录组织](reference/project-structure.md)、[中文注释](reference/commenting.md) |
|
|
27
|
+
| `tools/` 工具与排错 | [诊断](tools/diagnostics.md)、[本体上下文](tools/ontology-context.md)、[排错方法](tools/troubleshooting.md) |
|
|
28
|
+
| `examples/` 教学示例 | [便笺源码](examples/note/note.ts)、[采购导读](examples/purchase-example.md);按入门课与导读阅读,源码不自动注册 |
|
|
29
|
+
| `skills/` agent 开发流程 | [cage-development](skills/cage-development/SKILL.md),按任务加载上述教材 |
|
|
30
|
+
|
|
31
|
+
查明确符号可用 `rg -n "术语或符号" docs/development docs/errors`,没有 rg 时使用 agent 的本地文件搜索。用 `pnpm exec cage capabilities 符号 --format json` 核对已安装版本公开签名,用 `pnpm exec cage context "业务关键词" --format json` 定位当前应用。候选命中不能代替阅读上下文,未命中也不能证明框架不支持。
|
|
32
|
+
|
|
33
|
+
## 确认代码与资料的位置
|
|
34
|
+
|
|
35
|
+
本指南的业务路径和命令默认相对应用根目录。应用的 `packages/domain/src` 定义业务,`packages/contracts/src` 是生成契约,`apps/web/src` 是界面,`apps/api/src` 是薄启动入口,`db/migrations` 保存审查过的迁移。
|
|
36
|
+
|
|
37
|
+
空白模板只启用组织基础;`docs/examples/purchase-admin` 是离线采购参考源码,不参与注册、编译或迁移。采购模板直接在业务目录包含该范例。框架仓库的应用根目录是 `examples/purchase-admin`,规范教材位于仓库 `docs/development`,以应用 AGENTS.md 的说明为准。
|
|
38
|
+
|
|
39
|
+
`docs/development` 是框架教学内容的唯一手写来源;Skills 发现入口和模板副本由同步脚本生成。用户的业务约定保留在项目 AGENTS.md 的托管区外。教材分发检查只能证明资料存在且一致,模型是否学会需要框架维护者另做任务评估。
|
|
40
|
+
|
|
41
|
+
## 当前实现边界
|
|
42
|
+
|
|
43
|
+
以下区分可避免 agent 把方案中的愿景写成不存在的功能。
|
|
44
|
+
|
|
45
|
+
| 已有能力 | 使用边界 |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| 真实 PostgreSQL 连接、分账号、表结构迁移 | 连接已有数据库;`init` 不建库;不会自动识别并接管任意历史表 |
|
|
48
|
+
| 聚合/命令、能力与范围、掩码、审计、outbox、worker | handler 不做数据库/网络 IO;生产角色不会自动拿到新能力 |
|
|
49
|
+
| fields 中的 ref / hasMany / manyToMany | hasMany 为只读反查;manyToMany 自动中间表并随主对象事务写入,公开读取独立分页;双向集合不会自动互为镜像 |
|
|
50
|
+
| 本体抽取、中文检索/节点/路径/AI 上下文、图规则、图谱、生成、影响分析与门禁 | 上下文注明证据、源码和覆盖边界;名称与测试匹配是候选线索,不能证明任意 JS 正确;跳过用例仍需补足 |
|
|
51
|
+
| 有界集合 reactionEach、显式步骤 order | 稳定唯一键排序后串行调用目标命令;同事务整体回滚,异步链按 outbox 恢复;不是并行写表接口 |
|
|
52
|
+
| capabilities、doctor、timeline、explain、snapshot | 实际运行诊断需要受控会话与权限;未取得的证据为 unknown,授权解释不执行 handler |
|
|
53
|
+
| 代码审批路由与任务流转 | 顺序/条件、`parallel/branch` 结构化 AND 分支与汇合、any/all、字段选人、候选领取/释放、转办、单层委派归还、前后/并行必签和动作历史;候选池仅支持 any,追加票全部必签。条件和依赖随提交冻结,currentStep 仅为最小活动索引;尚无任意连线/循环/OR 网关、岗位/代理规则、通用恢复、任意 JS 选人或在途迁移,见[任务流转](guides/approvals.md) |
|
|
54
|
+
| 审批时限、站内提醒与催办 | 人工节点按实际开启时间计算自然分钟 SLA,worker 持久投递临期/超时提醒;申请人可按完整活动集合催办,同实例共享冷却,接收人可标已读。旧快照不自动获得政策;尚无工作日历、自动升级、抄送或邮件/短信通知 |
|
|
55
|
+
| 审批界面与 SDK | Admin/采购待办可领取、释放、归还受托任务并查看等待加签;采购另有协作名录选人器、转办/委派/三种加签及分页人工历史,view 查询参数保留视图。启用运营后通用 Admin 提供我的申请、催办和流程提醒;页面仍需应用启用、真实授权与浏览器验收。AI 助理目前只查询本人待办及提交决定,无人员管理写工具 |
|
|
56
|
+
| 原生 AI 审批与领域助理 | 现有 `step` 支持 `kind: 'ai'`;三态审核、自动工具、会话及偏好记忆可复用;需显式启用、授权并做模型质量验收 |
|
|
57
|
+
| Admin 模型与性格、助理 SDK | 动态模型连接和性格管理;Chat Completions / Responses 兼容性以实际服务为准;SDK 提供流式状态与页面快照,悬浮窗和 Markdown 由应用实现 |
|
|
58
|
+
| 连接器 fake、出站、入站验签、同步记录 | fake 不等于真实 ERP 联调,也不等于完整请求录制/回放平台 |
|
|
59
|
+
| 异步 CSV 导入/导出接口与客户端任务查询 | 界面由业务项目决定;导出结果不是可直接回导的命令输入模板 |
|
|
60
|
+
| 私有文件字段、流式分片上传、暂停与续传、范围下载 | 默认本地存储,提供对象存储适配接口;尚无内置 S3/OSS、签名直传、病毒扫描及文件共享 |
|
|
61
|
+
| 组织模型、系统管理界面 | 暂无移动部门(改上级)的完整支持、菜单配置页 |
|
|
62
|
+
| 库存锁采购范例 | 演示资源生命周期;不是仓库级并发库存扣减、退货或 ERP 撤销补偿系统 |
|
|
63
|
+
|
|
64
|
+
文档与实现冲突时,以当前代码和检查结果为依据,指出冲突并修正文档;不要默默扩展公开 API。规划、代码存在、构建通过、真实联调通过是不同状态,交付时分别说明。
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 入门课详情页,从 URL 的 id 独立读取便笺并通过契约修改或归档。
|
|
3
|
+
* 由 app 组合到 /notes/:id;query 缓存与退出清理由现有应用会话层管理。
|
|
4
|
+
* 每次写入传服务端记录版本;冲突后刷新而不自动覆盖,归档后仅展示结果。
|
|
5
|
+
*/
|
|
6
|
+
import { useRef, useState } from 'react';
|
|
7
|
+
import { Link, useParams } from 'react-router-dom';
|
|
8
|
+
import { note, useNote } from '@app/contracts';
|
|
9
|
+
import { useCan } from '@yss123/cage-client';
|
|
10
|
+
|
|
11
|
+
/** 加载独立详情;标题草稿为 null 时显示服务端标题,空字符串仍表示用户正在编辑。 */
|
|
12
|
+
export function NoteDetailPage() {
|
|
13
|
+
const { id = '' } = useParams();
|
|
14
|
+
const query = useNote(id);
|
|
15
|
+
const canUpdate = useCan('Note.update');
|
|
16
|
+
const canArchive = useCan('Note.archive');
|
|
17
|
+
const [draft, setDraft] = useState<{ id: string; title: string } | null>(null);
|
|
18
|
+
const [error, setError] = useState('');
|
|
19
|
+
const [saving, setSaving] = useState(false);
|
|
20
|
+
const submitting = useRef(false);
|
|
21
|
+
const record = query.data;
|
|
22
|
+
const title = draft?.id === id ? draft.title : (record?.title ?? '');
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* 保存或归档当前记录,使用读取版本防止覆盖并发变更;失败保留草稿,成功后清除草稿并读取。
|
|
26
|
+
* 冲突刷新后要求用户核对再提交;按钮禁用与引用锁限制本页同时提交,不替代内核检查。
|
|
27
|
+
*/
|
|
28
|
+
async function save(action: 'update' | 'archive') {
|
|
29
|
+
if (!record || submitting.current) return;
|
|
30
|
+
submitting.current = true;
|
|
31
|
+
setSaving(true);
|
|
32
|
+
setError('');
|
|
33
|
+
try {
|
|
34
|
+
const result =
|
|
35
|
+
action === 'update'
|
|
36
|
+
? await note.update(record.id, { title }, record.version)
|
|
37
|
+
: await note.archive(record.id, record.version);
|
|
38
|
+
if (!result.ok) {
|
|
39
|
+
setError(
|
|
40
|
+
result.code === 'CONFLICT'
|
|
41
|
+
? '记录已变化,请核对最新数据和当前草稿后再提交。'
|
|
42
|
+
: `操作失败:${result.code}`,
|
|
43
|
+
);
|
|
44
|
+
if (result.code === 'CONFLICT') await query.refetch();
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
setDraft(null);
|
|
48
|
+
await query.refetch();
|
|
49
|
+
} catch {
|
|
50
|
+
setError('请求未完成,请重新读取记录确认结果。');
|
|
51
|
+
} finally {
|
|
52
|
+
submitting.current = false;
|
|
53
|
+
setSaving(false);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
return (
|
|
58
|
+
<section>
|
|
59
|
+
<Link to="/notes">返回列表</Link>
|
|
60
|
+
{query.isPending && <p role="status">正在加载…</p>}
|
|
61
|
+
{query.isError && (
|
|
62
|
+
<p role="alert">
|
|
63
|
+
无法读取记录:可能不存在、会话失效或不在可见范围。
|
|
64
|
+
<button onClick={() => void query.refetch()}>重试</button>
|
|
65
|
+
</p>
|
|
66
|
+
)}
|
|
67
|
+
{record && (
|
|
68
|
+
<>
|
|
69
|
+
<h1>{record.title}</h1>
|
|
70
|
+
<p>
|
|
71
|
+
状态:{record.status};版本:{record.version}
|
|
72
|
+
</p>
|
|
73
|
+
{record.status === 'active' && (
|
|
74
|
+
<>
|
|
75
|
+
{canUpdate && (
|
|
76
|
+
<form
|
|
77
|
+
onSubmit={(event) => {
|
|
78
|
+
event.preventDefault();
|
|
79
|
+
void save('update');
|
|
80
|
+
}}
|
|
81
|
+
>
|
|
82
|
+
<label>
|
|
83
|
+
标题
|
|
84
|
+
<input
|
|
85
|
+
value={title}
|
|
86
|
+
required
|
|
87
|
+
maxLength={120}
|
|
88
|
+
onChange={(event) => setDraft({ id, title: event.target.value })}
|
|
89
|
+
/>
|
|
90
|
+
</label>
|
|
91
|
+
<button disabled={saving || !title.trim()}>保存</button>
|
|
92
|
+
</form>
|
|
93
|
+
)}
|
|
94
|
+
{canArchive && (
|
|
95
|
+
<button disabled={saving} onClick={() => void save('archive')}>
|
|
96
|
+
归档
|
|
97
|
+
</button>
|
|
98
|
+
)}
|
|
99
|
+
</>
|
|
100
|
+
)}
|
|
101
|
+
</>
|
|
102
|
+
)}
|
|
103
|
+
{error && <p role="alert">{error}</p>}
|
|
104
|
+
</section>
|
|
105
|
+
);
|
|
106
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 框架入门课的部门便笺声明,由学习者放入应用领域模块后从 domain 入口导出。
|
|
3
|
+
* 聚合维护标题、归属和状态;命令仅描述业务变化,实际权限、事务与持久化由内核执行。
|
|
4
|
+
* 本文件作为教材分发,不自动注册到空白应用;不存在文件、审批或外部 IO 副作用。
|
|
5
|
+
*/
|
|
6
|
+
import { aggregate, command, ref, scope, states, text } from '@yss123/cage-kernel';
|
|
7
|
+
import { z } from 'zod';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* 部门便笺以标题和生命周期为一致性边界,通过部门与创建人字段支持安全读取。
|
|
11
|
+
* 声明被 domain 导出后参与注册和生成;实际可见范围取决于角色授权,本声明不授予权限。
|
|
12
|
+
* 所有命令结果均须满足非空标题不变量,归档保留记录并关闭修改入口。
|
|
13
|
+
*/
|
|
14
|
+
export const Note = aggregate('Note', {
|
|
15
|
+
description: '部门便笺',
|
|
16
|
+
fields: {
|
|
17
|
+
/** 标题最多 120 字符;命令先去除两端空白,不变量拒绝空白标题。 */
|
|
18
|
+
title: text(120),
|
|
19
|
+
/** 内核新建时按当前主体填充的部门,用于服务端范围过滤。 */
|
|
20
|
+
deptId: ref('Dept'),
|
|
21
|
+
/** 内核新建时记录的创建人,可用于本人范围;不接受客户端指定。 */
|
|
22
|
+
createdBy: ref('User'),
|
|
23
|
+
},
|
|
24
|
+
states: states('active', 'archived', { terminal: ['archived'] }),
|
|
25
|
+
scope: scope.deptSubtree('deptId'),
|
|
26
|
+
invariants: { titleNotBlank: (record) => record.title.trim().length > 0 },
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* 创建 active 便笺,输入只有去除两端空白后的标题,草稿直接作为业务结果返回。
|
|
31
|
+
* 内核填写归属并执行 Note.create 授权、审计及事务;空标题、无能力或不合格范围会拒绝写入。
|
|
32
|
+
* 不发布额外业务事件,也不接受客户端指定归属字段。
|
|
33
|
+
*/
|
|
34
|
+
export const createNote = command(Note, {
|
|
35
|
+
name: 'create',
|
|
36
|
+
description: '创建便笺',
|
|
37
|
+
from: 'new',
|
|
38
|
+
to: 'active',
|
|
39
|
+
input: z.object({ title: z.string().trim().min(1).max(120) }),
|
|
40
|
+
handler: (draft) => draft,
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* 修改 active 便笺标题;id 用于内核按范围锁定记录,页面另传已读取的 expectedVersion。
|
|
45
|
+
* to: null 保留状态,返回值只包含标题变化;归档或版本冲突由内核拒绝,handler 不直接写库。
|
|
46
|
+
*/
|
|
47
|
+
export const updateNote = command(Note, {
|
|
48
|
+
name: 'update',
|
|
49
|
+
description: '修改便笺标题',
|
|
50
|
+
from: 'active',
|
|
51
|
+
to: null,
|
|
52
|
+
input: z.object({ id: z.string().uuid(), title: z.string().trim().min(1).max(120) }),
|
|
53
|
+
handler: (_draft, input) => ({ title: input.title }),
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* 归档 active 便笺,输入沿用已有对象命令的默认 id,返回草稿以保留标题与归属。
|
|
58
|
+
* 内核检查 Note.archive、范围与版本,再设置 archived;已有归档记录的修改和重复归档会拒绝。
|
|
59
|
+
* 本动作不删除历史记录,不发布需 worker 处理的业务事件。
|
|
60
|
+
*/
|
|
61
|
+
export const archiveNote = command(Note, {
|
|
62
|
+
name: 'archive',
|
|
63
|
+
description: '归档便笺',
|
|
64
|
+
from: 'active',
|
|
65
|
+
to: 'archived',
|
|
66
|
+
handler: (draft) => draft,
|
|
67
|
+
});
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 入门课的便笺列表与创建页面,通过生成契约读写服务端记录,不维护本地业务仓储。
|
|
3
|
+
* 由 app 路由在已登录且具备 Note.read 的页面内挂载;服务端仍执行全部权限与范围判断。
|
|
4
|
+
* 表单状态只保留未提交标题,失败不清空;创建成功后重新查询列表,详情使用独立 URL。
|
|
5
|
+
*/
|
|
6
|
+
import { useRef, useState, type FormEvent } from 'react';
|
|
7
|
+
import { Link } from 'react-router-dom';
|
|
8
|
+
import { note, useNoteList } from '@app/contracts';
|
|
9
|
+
import { useCan } from '@yss123/cage-client';
|
|
10
|
+
|
|
11
|
+
/** 显示当前主体可见的第一页便笺并提供创建入口;分页扩展应按路由规范放入 URL 参数。 */
|
|
12
|
+
export function NotesPage() {
|
|
13
|
+
const query = useNoteList();
|
|
14
|
+
const canCreate = useCan('Note.create');
|
|
15
|
+
const [title, setTitle] = useState('');
|
|
16
|
+
const [error, setError] = useState('');
|
|
17
|
+
const [saving, setSaving] = useState(false);
|
|
18
|
+
const submitting = useRef(false);
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* 提交一次创建,立即锁住重复点击;业务失败保留输入,成功后从安全接口重新读取。
|
|
22
|
+
* 此锁只限制当前页面的并发点击,不承诺跨刷新重试去重;业务需恢复同次请求时另保存幂等键。
|
|
23
|
+
*/
|
|
24
|
+
async function create(event: FormEvent<HTMLFormElement>) {
|
|
25
|
+
event.preventDefault();
|
|
26
|
+
if (submitting.current) return;
|
|
27
|
+
submitting.current = true;
|
|
28
|
+
setSaving(true);
|
|
29
|
+
setError('');
|
|
30
|
+
try {
|
|
31
|
+
const result = await note.create({ title });
|
|
32
|
+
if (!result.ok) {
|
|
33
|
+
setError(`创建失败:${result.code}`);
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
setTitle('');
|
|
37
|
+
await query.refetch();
|
|
38
|
+
} catch {
|
|
39
|
+
setError('请求未完成,请重新读取列表确认结果后再决定是否重试。');
|
|
40
|
+
} finally {
|
|
41
|
+
submitting.current = false;
|
|
42
|
+
setSaving(false);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
return (
|
|
47
|
+
<section>
|
|
48
|
+
<h1>部门便笺</h1>
|
|
49
|
+
{canCreate && (
|
|
50
|
+
<form onSubmit={create}>
|
|
51
|
+
<label>
|
|
52
|
+
标题
|
|
53
|
+
<input
|
|
54
|
+
value={title}
|
|
55
|
+
maxLength={120}
|
|
56
|
+
required
|
|
57
|
+
onChange={(event) => setTitle(event.target.value)}
|
|
58
|
+
/>
|
|
59
|
+
</label>
|
|
60
|
+
<button disabled={saving || !title.trim()}>{saving ? '正在保存…' : '创建'}</button>
|
|
61
|
+
</form>
|
|
62
|
+
)}
|
|
63
|
+
{error && <p role="alert">{error}</p>}
|
|
64
|
+
{query.isPending && <p role="status">正在加载…</p>}
|
|
65
|
+
{query.isError && (
|
|
66
|
+
<p role="alert">
|
|
67
|
+
读取失败,请检查会话和读取权限。<button onClick={() => void query.refetch()}>重试</button>
|
|
68
|
+
</p>
|
|
69
|
+
)}
|
|
70
|
+
{query.data && (
|
|
71
|
+
<>
|
|
72
|
+
<p>
|
|
73
|
+
共 {query.data.total} 条,当前显示 {query.data.items.length} 条。
|
|
74
|
+
</p>
|
|
75
|
+
<ul>
|
|
76
|
+
{query.data.items.map((record) => (
|
|
77
|
+
<li key={record.id}>
|
|
78
|
+
<Link to={`/notes/${encodeURIComponent(record.id)}`}>{record.title}</Link>({record.status})
|
|
79
|
+
</li>
|
|
80
|
+
))}
|
|
81
|
+
</ul>
|
|
82
|
+
{query.data.items.length === 0 && <p>当前可见范围内没有便笺。</p>}
|
|
83
|
+
</>
|
|
84
|
+
)}
|
|
85
|
+
</section>
|
|
86
|
+
);
|
|
87
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 标准采购范例:从声明到业务页面
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [业务任务配方](recipes.md)
|
|
3
|
+
[返回学习入口](../README.md) · [业务任务配方](../guides/recipes.md)
|
|
4
4
|
|
|
5
5
|
选择 `--template purchase` 创建的是可运行的采购应用,下面的路径相对应用根目录;选择 `--template blank` 时,同一份范例仅作为参考源码保存在 `docs/examples/purchase-admin`,下面路径相对该参考目录,它不参与当前应用的编译、注册或迁移。框架能力来自 npm 依赖。先沿一条真实链路读代码,再把需要的模式应用到自己的业务。
|
|
6
6
|
|
|
@@ -71,13 +71,13 @@ submit 返回成功只表示单据和事件已提交,不表示待办、ERP 或
|
|
|
71
71
|
|
|
72
72
|
## 首次体验所需业务配置
|
|
73
73
|
|
|
74
|
-
以下体验需要采购模板;空白模板不会出现采购页面和审批配置。先按[开发步骤](workflow.md)准备已有数据库并启动 API、worker、Web。首次管理员凭证按 API 提示获取,不把凭证写到仓库。以下是业务配置,不是需要写进框架内核的逻辑。
|
|
74
|
+
以下体验需要采购模板;空白模板不会出现采购页面和审批配置。先按[开发步骤](../getting-started/workflow.md)准备已有数据库并启动 API、worker、Web。首次管理员凭证按 API 提示获取,不把凭证写到仓库。以下是业务配置,不是需要写进框架内核的逻辑。
|
|
75
75
|
|
|
76
76
|
| 对象 | 配置要点 |
|
|
77
77
|
| --- | --- |
|
|
78
78
|
| 采购员 | 创建/查看/提交/取消采购单等所需能力,所属部门,以及采购单数据范围;配置专业复核需 `PurchaseOrder.setReviewers` 和 `ApprovalMember.read` |
|
|
79
79
|
| 智能助理使用人 | 显式授予 `Sys.ai.use`;编辑用途还需 `PurchaseOrder.explainPurpose` |
|
|
80
|
-
| 模型管理者 | `Sys.ai.models.manage`;在 `/admin/#/models` 配置并启用 `main`,部署主密钥见[智能能力指南](intelligence.md) |
|
|
80
|
+
| 模型管理者 | `Sys.ai.models.manage`;在 `/admin/#/models` 配置并启用 `main`,部署主密钥见[智能能力指南](../guides/intelligence.md) |
|
|
81
81
|
| 助理性格管理者 | `Sys.ai.personalities.manage`;在 `/admin/#/personalities` 编辑预设、自定义性格、设置默认并试聊 |
|
|
82
82
|
| AI 预审角色 | 创建 code 为 `purchase_ai_reviewer` 的角色,授予 `PurchaseOrder.read/returnForChanges` 及覆盖申请范围的数据权限;本例 AI 仅预审,不执行最终 approve |
|
|
83
83
|
| 经理 | `PurchaseOrder.read/approve/reject/returnForChanges`,适当数据范围,`approve` 的 `ceiling` 额度参数 |
|
|
@@ -110,11 +110,11 @@ submit 返回成功只表示单据和事件已提交,不表示待办、ERP 或
|
|
|
110
110
|
|
|
111
111
|
`apps/web` 中对字段和按钮的中文名称属于业务文案。图谱名称来自 `cage.config.json` 的 `graph.labels`,比如 `command:PurchaseOrder.submit` 对应“提交审批”。替换业务时别忘了更新这些名称,不要改英文能力标识来做翻译。
|
|
112
112
|
|
|
113
|
-
导出按钮是调用通用异步接口的一个例子;框架不规定所有业务都要放相同的按钮。导入、导出、任务列表与错误报告应按客户页面需要接入,参考[开发步骤](workflow.md)中的客户端方法。
|
|
113
|
+
导出按钮是调用通用异步接口的一个例子;框架不规定所有业务都要放相同的按钮。导入、导出、任务列表与错误报告应按客户页面需要接入,参考[开发步骤](../getting-started/workflow.md)中的客户端方法。
|
|
114
114
|
|
|
115
115
|
## 把示例改成自己的业务
|
|
116
116
|
|
|
117
|
-
先按[目录规范](project-structure.md)新增自己的领域模块和前端模块,完成一条完整链路,再逐步移除不需要的采购导出、路由、反应、连接器和页面引用。`@app/domain`、`@app/contracts` 是应用内包名,可以保留;npm 框架包也不需要重命名。
|
|
117
|
+
先按[目录规范](../reference/project-structure.md)新增自己的领域模块和前端模块,完成一条完整链路,再逐步移除不需要的采购导出、路由、反应、连接器和页面引用。`@app/domain`、`@app/contracts` 是应用内包名,可以保留;npm 框架包也不需要重命名。
|
|
118
118
|
|
|
119
119
|
若数据库尚未投入使用,可为新应用审查和规划初始结构;只要迁移已执行或已发布,就不能通过覆盖 `0001_init.sql` 来假装采购表从未存在。用新迁移表达后续变更,并明确已有数据处理方式。
|
|
120
120
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 架构与执行模型
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [下一篇:原语](primitives.md)
|
|
3
|
+
[返回学习入口](../README.md) · [下一篇:原语](../reference/primitives.md)
|
|
4
4
|
|
|
5
5
|
## 业务声明是一份可执行规格
|
|
6
6
|
|
|
@@ -34,7 +34,7 @@ domain/index.ts 导出的声明
|
|
|
34
34
|
|
|
35
35
|
一个采购单可以有明细列表,也可以引用库存等其他聚合。跨聚合写入要调用对方的命令,通过反应表达关系,不能拿到对方数据库表直接更新。
|
|
36
36
|
|
|
37
|
-
对象关联统一写在 fields:ref 为本表外键,hasMany 依据目标外键反查,manyToMany 自动生成中间表。多对多链接属于来源对象的命令事务,但不授权修改目标内容;公开关联通过两侧安全视图分页读取。完整模式见[对象关系](relations.md)。
|
|
37
|
+
对象关联统一写在 fields:ref 为本表外键,hasMany 依据目标外键反查,manyToMany 自动生成中间表。多对多链接属于来源对象的命令事务,但不授权修改目标内容;公开关联通过两侧安全视图分页读取。完整模式见[对象关系](../guides/relations.md)。
|
|
38
38
|
|
|
39
39
|
## 一次写入的完整路径
|
|
40
40
|
|
|
@@ -69,7 +69,7 @@ worker → 消费 outbox → 异步反应 / 审批 / 连接器
|
|
|
69
69
|
|
|
70
70
|
资源标签 `acquires: 'inventory.lock'`、`releases: 'inventory.lock'` 为图规则提供证据。它们不会自动加锁或释放,真正效果来自 `acquireLock/releaseLock` 命令。
|
|
71
71
|
|
|
72
|
-
有界批量步骤可用 `reactionEach`:声明目标命令、最大项数、唯一排序键和映射,按稳定顺序串行调用。`order` 表达同一事件的步骤依赖,同事务链仍整体回滚。具体声明见[原语指南](primitives.md#有界集合与步骤顺序)。
|
|
72
|
+
有界批量步骤可用 `reactionEach`:声明目标命令、最大项数、唯一排序键和映射,按稳定顺序串行调用。`order` 表达同一事件的步骤依赖,同事务链仍整体回滚。具体声明见[原语指南](../reference/primitives.md#有界集合与步骤顺序)。
|
|
73
73
|
|
|
74
74
|
出站分成外部执行与短事务回写两个阶段。框架先领取本地执行租约,用 `${tenantId}:${declaredKey}` 作为远端幂等键,可靠保存回执后再在短事务调用成功命令;回写失败可复用已保存回执。远端必须实际支持幂等,框架不能承诺任意外部系统恰好一次。不可安全重试的写入结果未知时隔离并要求核对,不能把超时当作远端未执行。
|
|
75
75
|
|
|
@@ -141,7 +141,7 @@ APP、READ、MIGRATE 指向**同一个已经存在的数据库**,用不同账
|
|
|
141
141
|
|
|
142
142
|
## 本体图为什么有这些连线
|
|
143
143
|
|
|
144
|
-
图谱抽取命令状态迁移与事件、反应调用、审批 start/cancelOn、约束/路由字段、查询读依赖和外部映射;另以虚线标记按标识推导的所属聚合。关系解释区分显式声明、规则推导与文本匹配,箭头要按各自含义阅读。开发前可用[本体上下文工具](ontology-context.md)检索相关业务与源码。
|
|
144
|
+
图谱抽取命令状态迁移与事件、反应调用、审批 start/cancelOn、约束/路由字段、查询读依赖和外部映射;另以虚线标记按标识推导的所属聚合。关系解释区分显式声明、规则推导与文本匹配,箭头要按各自含义阅读。开发前可用[本体上下文工具](../tools/ontology-context.md)检索相关业务与源码。
|
|
145
145
|
|
|
146
146
|
`cage analyze` 将图写到 `.cage/ontology.json`;`cage graph` 提供浏览器工作台。中文显示名写在 `cage.config.json` 的 `graph.labels`,例如 `"command:PurchaseOrder.submit": "提交审批"`。显示名不更改能力标识、源码符号或表名。
|
|
147
147
|
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# 第一条完整业务链
|
|
2
|
+
|
|
3
|
+
[学习入口](../README.md) · [框架开发 Skill](../skills/cage-development/SKILL.md) · [原语参考](../reference/primitives.md)
|
|
4
|
+
|
|
5
|
+
本课教会你把声明、契约、页面和持久数据连接起来。以“部门便笺”解释方法:创建便笺、查看列表与详情、修改标题、归档。这个对象只用于教学;开发真实业务时替换对象含义和规则,不需要向用户项目添加便笺。
|
|
6
|
+
|
|
7
|
+
## 先确定业务,再选择声明
|
|
8
|
+
|
|
9
|
+
一条便笺有标题、所属部门和创建人,状态为 active 或 archived。创建、修改标题、归档都是命令;列表和详情使用生成的读取接口。标题不能为空是不变量,归档后不能修改由 update 的 from 表达。
|
|
10
|
+
|
|
11
|
+
归属字段使用 `deptId: ref('Dept')` 与 `createdBy: ref('User')`,内核新建时根据当前主体填写;`scope.deptSubtree('deptId')` 描述范围字段。实际授权仍由角色配置决定,普通用户不能通过提交任意部门 ID 把记录放进其他部门。公司、项目组等自定义归属不能仅改一个字段名字就假定沿用同样规则,应核对当前支持的范围模型。
|
|
12
|
+
|
|
13
|
+
完整领域代码见[便笺声明](../examples/note/note.ts)。依次阅读聚合、createNote、updateNote、archiveNote,注意命令导出名不同于 `name` 指定的能力名称。
|
|
14
|
+
|
|
15
|
+
## 让声明进入应用
|
|
16
|
+
|
|
17
|
+
把本课声明放入应用的 `packages/domain/src/modules/note/note.ts`,在模块 index.ts 导出它,再从 domain 总入口导出模块。保留原有组织模型及其他业务;不要让不同模块的 `export *` 带来重名导出。
|
|
18
|
+
|
|
19
|
+
在应用根目录执行:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
pnpm exec cage check
|
|
23
|
+
pnpm gen
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
检查生成的 Note 契约、图节点、路由信息及迁移草稿。应能找到 `note.create`、`note.update`、`note.archive`、`note.list` 和 `note.get`。这里验证的是注册和生成;尚未证明数据库里有表或用户有权执行。
|
|
27
|
+
|
|
28
|
+
数据库初次准备按[开发步骤](workflow.md#第一次启动应用)进行;已有项目复用现有配置。审查新迁移后执行 `pnpm migrate`,再按当前环境启动/重启 API 与 worker。不要改已执行迁移,也不要为学习案例覆盖业务数据库配置。
|
|
29
|
+
|
|
30
|
+
## 给真实主体配置权限
|
|
31
|
+
|
|
32
|
+
在独立验收环境准备有能力的主体、同部门另一主体和范围外主体。为所需角色明确配置 `Note.read`、`Note.create`、`Note.update`、`Note.archive` 及对应数据范围。按业务分别选择本人、部门或部门及下级等范围;创建一个角色名称不会自动获得这些能力。
|
|
33
|
+
|
|
34
|
+
`scope.none()` 缺少部门/创建人范围表达,不能拿它替代“仅看本部门”。当前框架合并多角色能力与范围;只切换前端门户不会把后端权限自动缩减到所选角色。产品确需切换执行身份时,先确认当前公开协议是否支持该语义,不能通过本地 role 变量伪装授权。
|
|
35
|
+
|
|
36
|
+
## 页面调用真实契约
|
|
37
|
+
|
|
38
|
+
[列表与新建页面](../examples/note/notes-page.tsx)演示创建成功后重新读取服务端列表;[详情页面](../examples/note/note-detail-page.tsx)从 URL 读取 ID,直接加载服务端记录,修改和归档带上读取到的版本。它们是可编译的完整教学组件,样式由应用自行设计。
|
|
39
|
+
|
|
40
|
+
将组件放到 `apps/web/src/modules/note/pages`,从模块 index.ts 公开导出。再在已有 app 路由组合层导入模块入口,在登录后的 Outlet 内加入以下路由片段:
|
|
41
|
+
|
|
42
|
+
```tsx
|
|
43
|
+
<Route path="notes" element={<RequireCapability capability="Note.read" home="/workspace"><NotesPage /></RequireCapability>} />
|
|
44
|
+
<Route path="notes/:id" element={<RequireCapability capability="Note.read" home="/workspace"><NoteDetailPage /></RequireCapability>} />
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
片段中的 Route、RequireCapability 和两个页面要从当前应用真实入口导入;保留已有会话恢复、退出清理和 404。新增菜单使用 Link 指向 `/notes`。完整导航要求见[路由与浏览器验收](../guides/routing.md)。
|
|
48
|
+
|
|
49
|
+
创建按钮检查 `Note.create` 只是界面提示。提交后检查 `result.ok`,成功才清空输入并重新读取;失败展示错误并保留输入。详情请求可能返回范围外的 NOT_FOUND,不能显示“该记录已删除”这种未经证明的结论。编辑冲突后重新读取版本并让用户核对,不静默覆盖他人修改。
|
|
50
|
+
|
|
51
|
+
## 沿操作观察结果
|
|
52
|
+
|
|
53
|
+
| 操作 | 预期观察 | 若失败,优先检查 |
|
|
54
|
+
| --- | --- | --- |
|
|
55
|
+
| 有权用户创建便笺 | 真实请求成功,服务端返回 ID,独立 list/get 可读 | 契约调用、迁移、能力与归属字段 |
|
|
56
|
+
| 新标签页打开详情 URL | 重新请求后显示同一条记录 | URL ID、会话恢复、读取范围 |
|
|
57
|
+
| 另一位有同部门范围的用户查看 | 服务端读取同一条记录 | 实际部门、角色范围、接口结果 |
|
|
58
|
+
| 范围外主体直接请求详情 | 请求拒绝或安全地返回不可见 | 服务端范围,不能只看菜单是否隐藏 |
|
|
59
|
+
| 两个页面使用同一旧版本修改 | 后一次得到冲突,不覆盖新值 | expectedVersion 和页面刷新策略 |
|
|
60
|
+
| 归档后再次修改 | 业务状态拒绝;页面重新读取为 archived | from/to 与真实状态 |
|
|
61
|
+
|
|
62
|
+
运行受影响包的类型检查和构建、生成一致性与必要业务测试,再按浏览器配方操作。未配置测试账号、未连接独立测试库或没有浏览器能力时,写清未执行项;不要用编译通过替代本表结果。
|
|
63
|
+
|
|
64
|
+
## 从本课迁移到其他业务
|
|
65
|
+
|
|
66
|
+
先替换对象、字段、归属与动作,保留“声明 → 导出 → 生成 → 运行配置 → 契约 → 观察结果”的方法。只有需求需要时再增加能力:审批学习[审批单元](../guides/approvals.md),附件学习[文件单元](../guides/files.md),关联学习[关系单元](../guides/relations.md),跨对象联动参考[事务选择](architecture.md#同事务与异步的选择)。完整组合范例见[采购导读](../examples/purchase-example.md),无需一次复制全部采购实现。
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 开发步骤与交付要求
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [
|
|
3
|
+
[返回学习入口](../README.md) · [框架开发 Skill](../skills/cage-development/SKILL.md) · [完整入门课](first-feature.md) · [详细中文注释](../reference/commenting.md)
|
|
4
4
|
|
|
5
5
|
本页命令在**应用根目录**执行,除非注明“框架根目录”。使用项目安装的 CLI:`pnpm exec cage ...`。项目脚本可简写为 `pnpm gen / pnpm migrate / pnpm dev / pnpm verify`;不要假定机器已全局安装 cage。
|
|
6
6
|
|
|
@@ -25,7 +25,7 @@ pnpm dev
|
|
|
25
25
|
|
|
26
26
|
`init` 自动创建独立账号与随机密码,填写 APP/READ/MIGRATE 连接和 Cookie 密钥,成功后删除文件中的管理员连接。三个连接使用同一数据库。已有 Cage 集群账号时复用原连接,不能重置其他应用的账号密码。生产环境可由平台直接提供账号连接,不必执行本地 init。
|
|
27
27
|
|
|
28
|
-
`bootstrap` 独立初始化组织,不自动授予业务能力。管理员凭据只进入新的受限文件,不进入服务控制台;已有用户时不重置。交付后移除凭据文件。日常 API 启动不初始化组织;生产缺少合格 Cookie 密钥会拒绝启动。具体文件权限与诊断用法见[能力发现与状态诊断](diagnostics.md)。
|
|
28
|
+
`bootstrap` 独立初始化组织,不自动授予业务能力。管理员凭据只进入新的受限文件,不进入服务控制台;已有用户时不重置。交付后移除凭据文件。日常 API 启动不初始化组织;生产缺少合格 Cookie 密钥会拒绝启动。具体文件权限与诊断用法见[能力发现与状态诊断](../tools/diagnostics.md)。
|
|
29
29
|
|
|
30
30
|
`.env.example` 是配置说明,`.env` 是本机私密配置,二者不混用。CLI 自动加载应用 `.env`,部署环境同名变量优先。API 和 worker 启动需重启后读取变更;不要输出整个 `.env` 排障。
|
|
31
31
|
|
|
@@ -33,12 +33,12 @@ pnpm dev
|
|
|
33
33
|
|
|
34
34
|
## 做一项业务修改
|
|
35
35
|
|
|
36
|
-
1. 读 AGENTS.md
|
|
36
|
+
1. 读 AGENTS.md 和[框架开发 Skill](../skills/cage-development/SKILL.md),确认需求属于领域模块、前端模块、组织配置还是框架。阅读需求和文档后,按[业务澄清与共同设计](../guides/business-collaboration.md)主动提出疑问、选项和建议,与用户确定相关规则及验收;已明确部分继续推进。按任务选手册,必要时本地搜索术语;用 `capabilities` 核对公开 API、`context "需求关键词"` 定位当前业务。按需 `graph search/inspect/path`,阅读对应源码、范例与测试;证据边界见[本体上下文指南](../tools/ontology-context.md)。遵守[目录规范](../reference/project-structure.md)和[详细中文注释规范](../reference/commenting.md),发现能力缺口先说明,不编造 API。
|
|
37
37
|
2. 涉及已存在业务含义变化时,**修改前**运行 `pnpm exec cage snapshot save before-change` 保存命名基线;也可使用真实 Git 提交或独立本体图文件。
|
|
38
38
|
3. 在所属领域模块写字段、状态、不变量和命令输入;再实现 handler、事件、查询与审批。跨模块反应放 workflows,第三方协议放 integrations。从模块 index 到 domain 总入口逐层导出,避免跨文件 export 名冲突。同步编写详细中文注释:文件职责与调用链、导出声明及输入字段、权限/状态/reads/事件/事务、关键步骤和失败边界;涉及已有行为时补齐受影响的上下游说明。
|
|
39
39
|
4. `pnpm exec cage check` 检查声明和图规则;`pnpm gen` 更新契约与迁移草稿。聚合和命令填写中文 `description`,需要覆盖时补 `cage.config.json` 的 `graph.labels`(如 `aggregate:Note`、`command:Note.archive`、`capability:Note.export`)。这些名称同时用于图谱和 `/admin` 授权界面;修改后重启 API。不重命名实际能力点来实现翻译。在图谱确认连接与资源生命周期。
|
|
40
40
|
5. 审查数据库变更,特别是非空字段、数据回填、删列和索引。已执行的迁移不可改写。需要落库时显式 `pnpm migrate`。
|
|
41
|
-
6. 页面和表单放 `apps/web/src/modules/<业务>`,从模块公开入口接入 app 的 URL 路由;依赖生成 contracts,处理失败结果。列表、详情等多页面使用 React Router,筛选和分页进入 URL;组件状态只管理页面内临时交互。新增能力由管理员授权,页面按钮可用 `useCan` 控制。按[路由与浏览器验收](routing.md)检查直达、刷新、前进后退和登录回跳。
|
|
41
|
+
6. 页面和表单放 `apps/web/src/modules/<业务>`,从模块公开入口接入 app 的 URL 路由;依赖生成 contracts,处理失败结果。列表、详情等多页面使用 React Router,筛选和分页进入 URL;组件状态只管理页面内临时交互。新增能力由管理员授权,页面按钮可用 `useCan` 控制。按[路由与浏览器验收](../guides/routing.md)检查直达、刷新、前进后退和登录回跳。
|
|
42
42
|
7. 补足重要业务反例并运行相关验证;测试解释夹具目的、所保护的规则和覆盖边界。按注释规范审查本次 diff,核对页面、组件/hooks、类型字段、脚本副作用和恢复流程的说明是否完整准确。提交源声明、契约和审查过的迁移,报告跳过及未执行项。
|
|
43
43
|
|
|
44
44
|
### 如何保存和比较基线
|
|
@@ -98,7 +98,7 @@ if (!result.ok) {
|
|
|
98
98
|
- `atomic: true` 请求整批原子处理,普通逐行导入需展示成功/失败计数及报告。HTTP 202 仅代表接受任务,不能立即提示处理完成。
|
|
99
99
|
- worker 必须运行;任务可能 queued/retrying/failed/expired。下载会再次校验当前权限。导出的系统列和掩码值不能原样回导。
|
|
100
100
|
|
|
101
|
-
CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入导出](transfers.md)。给新业务做入口时按实际生成的签名调用,不硬编码采购单专属逻辑进框架。
|
|
101
|
+
CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入导出](../guides/transfers.md)。给新业务做入口时按实际生成的签名调用,不硬编码采购单专属逻辑进框架。
|
|
102
102
|
|
|
103
103
|
## 工具做什么,结果在哪里
|
|
104
104
|
|
|
@@ -106,12 +106,12 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
|
|
|
106
106
|
| --- | --- | --- |
|
|
107
107
|
| `pnpm exec cage analyze` | 抽取显式声明与源码位置 | `.cage/ontology.json` |
|
|
108
108
|
| `pnpm exec cage capabilities 关键词 --format json` | 查询当前安装版本的公开能力 | 公开签名、声明位置和学习入口 |
|
|
109
|
-
| `pnpm exec cage doctor` | 统一核对注册、生成、构建及可用运行证据 | pass / fail / unknown 与下一步;见[诊断指南](diagnostics.md) |
|
|
109
|
+
| `pnpm exec cage doctor` | 统一核对注册、生成、构建及可用运行证据 | pass / fail / unknown 与下一步;见[诊断指南](../tools/diagnostics.md) |
|
|
110
110
|
| `pnpm exec cage snapshot save 名称` | 保存不可覆盖的命名基线 | `.cage/snapshots`;配合 `impact --snapshot 名称` |
|
|
111
111
|
| `pnpm exec cage check` | 静态检查、注册表与图规则 | 终端 `code/at/reason/fix` |
|
|
112
112
|
| `pnpm exec cage graph` | 启动中文本体图谱 | 默认 `http://127.0.0.1:15418`,按终端地址访问 |
|
|
113
113
|
| `pnpm exec cage context "需求或节点"` | 开发前取得相关子图、原因、源码与候选验证 | 默认终端 Markdown;`--format json --out .cage/context.json` 保存结构化报告 |
|
|
114
|
-
| `pnpm exec cage graph search/inspect/path ...` | 检索候选 / 精确节点 / 关系路径 | 同源中文与证据;每次重新抽取,见[用法](ontology-context.md) |
|
|
114
|
+
| `pnpm exec cage graph search/inspect/path ...` | 检索候选 / 精确节点 / 关系路径 | 同源中文与证据;每次重新抽取,见[用法](../tools/ontology-context.md) |
|
|
115
115
|
| `pnpm gen` | 更新契约、结构说明、迁移草稿 | `packages/contracts/src`、`db/migrations`、`generated`、`.cage/ontology.json` |
|
|
116
116
|
| `pnpm exec cage gen --check` | 只比较需提交的生成物 | 不一致时报 CAGE-GEN;不是实际数据库漂移扫描 |
|
|
117
117
|
| `pnpm exec cage test --only project` | 项目测试 | `.cage/test-results.json` 与终端 |
|
|
@@ -127,10 +127,10 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
|
|
|
127
127
|
## 验证要与改动匹配
|
|
128
128
|
|
|
129
129
|
- 文档、文案、可逆的小改动:检查链接、格式、资料分发;不需要重复运行全套数据库测试。
|
|
130
|
-
- 所有源码变更:按[注释交付清单](commenting.md#交付前逐项核对)人工核对中文职责、接口与关键流程说明;静态检查不能替代注释准确性检查。仅补注释时不新增复述实现的测试、不改写已执行迁移。
|
|
130
|
+
- 所有源码变更:按[注释交付清单](../reference/commenting.md#交付前逐项核对)人工核对中文职责、接口与关键流程说明;静态检查不能替代注释准确性检查。仅补注释时不新增复述实现的测试、不改写已执行迁移。
|
|
131
131
|
- 命令/约束/反应变化:针对成功路径及真正的风险增加用例,如越权拒绝、额度边界、资源释放、同事务回滚。不要写只复述实现的测试。
|
|
132
132
|
- 领域结构变化:check、gen、生成一致性、类型检查;有数据库影响时在独立测试库验证迁移和读写。
|
|
133
|
-
- 页面或导航变化:构建后按[浏览器配方](routing.md)实际操作,包含深链接、新标签页、刷新、前进后退、登录回跳、无权限和 404。check/verify 不自动执行浏览器验收;未操作时明确报告未执行,不能写“页面功能完整”。
|
|
133
|
+
- 页面或导航变化:构建后按[浏览器配方](../guides/routing.md)实际操作,包含深链接、新标签页、刷新、前进后退、登录回跳、无权限和 404。check/verify 不自动执行浏览器验收;未操作时明确报告未执行,不能写“页面功能完整”。
|
|
134
134
|
- 发布前:按项目要求执行完整 verify/build/test,核对分发包。没有执行的项目明确写出原因。
|
|
135
135
|
|
|
136
136
|
测试使用真实 PostgreSQL。`CAGE_TEST_DATABASE_URL` 供独立测试集群使用,测试工具会准备角色和临时数据库;不要指向业务/生产集群。没有设置时 testkit 可使用内嵌的真实 PostgreSQL,这与 dev 的固定已有库流程不同。
|
|
@@ -140,12 +140,13 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
|
|
|
140
140
|
## 可以交给 AI 的任务描述
|
|
141
141
|
|
|
142
142
|
```text
|
|
143
|
-
先读 AGENTS.md 和它指定的 docs/
|
|
143
|
+
先读 AGENTS.md 和它指定的 docs/development/README.md,再参考对应标准范例。
|
|
144
144
|
需求:为某业务增加……
|
|
145
|
+
阅读需求、业务文档和现有代码,主动指出疑点与建议,给出可行选项、影响和推荐理由,让我选择业务规则;已给出的答案直接沿用,技术事实自行查证。
|
|
145
146
|
先用 cage context 查询现有业务,必要时 graph inspect/path,确认候选与关系后阅读实现。
|
|
146
|
-
|
|
147
|
+
把已确定的规则映射到字段、状态、能力与范围、事件/资源和验收,再修改 domain、生成契约和迁移草稿、接入业务页面;等待业务选择时推进独立部分。
|
|
147
148
|
使用真实公开 API;不要手写业务路由、直接写表或新增本地数据库生命周期命令。
|
|
148
|
-
按 docs/
|
|
149
|
+
按 docs/development/reference/commenting.md 给新建和修改代码写详细中文注释,覆盖职责、API/字段、步骤、原因和边界,同步修正相关上下游说明。
|
|
149
150
|
按改动运行必要检查,报告通过/跳过/未执行项和需要的管理员配置。
|
|
150
151
|
```
|
|
151
152
|
|