Add errors to TomlFile and Project, surface TOML parse failures in validate --json

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: ryancbahan

packages/app/src/cli/commands/app/config/validate.test.ts

@@ -3,26 +3,33 @@ import {linkedAppContext} from '../../../services/app-context.js'
 import {validateApp} from '../../../services/validate.js'
 import {testAppLinked} from '../../../models/app/app.test-data.js'
 import {Project} from '../../../models/project/project.js'
+import {selectActiveConfig} from '../../../models/project/active-config.js'
+import {errorsForConfig} from '../../../models/project/config-selection.js'
 import {outputResult} from '@shopify/cli-kit/node/output'
+import {TomlFile} from '@shopify/cli-kit/node/toml/toml-file'
 import {describe, expect, test, vi} from 'vitest'
 
 vi.mock('../../../services/app-context.js')
 vi.mock('../../../services/validate.js')
 vi.mock('../../../models/project/project.js')
+vi.mock('../../../models/project/active-config.js')
+vi.mock('../../../models/project/config-selection.js')
 vi.mock('@shopify/cli-kit/node/output', async (importOriginal) => {
   const actual = await importOriginal<typeof import('@shopify/cli-kit/node/output')>()
   return {...actual, outputResult: vi.fn()}
 })
 vi.mock('@shopify/cli-kit/node/ui')
 
