Update theme rename command for multi-environment

Previously `theme rename` command could only be in
in a single environment at a time. This commit allows
`rename` to be run in multiple environments in a
single command run.

Author: dejmedus

.changeset/great-dragons-float.md

@@ -0,0 +1,6 @@
+---
+'@shopify/theme': minor
+'@shopify/cli': minor
+---
+
+Allow theme rename command to be run with multiple environments

packages/cli/oclif.manifest.json

@@ -6762,6 +6762,16 @@
       "hiddenAliases": [
       ],
       "id": "theme:rename",
+      "multiEnvironmentsFlags": [
+        "store",
+        "password",
+        "name",
+        [
+          "live",
+          "development",
+          "theme"
+        ]
+      ],
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",

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

@@ -1,11 +1,9 @@
-import ThemeCommand from '../../utilities/theme-command.js'
-import {RenameOptions, renameTheme} from '../../services/rename.js'
-import {ensureThemeStore} from '../../utilities/theme-store.js'
+import ThemeCommand, {RequiredFlags} from '../../utilities/theme-command.js'
 import {themeFlags} from '../../flags.js'
+import {RenameOptions, renameTheme} from '../../services/rename.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
-import {promptThemeName} from '@shopify/cli-kit/node/themes/utils'
+import {AdminSession} from '@shopify/cli-kit/node/session'
 
 export default class Rename extends ThemeCommand {
   static summary = 'Renames an existing theme.'
@@ -43,21 +41,9 @@ export default class Rename extends ThemeCommand {
     }),
   }
 
-  public async run(): Promise<void> {
-    const {flags} = await this.parse(Rename)
-    const {password, development, name, theme, live} = flags
-
-    const store = ensureThemeStore(flags)
-    const adminSession = await ensureAuthenticatedThemes(store, password)
-    const newName = name || (await promptThemeName('New name for the theme'))
-
-    const renameOptions: RenameOptions = {
-      newName,
-      development,
-      theme,
-      live,
-    }
+  static multiEnvironmentsFlags: RequiredFlags = ['store', 'password', 'name', ['live', 'development', 'theme']]
 
-    await renameTheme(adminSession, renameOptions)
+  async command(flags: RenameOptions, adminSession: AdminSession) {
+    await renameTheme(flags, adminSession)
   }
 }

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

@@ -23,7 +23,7 @@ const developmentTheme = {
 
 const options: RenameOptions = {
   development: false,
-  newName: 'Renamed Theme',
+  name: 'Renamed Theme',
   live: false,
 }
 
@@ -33,10 +33,10 @@ describe('renameTheme', () => {
     vi.mocked(findOrSelectTheme).mockResolvedValue(developmentTheme)
 
     // When
-    await renameTheme(adminSession, {...options, development: true})
+    await renameTheme({...options, development: true}, adminSession)
 
     // Then
-    expect(themeUpdate).toBeCalledWith(developmentTheme.id, {name: options.newName}, adminSession)
+    expect(themeUpdate).toBeCalledWith(developmentTheme.id, {name: options.name}, adminSession)
     expect(renderSuccess).toBeCalledWith({
       body: ['The theme', "'my development theme'", {subdued: '(#1)'}, 'was renamed to', "'Renamed Theme'"],
     })
@@ -52,10 +52,10 @@ describe('renameTheme', () => {
     vi.mocked(findOrSelectTheme).mockResolvedValue(theme1)
 
     // When
-    await renameTheme(adminSession, {...options, theme: '2'})
+    await renameTheme({...options, theme: '2'}, adminSession)
 
     // Then
-    expect(themeUpdate).toBeCalledWith(theme1.id, {name: options.newName}, adminSession)
+    expect(themeUpdate).toBeCalledWith(theme1.id, {name: options.name}, adminSession)
     expect(renderSuccess).toBeCalledWith({
       body: ['The theme', "'my theme'", {subdued: '(#2)'}, 'was renamed to', "'Renamed Theme'"],
     })
@@ -71,10 +71,10 @@ describe('renameTheme', () => {
     vi.mocked(findOrSelectTheme).mockResolvedValue(theme1)
 
     // When
-    await renameTheme(adminSession, {...options, live: true})
+    await renameTheme({...options, live: true}, adminSession)
 
     // Then
-    expect(themeUpdate).toBeCalledWith(theme1.id, {name: options.newName}, adminSession)
+    expect(themeUpdate).toBeCalledWith(theme1.id, {name: options.name}, adminSession)
     expect(renderSuccess).toBeCalledWith({
       body: ['The theme', "'live theme'", {subdued: '(#2)'}, 'was renamed to', "'Renamed Theme'"],
     })

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

@@ -3,15 +3,19 @@ import {themeComponent} from '../utilities/theme-ui.js'
 import {themeUpdate} from '@shopify/cli-kit/node/themes/api'
 import {AdminSession} from '@shopify/cli-kit/node/session'
 import {renderSuccess} from '@shopify/cli-kit/node/ui'
+import {promptThemeName} from '@shopify/cli-kit/node/themes/utils'
 
 export interface RenameOptions {
-  newName: string
+  name?: string
   development?: boolean
   theme?: string
   live?: boolean
+  environment?: string
 }
 
-export async function renameTheme(adminSession: AdminSession, options: RenameOptions) {
+export async function renameTheme(options: RenameOptions, adminSession: AdminSession) {
+  const newName = options.name || (await promptThemeName('New name for the theme'))
+
   const theme = await findOrSelectTheme(adminSession, {
     header: 'Select a theme to rename',
     filter: {
@@ -20,8 +24,16 @@ export async function renameTheme(adminSession: AdminSession, options: RenameOpt
       live: options.live,
     },
   })
-  await themeUpdate(theme.id, {name: options.newName}, adminSession)
+
+  await themeUpdate(theme.id, {name: newName}, adminSession)
+
   renderSuccess({
-    body: ['The theme', ...themeComponent(theme), 'was renamed to', `'${options.newName}'`],
+    body: [
+      ...(options.environment ? [{subdued: `Environment: ${options.environment}\n\n`}] : []),
+      'The theme',
+      ...themeComponent(theme),
+      'was renamed to',
+      `'${newName}'`,
+    ],
   })
 }