@sanity/cli-test 10.0.0 → 11.0.0

package/dist/test/oclif.d.ts

@@ -1,179 +1,2 @@
-import { CliConfig } from "@sanity/cli-core/types";
-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 { ProjectRootResult } from "@sanity/cli-core/types";
-import { SanityCommand } from "@sanity/cli-core/SanityCommand";
-
-/** @public */
-export declare interface CaptureOptions {
-  /**
-   * Whether to print the output to the console
-   */
-  print?: boolean;
-  /**
-   * Whether to strip ANSI escape codes from the output
-   */
-  stripAnsi?: boolean;
-  testNodeEnv?: string;
-}
-
-/**
- * Capture the output of a command and return the result
- *
- * @param fn - The function to capture the output of
- * @param opts - The options for the capture
- * @returns The result of the command
- * @public
- *
- * Credits to oclif for the original implementation:
- * https://github.com/oclif/test/blob/2a5407e6fc80d388043d10f6b7b8eaa586483015/src/index.ts
- *
- * We are not using the library directly since it does not support mocking code inside of the command
- * possibly because the commands run in a different thread
- */
-export declare function captureOutput<T>(
-  fn: () => Promise<T>,
-  opts?: CaptureOptions,
-): Promise<CaptureResult<T>>;
-
-/** @public */
-export declare interface CaptureResult<T = unknown> {
-  stderr: string;
-  stdout: string;
-  error?: Error & Partial<Errors.CLIError>;
-  result?: T;
-}
-
-declare type CommandClass = (new (argv: string[], config: Config) => Command) &
-  typeof Command;
-
-/**
- * Creates a testable subclass of a command with mocked SanityCommand dependencies.
- *
- * @public
- *
- * @example
- * ```ts
- * // Basic config mocking
- * const TestAdd = mockSanityCommand(Add, {
- *   cliConfig: { api: { projectId: 'test-project' } }
- * })
- *
- * // With mock API client
- * const mockClient = {
- *   getDocument: vi.fn().mockResolvedValue({ _id: 'doc1', title: 'Test' }),
- *   fetch: vi.fn().mockResolvedValue([]),
- * }
- * const TestGet = mockSanityCommand(GetDocumentCommand, {
- *   cliConfig: { api: { projectId: 'test-project', dataset: 'production' } },
- *   projectApiClient: mockClient,
- * })
- *
- * const {stdout} = await testCommand(TestGet, ['doc1'])
- * expect(mockClient.getDocument).toHaveBeenCalledWith('doc1')
- * ```
- */
-export declare function mockSanityCommand<
-  T extends typeof SanityCommand<typeof Command>,
->(CommandClass: T, options?: MockSanityCommandOptions): T;
-
-/**
- * @public
- */
-export declare interface MockSanityCommandOptions {
-  /**
-   * Mock CLI config (required if command uses getCliConfig or getProjectId)
-   */
-  cliConfig?: CliConfig;
-  /**
-   * When provided, getCliConfig() will throw this error instead of returning a config.
-   * Useful for simulating running outside a project directory.
-   */
-  cliConfigError?: Error;
-  /**
-   * Mock whether the terminal is interactive (used by isUnattended)
-   */
-  isInteractive?: boolean;
-  /**
-   * Mock project root result (required if command uses getProjectRoot)
-   */
-  projectRoot?: ProjectRootResult;
-  /**
-   * Mock authentication token (passed to API clients, bypasses getCliToken)
-   */
-  token?: string;
-}
-
-/**
- * @public
- */
-declare interface MockTelemetryOptions {
-  trace?: () => void;
-  updateUserProperties?: () => void;
-}
-
-declare interface Options {
-  config: Config;
-  Command?: Command.Class;
-  context?: Hook.Context;
-}
-
-/**
- * @public
- */
-export declare function testCommand(
-  command: CommandClass,
-  args?: string[],
-  options?: TestCommandOptions,
-): Promise<CaptureResult<unknown>>;
-
-/**
- * @public
- */
-export declare interface TestCommandOptions {
-  /**
-   * Options for capturing output
-   */
-  capture?: CaptureOptions;
-  /**
-   * Partial oclif config overrides
-   */
-  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;
-}
-
-/**
- * Test an oclif hook
- *
- * @public
- *
- * @example
- * ```ts
- * const result = await testHook(hook, {
- *   Command: Command.loadable,
- *   context: {
- *     config: Config.load({
- *      // CLI root is the directory of the package that contains the hook.
- *       root: path.resolve(fileURLToPath(import.meta.url), '../../../root'),
- *     }),
- *   },
- * })
- * ```
- *
- * @param hook - The hook to test
- * @param options - The options for the hook
- * @returns The result of the hook
- */
-export declare function testHook<T extends keyof Hooks>(
-  hook: Hook<T>,
-  options: Options,
-): Promise<CaptureResult<Hooks[T]["return"]>>;
-
-export {};
+import { a as CaptureResult, c as mockSanityCommand, i as CaptureOptions, n as TestCommandOptions, o as captureOutput, r as testCommand, s as MockSanityCommandOptions, t as testHook } from "../testHook-CG6GhHGq.js";
+export { CaptureOptions, CaptureResult, MockSanityCommandOptions, TestCommandOptions, captureOutput, mockSanityCommand, testCommand, testHook };

