refactor: reorganize source, errors

Author: rexxars

packages/@sanity/cli-core/package.json

@@ -25,12 +25,16 @@
   ],
   "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/_exports/index.js",
+  "types": "dist/_exports/index.d.ts",
   "exports": {
     ".": {
-      "source": "./src/index.ts",
-      "default": "./dist/index.js"
+      "source": "./src/_exports/index.ts",
+      "default": "./dist/_exports/index.js"
+    },
+    "./errors": {
+      "source": "./src/_exports/errors.ts",
+      "default": "./dist/_exports/errors.js"
     },
     "./ux": {
       "source": "./src/_exports/ux.ts",

packages/@sanity/cli-core/src/_exports/errors.ts

@@ -0,0 +1,5 @@
+export * from '../errors/CLIError.js'
+export * from '../errors/CLIWarning.js'
+export * from '../errors/NonInteractiveError.js'
+export * from '../errors/NotFoundError.js'
+export * from '../errors/ProjectRootNotFoundError.js'

packages/@sanity/cli-core/src/_exports/index.ts

@@ -0,0 +1,67 @@
+import {deprecate} from 'node:util'
+
+import {NonInteractiveError as _NonInteractiveError} from '../errors/NonInteractiveError.js'
+import {NotFoundError as _NotFoundError} from '../errors/NotFoundError.js'
+import {ProjectRootNotFoundError as _ProjectRootNotFoundError} from '../errors/ProjectRootNotFoundError.js'
+
+export * from '../config/cli/getCliConfig.js'
+export * from '../config/cli/getCliConfigSync.js'
+export {type CliConfig} from '../config/cli/types/cliConfig.js'
+export {type UserViteConfig} from '../config/cli/types/userViteConfig.js'
+export * from '../config/findProjectRoot.js'
+export * from '../config/findProjectRootSync.js'
+export * from '../config/studio/getStudioConfig.js'
+export * from '../config/studio/getStudioWorkspaces.js'
+export * from '../config/studio/isStudioConfig.js'
+export * from '../config/util/findConfigsPaths.js'
+export * from '../config/util/findStudioConfigPath.js'
+export {type ProjectRootResult} from '../config/util/recursivelyResolveProjectRoot.js'
+export * from '../debug.js'
+export * from '../loaders/studio/studioWorkerTask.js'
+export * from '../loaders/tsx/tsxWorkerTask.js'
+export * from '../SanityCommand.js'
+export * from '../services/apiClient.js'
+export * from '../services/cliUserConfig.js'
+export * from '../services/getCliToken.js'
+export * from '../telemetry/getTelemetryBaseInfo.js'
+export {
+  type CLITelemetryStore,
+  type ConsentInformation,
+  type TelemetryUserProperties,
+} from '../telemetry/types.js'
+export {type Output, type SanityOrgUser} from '../types.js'
+export {doImport} from '../util/doImport.js'
+export * from '../util/environment/mockBrowserEnvironment.js'
+export {
+  clearCliTelemetry,
+  CLI_TELEMETRY_SYMBOL,
+  getCliTelemetry,
+  setCliTelemetry,
+} from '../util/getCliTelemetry.js'
+export * from '../util/getSanityEnvVar.js'
+export * from '../util/getSanityUrl.js'
+export * from '../util/getUserConfig.js'
+export * from '../util/importModule.js'
+export * from '../util/isCi.js'
+export * from '../util/isInteractive.js'
+export * from '../util/isStaging.js'
+export * from '../util/normalizePath.js'
+export * from '../util/promisifyWorker.js'
+export * from '../util/readPackageJson.js'
+export * from '../util/resolveLocalPackage.js'
+export * from '../util/safeStructuredClone.js'
+export * from '../ux/colorizeJson.js'
+export * from '../ux/timer.js'
+
+export const NonInteractiveError = deprecate(
+  _NonInteractiveError,
+  'Import `NonInteractiveError` from `@sanity/cli-core/errors`',
+)
+export const NotFoundError = deprecate(
+  _NotFoundError,
+  'Import `NotFoundError` from `@sanity/cli-core/errors`',
+)
+export const ProjectRootNotFoundError = deprecate(
+  _ProjectRootNotFoundError,
+  'Import `ProjectRootNotFoundError` from `@sanity/cli-core/errors`',
+)

packages/@sanity/cli-core/src/errors/CLIError.ts

@@ -0,0 +1,45 @@
+import {styleText} from 'node:util'
+
+import {type PrettyPrintableError} from '@oclif/core/interfaces'
+import cleanStack from 'clean-stack'
+
+/**
+ * A formatted CLI error that pretty-prints to stderr.
+ *
+ * This is a lightweight reimplementation of `@oclif/core`'s `CLIError`.
+ * We can't import the original because `@oclif/core` is a CJS barrel that
+ * pulls in the entire oclif runtime (~10MB) when bundled - defeating
+ * tree-shaking in the standalone `create-sanity` bundle. By owning the
+ * error class here, code in `@sanity/cli-core` and the init action tree
+ * can throw formatted errors without depending on oclif at all.
+ *
+ * The `oclif` property is shaped so oclif's error handler still recognises
+ * these errors when thrown inside an oclif command, preserving the correct
+ * exit code and suppressing redundant stack traces.
+ */
+export class CLIError extends Error {
+  code?: string
+  oclif: {exit?: number} = {exit: 2}
+  ref?: string
+  skipOclifErrorHandling?: boolean
+  suggestions?: string[]
+
+  constructor(error: Error | string, options: PrettyPrintableError & {exit?: false | number} = {}) {
+    super(error instanceof Error ? error.message : error)
+    if (error instanceof Error && error.stack) {
+      this.stack = error.stack
+    }
+    if (options.exit !== undefined) this.oclif.exit = options.exit || undefined
+    this.code = options.code
+    this.suggestions = options.suggestions
+    this.ref = options.ref
+  }
+
+  get bang(): string | undefined {
+    return styleText('red', process.platform === 'win32' ? '»' : '›')
+  }
+
+  get prettyStack(): string {
+    return cleanStack(super.stack!, {pretty: true})
+  }
+}

packages/@sanity/cli-core/src/errors/CLIWarning.ts

@@ -0,0 +1,18 @@
+import {styleText} from 'node:util'
+
+import {CLIError} from './CLIError.js'
+
+/**
+ * A warning-level CLI error. Identical to {@link CLIError} except the
+ * bang prefix is yellow instead of red.
+ */
+export class CLIWarning extends CLIError {
+  constructor(input: Error | string) {
+    super(input instanceof Error ? input.message : input)
+    this.name = 'Warning'
+  }
+
+  override get bang(): string | undefined {
+    return styleText('yellow', process.platform === 'win32' ? '»' : '›')
+  }
+}

packages/@sanity/cli-core/src/errors/NonInteractiveError.ts

@@ -1,4 +1,4 @@
-import {CLIError} from '../ux/errors.js'
+import {CLIError} from './CLIError.js'
 
 /**
  * Error thrown when a prompt is attempted in a non-interactive environment

packages/@sanity/cli-core/src/errors/ProjectRootNotFoundError.ts

@@ -1,5 +1,5 @@
 import {isRecord} from '../util/isRecord.js'
-import {CLIError} from '../ux/errors.js'
+import {CLIError} from './CLIError.js'
 
 /**
  * Error thrown when a project root directory cannot be found.