Prefer output* functions over console* functions

Author: gordonhirsch

packages/app/src/cli/services/logs.test.ts

@@ -11,7 +11,7 @@ import {
   testOrganizationStore,
 } from '../models/app/app.test-data.js'
 import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js'
-import {consoleLog, consoleWarn} from '@shopify/cli-kit/node/output'
+import {outputInfo, outputResult} from '@shopify/cli-kit/node/output'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {describe, test, vi, expect, beforeEach} from 'vitest'
 import {renderInfo} from '@shopify/cli-kit/node/ui'
@@ -54,7 +54,7 @@ describe('logs', () => {
     })
 
     // Then
-    expect(consoleWarn).toHaveBeenCalledWith('{"message":"Waiting for app logs..."}')
+    expect(outputInfo).toHaveBeenCalledWith('{"message":"Waiting for app logs..."}')
     expect(spy).toHaveBeenCalled()
   })
 
@@ -78,7 +78,7 @@ describe('logs', () => {
     })
 
     // Then
-    expect(consoleWarn).toHaveBeenCalledWith('Waiting for app logs...\n')
+    expect(outputInfo).toHaveBeenCalledWith('Waiting for app logs...\n')
     expect(spy).toHaveBeenCalled()
   })
 
@@ -156,8 +156,8 @@ describe('logs', () => {
     const expectedStoreMap = new Map()
     expectedStoreMap.set('1', 'store-fqdn')
     expectedStoreMap.set('2', 'other-fqdn')
-    expect(consoleLog).toHaveBeenCalledWith('{"subscribedToStores":["store-fqdn","other-fqdn"]}')
-    expect(consoleWarn).toHaveBeenCalledWith('{"message":"Waiting for app logs..."}')
+    expect(outputResult).toHaveBeenCalledWith('{"subscribedToStores":["store-fqdn","other-fqdn"]}')
+    expect(outputInfo).toHaveBeenCalledWith('{"message":"Waiting for app logs..."}')
     expect(spy).toHaveBeenCalledWith({
       options: {
         developerPlatformClient: expect.anything(),
@@ -193,7 +193,7 @@ describe('logs', () => {
     const expectedStoreMap = new Map()
     expectedStoreMap.set('1', 'store-fqdn')
     expectedStoreMap.set('2', 'other-fqdn')
-    expect(consoleWarn).toHaveBeenCalledWith('Waiting for app logs...\n')
+    expect(outputInfo).toHaveBeenCalledWith('Waiting for app logs...\n')
     expect(spy).toHaveBeenCalledWith({
       options: {
         developerPlatformClient: expect.anything(),

packages/app/src/cli/services/logs.ts

@@ -8,7 +8,7 @@ import {getAppConfigurationFileName} from '../models/app/loader.js'
 import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {Organization, OrganizationApp, OrganizationStore} from '../models/organization.js'
 import {AbortError} from '@shopify/cli-kit/node/error'
-import {consoleLog, consoleWarn} from '@shopify/cli-kit/node/output'
+import {outputInfo, outputResult} from '@shopify/cli-kit/node/output'
 import {renderInfo} from '@shopify/cli-kit/node/ui'
 import {basename} from '@shopify/cli-kit/node/path'
 
@@ -66,8 +66,8 @@ export async function logs(commandOptions: LogsOptions) {
   }
 
   if (commandOptions.format === 'json') {
-    consoleLog(JSON.stringify({subscribedToStores: commandOptions.storeFqdns}))
-    consoleWarn(JSON.stringify({message: 'Waiting for app logs...'}))
+    outputResult(JSON.stringify({subscribedToStores: commandOptions.storeFqdns}))
+    outputInfo(JSON.stringify({message: 'Waiting for app logs...'}))
     await renderJsonLogs({
       options: {
         variables,
@@ -77,7 +77,7 @@ export async function logs(commandOptions: LogsOptions) {
       storeNameById: logsConfig.storeNameById,
     })
   } else {
-    consoleWarn('Waiting for app logs...\n')
+    outputInfo('Waiting for app logs...\n')
     await renderLogs({
       options: {
         variables,

packages/app/src/cli/services/webhook/trigger.test.ts

@@ -10,7 +10,7 @@ import {
   testOrganizationApp,
 } from '../../models/app/app.test-data.js'
 import {loadApp} from '../../models/app/loader.js'
-import {outputSuccess, consoleError} from '@shopify/cli-kit/node/output'
+import {outputSuccess, outputWarn} from '@shopify/cli-kit/node/output'
 import {describe, expect, vi, test, beforeEach} from 'vitest'
 
 const samplePayload = '{ "sampleField": "SampleValue" }'
@@ -83,7 +83,7 @@ describe('webhookTriggerService', () => {
 
     // Then
     expectCalls(aVersion, anOrganizationId)
-    expect(consoleError).toHaveBeenCalledWith(`Request errors:\n  · Some error\n  · Another error`)
+    expect(outputWarn).toHaveBeenCalledWith(`Request errors:\n  · Some error\n  · Another error`)
   })
 
   test('Safe notification in case of unexpected request errors', async () => {
@@ -106,7 +106,7 @@ describe('webhookTriggerService', () => {
 
     // Then
     expectCalls(aVersion, anOrganizationId)
-    expect(consoleError).toHaveBeenCalledWith(`Request errors:\n${JSON.stringify(response.userErrors)}`)
+    expect(outputWarn).toHaveBeenCalledWith(`Request errors:\n${JSON.stringify(response.userErrors)}`)
   })
 
   test('notifies about real delivery being sent', async () => {
@@ -240,7 +240,7 @@ describe('webhookTriggerService', () => {
         anOrganizationId,
       )
       expect(triggerLocalWebhook).toHaveBeenCalledWith(aFullLocalAddress, samplePayload, sampleHeaders)
-      expect(consoleError).toHaveBeenCalledWith('Localhost delivery failed')
+      expect(outputWarn).toHaveBeenCalledWith('Localhost delivery failed')
     })
   })
 

packages/app/src/cli/services/webhook/trigger.ts

@@ -5,7 +5,7 @@ import {collectAddressAndMethod, collectApiVersion, collectCredentials, collectT
 import {DeveloperPlatformClient} from '../../utilities/developer-platform-client.js'
 import {AppLinkedInterface} from '../../models/app/app.js'
 import {OrganizationApp} from '../../models/organization.js'
-import {consoleError, outputSuccess} from '@shopify/cli-kit/node/output'
+import {outputWarn, outputSuccess} from '@shopify/cli-kit/node/output'
 
 export interface WebhookTriggerInput {
   app: AppLinkedInterface
@@ -76,7 +76,7 @@ async function sendSample(options: WebhookTriggerOptions) {
   const sample = await getWebhookSample(options.developerPlatformClient, variables, options.organizationId)
 
   if (!sample.success) {
-    consoleError(`Request errors:\n${formatErrors(sample.userErrors)}`)
+    outputWarn(`Request errors:\n${formatErrors(sample.userErrors)}`)
     return
   }
 
@@ -88,7 +88,7 @@ async function sendSample(options: WebhookTriggerOptions) {
       return
     }
 
-    consoleError('Localhost delivery failed')
+    outputWarn('Localhost delivery failed')
     return
   }
 

packages/theme/src/cli/commands/theme/check.ts

@@ -15,7 +15,7 @@ import {
 import ThemeCommand from '../../utilities/theme-command.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {outputResult, consoleError} from '@shopify/cli-kit/node/output'
+import {outputResult, outputDebug} from '@shopify/cli-kit/node/output'
 import {renderInfo, renderSuccess} from '@shopify/cli-kit/node/ui'
 import {themeCheckRun, LegacyIdentifiers} from '@shopify/theme-check-node'
 import {findPathUp} from '@shopify/cli-kit/node/fs'
@@ -146,11 +146,8 @@ export default class Check extends ThemeCommand {
 
 export async function runThemeCheck(path: string, outputFormat: string, config?: string) {
   const {offenses, theme} = await themeCheckRun(path, config, (message) => {
-    // We should replace this with outputDebug when it logs to STDERR by default.
-    // We need this right now because the --verbose flags pollutes STDOUT
-    // when used with --output=json with the current outputDebug defaults.
     if (process.env.SHOPIFY_TMP_FLAG_DEBUG) {
-      consoleError(message)
+      outputDebug(message)
     }
   })
 

packages/theme/src/cli/services/console.ts

@@ -4,7 +4,7 @@ import {ensureValidPassword} from '../utilities/theme-environment/storefront-pas
 import {replLoop} from '../utilities/repl/repl.js'
 import {initializeDevServerSession} from '../utilities/theme-environment/dev-server-session.js'
 import {AdminSession} from '@shopify/cli-kit/node/session'
-import {consoleWarn} from '@shopify/cli-kit/node/output'
+import {outputInfo} from '@shopify/cli-kit/node/output'
 
 export async function ensureReplEnv(adminSession: AdminSession, storePasswordFlag?: string) {
   const themeId = await findOrCreateReplTheme(adminSession)
@@ -33,7 +33,7 @@ export async function initializeRepl(
   themeAccessPassword?: string,
   storefrontPassword?: string,
 ) {
-  consoleWarn('Welcome to Shopify Liquid console\n(press Ctrl + C to exit)')
+  outputInfo('Welcome to Shopify Liquid console\n(press Ctrl + C to exit)')
 
   const session = await initializeDevServerSession(themeId, adminSession, themeAccessPassword, storefrontPassword)
 

packages/theme/src/cli/utilities/repl/presenter.test.ts

@@ -1,10 +1,13 @@
 import {presentValue} from './presenter.js'
-import {consoleWarn, outputContent, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
+import {outputContent, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
 import {describe, expect, test, vi} from 'vitest'
 
 vi.mock('@shopify/cli-kit/node/output')
 
 describe('presentValue', () => {
+  const cantBePrintedMessage =
+    "Object can't be printed, but you can access its fields. Read more at https://shopify.dev/docs/api/liquid."
+
   test('should print a warning message if value has a JSON error', () => {
     // Given
     const value = {error: 'json not allowed for this object'}
@@ -13,10 +16,8 @@ describe('presentValue', () => {
     presentValue(value)
 
     // Then
-    expect(consoleWarn).toHaveBeenCalledWith(
-      "Object can't be printed, but you can access its fields. Read more at https://shopify.dev/docs/api/liquid.",
-    )
-    expect(outputInfo).not.toHaveBeenCalled()
+    expect(outputInfo).toHaveBeenCalledOnce()
+    expect(outputInfo).toHaveBeenCalledWith(cantBePrintedMessage)
   })
 
   test('should print "null" if value is undefined', () => {
@@ -28,7 +29,7 @@ describe('presentValue', () => {
 
     // Then
     expect(outputInfo).toHaveBeenCalledWith(outputContent`${outputToken.cyan('null')}`)
-    expect(consoleWarn).not.toHaveBeenCalled()
+    expect(outputInfo).not.toHaveBeenCalledWith(cantBePrintedMessage)
   })
 
   test('should print "null" if value is null', () => {
@@ -40,7 +41,7 @@ describe('presentValue', () => {
 
     // Then
     expect(outputInfo).toHaveBeenCalledWith(outputContent`${outputToken.cyan('null')}`)
-    expect(consoleWarn).not.toHaveBeenCalled()
+    expect(outputInfo).not.toHaveBeenCalledWith(cantBePrintedMessage)
   })
 
   test('should print the formatted output if value is not undefined, null, or has a JSON error', () => {
@@ -53,6 +54,6 @@ describe('presentValue', () => {
 
     // Then
     expect(outputInfo).toHaveBeenCalledWith(outputContent`${outputToken.cyan(formattedOutput)}`)
-    expect(consoleWarn).not.toHaveBeenCalled()
+    expect(outputInfo).not.toHaveBeenCalledWith(cantBePrintedMessage)
   })
 })

packages/theme/src/cli/utilities/repl/presenter.ts

@@ -1,8 +1,8 @@
-import {consoleWarn, outputContent, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
+import {outputContent, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
 
 export function presentValue(value?: unknown) {
   if (hasJsonError(value)) {
-    consoleWarn(
+    outputInfo(
       "Object can't be printed, but you can access its fields. Read more at https://shopify.dev/docs/api/liquid.",
     )
     return

packages/theme/src/cli/utilities/repl/repl.test.ts

@@ -3,7 +3,7 @@ import {evaluate} from './evaluator.js'
 import {presentValue} from './presenter.js'
 import {DevServerSession} from '../theme-environment/types.js'
 import {describe, expect, test, vi} from 'vitest'
-import {consoleWarn} from '@shopify/cli-kit/node/output'
+import {outputInfo} from '@shopify/cli-kit/node/output'
 import {createInterface} from 'readline'
 
 vi.mock('@shopify/cli-kit/node/output')
@@ -25,37 +25,37 @@ describe('handleInput', () => {
     output: process.stdout,
   })
 
-  test('should call consoleWarn if input has {{ delimiter', async () => {
+  test('should call outputInfo if input has {{ delimiter', async () => {
     // Given
     const inputValue = '{{ collections.first }}'
 
     // When
     await handleInput(inputValue, themeSesssion, themeId, url, rl, [])
 
     // Then
-    expect(consoleWarn).toHaveBeenCalledWith(DELIMITER_WARNING_MESSAGE)
+    expect(outputInfo).toHaveBeenCalledWith(DELIMITER_WARNING_MESSAGE)
   })
 
-  test('should call consoleWarn if input has {% delimiter', async () => {
+  test('should call outputInfo if input has {% delimiter', async () => {
     // Given
     const inputValue = '{%'
 
     // When
     await handleInput(inputValue, themeSesssion, themeId, url, rl, [])
 
     // Then
-    expect(consoleWarn).toHaveBeenCalledWith(DELIMITER_WARNING_MESSAGE)
+    expect(outputInfo).toHaveBeenCalledWith(DELIMITER_WARNING_MESSAGE)
   })
 
-  test('should not call consoleWarn if {{ delimiter is wrapped in quotes', async () => {
+  test('should not call outputInfo if {{ delimiter is wrapped in quotes', async () => {
     // Given
     const inputValue = '"{{ collections.first }}"'
 
     // When
     await handleInput(inputValue, themeSesssion, themeId, url, rl, [])
 
     // Then
-    expect(consoleWarn).not.toHaveBeenCalled()
+    expect(outputInfo).not.toHaveBeenCalled()
   })
 
   test('should call evaluate, presentValue, and prompt readline if input is valid', async () => {
@@ -66,7 +66,7 @@ describe('handleInput', () => {
     await handleInput(inputValue, themeSesssion, themeId, url, rl, [])
 
     // Then
-    expect(consoleWarn).not.toHaveBeenCalled()
+    expect(outputInfo).not.toHaveBeenCalled()
     expect(evaluate).toHaveBeenCalled()
     expect(presentValue).toHaveBeenCalled()
   })

packages/theme/src/cli/utilities/repl/repl.ts

@@ -2,7 +2,7 @@ import {evaluate, SessionItem} from './evaluator.js'
 import {presentValue} from './presenter.js'
 import {DevServerSession} from '../theme-environment/types.js'
 import {AbortSilentError} from '@shopify/cli-kit/node/error'
-import {consoleWarn, outputContent, outputDebug, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
+import {outputContent, outputDebug, outputInfo, outputToken} from '@shopify/cli-kit/node/output'
 import {createInterface, Interface} from 'readline'
 
 export const DELIMITER_WARNING =
@@ -38,7 +38,7 @@ export async function handleInput(
 ) {
   try {
     if (hasDelimiter(inputValue)) {
-      consoleWarn(DELIMITER_WARNING)
+      outputInfo(DELIMITER_WARNING)
       return rl.prompt()
     }
     const evaluatedValue = await evaluate({snippet: inputValue, themeSession, themeId, url, replSession})