fix: schema extract path always appends schema.json (#686)

Author: rexxars

packages/@sanity/cli/src/actions/schema/__tests__/getExtractOptions.test.ts

@@ -1,3 +1,5 @@
+import {mkdtempSync, writeFileSync} from 'node:fs'
+import {tmpdir} from 'node:os'
 import {join, resolve} from 'node:path'
 
 import {describe, expect, test} from 'vitest'
@@ -69,6 +71,101 @@ describe('getExtractOptions', () => {
     })
   })
 
+  test('should append schema.json when path points to an existing directory', () => {
+    const tempDir = mkdtempSync(join(tmpdir(), 'schema-test-'))
+    const projectRoot = {
+      directory: tempDir,
+      path: join(tempDir, 'sanity.config.ts'),
+      type: 'studio' as const,
+    }
+
+    const result = getExtractOptions({
+      flags: {
+        format: 'groq-type-nodes',
+        path: '.', // current dir - definitely exists
+        watch: false,
+        'watch-patterns': undefined,
+        workspace: undefined,
+      } as ExtractSchemaCommand['flags'],
+      projectRoot,
+      schemaExtraction: undefined,
+    })
+
+    expect(result.outputPath).toEqual(join(tempDir, 'schema.json'))
+  })
+
+  test('should treat path with .json extension as a file path', () => {
+    const result = getExtractOptions({
+      flags: {
+        format: 'groq-type-nodes',
+        path: './schema.json',
+        watch: false,
+        'watch-patterns': undefined,
+        workspace: undefined,
+      } as ExtractSchemaCommand['flags'],
+      projectRoot: mockProjectRoot,
+      schemaExtraction: undefined,
+    })
+
+    expect(result.outputPath).toEqual(resolve(join('/test/project', 'schema.json')))
+  })
+
+  test('should treat path with .json extension in subdirectory as a file path', () => {
+    const result = getExtractOptions({
+      flags: {
+        format: 'groq-type-nodes',
+        path: 'output/my-schema.json',
+        watch: false,
+        'watch-patterns': undefined,
+        workspace: undefined,
+      } as ExtractSchemaCommand['flags'],
+      projectRoot: mockProjectRoot,
+      schemaExtraction: undefined,
+    })
+
+    expect(result.outputPath).toEqual(resolve(join('/test/project', 'output', 'my-schema.json')))
+  })
+
+  test('should treat path with non-.json extension as a file path', () => {
+    const result = getExtractOptions({
+      flags: {
+        format: 'groq-type-nodes',
+        path: 'output/my-schema.yaml',
+        watch: false,
+        'watch-patterns': undefined,
+        workspace: undefined,
+      } as ExtractSchemaCommand['flags'],
+      projectRoot: mockProjectRoot,
+      schemaExtraction: undefined,
+    })
+
+    expect(result.outputPath).toEqual(resolve(join('/test/project', 'output', 'my-schema.yaml')))
+  })
+
+  test('should respect .json file path when file exists on disk', () => {
+    const tempDir = mkdtempSync(join(tmpdir(), 'schema-test-'))
+    writeFileSync(join(tempDir, 'schema.json'), '{}')
+    const projectRoot = {
+      directory: tempDir,
+      path: join(tempDir, 'sanity.config.ts'),
+      type: 'studio' as const,
+    }
+
+    const result = getExtractOptions({
+      flags: {
+        format: 'groq-type-nodes',
+        path: 'schema.json',
+        watch: false,
+        'watch-patterns': undefined,
+        workspace: undefined,
+      } as ExtractSchemaCommand['flags'],
+      projectRoot,
+      schemaExtraction: undefined,
+    })
+
+    expect(result.outputPath).toEqual(join(tempDir, 'schema.json'))
+  })
+
   test('should use default values when neither flags nor CLI config are provided', () => {
     const result = getExtractOptions({
       flags: {
@@ -86,7 +183,7 @@ describe('getExtractOptions', () => {
       configPath: '/test/project/sanity.config.ts',
       enforceRequiredFields: false,
       format: 'groq-type-nodes',
-      outputPath: join('/test/project', 'schema.json'),
+      outputPath: resolve(join('/test/project', 'schema.json')),
       watchPatterns: [],
       workspace: undefined,
     })

packages/@sanity/cli/src/actions/schema/getExtractOptions.ts

@@ -1,4 +1,5 @@
-import {join, resolve} from 'node:path'
+import {existsSync, statSync} from 'node:fs'
+import {extname, join, resolve} from 'node:path'
 
 import {type CliConfig, ProjectRootResult} from '@sanity/cli-core'
 
@@ -25,10 +26,19 @@ export function getExtractOptions({
   schemaExtraction,
 }: GetExtractionOptions): ExtractOptions {
   const pathFlag = flags.path ?? schemaExtraction?.path
-  const outputDir = pathFlag
-    ? resolve(join(projectRoot.directory, pathFlag))
-    : projectRoot.directory
-  const outputPath = join(outputDir, 'schema.json')
+  let outputPath: string
+  if (pathFlag) {
+    const resolved = resolve(join(projectRoot.directory, pathFlag))
+    const isExistingDirectory = existsSync(resolved) && statSync(resolved).isDirectory()
+
+    if (isExistingDirectory || !extname(resolved)) {
+      outputPath = join(resolved, 'schema.json')
+    } else {
+      outputPath = resolved
+    }
+  } else {
+    outputPath = resolve(join(projectRoot.directory, 'schema.json'))
+  }
 
   return {
     configPath: projectRoot.path,

packages/@sanity/cli/src/commands/schema/__tests__/extract.test.ts

@@ -105,7 +105,7 @@ describe('#schema:extract', {timeout: 60 * 1000}, () => {
     expect(existsSync(resolve(cwd, 'schema.json'))).toBe(true)
   })
 
-  test('should extract schema with path flag', async () => {
+  test('should extract schema with path flag (directory)', async () => {
     const cwd = await testFixture('basic-studio')
     process.chdir(cwd)
 
@@ -117,6 +117,18 @@ describe('#schema:extract', {timeout: 60 * 1000}, () => {
     expect(existsSync(resolve(cwd, 'custom-output', 'schema.json'))).toBe(true)
   })
 
+  test('should extract schema with path flag (file path with .json extension)', async () => {
+    const cwd = await testFixture('basic-studio')
+    process.chdir(cwd)
+
+    const {error, stderr} = await testCommand(ExtractSchemaCommand, ['--path', './my-schema.json'])
+
+    if (error) throw error
+    expect(stderr).toContain('Extracting schema')
+    expect(stderr).toContain('Extracted schema')
+    expect(existsSync(resolve(cwd, 'my-schema.json'))).toBe(true)
+  })
+
   test('throws an error if format flag is not groq-type-nodes', async () => {
     const cwd = await testFixture('basic-studio')
     process.chdir(cwd)