validate listing exists

Author: chrisberthe

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

@@ -6,6 +6,7 @@ import {isStorefrontPasswordProtected} from '../utilities/theme-environment/stor
 import {ensureValidPassword} from '../utilities/theme-environment/storefront-password-prompt.js'
 import {emptyThemeExtFileSystem} from '../utilities/theme-fs-empty.js'
 import {initializeDevServerSession} from '../utilities/theme-environment/dev-server-session.js'
+import {ensureListingExists} from '../utilities/theme-listing.js'
 import {renderSuccess, renderWarning} from '@shopify/cli-kit/node/ui'
 import {AdminSession} from '@shopify/cli-kit/node/session'
 import {Theme} from '@shopify/cli-kit/node/themes/types'
@@ -44,6 +45,10 @@ export async function dev(options: DevOptions) {
     return
   }
 
+  if (options.listing) {
+    await ensureListingExists(options.directory, options.listing)
+  }
+
   const storefrontPasswordPromise = await isStorefrontPasswordProtected(options.adminSession).then((needsPassword) =>
     needsPassword ? ensureValidPassword(options.storePassword, options.adminSession.storeFqdn) : undefined,
   )

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

@@ -8,6 +8,7 @@ import {findOrSelectTheme} from '../utilities/theme-selector.js'
 import {Role} from '../utilities/theme-selector/fetch.js'
 import {configureCLIEnvironment} from '../utilities/cli-config.js'
 import {runThemeCheck} from '../commands/theme/check.js'
+import {ensureListingExists} from '../utilities/theme-listing.js'
 import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
 import {themeCreate, fetchChecksums, themePublish} from '@shopify/cli-kit/node/themes/api'
 import {Result, Theme} from '@shopify/cli-kit/node/themes/types'
@@ -139,6 +140,10 @@ export async function push(flags: PushFlags): Promise<void> {
     return
   }
 
+  if (flags.listing) {
+    await ensureListingExists(workingDirectory, flags.listing)
+  }
+
   const selectedTheme: Theme | undefined = await createOrSelectTheme(adminSession, flags)
   if (!selectedTheme) {
     return

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

@@ -1,4 +1,4 @@
-import {getListingFilePath, updateSettingsDataForListing} from './theme-listing.js'
+import {getListingFilePath, updateSettingsDataForListing, ensureListingExists} from './theme-listing.js'
 import {test, describe, expect} from 'vitest'
 import {inTemporaryDirectory, mkdir, writeFile} from '@shopify/cli-kit/node/fs'
 import {joinPath} from '@shopify/cli-kit/node/path'
@@ -151,4 +151,46 @@ describe('theme-listing', () => {
       })
     })
   })
+
+  describe('ensureListingExists', () => {
+    test('resolves when the listing preset directory exists', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const themeDir = joinPath(tmpDir, 'theme')
+        const listingDir = joinPath(themeDir, 'listings', 'modern')
+        await mkdir(listingDir, {recursive: true})
+
+        // When / Then (no throw)
+        await ensureListingExists(themeDir, 'modern')
+      })
+    })
+
+    test('throws with available presets listed when the preset is missing', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const themeDir = joinPath(tmpDir, 'theme')
+        const listingsRoot = joinPath(themeDir, 'listings')
+        await mkdir(joinPath(listingsRoot, 'modern'), {recursive: true})
+        await mkdir(joinPath(listingsRoot, 'classic'), {recursive: true})
+
+        // When / Then
+        await expect(ensureListingExists(themeDir, 'unknown')).rejects.toThrow(
+          'Listing preset "unknown" was not found.',
+        )
+
+        await expect(ensureListingExists(themeDir, 'unknown')).rejects.toThrow('Available presets: "Modern"')
+        await expect(ensureListingExists(themeDir, 'unknown')).rejects.toThrow('"Classic"')
+      })
+    })
+
+    test('throws with no presets message when listings directory does not exist', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const themeDir = joinPath(tmpDir, 'theme')
+
+        // When / Then
+        await expect(ensureListingExists(themeDir, 'unknown')).rejects.toThrow('No presets found under "listings/"')
+      })
+    })
+  })
 })

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

@@ -1,6 +1,7 @@
-import {fileExists, readFile} from '@shopify/cli-kit/node/fs'
+import {fileExists, readFile, glob} from '@shopify/cli-kit/node/fs'
 import {joinPath} from '@shopify/cli-kit/node/path'
 import {capitalizeWords} from '@shopify/cli-kit/common/string'
+import {AbortError} from '@shopify/cli-kit/node/error'
 
 function isListingFile(fileKey: string): boolean {
   return (fileKey.startsWith('templates/') || fileKey.startsWith('sections/')) && fileKey.endsWith('.json')
@@ -40,3 +41,27 @@ export async function updateSettingsDataForListing(themeDirectory: string, listi
     throw error
   }
 }
+
+export async function ensureListingExists(themeDirectory: string, listingName: string): Promise<void> {
+  const listingsRoot = joinPath(themeDirectory, 'listings')
+  const dir = joinPath(listingsRoot, listingName)
+  const exists = await fileExists(dir)
+  if (exists) return
+
+  let available: string[] = []
+  if (await fileExists(listingsRoot)) {
+    available = await glob('*', {cwd: listingsRoot, onlyDirectories: true, deep: 1})
+  }
+
+  const availablePresetsMessage =
+    available.length > 0
+      ? `Available presets: ${available
+          .map((presetDirectoryName) => `"${capitalizeWords(presetDirectoryName)}"`)
+          .join(', ')}`
+      : 'No presets found under "listings/"'
+
+  throw new AbortError(
+    `Listing preset "${listingName}" was not found. ${availablePresetsMessage}.`,
+    `Add the preset to config/settings_data.json and its corresponding "listings/${listingName}" folder, or remove the --listing flag to use the default theme settings.`,
+  )
+}