test(cli-e2e): add comprehensive init E2E tests

.claude/settings.json

@@ -1,4 +1,7 @@
 {
+  "permissions": {
+    "deny": ["Read(**/.env)"]
+  },
   "hooks": {
     "PostToolUse": [
       {

.github/workflows/e2e-scheduled.yml

@@ -35,6 +35,14 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
+      - name: Restore Vitest cache
+        uses: actions/cache@v5
+        with:
+          path: packages/@sanity/cli-e2e/node_modules/.vite/vitest
+          key: vitest-e2e-scheduled-cache-${{ matrix.os }}-node${{ matrix.node-version }}-${{ github.run_id }}
+          restore-keys: |
+            vitest-e2e-scheduled-cache-${{ matrix.os }}-node${{ matrix.node-version }}-
+
       - name: Install CLI from npm
         run: |
           CLI_VERSION="${{ inputs.cli_version || 'latest' }}"
@@ -54,6 +62,7 @@ jobs:
           SANITY_E2E_TOKEN: ${{ secrets.SANITY_E2E_TOKEN }}
           SANITY_E2E_PROJECT_ID: ${{ secrets.SANITY_E2E_PROJECT_ID }}
           SANITY_E2E_DATASET: ${{ secrets.SANITY_E2E_DATASET }}
+          SANITY_E2E_ORGANIZATION_ID: ${{ secrets.SANITY_E2E_ORGANIZATION_ID }}
         run: pnpm --filter @sanity/cli-e2e test
 
   notify-failure:

.github/workflows/e2e.yml

@@ -45,6 +45,8 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         node-version: [20, 22, 24]
+        shardIndex: [1, 2]
+        shardTotal: [2]
       fail-fast: false
 
     steps:
@@ -55,6 +57,14 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
+      - name: Restore Vitest cache
+        uses: actions/cache@v5
+        with:
+          path: packages/@sanity/cli-e2e/node_modules/.vite/vitest
+          key: vitest-e2e-cache-${{ matrix.os }}-node${{ matrix.node-version }}-shard${{ matrix.shardIndex }}-${{ github.run_id }}
+          restore-keys: |
+            vitest-e2e-cache-${{ matrix.os }}-node${{ matrix.node-version }}-shard${{ matrix.shardIndex }}-
+
       - name: Build CLI
         run: pnpm build:cli
 
@@ -63,7 +73,8 @@ jobs:
           SANITY_E2E_TOKEN: ${{ secrets.SANITY_E2E_TOKEN }}
           SANITY_E2E_PROJECT_ID: ${{ secrets.SANITY_E2E_PROJECT_ID }}
           SANITY_E2E_DATASET: ${{ secrets.SANITY_E2E_DATASET }}
-        run: pnpm --filter @sanity/cli-e2e test
+          SANITY_E2E_ORGANIZATION_ID: ${{ secrets.SANITY_E2E_ORGANIZATION_ID }}
+        run: pnpm --filter @sanity/cli-e2e test --shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
 
   e2e-status:
     if: always()

AGENTS.md

@@ -12,6 +12,8 @@ All commands are run from the root of the repo.
 - `pnpm check:deps` - unused dependency / export check
 - `pnpm build:cli` - build the project
 - `pnpm watch:cli` - build in watch mode
+- `pnpm --filter @sanity/cli-e2e exec vitest run <file>` - run specific e2e test file
+- `pnpm --filter @sanity/cli-e2e exec vitest run <file> -t "<pattern>"` - run specific e2e test by name
 
 # Workflow
 

packages/@sanity/cli-e2e/.env.example

@@ -1,2 +1,3 @@
 SANITY_E2E_TOKEN=
 SANITY_E2E_PROJECT_ID=
+SANITY_E2E_ORGANIZATION_ID=

packages/@sanity/cli-e2e/__tests__/init/init.app.test.ts

@@ -0,0 +1,130 @@
+import {existsSync, readFileSync} from 'node:fs'
+
+import {createTmpDir} from '@sanity/cli-test'
+import {afterEach, beforeEach, describe, expect, test} from 'vitest'
+
+import {getE2EDataset, getE2EOrganizationId, getE2EProjectId, runCli} from '../../helpers/runCli.js'
+
+const orgId = getE2EOrganizationId()
+const projectId = getE2EProjectId()
+const dataset = getE2EDataset()
+
+describe('sanity init - app', {timeout: 120_000}, () => {
+  let tmp: Awaited<ReturnType<typeof createTmpDir>>
+
+  beforeEach(async () => {
+    tmp = await createTmpDir({useSystemTmp: true})
+  })
+
+  afterEach(async () => {
+    await tmp.cleanup()
+  })
+
+  describe.each([
+    {label: 'with -y flag', yFlag: ['-y']},
+    {label: 'unattended (no -y)', yFlag: [] as string[]},
+  ])('non-interactive ($label)', ({yFlag}) => {
+    test('creates app with app-quickstart template', async () => {
+      const {error, exitCode, stdout} = await runCli({
+        args: [
+          'init',
+          ...yFlag,
+          '--template',
+          'app-quickstart',
+          '--organization',
+          orgId,
+          '--output-path',
+          tmp.path,
+          '--typescript',
+          '--package-manager',
+          'pnpm',
+          '--no-git',
+        ],
+      })
+
+      if (error) throw error
+      expect(exitCode).toBe(0)
+
+      expect(existsSync(`${tmp.path}/src/App.tsx`)).toBe(true)
+      expect(existsSync(`${tmp.path}/package.json`)).toBe(true)
+
+      const cliConfig = readFileSync(`${tmp.path}/sanity.cli.ts`, 'utf8')
+      expect(cliConfig).toContain('organizationId')
+      expect(cliConfig).toContain('entry')
+
+      expect(existsSync(`${tmp.path}/sanity.config.ts`)).toBe(false)
+
+      expect(stdout).toMatch(/app has been scaffolded|Success/i)
+    })
+
+    test('scaffolds app with --project and --dataset', async () => {
+      const {error, exitCode} = await runCli({
+        args: [
+          'init',
+          ...yFlag,
+          '--template',
+          'app-quickstart',
+          '--project',
+          projectId,
+          '--dataset',
+          dataset,
+          '--output-path',
+          tmp.path,
+          '--package-manager',
+          'pnpm',
+          '--no-git',
+        ],
+      })
+
+      if (error) throw error
+      expect(exitCode).toBe(0)
+
+      const appTsx = readFileSync(`${tmp.path}/src/App.tsx`, 'utf8')
+      expect(appTsx).toContain(projectId)
+      expect(appTsx).toContain(dataset)
+
+      const cliConfig = readFileSync(`${tmp.path}/sanity.cli.ts`, 'utf8')
+      expect(cliConfig).toContain(orgId)
+    })
+  })
+
+  test('complete interactive flow selects project and dataset', async () => {
+    const session = await runCli({
+      args: [
+        'init',
+        '--template',
+        'app-quickstart',
+        '--organization',
+        orgId,
+        '--output-path',
+        tmp.path,
+        '--no-git',
+        '--no-mcp',
+      ],
+      interactive: true,
+    })
+
+    await session.waitForText(/Configure a project for this app/i)
+    await session.selectOption(new RegExp(`\\(${projectId}\\)`))
+
+    await session.waitForText(/Select dataset to use/i)
+    await session.selectOption(dataset)
+
+    await session.waitForText(/Package manager to use/i)
+    await session.selectOption('pnpm')
+
+    const exitCode = await session.waitForExit(90_000)
+    expect(exitCode).toBe(0)
+
+    expect(existsSync(`${tmp.path}/src/App.tsx`)).toBe(true)
+    expect(existsSync(`${tmp.path}/package.json`)).toBe(true)
+    expect(existsSync(`${tmp.path}/sanity.cli.ts`)).toBe(true)
+
+    const cliConfig = readFileSync(`${tmp.path}/sanity.cli.ts`, 'utf8')
+    expect(cliConfig).toContain('organizationId')
+
+    const output = session.getOutput()
+    expect(output).toContain('Your custom app has been scaffolded')
+    expect(output).toMatch(/Configured with project .+ and dataset/)
+  })
+})

packages/@sanity/cli-e2e/__tests__/init/init.nextjs.test.ts

@@ -0,0 +1,190 @@
+import {existsSync, readFileSync} from 'node:fs'
+import {rm} from 'node:fs/promises'
+import {join} from 'node:path'
+
+import {testFixture} from '@sanity/cli-test'
+import {afterEach, beforeEach, describe, expect, test} from 'vitest'
+
+import {getE2EProjectId, runCli} from '../../helpers/runCli.js'
+
+const projectId = getE2EProjectId()
+
+describe('sanity init - Next.js integration', {timeout: 120_000}, () => {
+  let nextjsDir: string
+
+  beforeEach(async () => {
+    nextjsDir = await testFixture('nextjs-app', {useSystemTmp: true})
+    await rm(join(nextjsDir, 'node_modules'), {force: true, recursive: true})
+  })
+
+  afterEach(async () => {
+    if (nextjsDir) await rm(nextjsDir, {force: true, recursive: true})
+  })
+
+  describe.each([
+    {label: 'with -y flag', yFlag: ['-y']},
+    {label: 'unattended (no -y)', yFlag: [] as string[]},
+  ])('non-interactive ($label)', ({yFlag}) => {
+    test('creates sanity config, schema, and cli files with --nextjs-add-config-files', async () => {
+      const {error, exitCode} = await runCli({
+        args: [
+          'init',
+          ...yFlag,
+          '--project',
+          projectId,
+          '--dataset',
+          'production',
+          '--nextjs-add-config-files',
+          '--package-manager',
+          'pnpm',
+        ],
+        cwd: nextjsDir,
+      })
+
+      if (error) throw error
+      expect(exitCode).toBe(0)
+
+      expect(existsSync(`${nextjsDir}/sanity.config.ts`)).toBe(true)
+      expect(existsSync(`${nextjsDir}/sanity/schemaTypes/index.ts`)).toBe(true)
+
+      const cliConfig = readFileSync(`${nextjsDir}/sanity.cli.ts`, 'utf8')
+      expect(cliConfig).toContain('NEXT_PUBLIC_SANITY_PROJECT_ID')
+    })
+
+    test('creates embedded studio route with --nextjs-embed-studio', async () => {
+      const {error, exitCode} = await runCli({
+        args: [
+          'init',
+          ...yFlag,
+          '--project',
+          projectId,
+          '--dataset',
+          'production',
+          '--nextjs-add-config-files',
+          '--nextjs-embed-studio',
+          '--package-manager',
+          'pnpm',
+        ],
+        cwd: nextjsDir,
+      })
+
+      if (error) throw error
+      expect(exitCode).toBe(0)
+      expect(existsSync(`${nextjsDir}/app/studio/[[...tool]]/page.tsx`)).toBe(true)
+    })
+
+    test('writes env variables to .env.local with --nextjs-append-env', async () => {
+      const {error, exitCode} = await runCli({
+        args: [
+          'init',
+          ...yFlag,
+          '--project',
+          projectId,
+          '--dataset',
+          'production',
+          '--nextjs-add-config-files',
+          '--nextjs-append-env',
+          '--package-manager',
+          'pnpm',
+        ],
+        cwd: nextjsDir,
+      })
+
+      if (error) throw error
+      expect(exitCode).toBe(0)
+
+      const envContent = readFileSync(`${nextjsDir}/.env.local`, 'utf8')
+      expect(envContent).toContain('NEXT_PUBLIC_SANITY_PROJECT_ID')
+      expect(envContent).toContain('NEXT_PUBLIC_SANITY_DATASET')
+    })
+  })
+
+  describe('interactive', () => {
+    test('detects Next.js and completes with config files', async () => {
+      const session = await runCli({
+        args: [
+          'init',
+          '--project',
+          projectId,
+          '--dataset',
+          'production',
+          '--package-manager',
+          'pnpm',
+          '--no-mcp',
+          '--no-git',
+        ],
+        cwd: nextjsDir,
+        interactive: true,
+      })
+
+      await session.waitForText(/Would you like to add configuration files/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Do you want to use TypeScript/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Would you like an embedded Sanity Studio/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/What route do you want to use for the Studio/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Select project template to use/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Would you like to add the project ID and dataset/i)
+      session.sendKey('Enter')
+
+      const exitCode = await session.waitForExit(90_000)
+      expect(exitCode).toBe(0)
+
+      expect(existsSync(`${nextjsDir}/sanity.config.ts`)).toBe(true)
+
+      const output = session.getOutput()
+      expect(output).toMatch(/\/studio/i)
+      expect(output).not.toMatch(/Project output path/i)
+    })
+
+    test('accepts custom studio route', async () => {
+      const session = await runCli({
+        args: [
+          'init',
+          '--project',
+          projectId,
+          '--dataset',
+          'production',
+          '--package-manager',
+          'pnpm',
+          '--no-mcp',
+          '--no-git',
+        ],
+        cwd: nextjsDir,
+        interactive: true,
+      })
+
+      await session.waitForText(/Would you like to add configuration files/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Do you want to use TypeScript/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Would you like an embedded Sanity Studio/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/What route do you want to use for the Studio/i)
+      session.write('/admin\n')
+
+      await session.waitForText(/Select project template to use/i)
+      session.sendKey('Enter')
+
+      await session.waitForText(/Would you like to add the project ID and dataset/i)
+      session.sendKey('Enter')
+
+      const exitCode = await session.waitForExit(90_000)
+      expect(exitCode).toBe(0)
+
+      expect(existsSync(`${nextjsDir}/app/admin/[[...tool]]/page.tsx`)).toBe(true)
+      expect(existsSync(`${nextjsDir}/sanity.config.ts`)).toBe(true)
+    })
+  })
+})