fix: warn user when choosen profile is not defined in config

Author: rossiam

.changeset/brave-links-mend.md

@@ -0,0 +1,5 @@
+---
+"@smartthings/cli": patch
+---
+
+Fix broken configuration documentation links in config and logging error messages.

.changeset/quiet-owls-warn.md

@@ -0,0 +1,5 @@
+---
+"@smartthings/cli": patch
+---
+
+Warn when the selected non-default profile is not defined in configuration.

doc/configuration.md

@@ -21,6 +21,13 @@ specified. Most users can simply put their configuration options here.
 environment variable or use the `--profile` (shortcut `-p`) command line
 argument. (When both are used, the command line argument overrides the
 environment variable.)
+* The CLI warns when the selected profile (other than "default") is not defined in
+`config.yaml`. To use a profile without any configuration options, such as one used only to
+log in with a different account, define it with an empty value:
+
+  ```yaml
+  work: {}
+  ```
 
 The [YAML Primer](https://github.com/darvid/trine/wiki/YAML-Primer) is a good source of information
 on YAML. Note, however, some features (like merge keys) have been removed in 1.2. The YAML parser

src/__tests__/lib/command/smartthings-command.test.ts

@@ -5,6 +5,7 @@ import type { Paths } from 'env-paths'
 import type log4js from 'log4js'
 
 import type { CLIConfig, loadConfig } from '../../../lib/cli-config.js'
+import type { yellow } from '../../../lib/colors.js'
 import type { ensureDir } from '../../../lib/file-util.js'
 import type { buildDefaultLog4jsConfig, loadLog4jsConfig } from '../../../lib/log-utils.js'
 import type { SmartThingsCommandFlags } from '../../../lib/command/smartthings-command.js'
@@ -30,6 +31,11 @@ jest.unstable_mockModule('../../../lib/cli-config.js', () => ({
 	loadConfig: loadConfigMock,
 }))
 
+const yellowMock = jest.fn<typeof yellow>()
+jest.unstable_mockModule('../../../lib/colors.js', () => ({
+	yellow: yellowMock,
+}))
+
 const ensureDirMock = jest.fn<typeof ensureDir>()
 jest.unstable_mockModule('../../../lib/file-util.js', () => ({
 	ensureDir: ensureDirMock,
@@ -58,6 +64,7 @@ jest.unstable_mockModule('../../../lib/yargs-transition-temp.js', () => ({
 }))
 
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { /* do nothing */ })
+const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { /* do nothing */ })
 
 
 const {
@@ -94,6 +101,7 @@ describe('smartThingsCommand', () => {
 		.mockReturnValue(true)
 	const cliConfig = {
 		profile: {},
+		mergedProfiles: {},
 		booleanConfigValue: booleanConfigValueMock,
 	} as unknown as CLIConfig
 	loadConfigMock.mockResolvedValue(cliConfig)
@@ -121,5 +129,31 @@ describe('smartThingsCommand', () => {
 		}, loggerMock)
 		expect(defaultTableGeneratorMock).toHaveBeenCalledTimes(1)
 		expect(defaultTableGeneratorMock).toHaveBeenCalledWith({ groupRows: true })
+		expect(consoleWarnSpy).not.toHaveBeenCalled()
+	})
+
+	it('warns when a non-default profile is missing', async () => {
+		yellowMock.mockReturnValueOnce('yellow warning')
+
+		await smartThingsCommand({ profile: 'other' })
+
+		expect(yellowMock).toHaveBeenCalledExactlyOnceWith(
+			'warning: profile other not found in configuration\n' +
+			'To use a profile with no configuration options, add "other: {}" to config.yaml.\n' +
+			'See https://github.com/SmartThingsCommunity/smartthings-cli/blob/main/doc/configuration.md#profiles' +
+			' for more information.',
+		)
+		expect(consoleWarnSpy).toHaveBeenCalledExactlyOnceWith('yellow warning')
+	})
+
+	it('does not warn when a non-default profile exists but is empty', async () => {
+		loadConfigMock.mockResolvedValueOnce({
+			...cliConfig,
+			mergedProfiles: { other: {} },
+		} as unknown as CLIConfig)
+
+		await smartThingsCommand({ profile: 'other' })
+
+		expect(consoleWarnSpy).not.toHaveBeenCalled()
 	})
 })

src/lib/cli-config.ts

@@ -8,7 +8,7 @@ import { fatalError } from './util.js'
 
 
 export const seeConfigDocs = 'see https://github.com/SmartThingsCommunity/smartthings-cli/blob/' +
-	'main/packages/cli/doc/configuration.md for more information'
+	'main/doc/configuration.md for more information'
 
 export type Profile = Record<string, unknown>
 export type ProfilesByName = Record<string, Profile>

src/lib/command/smartthings-command.ts

@@ -3,6 +3,7 @@ import log4js from 'log4js'
 import { type Argv } from 'yargs'
 
 import { type CLIConfig, loadConfig, type Profile } from '../cli-config.js'
+import { yellow } from '../colors.js'
 import { ensureDir } from '../file-util.js'
 import { buildDefaultLog4jsConfig, loadLog4jsConfig } from '../log-utils.js'
 import { defaultTableGenerator, type TableGenerator } from '../table-generator.js'
@@ -136,6 +137,9 @@ export const getConfigDirsCheckingForOldConfig = async (
 	return { configDir, dataDir, logDir }
 }
 
+const profileDocsURL =
+	'https://github.com/SmartThingsCommunity/smartthings-cli/blob/main/doc/configuration.md#profiles'
+
 /**
  * A function to be called at the start of every CLI command that sets up shared things.
  */
@@ -162,6 +166,11 @@ export const smartThingsCommand = async <T extends SmartThingsCommandFlags>(
 	}, logger)
 
 	const profile = cliConfig.profile
+	if (profileName !== 'default' && !(profileName in cliConfig.mergedProfiles)) {
+		console.warn(yellow(`warning: profile ${profileName} not found in configuration\n` +
+			`To use a profile with no configuration options, add "${profileName}: {}" to config.yaml.\n` +
+			`See ${profileDocsURL} for more information.`))
+	}
 
 	const groupRowsFlag = (flags as Pick<BuildOutputFormatterFlags, 'groupRows'>).groupRows
 	const groupRows = groupRowsFlag ?? cliConfig.booleanConfigValue('groupTableOutputRows', true)

src/lib/log-utils.ts

@@ -11,7 +11,7 @@ import { fatalError } from './util.js'
 
 const defaultLogFileSize = 1_000_000 // bytes
 const loggingDocsURL = 'https://github.com/SmartThingsCommunity/smartthings-cli/' +
-	'blob/main/packages/cli/doc/configuration.md#logging'
+	'blob/main/doc/configuration.md#logging'
 
 
 export function buildDefaultLog4jsConfig(logFilename: string): Log4jsConfig {