rename spaces get-all to get to align with the rest of the cli#192
rename spaces get-all to get to align with the rest of the cli#192umair-ably merged 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR renames all Changes
Review Notes
|
Ably capabilities are operation-based, not clientId-based, so client identity is irrelevant for pure read queries. Removed clientIdFlag from spaces members/locations/cursors/locks get and rooms occupancy get. Updated docs and skills to clarify when --client-id should be used.
There was a problem hiding this comment.
Pull request overview
Renames Spaces CLI subcommands from get-all to get for consistency, and merges Spaces locks “get” + “get-all” into a single get command with optional LOCKID.
Changes:
- Renamed Spaces
cursors/locations/members get-alltogetacross command implementations, docs, and unit/E2E tests. - Merged
spaces locks get-allintospaces locks get SPACE_NAME [LOCKID], adding “get all locks” behavior whenLOCKIDis omitted. - Updated output formatting (lock block indentation) and adjusted flag guidance/usage (notably removing
client-idfrom read-only commands) and suppressed teardown SDK error logs.
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/commands/spaces/members/get.test.ts | Updates unit tests to use spaces:members:get instead of get-all. |
| test/unit/commands/spaces/locks/get.test.ts | Expands tests for merged locks get behavior (single vs all) and updates arg validation expectations. |
| test/unit/commands/spaces/locks/get-all.test.ts | Removes tests for deleted spaces:locks:get-all command. |
| test/unit/commands/spaces/locations/get.test.ts | Updates unit tests to use spaces:locations:get. |
| test/unit/commands/spaces/cursors/get.test.ts | Updates unit tests to use spaces:cursors:get and aligns error expectations. |
| test/e2e/spaces/spaces-e2e.test.ts | Updates E2E invocation from cursors get-all to cursors get. |
| src/utils/spaces-output.ts | Adds indentation support to formatLockBlock for list output formatting. |
| src/spaces-base-command.ts | Suppresses SDK error logs during teardown to avoid noisy/benign cleanup errors. |
| src/flags.ts | Clarifies when client-id is applicable; treats read-only queries as not needing it. |
| src/commands/spaces/members/index.ts | Updates example from get-all to get. |
| src/commands/spaces/members/get.ts | Renames implementation to SpacesMembersGet and updates telemetry/error keys. |
| src/commands/spaces/members.ts | Updates example from get-all to get. |
| src/commands/spaces/locks/index.ts | Updates example from get-all to get (no LOCKID). |
| src/commands/spaces/locks/get.ts | Merges “get single” + “get all”, makes LOCKID optional, updates formatting and initialization behavior. |
| src/commands/spaces/locks/get-all.ts | Removes command implementation for spaces locks get-all. |
| src/commands/spaces/locks.ts | Updates example from get-all to get. |
| src/commands/spaces/locations/index.ts | Updates example from get-all to get. |
| src/commands/spaces/locations/get.ts | Adds new spaces locations get command implementation (replacing get-all). |
| src/commands/spaces/locations/get-all.ts | Removes command implementation for spaces locations get-all. |
| src/commands/spaces/locations.ts | Updates example from get-all to get. |
| src/commands/spaces/cursors/index.ts | Updates example from get-all to get. |
| src/commands/spaces/cursors/get.ts | Renames implementation to SpacesCursorsGet and updates telemetry/error keys. |
| src/commands/spaces/cursors.ts | Updates example from get-all to get. |
| src/commands/rooms/occupancy/get.ts | Removes client-id flag from read-only occupancy get. |
| src/base-command.ts | Adds log-handler suppression toggle for SDK error logs during teardown. |
| README.md | Regenerates CLI docs to reflect renamed commands and updated flags/usage. |
| .claude/skills/ably-review/SKILL.md | Updates internal review guidance around clientIdFlag usage for reads vs writes. |
| .claude/skills/ably-new-command/references/patterns.md | Updates internal patterns guidance for “Get” commands and clientIdFlag. |
| .claude/skills/ably-new-command/SKILL.md | Updates internal guidance for when to include clientIdFlag. |
| .claude/skills/ably-codebase-review/SKILL.md | Updates internal review guidance for clientIdFlag usage. |
Comments suppressed due to low confidence (2)
src/commands/spaces/cursors/get.ts:37
- The old
spaces:cursors:get-allcommand appears to be removed/renamed without providing an oclif alias. This is a breaking CLI change for existing scripts; consider addingstatic override aliases = ["spaces:cursors:get-all"](and potentially a deprecation warning) soget-allcontinues to work while users migrate toget.
src/commands/spaces/members/get.ts:37 - The old
spaces:members:get-allcommand appears to be removed/renamed without providing an oclif alias. This is a breaking CLI change for existing scripts; consider addingstatic override aliases = ["spaces:members:get-all"](and optionally a deprecation warning) soget-allcontinues to work while users migrate toget.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sacOO7
left a comment
There was a problem hiding this comment.
LGTM
PS. copilot comments doesn't seem important as such, but you can check
This PR renames all spaces * get-all subcommands to spaces * get for consistency with the rest of the CLI. For spaces locks, the two separate commands (get and get-all) are merged into a single get command where LOCKID is now optional — omitting it returns all locks, providing it returns a single lock.