fix(deploy): keep --json stdout clean for a custom output directory

gu-stav · gu-stav · commit 939cb151c432 · 2026-07-01T18:08:28.000+02:00
The "Building to …" line and the overwrite prompt from the custom source-dir
path ran before runDeploy installs its stdout redirect, so the JSON payload was
no longer the only thing on stdout. Skip both in --json mode.
diff --git a/packages/@sanity/cli/src/commands/deploy.ts b/packages/@sanity/cli/src/commands/deploy.ts
@@ -112,9 +112,10 @@ export class DeployCommand extends SanityCommand<typeof DeployCommand> {
         relativeOutput = `./${relativeOutput}`
       }
 
-      // A dry run is non-interactive (a preview / CI gate), so don't block on the
-      // overwrite prompt — the local build still writes to the directory.
-      if (!flags['dry-run']) {
+      // A dry run or --json is non-interactive (a preview / CI gate or machine
+      // output), so don't block on the overwrite prompt — the local build still
+      // writes to the directory.
+      if (!flags['dry-run'] && !flags.json) {
         const isEmpty = await dirIsEmptyOrNonExistent(sourceDir)
         const shouldProceed =
           isEmpty ||
@@ -128,7 +129,8 @@ export class DeployCommand extends SanityCommand<typeof DeployCommand> {
         }
       }
 
-      this.output.log(`Building to ${relativeOutput}\n`)
+      // Keep stdout clean for --json; this human line would otherwise precede the payload
+      if (!flags.json) this.output.log(`Building to ${relativeOutput}\n`)
     }
 
     // A dry run is a non-interactive preview, so run unattended end-to-end — the
diff --git a/packages/@sanity/cli/test/integration/commands/deploy.studio.test.ts b/packages/@sanity/cli/test/integration/commands/deploy.studio.test.ts
@@ -321,6 +321,46 @@ describe('#deploy studio', () => {
     expect(plan.files).toContainEqual(expect.objectContaining({path: 'dist/index.html'}))
   })
 
+  test('keeps stdout pure JSON when --json is given a custom output directory', async () => {
+    const cwd = await testFixture('basic-studio')
+    process.cwd = () => cwd
+
+    const projectId = 'test-project-id'
+    const studioHost = 'existing-studio'
+
+    await mkdir(join(cwd, 'output'), {recursive: true})
+    await writeFile(join(cwd, 'output', 'index.html'), '<html></html>')
+
+    mockApi({
+      apiVersion: USER_APPLICATIONS_API_VERSION,
+      query: {appHost: studioHost, appType: 'studio'},
+      uri: `/projects/${projectId}/user-applications`,
+    }).reply(200, {
+      appHost: studioHost,
+      createdAt: '2024-01-01T00:00:00Z',
+      id: 'studio-app-id',
+      projectId,
+      title: 'Existing Studio',
+      type: 'studio',
+      updatedAt: '2024-01-01T00:00:00Z',
+      urlType: 'internal',
+    })
+
+    const {error, stdout} = await testCommand(
+      DeployCommand,
+      ['output', '--dry-run', '--json', '--no-build'],
+      {
+        config: {root: cwd},
+        mocks: {cliConfig: {api: {projectId}, studioHost}},
+      },
+    )
+
+    if (error) throw error
+    // The "Building to …" line must not precede the JSON payload
+    expect(stdout).not.toContain('Building to')
+    expect(() => JSON.parse(stdout)).not.toThrow()
+  })
+
   test('should output the deploy result as JSON with --json', async () => {
     const cwd = await testFixture('basic-studio')
     process.cwd = () => cwd

Original file line number	Diff line number	Diff line change
`@@ -112,9 +112,10 @@ export class DeployCommand extends SanityCommand<typeof DeployCommand> {`
`112`	`112`	relativeOutput = `./${relativeOutput}`
`113`	`113`	`}`
`114`	`114`
`115`		`- // A dry run is non-interactive (a preview / CI gate), so don't block on the`
`116`		`- // overwrite prompt — the local build still writes to the directory.`
`117`		`- if (!flags['dry-run']) {`
	`115`	`+ // A dry run or --json is non-interactive (a preview / CI gate or machine`
	`116`	`+ // output), so don't block on the overwrite prompt — the local build still`
	`117`	`+ // writes to the directory.`
	`118`	`+ if (!flags['dry-run'] && !flags.json) {`
`118`	`119`	`const isEmpty = await dirIsEmptyOrNonExistent(sourceDir)`
`119`	`120`	`const shouldProceed =`
`120`	`121`	`isEmpty \|\|`
`@@ -128,7 +129,8 @@ export class DeployCommand extends SanityCommand<typeof DeployCommand> {`
`128`	`129`	`}`
`129`	`130`	`}`
`130`	`131`
`131`		- this.output.log(`Building to ${relativeOutput}\n`)
	`132`	`+ // Keep stdout clean for --json; this human line would otherwise precede the payload`
	`133`	+ if (!flags.json) this.output.log(`Building to ${relativeOutput}\n`)
`132`	`134`	`}`
`133`	`135`
`134`	`136`	`// A dry run is a non-interactive preview, so run unattended end-to-end — the`