@sanity/cli 3.93.1-next.2.cd584b9f46 → 3.93.1-next.21.af9f8fa054

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.93.1-next.2.cd584b9f46",
+  "version": "3.93.1-next.21.af9f8fa054",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -43,7 +43,6 @@
     "bin",
     "codemods",
     "lib",
-    "src",
     "templates"
   ],
   "scripts": {
@@ -59,11 +58,11 @@
   "dependencies": {
     "@babel/traverse": "^7.27.4",
     "@sanity/client": "^7.6.0",
-    "@sanity/codegen": "3.93.1-next.2.cd584b9f46",
+    "@sanity/codegen": "3.93.1-next.21.af9f8fa054",
     "@sanity/runtime-cli": "^8.1.0",
     "@sanity/telemetry": "^0.8.0",
     "@sanity/template-validator": "^2.4.3",
-    "@sanity/util": "3.93.1-next.2.cd584b9f46",
+    "@sanity/util": "3.93.1-next.21.af9f8fa054",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -84,7 +83,7 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^5.0.2",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.93.1-next.2.cd584b9f46",
+    "@sanity/types": "3.93.1-next.21.af9f8fa054",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -137,5 +136,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "cd584b9f46f81f3fcb46de6cc67f3647de9940ec"
+  "gitHead": "af9f8fa054c33a6b1d4e8058f046269c29c543bc"
 }

package/src/CommandRunner.ts

@@ -1,219 +0,0 @@
-import chalk from 'chalk'
-import {cloneDeep, sortBy} from 'lodash'
-
-import {baseCommands} from './commands'
-import {debug} from './debug'
-import cliOutputter from './outputters/cliOutputter'
-import {cliPackageManager} from './packageManager'
-import {prompt as cliPrompter} from './prompters/cliPrompter'
-import {
-  type CliCommandArguments,
-  type CliCommandContext,
-  type CliCommandDefinition,
-  type CliCommandGroupDefinition,
-  type CliConfig,
-  type CliOutputter,
-  type CliPrompter,
-  type CommandRunnerOptions,
-  type ResolvedCliCommand,
-  type SanityJson,
-} from './types'
-import {getClientWrapper} from './util/clientWrapper'
-import {
-  generateCommandDocumentation,
-  generateCommandsDocumentation,
-} from './util/generateCommandsDocumentation'
-import {type CliConfigResult} from './util/getCliConfig'
-import {isCommandGroup} from './util/isCommandGroup'
-import {getNoSuchCommandText} from './util/noSuchCommandText'
-
-interface Handlers {
-  outputter: CliOutputter
-  prompter: CliPrompter
-}
-
-type CommandOrGroup = CliCommandDefinition | CliCommandGroupDefinition
-
-export class CommandRunner {
-  public handlers: Handlers
-  public commands: CommandOrGroup[]
-  public commandGroups: Record<string, (CliCommandDefinition | CliCommandGroupDefinition)[]>
-
-  constructor(handlers: Handlers, commands: CommandOrGroup[] = baseCommands) {
-    this.handlers = handlers
-    this.commands = sortBy(commands, 'name')
-    this.commandGroups = {}
-    for (const cmd of this.commands) {
-      const group = ('group' in cmd && cmd.group) || 'default'
-      this.commandGroups[group] = this.commandGroups[group] || []
-      this.commandGroups[group].push(cmd)
-    }
-
-    if (!handlers.outputter || !handlers.prompter) {
-      throw new Error('`prompter` and `outputter` handlers must be defined')
-    }
-  }
-
-  async runCommand(
-    commandOrGroup: string,
-    args: CliCommandArguments,
-    options: CommandRunnerOptions,
-  ): Promise<unknown> {
-    if (!commandOrGroup) {
-      this.handlers.outputter.print(generateCommandsDocumentation(this.commandGroups))
-      return Promise.resolve()
-    }
-
-    // We might modify arguments for easier parsing in subcommand
-    const cmdArgs = cloneDeep(args)
-    const subCommandName = args.argsWithoutOptions[0]
-
-    const commandInfo = this.resolveCommand(commandOrGroup, subCommandName)
-    if (!commandInfo) {
-      throw new Error(getNoSuchCommandText(commandOrGroup, subCommandName, this.commandGroups))
-    }
-
-    const command = commandInfo.command
-
-    if (!isCommandGroup(command) && command.group && command.group !== 'default') {
-      cmdArgs.argsWithoutOptions = args.argsWithoutOptions.slice(1)
-    }
-
-    const output = this.handlers.outputter
-    const prompt = this.handlers.prompter
-
-    const {cliConfig, ...commandOptions} = options
-    const apiClient = getClientWrapper(
-      cliConfig?.config?.api || null,
-      cliConfig?.path || (cliConfig?.version === 2 ? 'sanity.json' : 'sanity.cli.js'),
-    )
-
-    const context: CliCommandContext = {
-      output,
-      prompt,
-      apiClient,
-      chalk,
-      cliPackageManager,
-      ...commandOptions,
-      commandRunner: this,
-      ...getVersionedContextParams(cliConfig),
-    }
-
-    if (isCommandGroup(command)) {
-      return context.output.print(generateCommandsDocumentation(this.commandGroups, command.name))
-    }
-
-    if (typeof command.action !== 'function') {
-      const cmdName = command.name || commandOrGroup || '<unknown>'
-      debug(`Command "${cmdName}" doesnt have a valid "action"-property, showing help`)
-      const groupName = command.group && command.group !== 'default' ? command.group : null
-      return context.output.print(generateCommandDocumentation(command, groupName, subCommandName))
-    }
-
-    debug(`Running command "${command.name}"`)
-    return command.action(cmdArgs, context)
-  }
-
-  resolveCommand(commandOrGroup: string, subCommandName?: string): ResolvedCliCommand | null {
-    // First, see if there is a group with the given name, if a subcommand is provided
-    if (this.commandGroups[commandOrGroup] && subCommandName) {
-      debug(`Found group for name "${commandOrGroup}", resolving subcommand`)
-
-      const subCommand = this.resolveSubcommand(
-        this.commandGroups[commandOrGroup],
-        subCommandName,
-        commandOrGroup,
-      )
-
-      debug(
-        subCommand
-          ? `Subcommand resolved to "${subCommand.commandName}"`
-          : `Subcommand with name "${subCommandName}" not found`,
-      )
-
-      return subCommand
-    }
-
-    // No group? See if there's a command within the default group
-    debug(`No group found with name "${commandOrGroup}", looking for command`)
-    const command = this.commandGroups.default.find((cmd) => cmd.name === commandOrGroup)
-    if (command) {
-      debug(`Found command in default group with name "${commandOrGroup}"`)
-      return {
-        command: command,
-        commandName: command.name,
-        parentName: 'default',
-        isGroup: false,
-        isCommand: true,
-      }
-    }
-
-    debug(`No default command with name "${commandOrGroup}" found, giving up`)
-    return null
-  }
-
-  resolveSubcommand(
-    group: (CliCommandDefinition | CliCommandGroupDefinition)[],
-    subCommandName: string,
-    parentGroupName: string,
-  ): ResolvedCliCommand | null {
-    if (!subCommandName) {
-      return null
-    }
-
-    const subCommand = group.find((cmd) => cmd.name === subCommandName)
-    if (!subCommand) {
-      throw new Error(getNoSuchCommandText(subCommandName, parentGroupName, this.commandGroups))
-    }
-
-    return {
-      command: subCommand,
-      commandName: subCommandName,
-      parentName: parentGroupName,
-      isGroup: false,
-      isCommand: true,
-    }
-  }
-
-  resolveHelpForGroup(): ResolvedCliCommand {
-    const command = this.commandGroups.default.find((cmd) => cmd.name === 'help')
-    if (!command) {
-      throw new Error('Failed to find default `help` command')
-    }
-
-    return {
-      command,
-      commandName: 'help',
-      isGroup: false,
-      isCommand: true,
-    }
-  }
-}
-
-export function getCliRunner(commands: CommandOrGroup[]): CommandRunner {
-  return new CommandRunner(
-    {
-      outputter: cliOutputter,
-      prompter: cliPrompter,
-    },
-    commands,
-  )
-}
-
-function getVersionedContextParams(
-  cliConfig: CliConfigResult | null,
-):
-  | {sanityMajorVersion: 2; cliConfig?: SanityJson; cliConfigPath?: string}
-  | {sanityMajorVersion: 3; cliConfig?: CliConfig; cliConfigPath?: string} {
-  return cliConfig?.version === 2
-    ? {
-        sanityMajorVersion: 2,
-        cliConfig: cliConfig?.config || undefined,
-        cliConfigPath: cliConfig?.path || undefined,
-      }
-    : {
-        sanityMajorVersion: 3,
-        cliConfig: cliConfig?.config || undefined,
-        cliConfigPath: cliConfig?.path || undefined,
-      }
-}

package/src/__telemetry__/cli.telemetry.ts

@@ -1,29 +0,0 @@
-import {defineTrace} from '@sanity/telemetry'
-
-interface CLITraceData {
-  /**
-   * Command flags, without the core options (help, debug, version etc)
-   */
-  groupOrCommand: string
-
-  /**
-   * Command arguments, eg any arguments after `sanity <command>` (no flags)
-   */
-  commandArguments: string[]
-
-  /**
-   * Arguments after the ended argument list (--)
-   */
-  extraArguments: string[]
-  coreOptions: {
-    help?: boolean
-    debug?: boolean
-    version?: boolean
-  }
-}
-
-export const CliCommand = defineTrace<CLITraceData>({
-  name: 'CLI Command Executed',
-  version: 1,
-  description: 'A CLI command was executed',
-})

package/src/__telemetry__/init.telemetry.ts

@@ -1,95 +0,0 @@
-import {defineTrace} from '@sanity/telemetry'
-
-interface StartStep {
-  step: 'start'
-  flags: Record<string, string | number | undefined | boolean>
-}
-
-interface LoginStep {
-  step: 'login'
-  alreadyLoggedIn?: boolean
-}
-
-interface FetchJourneyConfigStep {
-  step: 'fetchJourneyConfig'
-  projectId: string
-  datasetName: string
-  displayName: string
-  isFirstProject: boolean
-}
-
-interface CreateOrSelectProjectStep {
-  step: 'createOrSelectProject'
-  projectId: string
-  selectedOption: 'create' | 'select' | 'none'
-}
-
-interface CreateOrSelectDatasetStep {
-  step: 'createOrSelectDataset'
-  datasetName: string
-  selectedOption: 'create' | 'select' | 'none'
-  visibility: 'private' | 'public'
-}
-
-interface UseDefaultPlanCoupon {
-  step: 'useDefaultPlanCoupon'
-  selectedOption: 'yes' | 'no'
-  coupon?: string
-}
-
-interface UseDefaultPlanId {
-  step: 'useDefaultPlanId'
-  selectedOption: 'yes' | 'no'
-  planId?: string
-}
-
-interface UseDetectedFrameworkStep {
-  step: 'useDetectedFramework'
-  selectedOption: 'yes' | 'no'
-  detectedFramework?: string
-}
-
-interface UseTypeScriptStep {
-  step: 'useTypeScript'
-  selectedOption: 'yes' | 'no'
-}
-
-interface SelectTemplateStep {
-  step: 'selectProjectTemplate'
-  selectedOption: string
-}
-interface ImportTemplateDatasetStep {
-  step: 'importTemplateDataset'
-  selectedOption: 'yes' | 'no'
-}
-
-interface SendCommunityInviteStep {
-  step: 'sendCommunityInvite'
-  selectedOption: 'yes' | 'no'
-}
-
-interface SelectPackageManagerStep {
-  step: 'selectPackageManager'
-  selectedOption: string
-}
-
-type InitStepResult =
-  | StartStep
-  | LoginStep
-  | FetchJourneyConfigStep
-  | CreateOrSelectProjectStep
-  | CreateOrSelectDatasetStep
-  | UseDetectedFrameworkStep
-  | UseTypeScriptStep
-  | ImportTemplateDatasetStep
-  | SendCommunityInviteStep
-  | SelectPackageManagerStep
-  | SelectTemplateStep
-  | UseDefaultPlanCoupon
-  | UseDefaultPlanId
-
-export const CLIInitStepCompleted = defineTrace<InitStepResult>({
-  name: 'CLI Init Step Completed',
-  version: 1,
-  description: 'User completed a step in the CLI init flow',
-})

package/src/actions/codemod/codemodAction.ts

@@ -1,109 +0,0 @@
-/* eslint-disable no-process-exit, no-sync */
-import childProcess from 'node:child_process'
-import fs from 'node:fs'
-import path from 'node:path'
-
-import {type CliCommandAction, type CliCommandContext} from '../../types'
-import mods from './mods'
-import {type CodeMod} from './types'
-
-export interface CodeModFlags {
-  extensions?: string
-  verify?: boolean
-  dry?: boolean
-}
-
-export const codemodAction: CliCommandAction<CodeModFlags> = async function codemodAction(
-  args,
-  context,
-) {
-  const {output, cliRoot, workDir} = context
-  const [name] = args.argsWithoutOptions
-  const cliFlags = args.extOptions
-  if (!name) {
-    printMods(output)
-    return
-  }
-
-  // Make a record where all the keys of the available codemods are lowercased,
-  // eg `reactIconsV3` turns into `{reacticonsv3: CodeMod}`
-  const normalizedMods: Record<string, CodeMod> = {}
-  for (const [originalName, mod] of Object.entries(mods)) {
-    normalizedMods[originalName.toLowerCase()] = mod
-  }
-
-  // Verify that mod exists
-  const mod = normalizedMods[name.toLowerCase()]
-  if (!mod) {
-    throw new Error(`Codemod with name "${name}" not found`)
-  }
-
-  // Verify if there is any verification deefined, and user has not opted out of it
-  if (typeof mod.verify === 'function' && cliFlags.verify !== false) {
-    await mod.verify(context)
-  }
-
-  // If extensions are defined, they come in as CSV, so split and normalize them
-  const exts = cliFlags.extensions
-    ? cliFlags.extensions.split(',').map((ext) => ext.trim().replace(/^\./, ''))
-    : ['js', 'ts', 'tsx']
-
-  const dryRun = Boolean(typeof cliFlags.dry === 'undefined' ? false : cliFlags.dry)
-
-  // We use npx to run jscodeshift, so verify that it exists and works before using it
-  ensureNpx()
-
-  // If there is a gitignore in the target folder, we want to use that to know
-  // which folders to ignore - eg `dist`, `coverage` or whatever
-  const hasGitIgnore = fs.existsSync(path.join(workDir, '.gitignore'))
-
-  // Build the CLI command arguments
-  const modPath = path.resolve(path.join(cliRoot, 'codemods', mod.filename))
-  const cmdArgs = [
-    'jscodeshift',
-    '--ignore-pattern',
-    'node_modules',
-    '--ignore-pattern',
-    'dist',
-    hasGitIgnore && '--ignore-config',
-    hasGitIgnore && '.gitignore',
-    '-t',
-    modPath,
-    '--extensions',
-    exts.join(','),
-    dryRun && '--dry',
-    workDir,
-  ].filter((item): item is string => typeof item === 'string')
-
-  const child = childProcess.spawn('npx', cmdArgs, {
-    stdio: 'inherit',
-  })
-
-  process.on('SIGINT', () => {
-    child.kill(2)
-  })
-
-  child.on('close', (code) => {
-    process.exit(code || undefined)
-  })
-}
-function printMods(output: CliCommandContext['output']) {
-  output.print('Available code modifications:\n')
-
-  for (const [modName, mod] of Object.entries(mods)) {
-    output.print(`${modName} - ${mod.purpose}`)
-  }
-}
-
-function ensureNpx() {
-  try {
-    const npxHelp = childProcess.execSync('npx --help', {encoding: 'utf8'})
-    if (!npxHelp.includes('npm')) {
-      throw new Error('Not the npx we expected')
-    }
-  } catch {
-    throw new Error(
-      `Failed to run "npx" - required to run codemods. Do you have a recent version of npm installed?`,
-    )
-  }
-}

package/src/actions/codemod/mods/deskRename.ts

@@ -1,19 +0,0 @@
-import {type CodeMod} from '../types'
-
-const purpose = 'Transform `sanity/desk` imports to `sanity/structure`'
-const description = `
-Modifies all code paths that are found to import  from 'sanity/desk' to instead import from
-'sanity/structure', and renames any renamed members.
-
-from: import {deskTool} from 'sanity/desk'
-  to: import {structureTool} from 'sanity/structure'
-
-from: import {StructureBuilder} from 'sanity/desk'
-  to: import {StructureBuilder} from 'sanity/structure'
-`.trim()
-
-export const deskRename: CodeMod = {
-  purpose,
-  description,
-  filename: 'deskRename.js',
-}

package/src/actions/codemod/mods/index.ts

@@ -1,9 +0,0 @@
-import {deskRename} from './deskRename'
-import {partsTypeDirective} from './partsTypeDirective'
-import {reactIconsV3} from './reactIconsV3'
-
-export default {
-  reactIconsV3,
-  partsTypeDirective,
-  deskRename,
-}

package/src/actions/codemod/mods/partsTypeDirective.ts

@@ -1,28 +0,0 @@
-import {type CodeMod} from '../types'
-
-const purpose = 'Add parts types directive to all ts/tsx files that has one or more part imports'
-const description = `
-Adds a '///<reference types="@sanity/types/parts" />' header to all source files that has one or more part imports.
-For example:
-
-Before:
----- somefile.ts
-import client from 'part:@sanity/base/client'
-//…
-----
-
-After:
----- somefile.ts
-///<reference types="@sanity/types/parts" />
-import client from 'part:@sanity/base/client'
-//…
-----
-
-
-`.trim()
-
-export const partsTypeDirective: CodeMod = {
-  purpose,
-  description,
-  filename: 'partsTypeDirective.js',
-}

package/src/actions/codemod/mods/reactIconsV3.ts

@@ -1,54 +0,0 @@
-import path from 'node:path'
-
-import resolveFrom from 'resolve-from'
-import semverCompare from 'semver-compare'
-
-import {type PackageJson} from '../../../types'
-import {readJson} from '../../../util/readJson'
-import {type CodeMod} from '../types'
-
-const purpose = 'Transform react-icons v2 imports to v3 form'
-const description = `
-Modifies all found react-icons import and require statements from their v2 form
-to the path structure used in react-icons v3. For instance:
-
-from: import {MdPerson} from 'react-icons/lib/md'
-  to: import {MdPerson} from 'react-icons/md'
-
-from: import PersonIcon from 'react-icons/lib/md/person'
-  to: import {MdPerson as PersonIcon} from 'react-icons/md'
-`.trim()
-
-export const reactIconsV3: CodeMod = {
-  purpose,
-  description,
-  filename: 'reactIconsV3.js',
-  verify: async (context) => {
-    const {workDir} = context
-
-    const studioPkg = await maybeReadJson(path.join(workDir, 'package.json'))
-    const dependencies = (studioPkg && studioPkg.dependencies) || {}
-    const dependencyVersion = (dependencies['react-icons'] || '').replace(/^[\^~]/, '')
-    if (!dependencyVersion) {
-      throw new Error('Could not find react-icons declared as dependency in package.json')
-    }
-
-    if (semverCompare(dependencyVersion, '3.0.0') < 0) {
-      throw new Error('react-icons declared in package.json dependencies is lower than 3.0.0')
-    }
-
-    const iconPkgPath = resolveFrom.silent(workDir, 'react-icons/package.json')
-    const iconPkg = iconPkgPath && (await maybeReadJson(iconPkgPath))
-    if (iconPkg && semverCompare(iconPkg.version, '3.0.0') < 0) {
-      throw new Error('The installed version of react-icon seems to be < 3.0.0')
-    }
-  },
-}
-
-async function maybeReadJson(jsonPath: string): Promise<PackageJson | null> {
-  try {
-    return await readJson(jsonPath)
-  } catch {
-    return null
-  }
-}

package/src/actions/codemod/types.ts

@@ -1,10 +0,0 @@
-import {type CliCommandContext} from '../../types'
-
-export interface CodeMod {
-  purpose: string
-  description: string
-  verify?: (context: CliCommandContext) => Promise<void>
-
-  // Must match filename in `cli/codemods/`
-  filename: string
-}