fix(cli): improve error handling on missing extracted schema (#6204)

* fix(cli): allow `--config-path` flag for `typegen generate` command

* fix(cli): improve error handling on missing extracted schema

* fix(cli): rethrow error if schema file cannot be read

Co-authored-by: Sindre Gulseth <sgulseth@gmail.com>

* refactor(cli): allow only dash-cased `--config-path` for typegen

* fix(cli): use correct check for schema path not being a file

---------

Co-authored-by: Sindre Gulseth <sgulseth@gmail.com>

packages/@sanity/cli/src/actions/typegen/generateAction.ts

@@ -1,4 +1,4 @@
-import {constants, open} from 'node:fs/promises'
+import {constants, open, stat} from 'node:fs/promises'
 import {join} from 'node:path'
 
 import {readConfig} from '@sanity/codegen'
@@ -13,7 +13,7 @@ import {
 import {TypesGeneratedTrace} from './generate.telemetry'
 
 export interface TypegenGenerateTypesCommandFlags {
-  configPath?: string
+  'config-path'?: string
 }
 
 const generatedFileWarning = `/**
@@ -40,8 +40,22 @@ export default async function typegenGenerateAction(
   const trace = telemetry.trace(TypesGeneratedTrace)
   trace.start()
 
-  const codegenConfig = await readConfig(flags.configPath || 'sanity-typegen.json')
-
+  const codegenConfig = await readConfig(flags['config-path'] || 'sanity-typegen.json')
+
+  try {
+    const schemaStats = await stat(codegenConfig.schema)
+    if (!schemaStats.isFile()) {
+      throw new Error(`Schema path is not a file: ${codegenConfig.schema}`)
+    }
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      // If the user has not provided a specific schema path (eg we're using the default), give some help
+      const hint =
+        codegenConfig.schema === './schema.json' ? ` - did you run "sanity schema extract"?` : ''
+      throw new Error(`Schema file not found: ${codegenConfig.schema}${hint}`)
+    }
+    throw err
+  }
   const workerPath = await getCliWorkerPath('typegenGenerate')
 
   const spinner = output.spinner({}).start('Generating types')

packages/@sanity/cli/src/commands/typegen/generateTypesCommand.ts

@@ -10,6 +10,10 @@ Usage
   sanity typegen generate [options]
 
 Options:
+  --config-path <path>
+    Specifies the path to the typegen configuration file. This file should be a JSON file that contains settings for the type generation process.
+    Default: "sanity-typegen.json"
+
   --help, -h
     Displays this help message, providing information on command usage and options.
 

packages/@sanity/cli/test/__fixtures__/v3/folder-typegen.json

@@ -0,0 +1,3 @@
+{
+  "schema": "./components"
+}

packages/@sanity/cli/test/__fixtures__/v3/missing-typegen.json

@@ -0,0 +1,3 @@
+{
+  "schema": "./custom-schema.json"
+}

packages/@sanity/cli/test/__fixtures__/v3/working-schema.json

@@ -0,0 +1,84 @@
+[
+  {
+    "name": "person",
+    "type": "document",
+    "attributes": {
+      "_id": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string"
+        }
+      },
+      "_type": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string",
+          "value": "person"
+        }
+      },
+      "_createdAt": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string"
+        }
+      },
+      "_updatedAt": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string"
+        }
+      },
+      "_rev": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string"
+        }
+      },
+      "name": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "string"
+        },
+        "optional": true
+      },
+      "slug": {
+        "type": "objectAttribute",
+        "value": {
+          "type": "inline",
+          "name": "slug"
+        },
+        "optional": true
+      }
+    }
+  },
+  {
+    "name": "slug",
+    "type": "type",
+    "value": {
+      "type": "object",
+      "attributes": {
+        "_type": {
+          "type": "objectAttribute",
+          "value": {
+            "type": "string",
+            "value": "slug"
+          }
+        },
+        "current": {
+          "type": "objectAttribute",
+          "value": {
+            "type": "string"
+          },
+          "optional": true
+        },
+        "source": {
+          "type": "objectAttribute",
+          "value": {
+            "type": "string"
+          },
+          "optional": true
+        }
+      }
+    }
+  }
+]

packages/@sanity/cli/test/__fixtures__/v3/working-typegen.json

@@ -0,0 +1,3 @@
+{
+  "schema": "./working-schema.json"
+}

packages/@sanity/cli/test/typegen.test.ts

@@ -0,0 +1,48 @@
+import {expect, test} from '@jest/globals'
+
+import {describeCliTest} from './shared/describe'
+import {runSanityCmdCommand} from './shared/environment'
+
+describeCliTest('CLI: `sanity typegen`', () => {
+  test('sanity typegen generate: missing schema, default path', async () => {
+    const err = await runSanityCmdCommand('v3', ['typegen', 'generate']).catch((error) => error)
+    expect(err.code).toBe(1)
+    expect(err.stderr).toContain('did you run "sanity schema extract"')
+    expect(err.stderr).toContain('Schema file not found')
+  })
+
+  test('sanity typegen generate: missing schema, custom path', async () => {
+    const err = await runSanityCmdCommand('v3', [
+      'typegen',
+      'generate',
+      '--config-path',
+      'missing-typegen.json',
+    ]).catch((error) => error)
+    expect(err.code).toBe(1)
+    expect(err.stderr).not.toContain('did you run "sanity schema extract"')
+    expect(err.stderr).toContain('custom-schema.json')
+  })
+
+  test('sanity typegen generate: typegen config is not a file', async () => {
+    const err = await runSanityCmdCommand('v3', [
+      'typegen',
+      'generate',
+      '--config-path',
+      'folder-typegen.json',
+    ]).catch((error) => error)
+    expect(err.code).toBe(1)
+    expect(err.stderr).toContain('Schema path is not a file')
+  })
+
+  test('sanity typegen generate: working schema', async () => {
+    const result = await runSanityCmdCommand('v3', [
+      'typegen',
+      'generate',
+      '--config-path',
+      'working-typegen.json',
+    ])
+
+    expect(result.code).toBe(0)
+    expect(result.stderr).toContain('Generated TypeScript types for 2 schema types')
+  })
+})