-function mockProjectWithNoErrors() {
+function mockHealthyProject() {
   vi.mocked(Project.load).mockResolvedValue({errors: []} as unknown as Project)
+  vi.mocked(selectActiveConfig).mockResolvedValue({file: new TomlFile('shopify.app.toml', {})} as any)
+  vi.mocked(errorsForConfig).mockReturnValue([])
 }
 
 describe('app config validate command', () => {
   test('calls validateApp with json: false by default', async () => {
     const app = testAppLinked()
-    mockProjectWithNoErrors()
+    mockHealthyProject()
     vi.mocked(linkedAppContext).mockResolvedValue({app} as Awaited<ReturnType<typeof linkedAppContext>>)
     vi.mocked(validateApp).mockResolvedValue()
 
@@ -33,7 +40,7 @@ describe('app config validate command', () => {
 
   test('calls validateApp with json: true when --json flag is passed', async () => {
     const app = testAppLinked()
-    mockProjectWithNoErrors()
+    mockHealthyProject()
     vi.mocked(linkedAppContext).mockResolvedValue({app} as Awaited<ReturnType<typeof linkedAppContext>>)
     vi.mocked(validateApp).mockResolvedValue()
 
@@ -44,7 +51,7 @@ describe('app config validate command', () => {
 
   test('calls validateApp with json: true when -j flag is passed', async () => {
     const app = testAppLinked()
-    mockProjectWithNoErrors()
+    mockHealthyProject()
     vi.mocked(linkedAppContext).mockResolvedValue({app} as Awaited<ReturnType<typeof linkedAppContext>>)
     vi.mocked(validateApp).mockResolvedValue()
 
@@ -53,10 +60,12 @@ describe('app config validate command', () => {
     expect(validateApp).toHaveBeenCalledWith(app, {json: true})
   })
 
-  test('outputs JSON issues when project has TOML parse errors', async () => {
-    vi.mocked(Project.load).mockResolvedValue({
-      errors: [{path: '/app/shopify.app.toml', message: 'Unexpected character at row 1, col 5'}],
-    } as unknown as Project)
+  test('outputs JSON issues when active config has TOML parse errors', async () => {
+    vi.mocked(Project.load).mockResolvedValue({errors: []} as unknown as Project)
+    vi.mocked(selectActiveConfig).mockResolvedValue({file: new TomlFile('shopify.app.toml', {})} as any)
+    vi.mocked(errorsForConfig).mockReturnValue([
+      {path: '/app/shopify.app.toml', message: 'Unexpected character at row 1, col 5'} as any,
+    ])
 
     await expect(Validate.run(['--json'], import.meta.url)).rejects.toThrow()
 

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

@@ -2,6 +2,8 @@ import {appFlags} from '../../../flags.js'
 import {validateApp} from '../../../services/validate.js'
 import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-linked-command.js'
 import {linkedAppContext} from '../../../services/app-context.js'
+import {selectActiveConfig} from '../../../models/project/active-config.js'
+import {errorsForConfig} from '../../../models/project/config-selection.js'
 import {Project} from '../../../models/project/project.js'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {AbortError, AbortSilentError} from '@shopify/cli-kit/node/error'
@@ -24,9 +26,7 @@ export default class Validate extends AppLinkedCommand {
   public async run(): Promise<AppLinkedCommandOutput> {
     const {flags} = await this.parse(Validate)
 
-    // Check for TOML parse errors before attempting to link/load.
-    // If the active config has parse errors, report them directly
-    // instead of falling into the linking flow.
+    // Stage 1: Load project
     let project: Project
     try {
       project = await Project.load(flags.path)
@@ -39,8 +39,22 @@ export default class Validate extends AppLinkedCommand {
       throw err
     }
 
-    if (project.errors.length > 0) {
-      const issues = project.errors.map((err) => ({file: err.path, message: err.message}))
+    // Stage 2: Select active config and check for TOML parse errors scoped to it
+    let activeConfig
+    try {
+      activeConfig = await selectActiveConfig(project, flags.config)
+    } catch (err) {
+      if (err instanceof AbortError && flags.json) {
+        const message = unstyled(stringifyMessage(err.message)).trim()
+        outputResult(JSON.stringify({valid: false, issues: [{message}]}, null, 2))
+        throw new AbortSilentError()
+      }
+      throw err
+    }
+
+    const configErrors = errorsForConfig(project, activeConfig.file)
+    if (configErrors.length > 0) {
+      const issues = configErrors.map((err) => ({file: err.path, message: err.message}))
       if (flags.json) {
         outputResult(JSON.stringify({valid: false, issues}, null, 2))
         throw new AbortSilentError()
@@ -52,6 +66,7 @@ export default class Validate extends AppLinkedCommand {
       throw new AbortSilentError()
     }
 
+    // Stage 3: Load app (link + remote fetch + schema validation)
     let app
     try {
       const context = await linkedAppContext({
@@ -65,7 +80,6 @@ export default class Validate extends AppLinkedCommand {
     } catch (err) {
       // Only catch config validation errors for JSON output. Auth/linking/remote
       // failures should propagate normally — they aren't validation results.
-      // This is a workaround while we consider more granular error types -- today most everything is AbortError.
       const message = err instanceof AbortError ? unstyled(stringifyMessage(err.message)).trim() : ''
       const isValidationError = message.startsWith('Validation errors in ')
       if (isValidationError && flags.json) {

packages/app/src/cli/models/project/config-selection.ts

@@ -4,7 +4,7 @@ import {getAppConfigurationShorthand} from '../app/loader.js'
 import {dotEnvFileNames} from '../../constants.js'
 import {patchAppHiddenConfigFile} from '../../services/app/patch-app-configuration-file.js'
 import {getOrCreateAppConfigHiddenPath} from '../../utilities/app/config/hidden-app-config.js'
-import {TomlFile} from '@shopify/cli-kit/node/toml/toml-file'
+import {TomlFile, TomlFileError} from '@shopify/cli-kit/node/toml/toml-file'
 import {DotEnvFile} from '@shopify/cli-kit/node/dot-env'
 import {matchGlob} from '@shopify/cli-kit/node/fs'
 import {relativePath} from '@shopify/cli-kit/node/path'
@@ -112,3 +112,29 @@ export function webFilesForConfig(project: Project, activeConfig: TomlFile): Tom
     return globPatterns.some((pattern) => matchGlob(relPath, pattern))
   })
 }
+
+/**
+ * Filter project.errors to only those relevant to the active config:
+ * the active config file itself, plus extension/web TOMLs in its directories.
+ * @public
+ */
+export function errorsForConfig(project: Project, activeConfig: TomlFile): TomlFileError[] {
+  const extDirs = activeConfig.content.extension_directories
+  const extPatterns = (Array.isArray(extDirs) && extDirs.length > 0 ? (extDirs as string[]) : ['extensions/*']).map(
+    (dir) => `${dir}/*.extension.toml`,
+  )
+
+  const webDirs = activeConfig.content.web_directories
+  const webPatterns =
+    Array.isArray(webDirs) && webDirs.length > 0
+      ? (webDirs as string[]).map((dir) => `${dir}/shopify.web.toml`)
+      : ['**/shopify.web.toml']
+
+  const allPatterns = [...extPatterns, ...webPatterns]
+
+  return project.errors.filter((err) => {
+    if (err.path === activeConfig.path) return true
+    const relPath = relativePath(project.directory, err.path).replace(/\\/g, '/')
+    return allPatterns.some((pattern) => matchGlob(relPath, pattern))
+  })
+}

packages/app/src/cli/services/app-context.ts

@@ -177,6 +177,11 @@ export async function localAppContext({
   userProvidedConfigName,
 }: LocalAppContextOptions): Promise<LocalAppContextOutput> {
   const {project, activeConfig} = await getAppConfigurationContext(directory, userProvidedConfigName)
+
+  if (activeConfig.file.errors.length > 0) {
+    throw new AbortError(activeConfig.file.errors.map((err) => err.message).join('\n'))
+  }
+
   const specifications = await loadLocalExtensionsSpecifications()
   const app = await loadAppFromContext({project, activeConfig, specifications, ignoreUnknownExtensions: true})