package/dist/test/setupFixtures.d.ts

@@ -1,40 +1,10 @@
 import { TestProject } from "vitest/node";
-
-/**
- * Global setup function for initializing test fixtures.
- *
- * Copies fixtures from the bundled location to a temp directory
- * and installs dependencies.
- *
- * Note: Fixtures are NOT built during setup. Tests that need built
- * fixtures should build them as part of the test.
- *
- * This function is designed to be used with vitest globalSetup.
- *
- * @public
- *
- * @param options - Configuration options
- * @example
- * ```typescript
- * // In vitest.config.ts
- * export default defineConfig({
- *   test: {
- *     globalSetup: ['@sanity/cli-test/vitest']
- *   }
- * })
- * ```
- */
-export declare function setup(
-  _: TestProject,
-  options?: SetupTestFixturesOptions,
-): Promise<void>;
-
 /**
  * Options for setupTestFixtures
  *
  * @public
  */
-export declare interface SetupTestFixturesOptions {
+interface SetupTestFixturesOptions {
   /**
    * Glob patterns for additional fixture directories to set up.
    *
@@ -59,32 +29,53 @@ export declare interface SetupTestFixturesOptions {
    */
   tempDir?: string;
 }
-
 /**
- * Teardown function to clean up test fixtures.
+ * Global setup function for initializing test fixtures.
  *
- * Removes the temp directory created by setupTestFixtures.
+ * Copies fixtures from the bundled location to a temp directory
+ * and installs dependencies.
+ *
+ * Note: Fixtures are NOT built during setup. Tests that need built
+ * fixtures should build them as part of the test.
  *
  * This function is designed to be used with vitest globalSetup.
  *
  * @public
  *
  * @param options - Configuration options
+ * @example
+ * ```typescript
+ * // In vitest.config.ts
+ * export default defineConfig({
+ *   test: {
+ *     globalSetup: ['@sanity/cli-test/vitest']
+ *   }
+ * })
+ * ```
  */
-export declare function teardown(
-  options?: TeardownTestFixturesOptions,
-): Promise<void>;
-
+declare function setup(_: TestProject, options?: SetupTestFixturesOptions): Promise<void>;
 /**
  * Options for teardownTestFixtures
  *
  * @public
  */
-export declare interface TeardownTestFixturesOptions {
+interface TeardownTestFixturesOptions {
   /**
    * Custom temp directory path. Defaults to process.cwd()/tmp
    */
   tempDir?: string;
 }
-
-export {};
+/**
+ * Teardown function to clean up test fixtures.
+ *
+ * Removes the temp directory created by setupTestFixtures.
+ *
+ * This function is designed to be used with vitest globalSetup.
+ *
+ * @public
+ *
+ * @param options - Configuration options
+ */
+declare function teardown(options?: TeardownTestFixturesOptions): Promise<void>;
+export { SetupTestFixturesOptions, TeardownTestFixturesOptions, setup, teardown };
+//# sourceMappingURL=setupFixtures.d.ts.map

package/dist/test/util.d.ts

@@ -1,203 +1,4 @@
-import { CLITelemetryStore } from "@sanity/cli-core/types";
-import { Mock } from "vitest";
-import { SpinnerInstance } from "@sanity/cli-core/ux";
-
-/**
- * Creates a mock HTTP server for testing.
- *
- * @returns A mock HTTP server object with emit and once methods
- * @internal
- */
-export declare function createMockHttpServer(): {
-  emit(event: string, ...args: unknown[]): void;
-  once(event: string, listener: (...args: unknown[]) => void): void;
-};
-
-/**
- * Creates a mock spinner function to avoid writing output to stdout.
- * @param overrides - Pass any mocks or stubs for test expectations
- * @internal
- * @deprecated Use mocks/cli-core/ux/spinner instead
- */
-export declare function createMockSpinner(
-  overrides?: Partial<SpinnerInstance>,
-): Mock<(options: string) => SpinnerInstance>;
-
-/**
- * Creates a mock Vite watcher for testing.
- *
- * @returns A mock watcher object with add, emit, and on methods
- * @internal
- */
-export declare function createMockWatcher(): MockWatcher;
-
-/**
- * Creates a test token for the Sanity CLI
- *
- * @public
- *
- * @param token - The token to create
- * @returns 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>;
-
-/**
- * @deprecated Use {@link FixtureName} instead. This type alias will be removed in a future release.
- * @public
- */
-export declare type ExampleName = FixtureName;
-
-/**
- * Valid fixture name type.
- * @public
- */
-export declare type FixtureName =
-  | "basic-app"
-  | "basic-functions"
-  | "basic-studio"
-  | "federated-studio"
-  | "graphql-studio"
-  | "multi-workspace-studio"
-  | "nextjs-app"
-  | "prebuilt-app"
-  | "prebuilt-studio"
-  | "worst-case-studio";
-
-/**
- * Options for each fixture.
- * @public
- */
-export declare interface FixtureOptions {
-  includeDist?: boolean;
-}
-
-/**
- * @public
- * @param options - Options for mocking the telemetry store.
- * @returns The mocked telemetry store.
- */
-export declare const mockTelemetry: (
-  options?: MockTelemetryOptions,
-) => CLITelemetryStore;
-
-/**
- * @public
- */
-export declare interface MockTelemetryOptions {
-  trace?: () => void;
-  updateUserProperties?: () => void;
-}
-
-/**
- * @internal
- */
-export declare interface MockWatcher {
-  add: Mock;
-  emit: (event: string, ...args: unknown[]) => void;
-  on: (event: string, listener: (...args: unknown[]) => void) => 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;
-};
-
-/**
- * Recursively copy a directory, skipping specified folders.
- *
- * @param srcDir - Source directory to copy from
- * @param destDir - Destination directory to copy to
- * @param skip - Array of directory/file names to skip (e.g., ['node_modules', 'dist'])
- * @internal
- */
-export declare function testCopyDirectory(
-  srcDir: string,
-  destDir: string,
-  skip?: string[],
-): Promise<void>;
-
-/**
- * @deprecated Use {@link testFixture} instead. This function will be removed in a future release.
- *
- * Clones an example (now called fixture) directory into a temporary directory with an isolated copy.
- *
- * @param exampleName - The name of the example/fixture to clone (e.g., 'basic-app', 'basic-studio')
- * @param options - Configuration options
- * @returns The absolute path to the temporary directory containing the example/fixture
- *
- * @public
- */
-export declare function testExample(
-  exampleName: FixtureName | (string & {}),
-  options?: TestFixtureOptions,
-): Promise<string>;
-
-/**
- * @deprecated Use {@link TestFixtureOptions} instead. This type alias will be removed in a future release.
- * @public
- */
-export declare type TestExampleOptions = TestFixtureOptions;
-
-/**
- * Clones a fixture directory into a temporary directory with an isolated copy.
- *
- * The function creates a unique temporary copy of the specified fixture with:
- * - A random unique ID to avoid conflicts between parallel tests
- * - Symlinked node_modules for performance (from the global setup version)
- * - Modified package.json name to prevent conflicts
- *
- * The fixture is first looked up in the temp directory (if global setup ran),
- * otherwise it falls back to the bundled fixtures in the package.
- *
- * @param fixtureName - The name of the fixture to clone (e.g., 'basic-app', 'basic-studio')
- * @param options - Configuration options
- * @returns The absolute path to the temporary directory containing the fixture
- *
- * @public
- *
- * @example
- * ```typescript
- * import {testFixture} from '@sanity/cli-test'
- * import {describe, test} from 'vitest'
- *
- * describe('my test suite', () => {
- *   test('should work with basic-studio', async () => {
- *     const cwd = await testFixture('basic-studio')
- *     // ... run your tests in this directory
- *   })
- * })
- * ```
- */
-export declare function testFixture(
-  fixtureName: FixtureName | (string & {}),
-  options?: TestFixtureOptions,
-): Promise<string>;
-
-/**
- * @public
- */
-export declare interface TestFixtureOptions {
-  /**
-   * Custom temp directory. Defaults to process.cwd()/tmp (or the OS temp directory when
-   * `useSystemTmp` is true).
-   */
-  tempDir?: string;
-  /**
-   * Use the OS temp directory instead of cwd/tmp. Avoids monorepo workspace detection by
-   * package managers and git when tests run inside a monorepo. Ignored when `tempDir` is set.
-   */
-  useSystemTmp?: boolean;
-}
-
-export {};
+import { a as testFixture, c as createMockWatcher, d as DEFAULT_FIXTURES, f as ExampleName, i as testExample, l as createMockSpinner, m as FixtureOptions, n as TestFixtureOptions, o as createTestToken, p as FixtureName, r as testCopyDirectory, s as MockWatcher, t as TestExampleOptions, u as createMockHttpServer } from "../testFixture-8PtoG-6z.js";
+import { n as mockTelemetry, t as MockTelemetryOptions } from "../mockTelemetry-Bh1va02-.js";
+import { t as snapshotSerializer } from "../snapshotSerializer-B3X8EXGX.js";
+export { DEFAULT_FIXTURES, ExampleName, FixtureName, FixtureOptions, MockTelemetryOptions, MockWatcher, TestExampleOptions, TestFixtureOptions, createMockHttpServer, createMockSpinner, createMockWatcher, createTestToken, mockTelemetry, snapshotSerializer, testCopyDirectory, testExample, testFixture };

package/dist/testFixture-8PtoG-6z.d.ts

@@ -0,0 +1,140 @@
+import { SpinnerInstance } from "@sanity/cli-core/ux";
+import { Mock } from "vitest";
+/**
+ * Options for each fixture.
+ * @public
+ */
+interface FixtureOptions {
+  includeDist?: boolean;
+}
+/**
+ * Default fixtures bundled with the package and their options.
+ *
+ * @public
+ */
+declare const DEFAULT_FIXTURES: Record<FixtureName, FixtureOptions>;
+/**
+ * Valid fixture name type.
+ * @public
+ */
+type FixtureName = 'basic-app' | 'basic-functions' | 'basic-studio' | 'federated-studio' | 'graphql-studio' | 'multi-workspace-studio' | 'nextjs-app' | 'prebuilt-app' | 'prebuilt-studio' | 'worst-case-studio';
+/**
+ * @deprecated Use {@link FixtureName} instead. This type alias will be removed in a future release.
+ * @public
+ */
+type ExampleName = FixtureName;
+/**
+ * Creates a mock HTTP server for testing.
+ *
+ * @returns A mock HTTP server object with emit and once methods
+ * @internal
+ */
+declare function createMockHttpServer(): {
+  emit(event: string, ...args: unknown[]): void;
+  once(event: string, listener: (...args: unknown[]) => void): void;
+};
+/**
+ * Creates a mock spinner function to avoid writing output to stdout.
+ * @param overrides - Pass any mocks or stubs for test expectations
+ * @internal
+ * @deprecated Use mocks/cli-core/ux/spinner instead
+ */
+declare function createMockSpinner(overrides?: Partial<SpinnerInstance>): Mock<(options: string) => SpinnerInstance>;
+/**
+ * @internal
+ */
+interface MockWatcher {
+  add: Mock;
+  emit: (event: string, ...args: unknown[]) => void;
+  on: (event: string, listener: (...args: unknown[]) => void) => void;
+}
+/**
+ * Creates a mock Vite watcher for testing.
+ *
+ * @returns A mock watcher object with add, emit, and on methods
+ * @internal
+ */
+declare function createMockWatcher(): MockWatcher;
+/**
+ * Creates a test token for the Sanity CLI
+ *
+ * @public
+ *
+ * @param token - The token to create
+ * @returns void
+ */
+declare function createTestToken(token: string): void;
+/**
+ * @deprecated Use {@link TestFixtureOptions} instead. This type alias will be removed in a future release.
+ * @public
+ */
+type TestExampleOptions = TestFixtureOptions;
+/**
+ * Recursively copy a directory, skipping specified folders.
+ *
+ * @param srcDir - Source directory to copy from
+ * @param destDir - Destination directory to copy to
+ * @param skip - Array of directory/file names to skip (e.g., ['node_modules', 'dist'])
+ * @internal
+ */
+declare function testCopyDirectory(srcDir: string, destDir: string, skip?: string[]): Promise<void>;
+/**
+ * @public
+ */
+interface TestFixtureOptions {
+  /**
+   * Custom temp directory. Defaults to process.cwd()/tmp (or the OS temp directory when
+   * `useSystemTmp` is true).
+   */
+  tempDir?: string;
+  /**
+   * Use the OS temp directory instead of cwd/tmp. Avoids monorepo workspace detection by
+   * package managers and git when tests run inside a monorepo. Ignored when `tempDir` is set.
+   */
+  useSystemTmp?: boolean;
+}
+/**
+ * Clones a fixture directory into a temporary directory with an isolated copy.
+ *
+ * The function creates a unique temporary copy of the specified fixture with:
+ * - A random unique ID to avoid conflicts between parallel tests
+ * - Symlinked node_modules for performance (from the global setup version)
+ * - Modified package.json name to prevent conflicts
+ *
+ * The fixture is first looked up in the temp directory (if global setup ran),
+ * otherwise it falls back to the bundled fixtures in the package.
+ *
+ * @param fixtureName - The name of the fixture to clone (e.g., 'basic-app', 'basic-studio')
+ * @param options - Configuration options
+ * @returns The absolute path to the temporary directory containing the fixture
+ *
+ * @public
+ *
+ * @example
+ * ```typescript
+ * import {testFixture} from '@sanity/cli-test'
+ * import {describe, test} from 'vitest'
+ *
+ * describe('my test suite', () => {
+ *   test('should work with basic-studio', async () => {
+ *     const cwd = await testFixture('basic-studio')
+ *     // ... run your tests in this directory
+ *   })
+ * })
+ * ```
+ */
+declare function testFixture(fixtureName: FixtureName | (string & {}), options?: TestFixtureOptions): Promise<string>;
+/**
+ * @deprecated Use {@link testFixture} instead. This function will be removed in a future release.
+ *
+ * Clones an example (now called fixture) directory into a temporary directory with an isolated copy.
+ *
+ * @param exampleName - The name of the example/fixture to clone (e.g., 'basic-app', 'basic-studio')
+ * @param options - Configuration options
+ * @returns The absolute path to the temporary directory containing the example/fixture
+ *
+ * @public
+ */
+declare function testExample(exampleName: FixtureName | (string & {}), options?: TestFixtureOptions): Promise<string>;
+export { testFixture as a, createMockWatcher as c, DEFAULT_FIXTURES as d, ExampleName as f, testExample as i, createMockSpinner as l, FixtureOptions as m, TestFixtureOptions as n, createTestToken as o, FixtureName as p, testCopyDirectory as r, MockWatcher as s, TestExampleOptions as t, createMockHttpServer as u };
+//# sourceMappingURL=testFixture-8PtoG-6z.d.ts.map