Skip to content

Commit cebef55

Browse files
claude[bot]claude
andauthored
docs(console): README describes the real Console resolution, not a removed npm fallback (#11262) (#11281)
`packages/console/README.md` claimed `resolveConsolePath()` "prefers `@objectstack/console` and falls back to `@object-ui/console` when present — so cloud's Docker overlay (which `cp -r`s its build over `node_modules/@object-ui/console`) keeps working." Both halves are false against `packages/cli/src/utils/console.ts`. Strategies 1 and 2 (`require.resolve('@objectstack/console/package.json')` from the app and from the CLI itself; direct `<cwd>/node_modules/@objectstack/console`) each require the resolved `package.json` to be named `@objectstack/console`, so the legacy npm package is never consulted. `@object-ui/console` survives only in strategy 3, the sibling-repo dev fallback, which matches the `name` field of a checked-out `../objectui/apps/console` source tree — a source-checkout probe, not a package resolution. The corrected text keeps the two apart. The trailing consequence was the load-bearing half: cloud and objectos Docker images overlay into `@objectstack/console`'s `dist/`, so the README told an operator their overlay works by a mechanism that no longer exists. Docs only. The removal of the npm-package fallback was deliberate and is not restored here; `packages/cli/src/utils/console.ts` is unchanged. Claude-Session: https://claude.ai/code/session_019siH5jDmk5hrayvfyojUqR Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5e3caa1 commit cebef55

2 files changed

Lines changed: 48 additions & 4 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
"@objectstack/console": patch
3+
---
4+
5+
Correct the published `@objectstack/console` README's account of how the CLI
6+
resolves the Console SPA (#11262). `README.md` is in this package's `files`
7+
array, so it is the page npm renders.
8+
9+
The README claimed `resolveConsolePath()` "prefers `@objectstack/console` and
10+
falls back to `@object-ui/console` when present — so cloud's Docker overlay
11+
(which `cp -r`s its build over `node_modules/@object-ui/console`) keeps
12+
working." Both halves are false against
13+
`packages/cli/src/utils/console.ts`:
14+
15+
- There is no `node_modules` fallback to the `@object-ui/console` npm
16+
package. Strategy 1 (`require.resolve('@objectstack/console/package.json')`
17+
from the app and from the CLI itself) and strategy 2 (direct
18+
`<cwd>/node_modules/@objectstack/console`) each require the resolved
19+
`package.json` to be named `@objectstack/console`. The legacy package is
20+
never consulted; the function's own header says so.
21+
- `@object-ui/console` survives in exactly one branch — strategy 3, the
22+
sibling-repo dev fallback, which matches the `name` field of a checked-out
23+
`../objectui/apps/console` **source** tree. That is a source-checkout
24+
probe, not a package resolution, and the corrected text keeps the two
25+
apart.
26+
- The trailing consequence was the load-bearing half: cloud and objectos
27+
Docker images overlay into `@objectstack/console`'s `dist/`, so the README
28+
was telling an operator their overlay works by a mechanism that no longer
29+
exists. Replaced with the real overlay target.
30+
31+
Documentation only — no runtime, type or export change. The removal of the
32+
npm-package fallback was deliberate and is not restored here.

packages/console/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,22 @@ in sync.
2929
| Use | Cloud overlays, advanced users, anyone consuming Console directly | What every `@objectstack/cli` install gets by default |
3030

3131
The framework CLI's `resolveConsolePath()` (in
32-
`packages/cli/src/utils/console.ts`) prefers `@objectstack/console` and
33-
falls back to `@object-ui/console` when present — so cloud's Docker
34-
overlay (which `cp -r`s its build over `node_modules/@object-ui/console`)
35-
keeps working.
32+
`packages/cli/src/utils/console.ts`) resolves `@objectstack/console` and
33+
nothing else — `require.resolve('@objectstack/console/package.json')` from
34+
the app and from the CLI itself, then a direct
35+
`<cwd>/node_modules/@objectstack/console` check. Both require the resolved
36+
`package.json` to be *named* `@objectstack/console`, so there is **no**
37+
`node_modules` fallback to the `@object-ui/console` npm package; it is
38+
never consulted.
39+
40+
`@object-ui/console` survives in the CLI in exactly one place: the
41+
sibling-repo dev fallback, which accepts a checked-out **source** tree at
42+
`../objectui/apps/console` whose `package.json` `name` is either spelling
43+
(objectui still names that workspace package `@object-ui/console`). That is
44+
a source-checkout probe for developing the framework against in-tree
45+
objectui edits — not a package resolution. Cloud and objectos Docker images
46+
overlay their own Console build into `@objectstack/console`'s `dist/` — not
47+
into any `@object-ui/console` directory.
3648

3749
## Updating
3850

0 commit comments

Comments
 (0)