Integrate Project model into loader and decompose into composable stages

packages/app/src/cli/commands/app/config/link.ts

@@ -34,7 +34,7 @@ export default class ConfigLink extends AppLinkedCommand {
       directory: flags.path,
       clientId: undefined,
       forceRelink: false,
-      userProvidedConfigName: result.state.configurationFileName,
+      userProvidedConfigName: result.configFileName,
     })
 
     return {app}

packages/app/src/cli/models/app/config-file-naming.test.ts

@@ -0,0 +1,58 @@
+import {
+  getAppConfigurationFileName,
+  getAppConfigurationShorthand,
+  isValidFormatAppConfigurationFileName,
+} from './config-file-naming.js'
+import {describe, expect, test} from 'vitest'
+
+describe('getAppConfigurationFileName', () => {
+  test('returns default filename when no config name is provided', () => {
+    expect(getAppConfigurationFileName()).toBe('shopify.app.toml')
+    expect(getAppConfigurationFileName(undefined)).toBe('shopify.app.toml')
+  })
+
+  test('returns the config name as-is when it matches the valid format', () => {
+    expect(getAppConfigurationFileName('shopify.app.production.toml')).toBe('shopify.app.production.toml')
+    expect(getAppConfigurationFileName('shopify.app.staging.toml')).toBe('shopify.app.staging.toml')
+    expect(getAppConfigurationFileName('shopify.app.toml')).toBe('shopify.app.toml')
+  })
+
+  test('slugifies arbitrary strings into the filename pattern', () => {
+    expect(getAppConfigurationFileName('production')).toBe('shopify.app.production.toml')
+    expect(getAppConfigurationFileName('My Store')).toBe('shopify.app.my-store.toml')
+  })
+})
+
+describe('getAppConfigurationShorthand', () => {
+  test('returns undefined for the default config filename', () => {
+    expect(getAppConfigurationShorthand('shopify.app.toml')).toBeUndefined()
+    expect(getAppConfigurationShorthand('/some/path/shopify.app.toml')).toBeUndefined()
+  })
+
+  test('extracts the shorthand from a named config', () => {
+    expect(getAppConfigurationShorthand('shopify.app.production.toml')).toBe('production')
+    expect(getAppConfigurationShorthand('/path/to/shopify.app.staging.toml')).toBe('staging')
+    expect(getAppConfigurationShorthand('shopify.app.my-store.toml')).toBe('my-store')
+  })
+
+  test('returns undefined for non-matching filenames', () => {
+    expect(getAppConfigurationShorthand('random.toml')).toBeUndefined()
+    expect(getAppConfigurationShorthand('shopify.web.toml')).toBeUndefined()
+  })
+})
+
+describe('isValidFormatAppConfigurationFileName', () => {
+  test('returns true for valid app configuration filenames', () => {
+    expect(isValidFormatAppConfigurationFileName('shopify.app.toml')).toBe(true)
+    expect(isValidFormatAppConfigurationFileName('shopify.app.production.toml')).toBe(true)
+    expect(isValidFormatAppConfigurationFileName('shopify.app.my-store.toml')).toBe(true)
+    expect(isValidFormatAppConfigurationFileName('shopify.app.test_env.toml')).toBe(true)
+  })
+
+  test('returns false for invalid filenames', () => {
+    expect(isValidFormatAppConfigurationFileName('production')).toBe(false)
+    expect(isValidFormatAppConfigurationFileName('shopify.web.toml')).toBe(false)
+    expect(isValidFormatAppConfigurationFileName('shopify.app..toml')).toBe(false)
+    expect(isValidFormatAppConfigurationFileName('')).toBe(false)
+  })
+})

packages/app/src/cli/models/app/config-file-naming.ts

@@ -0,0 +1,42 @@
+import {configurationFileNames} from '../../constants.js'
+import {slugify} from '@shopify/cli-kit/common/string'
+import {basename} from '@shopify/cli-kit/node/path'
+
+const appConfigurationFileNameRegex = /^shopify\.app(\.[-\w]+)?\.toml$/
+export type AppConfigurationFileName = 'shopify.app.toml' | `shopify.app.${string}.toml`
+
+/**
+ * Gets the name of the app configuration file (e.g. `shopify.app.production.toml`) based on a provided config name.
+ *
+ * @param configName - Optional config name to base the file name upon
+ * @returns Either the default app configuration file name (`shopify.app.toml`), the given config name (if it matched the valid format), or `shopify.app.<config name>.toml` if it was an arbitrary string
+ */
+export function getAppConfigurationFileName(configName?: string): AppConfigurationFileName {
+  if (!configName) {
+    return configurationFileNames.app
+  }
+
+  if (isValidFormatAppConfigurationFileName(configName)) {
+    return configName
+  } else {
+    return `shopify.app.${slugify(configName)}.toml`
+  }
+}
+
+/**
+ * Given a path to an app configuration file, extract the shorthand section from the file name.
+ *
+ * This is undefined for `shopify.app.toml` files, or returns e.g. `production` for `shopify.app.production.toml`.
+ */
+export function getAppConfigurationShorthand(path: string) {
+  const match = basename(path).match(appConfigurationFileNameRegex)
+  return match?.[1]?.slice(1)
+}
+
+/** Checks if configName is a valid one (`shopify.app.toml`, or `shopify.app.<something>.toml`) */
+export function isValidFormatAppConfigurationFileName(configName: string): configName is AppConfigurationFileName {
+  if (appConfigurationFileNameRegex.test(configName)) {
+    return true
+  }
+  return false
+}