@sanity/cli-test 10.0.0 → 11.0.0

package/dist/testHook-CG6GhHGq.d.ts

@@ -0,0 +1,145 @@
+import { t as MockTelemetryOptions } from "./mockTelemetry-Bh1va02-.js";
+import { Command, Config, Errors } from "@oclif/core";
+import { SanityCommand } from "@sanity/cli-core/SanityCommand";
+import { CliConfig, ProjectRootResult } from "@sanity/cli-core/types";
+import { Hook, Hooks } from "@oclif/core/hooks";
+/**
+ * @public
+ */
+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;
+}
+/**
+ * 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')
+ * ```
+ */
+declare function mockSanityCommand<T extends typeof SanityCommand<typeof Command>>(CommandClass: T, options?: MockSanityCommandOptions): T;
+/** @public */
+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;
+}
+/** @public */
+interface CaptureResult<T = unknown> {
+  stderr: string;
+  stdout: string;
+  error?: Error & Partial<Errors.CLIError>;
+  result?: T;
+}
+/**
+ * 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
+ */
+declare function captureOutput<T>(fn: () => Promise<T>, opts?: CaptureOptions): Promise<CaptureResult<T>>;
+type CommandClass = (new (argv: string[], config: Config) => Command) & typeof Command;
+/**
+ * @public
+ */
+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;
+}
+/**
+ * @public
+ */
+declare function testCommand(command: CommandClass, args?: string[], options?: TestCommandOptions): Promise<CaptureResult<unknown>>;
+interface Options {
+  config: Config;
+  Command?: Command.Class;
+  context?: Hook.Context;
+}
+/**
+ * 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
+ */
+declare function testHook<T extends keyof Hooks>(hook: Hook<T>, options: Options): Promise<CaptureResult<Hooks[T]["return"]>>;
+export { CaptureResult as a, mockSanityCommand as c, CaptureOptions as i, TestCommandOptions as n, captureOutput as o, testCommand as r, MockSanityCommandOptions as s, testHook as t };
+//# sourceMappingURL=testHook-CG6GhHGq.d.ts.map

package/dist/utils/paths.d.ts

@@ -1,16 +1,25 @@
 /**
- * Converts Unix-style paths to platform-appropriate paths.
- * On Windows:
- *   - Absolute paths starting with '/': adds drive letter and converts to backslashes
- *   - Relative/partial paths: converts forward slashes to backslashes
- * On Unix: keeps paths as-is.
+ * Gets the path to the fixtures directory bundled with this package.
  *
- * @param pathStr - Unix-style path (e.g., '/test/path' or '.config/file.json')
- * @returns Platform-appropriate path
+ * The fixtures are copied during build and bundled with the published package.
+ * This function works the same whether the package is used in a monorepo
+ * or installed from npm.
+ *
+ * @returns Absolute path to the fixtures directory
+ * @internal
+ */
+declare function getFixturesPath(): string;
+/**
+ * Gets the path to the temporary directory for test fixtures.
+ *
+ * Uses the initial working directory captured when this module was first loaded,
+ * not process.cwd() which may change during test execution.
+ *
+ * @param customTempDir - Optional custom temp directory path
+ * @returns Absolute path to temp directory (default: initial cwd/tmp)
  * @internal
  */
-export declare function convertToSystemPath(pathStr: string): string;
-
+declare function getTempPath(customTempDir?: string): string;
 /**
  * Creates a unique temporary directory for test output.
  * Uses {@link getTempPath} as the base, creating it if needed.
@@ -21,14 +30,13 @@ export declare function convertToSystemPath(pathStr: string): string;
  * @returns The path and a cleanup function
  * @public
  */
