@sanity/cli-test 0.2.0 → 0.2.1

package/dist/index.d.ts

@@ -1,38 +1,39 @@
-import {CliConfig} from '@sanity/cli-core'
-import {ClientConfig} from '@sanity/client'
-import {CLITelemetryStore} from '@sanity/cli-core'
-import {Command} from '@oclif/core'
-import {Config} from '@oclif/core'
-import {Errors} from '@oclif/core'
-import {Hook} from '@oclif/core/hooks'
-import {Hooks} from '@oclif/core/hooks'
-import nock from 'nock'
-import {ProjectRootResult} from '@sanity/cli-core'
-import {SanityClient} from '@sanity/client'
-import {SanityCommand} from '@sanity/cli-core'
-import {TestProject} from 'vitest/node'
-import {vi} from 'vitest'
+import { CliConfig } from "@sanity/cli-core";
+import { ClientConfig } from "@sanity/client";
+import { CLITelemetryStore } from "@sanity/cli-core";
+import { Command } from "@oclif/core";
+import { Config } from "@oclif/core";
+import { Errors } from "@oclif/core";
+import { Hook } from "@oclif/core/hooks";
+import { Hooks } from "@oclif/core/hooks";
+import nock from "nock";
+import { ProjectRootResult } from "@sanity/cli-core";
+import { SanityClient } from "@sanity/client";
+import { SanityCommand } from "@sanity/cli-core";
+import { TestProject } from "vitest/node";
+import { vi } from "vitest";
 
 declare interface CaptureOptions {
   /**
    * Whether to print the output to the console
    */
-  print?: boolean
+  print?: boolean;
   /**
    * Whether to strip ANSI escape codes from the output
    */
-  stripAnsi?: boolean
-  testNodeEnv?: string
+  stripAnsi?: boolean;
+  testNodeEnv?: string;
 }
 
 declare interface CaptureResult<T = unknown> {
-  stderr: string
-  stdout: string
-  error?: Error & Partial<Errors.CLIError>
-  result?: T
+  stderr: string;
+  stdout: string;
+  error?: Error & Partial<Errors.CLIError>;
+  result?: T;
 }
 
-declare type CommandClass = (new (argv: string[], config: Config) => Command) & typeof Command
+declare type CommandClass = (new (argv: string[], config: Config) => Command) &
+  typeof Command;
 
 /**
  * Converts Unix-style paths to platform-appropriate paths.
@@ -45,7 +46,7 @@ declare type CommandClass = (new (argv: string[], config: Config) => Command) &
  * @returns Platform-appropriate path
  * @internal
  */
-export declare function convertToSystemPath(pathStr: string): string
+export declare function convertToSystemPath(pathStr: string): string;
 
 /**
  * Creates a real Sanity client instance for testing that makes actual HTTP requests.
@@ -79,9 +80,9 @@ export declare function convertToSystemPath(pathStr: string): string
  * ```
  */
 export declare function createTestClient(options: CreateTestClientOptions): {
-  client: SanityClient
-  request: ReturnType<typeof vi.fn>
-}
+  client: SanityClient;
+  request: ReturnType<typeof vi.fn>;
+};
 
 /**
  * Options for createTestClient
@@ -92,11 +93,11 @@ export declare interface CreateTestClientOptions extends ClientConfig {
   /**
    * API version for the client
    */
-  apiVersion: string
+  apiVersion: string;
   /**
    * Authentication token
    */
-  token?: string
+  token?: string;
 }
 
 /**
@@ -107,41 +108,41 @@ export declare interface CreateTestClientOptions extends ClientConfig {
  * @param token - The token to create
  * @returns void
  */
-export declare function createTestToken(token: string): void
+export declare function createTestToken(token: string): void;
 
 /**
  * Default fixtures bundled with the package and their options.
  *
  * @public
  */
-export declare const DEFAULT_FIXTURES: Record<FixtureName, FixtureOptions>
+export declare const DEFAULT_FIXTURES: Record<FixtureName, FixtureOptions>;
 
 /**
  * @deprecated Use {@link FixtureName} instead. This type alias will be removed in a future release.
  * @public
  */
