Merge pull request #6363 from Shopify/jb-multi-env-init

Refactor theme init command to use ThemeCommand's run method

Author: dejmedus

.changeset/twelve-squids-deliver.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme': minor
+---
+
+Extend ThemeCommand's command method to accept both flags and arguments from CLI

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

@@ -13,6 +13,11 @@ import {generateRandomNameForSubdirectory} from '@shopify/cli-kit/node/fs'
 import {renderTextPrompt} from '@shopify/cli-kit/node/ui'
 import {joinPath} from '@shopify/cli-kit/node/path'
 import {terminalSupportsPrompting} from '@shopify/cli-kit/node/system'
+import {InferredArgs, InferredFlags} from '@oclif/core/interfaces'
+import {AdminSession} from '@shopify/cli-kit/node/session'
+
+type InitFlags = InferredFlags<typeof Init.flags>
+type InitArgs = InferredArgs<typeof Init.args>
 
 export default class Init extends ThemeCommand {
   static summary = 'Clones a Git repository to use as a starting point for building a new theme.'
@@ -52,8 +57,7 @@ export default class Init extends ThemeCommand {
     }),
   }
 
-  async run(): Promise<void> {
-    const {args, flags} = await this.parse(Init)
+  async command(flags: InitFlags, _adminSession: AdminSession, _multiEnvironment: boolean, args: InitArgs) {
     const name = args.name || (await this.promptName(flags.path))
     const repoUrl = flags['clone-url']
     const destination = joinPath(flags.path, name)

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

@@ -6,6 +6,7 @@ import {Flags} from '@oclif/core'
 import {recordTiming} from '@shopify/cli-kit/node/analytics'
 import {InferredFlags} from '@oclif/core/interfaces'
 import {AdminSession} from '@shopify/cli-kit/node/session'
+import {ArgOutput} from '@shopify/cli-kit/node/base-command'
 import {Writable} from 'stream'
 
 type PullFlags = InferredFlags<typeof Pull.flags>
@@ -56,6 +57,7 @@ If no theme is specified, then you're prompted to select the theme to pull from
     flags: PullFlags,
     adminSession?: AdminSession,
     multiEnvironment?: boolean,
+    _args?: ArgOutput,
     context?: {stdout?: Writable; stderr?: Writable},
   ) {
     recordTiming('theme-command:pull')

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

@@ -6,6 +6,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {recordTiming} from '@shopify/cli-kit/node/analytics'
 import {AdminSession} from '@shopify/cli-kit/node/session'
 import {InferredFlags} from '@oclif/core/interfaces'
+import {ArgOutput} from '@shopify/cli-kit/node/base-command'
 import {Writable} from 'stream'
 
 type PushFlags = InferredFlags<typeof Push.flags>
@@ -105,6 +106,7 @@ export default class Push extends ThemeCommand {
     flags: PushFlags,
     adminSession: AdminSession,
     multiEnvironment: boolean,
+    _args?: ArgOutput,
     context?: {stdout?: Writable; stderr?: Writable},
   ) {
     recordTiming('theme-command:push')

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

@@ -7,6 +7,7 @@ import {getRandomName} from '@shopify/cli-kit/common/string'
 import {recordTiming} from '@shopify/cli-kit/node/analytics'
 import {InferredFlags} from '@oclif/core/interfaces'
 import {AdminSession} from '@shopify/cli-kit/node/session'
+import {ArgOutput} from '@shopify/cli-kit/node/base-command'
 import {Writable} from 'stream'
 
 type ShareFlags = InferredFlags<typeof Share.flags>
@@ -36,6 +37,7 @@ export default class Share extends ThemeCommand {
     flags: ShareFlags,
     adminSession: AdminSession,
     multiEnvironment: boolean,
+    _args?: ArgOutput,
     context?: {stdout?: Writable; stderr?: Writable},
   ) {
     const pushFlags: PushFlags = {

packages/theme/src/cli/utilities/theme-command.test.ts

@@ -43,15 +43,16 @@ class TestThemeCommand extends ThemeCommand {
 
   static multiEnvironmentsFlags: RequiredFlags = ['store']
 
-  commandCalls: {flags: any; session: AdminSession; multiEnvironment?: boolean; context?: any}[] = []
+  commandCalls: {flags: any; session: AdminSession; multiEnvironment: boolean; args: any; context?: any}[] = []
 
   async command(
     flags: any,
     session: AdminSession,
-    multiEnvironment?: boolean,
+    multiEnvironment = false,
+    args?: any,
     context?: {stdout?: Writable; stderr?: Writable},
   ): Promise<void> {
-    this.commandCalls.push({flags, session, multiEnvironment, context})
+    this.commandCalls.push({flags, session, multiEnvironment, args, context})
 
     if (flags.environment && flags.environment[0] === 'command-error') {
       throw new Error('Mocking a command error')
@@ -108,15 +109,16 @@ class TestUnauthenticatedThemeCommand extends ThemeCommand {
 
   static multiEnvironmentsFlags: RequiredFlags = ['store']
 
-  commandCalls: {flags: any; session: AdminSession; multiEnvironment?: boolean; context?: any}[] = []
+  commandCalls: {flags: any; session: AdminSession; multiEnvironment?: boolean; args?: any; context?: any}[] = []
 
   async command(
     flags: any,
     session: AdminSession,
     multiEnvironment?: boolean,
+    args?: any,
     context?: {stdout?: Writable; stderr?: Writable},
   ): Promise<void> {
-    this.commandCalls.push({flags, session, multiEnvironment, context})
+    this.commandCalls.push({flags, session, multiEnvironment, args, context})
   }
 }
 
@@ -153,6 +155,8 @@ describe('ThemeCommand', () => {
       expect(command.commandCalls[0]).toMatchObject({
         flags: {environment: []},
         session: mockSession,
+        multiEnvironment: false,
+        args: {},
         context: undefined,
       })
     })
@@ -181,6 +185,8 @@ describe('ThemeCommand', () => {
           store: 'env-store.myshopify.com',
         },
         session: mockSession,
+        multiEnvironment: false,
+        args: {},
         context: undefined,
       })
     })

packages/theme/src/cli/utilities/theme-command.ts

@@ -56,6 +56,7 @@ export default abstract class ThemeCommand extends Command {
     _flags: FlagValues,
     _session?: AdminSession,
     _multiEnvironment = false,
+    _args?: ArgOutput,
     _context?: {stdout?: Writable; stderr?: Writable},
   ): Promise<void> {}
 
@@ -68,10 +69,12 @@ export default abstract class ThemeCommand extends Command {
     const klass = this.constructor as unknown as Input<TFlags, TGlobalFlags, TArgs> & {
       multiEnvironmentsFlags: RequiredFlags
       flags: FlagOutput
+      args: ArgOutput
     }
     const requiredFlags = klass.multiEnvironmentsFlags
-    const {flags} = await this.parse(klass)
+    const {args, flags} = await this.parse(klass)
     const commandRequiresAuth = 'password' in klass.flags
+
     const environments = (Array.isArray(flags.environment) ? flags.environment : [flags.environment]).filter(Boolean)
 
     // Single environment or no environment
@@ -85,7 +88,7 @@ export default abstract class ThemeCommand extends Command {
         throw new AbortError(`Path does not exist: ${flags.path}`)
       }
 
-      await this.command(flags, session)
+      await this.command(flags, session, false, args)
       await this.logAnalyticsData(session)
       return
     }
@@ -264,7 +267,7 @@ export default abstract class ThemeCommand extends Command {
                 const commandName = this.constructor.name.toLowerCase()
                 recordEvent(`theme-command:${commandName}:multi-env:authenticated`)
 
-                await this.command(flags, session, true, {stdout, stderr})
+                await this.command(flags, session, true, {}, {stdout, stderr})
                 await this.logAnalyticsData(session)
               })