diff --git a/.changeset/cute-hornets-sleep.md b/.changeset/cute-hornets-sleep.md new file mode 100644 index 00000000..aad67081 --- /dev/null +++ b/.changeset/cute-hornets-sleep.md @@ -0,0 +1,5 @@ +--- +"@smartthings/cli": patch +--- + +Correct the capability presentation help examples to use the registered command name. diff --git a/src/__tests__/commands/capabilities/presentation.test.ts b/src/__tests__/commands/capabilities/presentation.test.ts index 20ef1eea..aa8e57e3 100644 --- a/src/__tests__/commands/capabilities/presentation.test.ts +++ b/src/__tests__/commands/capabilities/presentation.test.ts @@ -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) diff --git a/src/commands/capabilities/presentation.ts b/src/commands/capabilities/presentation.ts index ccd60b17..abe40836 100644 --- a/src/commands/capabilities/presentation.ts +++ b/src/commands/capabilities/presentation.ts @@ -40,20 +40,20 @@ export const builder = (yargs: Argv): Argv => }) .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"', ],