-export declare type ExampleName = FixtureName
+export declare type ExampleName = FixtureName;
 
 /**
  * Valid fixture name type.
  * @public
  */
 export declare type FixtureName =
-  | 'basic-app'
-  | 'basic-functions'
-  | 'basic-studio'
-  | 'graphql-studio'
-  | 'multi-workspace-studio'
-  | 'prebuilt-app'
-  | 'prebuilt-studio'
-  | 'worst-case-studio'
+  | "basic-app"
+  | "basic-functions"
+  | "basic-studio"
+  | "graphql-studio"
+  | "multi-workspace-studio"
+  | "prebuilt-app"
+  | "prebuilt-studio"
+  | "worst-case-studio";
 
 /**
  * Options for each fixture.
  * @public
  */
 export declare interface FixtureOptions {
-  includeDist?: boolean
+  includeDist?: boolean;
 }
 
 /**
@@ -151,7 +152,7 @@ export declare interface FixtureOptions {
  * @returns Drive letter with backslash (e.g., 'C:\\', 'D:\\') or empty string on Unix
  * @internal
  */
-export declare function getCurrentDrive(): string
+export declare function getCurrentDrive(): string;
 
 /**
  * Gets the path to the fixtures directory bundled with this package.
@@ -163,7 +164,7 @@ export declare function getCurrentDrive(): string
  * @returns Absolute path to the fixtures directory
  * @internal
  */
-export declare function getFixturesPath(): string
+export declare function getFixturesPath(): string;
 
 /**
  * Gets the path to the temporary directory for test fixtures.
@@ -175,7 +176,7 @@ export declare function getFixturesPath(): string
  * @returns Absolute path to temp directory (default: initial cwd/tmp)
  * @internal
  */
-export declare function getTempPath(customTempDir?: string): string
+export declare function getTempPath(customTempDir?: string): string;
 
 /**
  * Mocks the API calls, add some defaults so it doesn't cause too much friction
@@ -190,7 +191,7 @@ export declare function mockApi({
   projectId,
   query,
   uri,
-}: MockApiOptions): nock.Interceptor
+}: MockApiOptions): nock.Interceptor;
 
 /**
  * @internal
@@ -199,35 +200,35 @@ export declare interface MockApiOptions {
   /**
    * Uri to mock
    */
-  uri: string
+  uri: string;
   /**
    * Api host to mock, defaults to `https://api.sanity.io`
    */
-  apiHost?: string
+  apiHost?: string;
   /**
    * Api version to mock, defaults to `v2025-05-14`
    */
-  apiVersion?: string
+  apiVersion?: string;
   /**
    * Whether to include `tag: 'sanity.cli'` in query parameters.
    * Defaults to `true`. Set to `false` for endpoints that don't use CLI tagging.
    */
-  includeQueryTag?: boolean
+  includeQueryTag?: boolean;
   /**
    * HTTP method to mock
    *
    * Defaults to 'get'
    */
-  method?: 'delete' | 'get' | 'patch' | 'post' | 'put'
+  method?: "delete" | "get" | "patch" | "post" | "put";
   /**
    * Project ID to mock. When provided, constructs apiHost as `https://{projectId}.api.sanity.io`
    * Takes precedence over apiHost if both are provided.
    */
-  projectId?: string
+  projectId?: string;
   /**
    * Query parameters to mock
    */
-  query?: Record<string, string>
+  query?: Record<string, string>;
 }
 
 /**
@@ -256,10 +257,9 @@ export declare interface MockApiOptions {
  * expect(mockClient.getDocument).toHaveBeenCalledWith('doc1')
  * ```
  */
-export declare function mockSanityCommand<T extends typeof SanityCommand<typeof Command>>(
-  CommandClass: T,
-  options?: MockSanityCommandOptions,
-): T
+export declare function mockSanityCommand<
+  T extends typeof SanityCommand<typeof Command>,
+>(CommandClass: T, options?: MockSanityCommandOptions): T;
 
 /**
  * @public
@@ -268,24 +268,24 @@ export declare interface MockSanityCommandOptions {
   /**
    * Mock CLI config (required if command uses getCliConfig or getProjectId)
    */
-  cliConfig?: CliConfig
+  cliConfig?: CliConfig;
   /**
    * When provided, getCliConfig() will throw this error instead of returning a config.
    * Useful for simulating running outside a project directory.
    */
