Skip to content

fix: correct capability presentation examples #846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rossiam merged 1 commit into from
Aug 31, 2026
Merged

fix: correct capability presentation examples #846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cute-hornets-sleep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@smartthings/cli": patch
---

Correct the capability presentation help examples to use the registered command name.
21 changes: 20 additions & 1 deletion src/__tests__/commands/capabilities/presentation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,26 @@ test('builder', () => {
expect(capabilityIdOrIndexBuilderMock).toHaveBeenCalledExactlyOnceWith(apiOrganizationCommandBuilderArgvMock)
expect(formatAndWriteItemBuilderMock).toHaveBeenCalledExactlyOnceWith(capabilityIdOrIndexBuilderArgvMock)

expect(exampleMock).toHaveBeenCalledTimes(1)
expect(exampleMock).toHaveBeenCalledExactlyOnceWith([
[
'$0 capabilities:presentation',
'prompt for a capability and display its presentation information',
],
[
'$0 capabilities:presentation --namespace cathappy12345',
'prompt for a capability from the specified namespace and display its' +
' presentation information',
],
[
'$0 capabilities:presentation cathappy12345.myCapability',
'display details for a capability by id',
],
[
'$0 capabilities:presentation 1',
'display presentation information for the first capability in the list retrieved' +
' by running "smartthings capabilities"',
],
])
expect(optionMock).toHaveBeenCalledTimes(1)
expect(buildEpilogMock).toHaveBeenCalledTimes(1)
expect(epilogMock).toHaveBeenCalledTimes(1)
Expand Down
8 changes: 4 additions & 4 deletions src/commands/capabilities/presentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,20 @@ export const builder = (yargs: Argv): Argv<CommandArgs> =>
})
.example([
[
'$0 capabilities:presentations',
'$0 capabilities:presentation',
'prompt for a capability and display its presentation information',
],
[
'$0 capabilities:presentations --namespace cathappy12345',
'$0 capabilities:presentation --namespace cathappy12345',
'prompt for a capability from the specified namespace and display its' +
' presentation information',
],
[
'$0 capabilities:presentations cathappy12345.myCapability',
'$0 capabilities:presentation cathappy12345.myCapability',
'display details for a capability by id',
],
[
'$0 capabilities:presentations 1',
'$0 capabilities:presentation 1',
'display presentation information for the first capability in the list retrieved' +
' by running "smartthings capabilities"',
],
Expand Down