docs: scaffolding guide for connectum init / generate service#64
Open
intech wants to merge 3 commits into
Open
docs: scaffolding guide for connectum init / generate service#64intech wants to merge 3 commits into
connectum init / generate service#64intech wants to merge 3 commits into
Conversation
- new guide page en/guide/scaffolding.md (init flow, options table, interceptor order, generate service, the add-a-service recipe) + sidebar entry after Quickstart - cli-commands.md: point to the scaffolding guide for the published @connectum/cli tool - runtime-compatibility.md: note the Bun caveats are narrow (client transport) and that scaffolding emits Bun-appropriate defaults; restate the Node floor (raw .ts >=25.2 vs tsx/compiled >=22.13) Companion docs for the connectum cli-scaffolding change (Phase 4, tasks 4.1-4.3). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SdapMMJeamn5TDrY8yzHRQ
Rebased onto main after the runtime-switcher PR landed, and corrected content that it made stale: - `runtime-compatibility.md`: my earlier tip claimed the Bun limitations were "narrow — the HTTP/2 client transport". That is no longer true: main now documents that Bun >= 1.2.6 needs no special client code. The tip now only states what still holds — `init --runtime bun` emits Bun-appropriate defaults — and adds the newly documented guidance that the CLI is exercised on Node.js, so it should be run with `npx` even in a Bun project. - `scaffolding.md`: same `npx` note in Requirements, plus the generated `start`/`test` scripts are now shown through the `::: runtime` switcher (Node | Bun) instead of prose, and it is stated that the generated e2e test is runtime-agnostic (in-process `createLocalClient`, no socket). `vitepress build` passes; the built page contains both switcher branches. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SdapMMJeamn5TDrY8yzHRQ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new scaffolding commands shipped in
@connectum/cli(companion to the framework PR that addsconnectum initandconnectum generate service).Changes
en/guide/scaffolding.md— "Scaffolding a New Service":connectum initflow (interactive wizard and non-interactive flags) with a full options tableconnectum generate service, including why it prints the registration line instead of editing yoursrc/server.tsbuf generate→defineService→ register)en/contributing/cli-commands.md— a tip clarifying that this page covers monorepo development scripts, and pointing to the scaffolding guide for the published CLI toolen/guide/runtime-compatibility.md— a tip noting the Bun limitations are narrow (they affect the HTTP/2 client transport, not the server) and that a scaffolded Bun project already gets Bun-appropriate defaults; restates the Node floor (raw.ts>= 25.2 vstsx/compiled >= 22.13)🤖 Generated with Claude Code
https://claude.ai/code/session_01SdapMMJeamn5TDrY8yzHRQ