-  cliConfigError?: Error
+  cliConfigError?: Error;
   /**
    * Mock whether the terminal is interactive (used by isUnattended)
    */
-  isInteractive?: boolean
+  isInteractive?: boolean;
   /**
    * Mock project root result (required if command uses getProjectRoot)
    */
-  projectRoot?: ProjectRootResult
+  projectRoot?: ProjectRootResult;
   /**
    * Mock authentication token (passed to API clients, bypasses getCliToken)
    */
-  token?: string
+  token?: string;
 }
 
 /**
@@ -293,20 +293,22 @@ export declare interface MockSanityCommandOptions {
  * @param options - Options for mocking the telemetry store.
  * @returns The mocked telemetry store.
  */
-export declare const mockTelemetry: (options?: MockTelemetryOptions) => CLITelemetryStore
+export declare const mockTelemetry: (
+  options?: MockTelemetryOptions,
+) => CLITelemetryStore;
 
 /**
  * @public
  */
 export declare interface MockTelemetryOptions {
-  trace?: () => void
-  updateUserProperties?: () => void
+  trace?: () => void;
+  updateUserProperties?: () => void;
 }
 
 declare interface Options {
-  config: Config
-  Command?: Command.Class
-  context?: Hook.Context
+  config: Config;
+  Command?: Command.Class;
+  context?: Hook.Context;
 }
 
 /**
@@ -333,7 +335,10 @@ declare interface Options {
  * })
  * ```
  */
-export declare function setup(_: TestProject, options?: SetupTestFixturesOptions): Promise<void>
+export declare function setup(
+  _: TestProject,
+  options?: SetupTestFixturesOptions,
+): Promise<void>;
 
 /**
  * Options for setupTestFixtures
@@ -352,11 +357,11 @@ export declare interface SetupTestFixturesOptions {
    * ['fixtures/*', 'dev/*']
    * ```
    */
-  additionalFixtures?: string[]
+  additionalFixtures?: string[];
   /**
    * Custom temp directory path. Defaults to process.cwd()/tmp
    */
-  tempDir?: string
+  tempDir?: string;
 }
 
 /**
@@ -370,7 +375,9 @@ export declare interface SetupTestFixturesOptions {
  *
  * @param options - Configuration options
  */
-export declare function teardown(options?: TeardownTestFixturesOptions): Promise<void>
+export declare function teardown(
+  options?: TeardownTestFixturesOptions,
+): Promise<void>;
 
 /**
  * Options for teardownTestFixtures
@@ -381,7 +388,7 @@ export declare interface TeardownTestFixturesOptions {
   /**
    * Custom temp directory path. Defaults to process.cwd()/tmp
    */
-  tempDir?: string
+  tempDir?: string;
 }
 
 /**
@@ -391,7 +398,7 @@ export declare function testCommand(
   command: CommandClass,
   args?: string[],
   options?: TestCommandOptions,
-): Promise<CaptureResult<unknown>>
+): Promise<CaptureResult<unknown>>;
 
 /**
  * @public
@@ -400,16 +407,16 @@ export declare interface TestCommandOptions {
   /**
    * Options for capturing output
    */
-  capture?: CaptureOptions
+  capture?: CaptureOptions;
   /**
    * Partial oclif config overrides
    */
-  config?: Partial<Config>
+  config?: Partial<Config>;
   /**
    * Mock options for SanityCommand dependencies (config, project root, API clients).
    * When provided, the command is automatically wrapped with mockSanityCommand.
    */
-  mocks?: MockSanityCommandOptions & MockTelemetryOptions
+  mocks?: MockSanityCommandOptions & MockTelemetryOptions;
 }
 
 /**
@@ -424,7 +431,7 @@ export declare function testCopyDirectory(
   srcDir: string,
   destDir: string,
   skip?: string[],
-): Promise<void>
+): Promise<void>;
 
 /**
  * @deprecated Use {@link testFixture} instead. This function will be removed in a future release.
@@ -440,13 +447,13 @@ export declare function testCopyDirectory(
 export declare function testExample(
   exampleName: FixtureName | (string & {}),
   options?: TestFixtureOptions,
-): Promise<string>
+): Promise<string>;
 
 /**
  * @deprecated Use {@link TestFixtureOptions} instead. This type alias will be removed in a future release.
  * @public
  */