-export declare function createTmpDir(options?: {
+declare function createTmpDir(options?: {
   prefix?: string;
   useSystemTmp?: boolean;
 }): Promise<{
   cleanup: () => Promise<void>;
   path: string;
 }>;
-
 /**
  * Gets the current Windows drive letter from process.cwd().
  * Falls back to 'C:\\' if detection fails.
@@ -36,30 +44,18 @@ export declare function createTmpDir(options?: {
  * @returns Drive letter with backslash (e.g., 'C:\\', 'D:\\') or empty string on Unix
  * @internal
  */
-export declare function getCurrentDrive(): string;
-
+declare function getCurrentDrive(): string;
 /**
- * Gets the path to the fixtures directory bundled with this package.
- *
- * The fixtures are copied during build and bundled with the published package.
- * This function works the same whether the package is used in a monorepo
- * or installed from npm.
- *
- * @returns Absolute path to the fixtures directory
- * @internal
- */
-export declare function getFixturesPath(): string;
-
-/**
- * Gets the path to the temporary directory for test fixtures.
- *
- * Uses the initial working directory captured when this module was first loaded,
- * not process.cwd() which may change during test execution.
+ * Converts Unix-style paths to platform-appropriate paths.
+ * On Windows:
+ *   - Absolute paths starting with '/': adds drive letter and converts to backslashes
+ *   - Relative/partial paths: converts forward slashes to backslashes
+ * On Unix: keeps paths as-is.
  *
- * @param customTempDir - Optional custom temp directory path
- * @returns Absolute path to temp directory (default: initial cwd/tmp)
+ * @param pathStr - Unix-style path (e.g., '/test/path' or '.config/file.json')
+ * @returns Platform-appropriate path
  * @internal
  */
-export declare function getTempPath(customTempDir?: string): string;
-
-export {};
+declare function convertToSystemPath(pathStr: string): string;
+export { convertToSystemPath, createTmpDir, getCurrentDrive, getFixturesPath, getTempPath };
+//# sourceMappingURL=paths.d.ts.map

package/dist/vitest.d.ts

@@ -1,65 +1,5 @@
-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
- */
-declare interface SetupTestFixturesOptions {
-  /**
-   * Glob patterns for additional fixture directories to set up.
-   *
-   * Each pattern is matched against directories in the current working directory.
-   * Only directories containing a `package.json` file are included.
-   *
-   * @example
-   * ```typescript
-   * ['fixtures/*', 'dev/*']
-   * ```
-   */
-  additionalFixtures?: string[];
-  /**
-   * When true, passes `--ignore-workspace` to pnpm install so fixtures get
-   * their own node_modules even when the temp directory is inside a pnpm
-   * workspace. Required for E2E tests that spawn the CLI binary against
-   * fixture directories.
-   */
-  ignoreWorkspace?: boolean;
-  /**
-   * Custom temp directory path. Defaults to process.cwd()/tmp
-   */
-  tempDir?: string;
-}
-
+import { setup, teardown } from "./test/setupFixtures.js";
+import { t as snapshotSerializer } from "./snapshotSerializer-B3X8EXGX.js";
 /**
  * Setup function to build the worker files with esbuild.
  *
@@ -74,44 +14,7 @@ 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>;
-
-/**
- * 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;
-};
-
-/**
- * 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
- */
-export declare function teardown(
-  options?: TeardownTestFixturesOptions,
-): Promise<void>;
-
-/**
- * Options for teardownTestFixtures
- *
- * @public
- */
-declare interface TeardownTestFixturesOptions {
-  /**
-   * Custom temp directory path. Defaults to process.cwd()/tmp
-   */
-  tempDir?: string;
-}
-
+declare function setupWorkerBuild(filePaths: string[]): Promise<void>;
 /**
  * Teardown function to clean up the worker build.
  *
@@ -123,6 +26,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 { setup, setupWorkerBuild, snapshotSerializer, teardown, teardownWorkerBuild };
+//# sourceMappingURL=vitest.d.ts.map

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

@@ -28,6 +28,6 @@
     "@sanity/color": "^3.0.6",
     "@types/react": "^19.2.14",
     "typescript": "^6.0.3",
-    "vite": "^8.2.0"
+    "vite": "^8.2.1"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli-test",
-  "version": "10.0.0",
+  "version": "11.0.0",
   "description": "Sanity CLI test helpers and utilities",
   "keywords": [
     "cli",
@@ -106,21 +106,22 @@
     "@swc/core": "^1.15.43",
     "ansis": "^4.2.0",
     "esbuild": "^0.28.1",
+    "get-it": "^9.5.0",
     "nock": "^14.0.15",
     "tinyglobby": "^0.2.17",
-    "@sanity/cli-core": "3.0.0"
+    "@sanity/cli-core": "3.1.0"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
     "@oclif/core": "^4.11.14",
-    "@sanity/client": "^7.25.0",
-    "@sanity/pkg-utils": "^11.0.17",
+    "@sanity/client": "^8.1.0",
+    "@sanity/pkg-utils": "^12.1.2",
     "@swc/cli": "^0.8.1",
     "@types/node": "^22.20.0",
     "eslint": "^10.7.0",
     "publint": "^0.3.21",
     "rimraf": "^6.0.1",
-    "tsx": "^4.23.1",
+    "tsx": "^4.23.12",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "yaml": "^2.9.0",
@@ -130,9 +131,9 @@
   },
   "peerDependencies": {
     "@oclif/core": "^4.0.0",
-    "@sanity/client": "^7.0.0",
+    "@sanity/client": "^8.1.0",
     "vitest": ">=3.0.0 <5.0.0",
-    "@sanity/cli-core": "3.0.0"
+    "@sanity/cli-core": "3.1.0"
   },
   "engines": {
     "node": ">=22.12"