Warn if path is set via CLI during multi env command runs

The path flag should point to where a command
will be run. This defaults to the current working
directory

While running a command with multiple environment
flags, providing a path via the CLI will take
precedence over toml and default values and
try to run every environment at the same path. This
PR prevents this by displaying a warning message

Author: dejmedus

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

@@ -5,12 +5,14 @@ import {Config, Flags} from '@oclif/core'
 import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
 import {loadEnvironment} from '@shopify/cli-kit/node/environments'
 import {renderConcurrent, renderConfirmationPrompt, renderError} from '@shopify/cli-kit/node/ui'
+import {fileExistsSync} from '@shopify/cli-kit/node/fs'
 import type {Writable} from 'stream'
 
 vi.mock('@shopify/cli-kit/node/session')
 vi.mock('@shopify/cli-kit/node/environments')
 vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('./theme-store.js')
+vi.mock('@shopify/cli-kit/node/fs')
 
 const CommandConfig = new Config({root: __dirname})
 
@@ -450,6 +452,61 @@ describe('ThemeCommand', () => {
       )
     })
 
+    test('commands should display an error if the --path flag is used', async () => {
+      // Given
+      const environmentConfig = {store: 'store.myshopify.com'}
+      vi.mocked(loadEnvironment).mockResolvedValue(environmentConfig)
+      vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
+      vi.mocked(fileExistsSync).mockReturnValue(true)
+
+      await CommandConfig.load()
+      const command = new TestThemeCommand(
+        ['--environment', 'command-error', '--environment', 'development', '--path', 'path'],
+        CommandConfig,
+      )
+
+      // When
+      await command.run()
+
+      // Then
+      expect(renderError).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: [
+            "Can't use `--path` flag with multiple environments.",
+            "Configure each environment's theme path in your shopify.theme.toml file instead.",
+          ],
+        }),
+      )
+    })
+
+    test('commands should display an error if the --path flag is used and no shopify.theme.toml is found', async () => {
+      // Given
+      const environmentConfig = {store: 'store.myshopify.com'}
+      vi.mocked(loadEnvironment).mockResolvedValue(environmentConfig)
+      vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
+      vi.mocked(fileExistsSync).mockReturnValue(false)
+
+      await CommandConfig.load()
+      const command = new TestThemeCommand(
+        ['--environment', 'command-error', '--environment', 'development', '--path', 'path'],
+        CommandConfig,
+      )
+
+      // When
+      await command.run()
+
+      // Then
+      expect(renderError).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: [
+            "Can't use `--path` flag with multiple environments.",
+            'Run this command from the directory containing shopify.theme.toml.',
+            'No shopify.theme.toml found in current directory.',
+          ],
+        }),
+      )
+    })
+
     test('CLI and shopify.theme.toml flag values take precedence over defaults', async () => {
       // Given
       vi.mocked(loadEnvironment)

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

@@ -16,6 +16,8 @@ import {
 import {AbortController} from '@shopify/cli-kit/node/abort'
 import {recordEvent, compileData} from '@shopify/cli-kit/node/analytics'
 import {addPublicMetadata, addSensitiveMetadata} from '@shopify/cli-kit/node/metadata'
+import {cwd, joinPath} from '@shopify/cli-kit/node/path'
+import {fileExistsSync} from '@shopify/cli-kit/node/fs'
 import type {Writable} from 'stream'
 
 export interface FlagValues {
@@ -103,7 +105,13 @@ export default abstract class ThemeCommand extends Command {
       return
     }
 
-    const environmentsMap = await this.loadEnvironments(environments, flags, klass)
+    const {flags: flagsWithoutDefaults} = await this.parse(noDefaultsOptions(klass), this.argv)
+    if ('path' in flagsWithoutDefaults) {
+      this.errorOnGlobalPath()
+      return
+    }
+
+    const environmentsMap = await this.loadEnvironments(environments, flags, flagsWithoutDefaults)
     const validationResults = await this.validateEnvironments(environmentsMap, requiredFlags)
 
     const commandAllowsForceFlag = 'force' in klass.flags
@@ -120,16 +128,14 @@ export default abstract class ThemeCommand extends Command {
    * Create a map of environments from the shopify.theme.toml file
    * @param environments - Names of environments to load
    * @param flags - Flags provided via the CLI or by default
-   * @param klass - The command class
+   * @param flagsWithoutDefaults - Flags provided via the CLI
    * @returns The map of environments
    */
   private async loadEnvironments(
     environments: EnvironmentName[],
     flags: FlagValues,
-    klass: Input<FlagOutput, FlagOutput, ArgOutput>,
+    flagsWithoutDefaults: FlagValues,
   ): Promise<Map<EnvironmentName, FlagValues>> {
-    const {flags: flagsWithoutDefaults} = await this.parse(noDefaultsOptions(klass))
-
     const environmentMap = new Map<EnvironmentName, FlagValues>()
 
     for (const environmentName of environments) {
@@ -328,6 +334,27 @@ export default abstract class ThemeCommand extends Command {
     return true
   }
 
+  /**
+   * Error if the --path flag is provided via CLI when running a multi environment command
+   * Commands that act on local files require each environment to specify its own path in the shopify.theme.toml
+   */
+  private errorOnGlobalPath() {
+    const tomlPath = joinPath(cwd(), 'shopify.theme.toml')
+    const tomlInCwd = fileExistsSync(tomlPath)
+
+    renderError({
+      body: [
+        "Can't use `--path` flag with multiple environments.",
+        ...(tomlInCwd
+          ? ["Configure each environment's theme path in your shopify.theme.toml file instead."]
+          : [
+              'Run this command from the directory containing shopify.theme.toml.',
+              'No shopify.theme.toml found in current directory.',
+            ]),
+      ],
+    })
+  }
+
   private async logAnalyticsData(session: AdminSession): Promise<void> {
     const data = compileData()