-export declare type TestExampleOptions = TestFixtureOptions
+export declare type TestExampleOptions = TestFixtureOptions;
 
 /**
  * Clones a fixture directory into a temporary directory with an isolated copy.
@@ -481,7 +488,7 @@ export declare type TestExampleOptions = TestFixtureOptions
 export declare function testFixture(
   fixtureName: FixtureName | (string & {}),
   options?: TestFixtureOptions,
-): Promise<string>
+): Promise<string>;
 
 /**
  * @public
@@ -490,7 +497,7 @@ export declare interface TestFixtureOptions {
   /**
    * Custom temp directory. Defaults to process.cwd()/tmp
    */
-  tempDir?: string
+  tempDir?: string;
 }
 
 /**
@@ -518,6 +525,6 @@ export declare interface TestFixtureOptions {
 export declare function testHook<T extends keyof Hooks>(
   hook: Hook<T>,
   options: Options,
-): Promise<CaptureResult<Hooks[T]['return']>>
+): Promise<CaptureResult<Hooks[T]["return"]>>;
 
-export {}
+export {};

package/dist/vitest.d.ts

@@ -1,4 +1,4 @@
-import {TestProject} from 'vitest/node'
+import { TestProject } from "vitest/node";
 
 /**
  * Global setup function for initializing test fixtures.
@@ -24,7 +24,10 @@ import {TestProject} from 'vitest/node'
  * })
  * ```
  */
-export declare function setup(_: TestProject, options?: SetupTestFixturesOptions): Promise<void>
+export declare function setup(
+  _: TestProject,
+  options?: SetupTestFixturesOptions,
+): Promise<void>;
 
 /**
  * Options for setupTestFixtures
@@ -43,11 +46,11 @@ declare interface SetupTestFixturesOptions {
    * ['fixtures/*', 'dev/*']
    * ```
    */
-  additionalFixtures?: string[]
+  additionalFixtures?: string[];
   /**
    * Custom temp directory path. Defaults to process.cwd()/tmp
    */
-  tempDir?: string
+  tempDir?: string;
 }
 
 /**
@@ -64,16 +67,16 @@ declare interface SetupTestFixturesOptions {
  * @throws If the worker files cannot be bundled
  * @throws If the watcher cannot be set up
  */
-export declare function setupWorkerBuild(filePaths: string[]): Promise<void>
+export declare function setupWorkerBuild(filePaths: string[]): Promise<void>;
 
 /**
  * Serializer for snapshot tests to normalize line endings and Windows ^ to Unix `\`
  * @public
  */
 export declare const snapshotSerializer: {
-  serialize: (val: string) => string
-  test: (val: unknown) => val is string
-}
+  serialize: (val: string) => string;
+  test: (val: unknown) => val is string;
+};
 
 /**
  * Teardown function to clean up test fixtures.
@@ -86,7 +89,9 @@ export declare const snapshotSerializer: {
  *
  * @param options - Configuration options
  */
-export declare function teardown(options?: TeardownTestFixturesOptions): Promise<void>
+export declare function teardown(
+  options?: TeardownTestFixturesOptions,
+): Promise<void>;
 
 /**
  * Options for teardownTestFixtures
@@ -97,7 +102,7 @@ declare interface TeardownTestFixturesOptions {
   /**
    * Custom temp directory path. Defaults to process.cwd()/tmp
    */
-  tempDir?: string
+  tempDir?: string;
 }
 
 /**
@@ -111,6 +116,6 @@ declare interface TeardownTestFixturesOptions {
  * @throws If the build contexts cannot be disposed
  * @throws If the compiled JavaScript files cannot be deleted
  */
-export declare function teardownWorkerBuild(): Promise<void>
+export declare function teardownWorkerBuild(): Promise<void>;
 
-export {}
+export {};

package/fixtures/basic-app/package.json

@@ -16,11 +16,11 @@
     "@sanity/sdk-react": "^2.6.0",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0"
