Allow theme commands to take glob pattern for environments

Author: graygilmore

.changeset/wet-bats-glow.md

@@ -0,0 +1,14 @@
+---
+'@shopify/cli-kit': patch
+'@shopify/theme': patch
+'@shopify/app': patch
+---
+
+Updated the environment flag to support glob patterns
+
+For commands that support multiple environments you can now use glob patterns
+to specify the environments, e.g. `--environment "*-production"`. It's important
+to wrap any glob patterns in quotes to ensure your shell does not expand the
+value before passing it to the CLI.
+
+This comes with a side effect that environments will be deduplicated.

packages/cli-kit/src/public/node/base-command.test.ts

@@ -203,12 +203,12 @@ describe('applying environments', async () => {
     outputMock.clear()
 
     // When
-    await MockCommand.run(['--path', tmpDir, '--environment', 'validEnvironment', '--environment', 'validEnvironment'])
+    await MockCommand.run(['--path', tmpDir, '--environment', 'validEnvironment', '--environment', 'validEnvironment2'])
 
     // Then
     expect(testResult).toEqual({
       path: resolvePath(tmpDir),
-      environment: ['validEnvironment', 'validEnvironment'],
+      environment: ['validEnvironment', 'validEnvironment2'],
       someStringWithDefault: 'default stringy',
     })
     expect(outputMock.info()).toEqual('')

packages/cli-kit/src/public/node/base-command.ts

@@ -1,5 +1,5 @@
 import {errorHandler, registerCleanBugsnagErrorsFromWithinPlugins} from './error-handler.js'
-import {loadEnvironment, environmentFilePath} from './environments.js'
+import {loadEnvironment, environmentFilePath, expandEnvironmentPatterns} from './environments.js'
 import {isDevelopment} from './context/local.js'
 import {addPublicMetadata} from './metadata.js'
 import {AbortError} from './error.js'
@@ -146,16 +146,22 @@ This flag is required in non-interactive terminal environments, such as a CI env
     const environmentFileExists = await environmentFilePath(environmentsFileName, {from: flags.path})
 
     // Handle both string and array cases for environment flag
-    let environments: string[] = []
+    let environmentPatterns: string[] = []
     if (flags.environment) {
-      environments = Array.isArray(flags.environment) ? flags.environment : [flags.environment]
+      environmentPatterns = Array.isArray(flags.environment) ? flags.environment : [flags.environment]
     }
 
-    const environmentSpecified = environments.length > 0
+    const environmentSpecified = environmentPatterns.length > 0
 
     // Noop if no environment file exists and none was specified
     if (!environmentFileExists && !environmentSpecified) return originalResult
 
+    // Theme commands can have environment names with glob patterns, in order
+    // to check if there are multiple environments being specified we need to
+    // expand them before continuing even if other commands might not support
+    // multi environment behaviour.
+    const environments = await expandEnvironmentPatterns(environmentPatterns, environmentsFileName)
+
     // Noop if multiple environments were specified (let commands handle this)
     if (environmentSpecified && environments.length > 1) return originalResult
 

packages/theme/src/cli/flags.ts

@@ -4,6 +4,8 @@ import {resolvePath, cwd} from '@shopify/cli-kit/node/path'
 import {fileExistsSync} from '@shopify/cli-kit/node/fs'
 import {renderError} from '@shopify/cli-kit/node/ui'
 
+const globQuotesDescription = "Wrap the value in double quotes if you're using wildcards."
+
 /**
  * An object that contains the flags that
  * are shared across all the theme commands.
@@ -44,14 +46,12 @@ export const themeFlags = {
   }),
   environment: Flags.string({
     char: 'e',
-    description: 'The environment to apply to the current command.',
+    description: `The environment to apply to the current command. ${globQuotesDescription}`,
     env: 'SHOPIFY_FLAG_ENVIRONMENT',
     multiple: true,
   }),
 }
 
-const globQuotesDescription = "Wrap the value in double quotes if you're using wildcards."
-
 export const globFlags = (action: 'download' | 'upload') => ({
   only: Flags.string({
     char: 'o',

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

@@ -3,7 +3,7 @@ import {ensureThemeStore} from './theme-store.js'
 import {describe, vi, expect, test, beforeEach} from 'vitest'
 import {Config, Flags} from '@oclif/core'
 import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
-import {loadEnvironment} from '@shopify/cli-kit/node/environments'
+import {loadEnvironment, expandEnvironmentPatterns} from '@shopify/cli-kit/node/environments'
 import {fileExistsSync} from '@shopify/cli-kit/node/fs'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {resolvePath} from '@shopify/cli-kit/node/path'
@@ -137,6 +137,7 @@ describe('ThemeCommand', () => {
     vi.mocked(ensureThemeStore).mockReturnValue('test-store.myshopify.com')
     vi.mocked(ensureAuthenticatedThemes).mockResolvedValue(mockSession)
     vi.mocked(fileExistsSync).mockReturnValue(true)
+    vi.mocked(expandEnvironmentPatterns).mockImplementation(async (patterns) => patterns)
   })
 
   describe('run', () => {

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

@@ -5,7 +5,7 @@ import {hashString} from '@shopify/cli-kit/node/crypto'
 import {Input} from '@oclif/core/interfaces'
 import Command, {ArgOutput, FlagOutput, noDefaultsOptions} from '@shopify/cli-kit/node/base-command'
 import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
-import {loadEnvironment} from '@shopify/cli-kit/node/environments'
+import {loadEnvironment, expandEnvironmentPatterns} from '@shopify/cli-kit/node/environments'
 import {
   renderWarning,
   renderConcurrent,
@@ -75,7 +75,14 @@ export default abstract class ThemeCommand extends Command {
     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)
+    const environmentPatterns = (Array.isArray(flags.environment) ? flags.environment : [flags.environment]).filter(
+      Boolean,
+    )
+
+    const environments =
+      environmentPatterns.length > 0
+        ? await expandEnvironmentPatterns(environmentPatterns, 'shopify.theme.toml', {from: flags.path as string})
+        : []
 
     // Single environment or no environment
     if (environments.length <= 1) {