From f566a4ae32c52e907158fb0fb573efa47fe1520d Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 21 Aug 2026 18:05:34 +0000 Subject: [PATCH] docs(cli): drop phantom os codemod v2-to-v3 and stale projects/ tree node Fixes #10881 Remove the "Code Transforms" table row and the codemod/v2-to-v3.ts source-tree node, neither of which has ever been registered (probed against the built binary: exit 2 "command codemod:v2-to-v3 not found"). Rename the projects/ tree node to environments/, matching the v5.0 project -> environment rename (ADR-0006). Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_019bmVFqoQPq63zhKrxdYG1r --- .changeset/cli-readme-drop-phantom-codemod.md | 30 +++++++++++++++++++ packages/cli/README.md | 10 +------ 2 files changed, 31 insertions(+), 9 deletions(-) create mode 100644 .changeset/cli-readme-drop-phantom-codemod.md diff --git a/.changeset/cli-readme-drop-phantom-codemod.md b/.changeset/cli-readme-drop-phantom-codemod.md new file mode 100644 index 0000000000..33f8567609 --- /dev/null +++ b/.changeset/cli-readme-drop-phantom-codemod.md @@ -0,0 +1,30 @@ +--- +"@objectstack/cli": patch +--- + +docs(cli): drop the phantom `os codemod v2-to-v3` claim and stale `projects/` tree node (#10881) + +`packages/cli/README.md` is this package's published README, and it carried two +false claims about what the CLI can do. + +Its "Code Transforms" section tabled `os codemod v2-to-v3` in the exact same +format as the ~60 real commands above it, and the Architecture source-tree +listing showed a matching `src/commands/codemod/v2-to-v3.ts`. Neither the +command nor the file has ever existed: `packages/cli/src/commands/` has no +`codemod/` directory, and oclif (which resolves commands by globbing +`dist/commands/**/*.js`) returns `command codemod:v2-to-v3 not found` (exit 2). +Removed rather than marked "not yet available", because a reader-facing +row/node with that exact name and shape would still misdescribe the one +concrete plan for this space: #9591 (`os migrate meta --write`, on hold, +targeting v18) is a differently-scoped, differently-named command over the +mechanical retired-key set, not a "v2 config to v3 format" transform — so there +is no accurate future command to point the row at. The "not yet available" +information already lives in `content/docs/protocol/backward-compatibility.mdx` +and `docs/DX_ROADMAP.md`; this brings the package README in line with the tool +itself, which lost the same false prescription in #10882. + +The same source-tree listing also showed a `projects/` node under +`src/commands/` with `list/show/create/switch/bind` — stale since the v5.0 +`project` → `environment` rename (ADR-0006, no aliases). Renamed to +`environments/`, matching the real directory; the subcommand file list was +already accurate and is unchanged. diff --git a/packages/cli/README.md b/packages/cli/README.md index 11f3c9f89e..a5225633fd 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -112,12 +112,6 @@ Runtime plugins (declared in `objectstack.config.ts` `plugins`) are loaded autom |---------|-------------| | `os explain [schema]` | Display human-readable explanation of an ObjectStack schema | -### Code Transforms - -| Command | Description | -|---------|-------------| -| `os codemod v2-to-v3` | Migrate ObjectStack v2 config to v3 format | - ## Configuration The CLI looks for `objectstack.config.ts` (or `.js`, `.mjs`) in the current directory: @@ -296,14 +290,12 @@ os projects bind --artifact dist/objectstack.json # 8. Bind to a Cloud Pro │ ├── compile.ts # os compile │ ├── validate.ts # os validate │ ├── generate.ts # os generate (alias: g) -│ ├── projects/ # os projects +│ ├── environments/ # os environments │ │ ├── list.ts │ │ ├── show.ts │ │ ├── create.ts │ │ ├── switch.ts │ │ └── bind.ts -│ ├── codemod/ # os codemod -│ │ └── v2-to-v3.ts │ └── ... ├── src/utils/ # Shared utilities └── package.json # oclif config under "oclif" key