docs(scaffolding): realtime generator reference
This commit is contained in:
@@ -98,9 +98,13 @@ Once a feature exists, augment it with cross-feature events or background jobs u
|
||||
pnpm turbo gen event publish # publisher contract
|
||||
pnpm turbo gen event consume # consumer handler + Payload event-task
|
||||
pnpm turbo gen job # background job + TaskConfig
|
||||
pnpm turbo gen realtime channel # realtime channel descriptor (ADR-016)
|
||||
pnpm turbo gen realtime handler # inbound realtime handler (ADR-016)
|
||||
```
|
||||
|
||||
The generators insert at six fixed `// <gen:*>` anchor comments. Generated features include four of them automatically (the `// <gen:job-tasks>` location is in `integrations/cms/index.ts`, which is manually authored as part of Phase-2 wiring); pre-existing features were retrofitted in ADR-015.
|
||||
The event/job generators insert at six fixed `// <gen:*>` anchor comments. Generated features include four of them automatically (the `// <gen:job-tasks>` location is in `integrations/cms/index.ts`, which is manually authored as part of Phase-2 wiring); pre-existing features were retrofitted in ADR-015.
|
||||
|
||||
The realtime generators insert at three additional fixed `// <gen:realtime-*>` anchor comments (`// <gen:realtime-channels>` in `src/index.ts`, `// <gen:realtime-handler-symbols>` in `src/di/symbols.ts`, `// <gen:realtime-handlers>` in both `bind-*.ts` files). Generated features include all three automatically; pre-existing features were retrofitted in ADR-016.
|
||||
|
||||
## Cross-links
|
||||
|
||||
@@ -112,3 +116,4 @@ The generators insert at six fixed `// <gen:*>` anchor comments. Generated featu
|
||||
- `docs/decisions/adr-013-input-output-unification.md` — schemas-in-use-case + presenter
|
||||
- `docs/decisions/adr-014-instrumentation-sentry.md` — span + capture wiring (R41–R44)
|
||||
- `docs/decisions/adr-015-events-and-jobs.md` — cross-feature events + background jobs
|
||||
- `docs/decisions/adr-016-realtime-layer.md` — Socket.IO realtime channels + handlers
|
||||
|
||||
Reference in New Issue
Block a user