Merge pull request #5874 from Shopify/publish-command-multi-env

Allow publish command to work with multiple environments

Author: EvilGenius13

.changeset/hot-fishes-develop.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme': patch
+---
+
+Allow publish command to be called with multiple environments

packages/cli/oclif.manifest.json

@@ -6338,10 +6338,15 @@
       "hiddenAliases": [
       ],
       "id": "theme:publish",
+      "multiEnvironmentsFlags": [
+        "store",
+        "password",
+        "theme"
+      ],
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "summary": "Set a remote theme as the live theme."
     },
     "theme:pull": {

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

@@ -1,10 +1,12 @@
-import {ensureThemeStore} from '../../utilities/theme-store.js'
 import ThemeCommand from '../../utilities/theme-command.js'
 import {themeFlags} from '../../flags.js'
-import {publish, renderArgumentsWarning} from '../../services/publish.js'
+import {publish} from '../../services/publish.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
+import {OutputFlags} from '@oclif/core/interfaces'
+import {AdminSession} from '@shopify/cli-kit/node/session'
+
+type PublishFlags = OutputFlags<typeof Publish.flags>
 
 export default class Publish extends ThemeCommand {
   static summary = 'Set a remote theme as the live theme.'
@@ -19,9 +21,6 @@ If you want to publish your local theme, then you need to run \`shopify theme pu
 
   static description = this.descriptionWithoutMarkdown()
 
-  // Accept any number of args without naming them
-  static strict = false
-
   static flags = {
     ...globalFlags,
     ...themeFlags,
@@ -37,16 +36,9 @@ If you want to publish your local theme, then you need to run \`shopify theme pu
     }),
   }
 
-  async run(): Promise<void> {
-    const {flags, argv} = await this.parse(Publish)
-    const store = await ensureThemeStore(flags)
-    const adminSession = await ensureAuthenticatedThemes(store, flags.password)
-    const themeId = flags.theme || argv[0]
-
-    if (argv.length > 0 && typeof argv[0] === 'string') {
-      renderArgumentsWarning(argv[0])
-    }
+  static multiEnvironmentsFlags = ['store', 'password', 'theme']
 
-    await publish(adminSession, themeId, flags)
+  async command(flags: PublishFlags, adminSession: AdminSession, multiEnvironment?: boolean) {
+    await publish(adminSession, flags, multiEnvironment)
   }
 }

packages/theme/src/cli/services/publish.test.ts

@@ -33,7 +33,7 @@ describe('publish', () => {
     vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
 
     // When
-    await publish(session, '1', options)
+    await publish(session, options)
 
     // Then
     expect(renderConfirmationPrompt).toBeCalledWith({
@@ -66,7 +66,7 @@ describe('publish', () => {
     vi.mocked(renderConfirmationPrompt).mockResolvedValue(false)
 
     // When
-    await publish(session, '1', options)
+    await publish(session, options)
 
     // Then
     expect(renderConfirmationPrompt).toBeCalledWith({
@@ -84,7 +84,7 @@ describe('publish', () => {
     vi.mocked(renderConfirmationPrompt).mockResolvedValue(false)
 
     // When
-    await publish(session, '1', {...options, force: true})
+    await publish(session, {...options, force: true})
 
     // Then
     expect(renderConfirmationPrompt).not.toBeCalled()

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

@@ -3,48 +3,43 @@ import {themeComponent} from '../utilities/theme-ui.js'
 import {themePublish} from '@shopify/cli-kit/node/themes/api'
 import {themePreviewUrl} from '@shopify/cli-kit/node/themes/urls'
 import {Theme} from '@shopify/cli-kit/node/themes/types'
-import {renderConfirmationPrompt, renderSuccess, renderWarning} from '@shopify/cli-kit/node/ui'
+import {renderConfirmationPrompt, renderSuccess} from '@shopify/cli-kit/node/ui'
 import {AdminSession} from '@shopify/cli-kit/node/session'
 
-export function renderArgumentsWarning(id: string) {
-  renderWarning({
-    body: [
-      'The theme ID positional argument is deprecated. Use the',
-      {command: '--theme'},
-      'flag instead:\n\n',
-      {command: `$ shopify theme publish --theme ${id}`},
-      {char: '.'},
-    ],
-  })
+interface PublishServiceOptions {
+  theme: string | undefined
+  force: boolean
+  environment?: string
 }
 
-export async function publish(adminSession: AdminSession, themeId: string | undefined, options: {force: boolean}) {
-  const theme = await findOrSelectTheme(adminSession, {
+export async function publish(adminSession: AdminSession, options: PublishServiceOptions, multiEnvironment?: boolean) {
+  const themeToPublish = await findOrSelectTheme(adminSession, {
     header: 'Select a theme to publish',
     filter: {
       development: false,
       live: false,
-      theme: themeId,
+      theme: options.theme,
     },
   })
 
-  const previewUrl = themePreviewUrl({...theme, role: 'live'} as Theme, adminSession)
+  const previewUrl = themePreviewUrl({...themeToPublish, role: 'live'} as Theme, adminSession)
 
-  if (!options.force) {
+  if (!options.force && !multiEnvironment) {
     const accept = await renderConfirmationPrompt({
-      message: `Do you want to make '${theme.name}' the new live theme on ${adminSession.storeFqdn}?`,
-      confirmationMessage: `Yes, make '${theme.name}' the new live theme`,
+      message: `Do you want to make '${themeToPublish.name}' the new live theme on ${adminSession.storeFqdn}?`,
+      confirmationMessage: `Yes, make '${themeToPublish.name}' the new live theme`,
       cancellationMessage: 'No, cancel publish',
     })
     if (!accept) return
   }
 
-  await themePublish(theme.id, adminSession)
+  await themePublish(themeToPublish.id, adminSession)
 
   renderSuccess({
+    headline: options.environment ? `Environment: ${options.environment}` : undefined,
     body: [
       'The theme',
-      ...themeComponent(theme),
+      ...themeComponent(themeToPublish),
       'is now live at',
       {
         link: {