+    "sanity": "^5.14.1"
   },
   "devDependencies": {
     "@types/react": "^19.2.9",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "typescript": "^5.9.3"
   }
 }

package/fixtures/basic-functions/package.json

@@ -9,6 +9,6 @@
     "@sanity/functions": "^1.2.0"
   },
   "devDependencies": {
-    "sanity": "^5.13.0"
+    "sanity": "^5.14.1"
   }
 }

package/fixtures/basic-studio/package.json

@@ -15,10 +15,10 @@
     "start": "sanity start"
   },
   "dependencies": {
-    "@sanity/vision": "^5.13.0",
+    "@sanity/vision": "^5.14.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "styled-components": "^6.3.8"
   },
   "devDependencies": {

package/fixtures/graphql-studio/package.json

@@ -12,10 +12,10 @@
     "deploy-graphql": "sanity graphql deploy"
   },
   "dependencies": {
-    "@sanity/vision": "^5.13.0",
+    "@sanity/vision": "^5.14.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "styled-components": "^6.3.8"
   },
   "devDependencies": {

package/fixtures/multi-workspace-studio/package.json

@@ -15,10 +15,10 @@
     "start": "sanity start"
   },
   "dependencies": {
-    "@sanity/vision": "^5.13.0",
+    "@sanity/vision": "^5.14.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "styled-components": "^6.3.8"
   },
   "devDependencies": {

package/fixtures/prebuilt-app/package.json

@@ -16,11 +16,11 @@
     "@sanity/sdk-react": "^2.6.0",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0"
+    "sanity": "^5.14.1"
   },
   "devDependencies": {
     "@types/react": "^19.2.9",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "typescript": "^5.9.3"
   }
 }

package/fixtures/prebuilt-studio/package.json

@@ -15,7 +15,7 @@
   "dependencies": {
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "styled-components": "^6.3.8"
   },
   "devDependencies": {

package/fixtures/worst-case-studio/package.json

@@ -16,10 +16,10 @@
   },
   "dependencies": {
     "@sanity/code-input": "^7.0.6",
-    "@sanity/vision": "^5.13.0",
+    "@sanity/vision": "^5.14.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.13.0",
+    "sanity": "^5.14.1",
     "sanity-plugin-media": "^4.1.1",
     "styled-components": "^6.3.8",
     "vite-tsconfig-paths": "^6.0.5"

package/package.json

@@ -1,27 +1,33 @@
 {
   "name": "@sanity/cli-test",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Sanity CLI test helpers and utilities",
   "keywords": [
-    "sanity",
+    "cli",
     "cms",
+    "content",
     "headless",
     "realtime",
-    "content",
-    "cli",
+    "sanity",
     "tool"
   ],
   "homepage": "https://github.com/sanity-io/cli",
   "bugs": "https://github.com/sanity-io/cli/issues",
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sanity-io/cli.git",
     "directory": "packages/@sanity/cli-test"
   },
-  "license": "MIT",
-  "author": "Sanity.io <hello@sanity.io>",
-  "sideEffects": false,
+  "files": [
+    "./dist",
+    "./fixtures"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "source": "./src/index.ts",
@@ -33,12 +39,9 @@
     },
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist",
-    "./fixtures"
-  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "@swc/core": "^1.15.18",
     "ansis": "^4.2.0",
@@ -61,23 +64,20 @@
     "typescript": "^5.9.3",
     "vitest": "^4.0.18",
     "yaml": "^2.8.2",
-    "@repo/tsconfig": "3.70.0",
-    "@sanity/cli-core": "1.0.0",
     "@repo/package.config": "0.0.1",
+    "@repo/tsconfig": "3.70.0",
+    "@sanity/cli-core": "1.0.1",
     "@sanity/eslint-config-cli": "1.0.0"
   },
   "peerDependencies": {
     "@oclif/core": "^4.0.0",
     "@sanity/client": "^7.0.0",
     "vitest": ">=3.0.0 <5.0.0",
-    "@sanity/cli-core": "1.0.0"
+    "@sanity/cli-core": "1.0.1"
   },
   "engines": {
     "node": ">=20.19.1 <22 || >=22.12"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "prebuild": "pnpm run clean",
     "build": "pnpm run build:js && pnpm run copy:fixtures",