@sanity/cli 3.93.1-next.8.cf0bf8550a → 3.94.0

package/src/commands/help/showHelp.ts

@@ -1,58 +0,0 @@
-import {debug} from '../../debug'
-import {type CliCommandDefinition} from '../../types'
-import {
-  generateCommandDocumentation,
-  generateCommandsDocumentation,
-} from '../../util/generateCommandsDocumentation'
-import {isCommandGroup} from '../../util/isCommandGroup'
-import {getNoSuchCommandText} from '../../util/noSuchCommandText'
-
-const showHelpAction: CliCommandDefinition['action'] = async (args, context) => {
-  const [commandName, subCommandName] = args.argsWithoutOptions
-  const {commandGroups} = context.commandRunner
-
-  if (!commandName) {
-    debug('No command given to "help", showing generate Sanity CLI help')
-    context.output.print(generateCommandsDocumentation(commandGroups))
-    return
-  }
-
-  const defaultCommand = commandGroups.default.find((cmd) => cmd.name === commandName)
-  if (defaultCommand && !isCommandGroup(defaultCommand)) {
-    debug(`Found command in default group with name "${commandName}"`)
-    context.output.print(generateCommandDocumentation(defaultCommand))
-    return
-  }
-
-  const group = commandGroups[commandName]
-  if (!subCommandName && !group) {
-    debug(`No subcommand given, and we couldn't find a group with name "${group}"`)
-    throw new Error(getNoSuchCommandText(commandName, null, commandGroups))
-  }
-
-  if (!subCommandName && group) {
-    debug(`No subcommand given, but found group with name "${commandName}"`)
-    context.output.print(generateCommandsDocumentation(commandGroups, commandName))
-    return
-  }
-
-  if (subCommandName && !group) {
-    debug(`Subcommand given, but couldn't find group with name "${commandName}"`)
-    throw new Error(getNoSuchCommandText(subCommandName, commandName, commandGroups))
-  }
-
-  const subCommand = context.commandRunner.resolveSubcommand(group, subCommandName, commandName)
-  if (!subCommand) {
-    debug(`Subcommand given, but not found in group "${commandName}"`)
-    throw new Error(getNoSuchCommandText(subCommandName, commandName, commandGroups))
-  }
-
-  debug('Subcommand "%s" for group "%s" found, showing help', subCommandName, commandName)
-  if (!isCommandGroup(subCommand.command)) {
-    context.output.print(
-      generateCommandDocumentation(subCommand.command, commandName, subCommandName),
-    )
-  }
-}
-
-export default showHelpAction

package/src/commands/index.ts

@@ -1,72 +0,0 @@
-import {type CliCommandDefinition, type CliCommandGroupDefinition} from '../types'
-import addBlueprintsCommand from './blueprints/addBlueprintsCommand'
-import blueprintsGroup from './blueprints/blueprintsGroup'
-import configBlueprintsCommand from './blueprints/configBlueprintsCommand'
-import deployBlueprintsCommand from './blueprints/deployBlueprintsCommand'
-import destroyBlueprintsCommand from './blueprints/destroyBlueprintsCommand'
-import infoBlueprintsCommand from './blueprints/infoBlueprintsCommand'
-import initBlueprintsCommand from './blueprints/initBlueprintsCommand'
-import logsBlueprintsCommand from './blueprints/logsBlueprintsCommand'
-import planBlueprintsCommand from './blueprints/planBlueprintsCommand'
-import listBlueprintsCommand from './blueprints/stacksBlueprintsCommand'
-import codemodCommand from './codemod/codemodCommand'
-import debugCommand from './debug/debugCommand'
-import docsCommand from './docs/docsCommand'
-import devfunctionsCommand from './functions/devFunctionsCommand'
-import envFunctionsCommand from './functions/envFunctionsCommand'
-import functionsGroup from './functions/functionsGroup'
-import logsfunctionsCommand from './functions/logsFunctionsCommand'
-import testfunctionsCommand from './functions/testFunctionsCommand'
-import helpCommand from './help/helpCommand'
-import initCommand from './init/initCommand'
-import installCommand from './install/installCommand'
-import learnCommand from './learn/learnCommand'
-import loginCommand from './login/loginCommand'
-import logoutCommand from './logout/logoutCommand'
-import manageCommand from './manage/manageCommand'
-import listProjectsCommand from './projects/listProjectsCommand'
-import projectsGroup from './projects/projectsGroup'
-import disableTelemetryCommand from './telemetry/disableTelemetryCommand'
-import enableTelemetryCommand from './telemetry/enableTelemetryCommand'
-import telemetryGroup from './telemetry/telemetryGroup'
-import telemetryStatusCommand from './telemetry/telemetryStatusCommand'
-import generateTypegenCommand from './typegen/generateTypesCommand'
-import typegenGroup from './typegen/typegenGroup'
-import versionsCommand from './versions/versionsCommand'
-
-export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[] = [
-  initCommand,
-  loginCommand,
-  logoutCommand,
-  installCommand,
-  versionsCommand,
-  docsCommand,
-  manageCommand,
-  debugCommand,
-  helpCommand,
-  projectsGroup,
-  learnCommand,
-  listProjectsCommand,
-  codemodCommand,
-  telemetryGroup,
-  disableTelemetryCommand,
-  enableTelemetryCommand,
-  telemetryStatusCommand,
-  generateTypegenCommand,
-  typegenGroup,
-  functionsGroup,
-  devfunctionsCommand,
-  logsfunctionsCommand,
-  testfunctionsCommand,
-  envFunctionsCommand,
-  blueprintsGroup,
-  addBlueprintsCommand,
-  configBlueprintsCommand,
-  deployBlueprintsCommand,
-  destroyBlueprintsCommand,
-  infoBlueprintsCommand,
-  initBlueprintsCommand,
-  listBlueprintsCommand,
-  logsBlueprintsCommand,
-  planBlueprintsCommand,
-]

package/src/commands/init/initCommand.ts

@@ -1,123 +0,0 @@
-import {type Framework, frameworks} from '@vercel/frameworks'
-import {detectFrameworkRecord, LocalFileSystemDetector} from '@vercel/fs-detectors'
-
-import initProject from '../../actions/init-project/initProject'
-import {
-  allowedPackageManagersString,
-  type PackageManager,
-} from '../../packageManager/packageManagerChoice'
-import {type CliCommandDefinition} from '../../types'
-
-const helpText = `
-Options
-  -y, --yes Use unattended mode, accepting defaults and using only flags for choices
-  --project <projectId> Project ID to use for the studio
-  --organization <organizationId> Organization ID to use for the project
-  --dataset <dataset> Dataset name for the studio
-  --dataset-default Set up a project with a public dataset named "production"
-  --output-path <path> Path to write studio project to
-  --template <template> Project template to use [default: "clean"]
-  --bare Skip the Studio initialization and only print the selected project ID and dataset name to stdout
-  --env <filename> Write environment variables to file [default: ".env"]
-  --provider <provider> Login provider to use
-  --visibility <mode> Visibility mode for dataset (public/private)
-  --create-project <name> Create a new project with the given name
-  --project-plan <name> Optionally select a plan for a new project
-  --coupon <name> Optionally select a coupon for a new project (cannot be used with --project-plan)
-  --no-typescript Do not use TypeScript for template files
-  --package-manager <name> Specify which package manager to use [allowed: ${allowedPackageManagersString}]
-  --no-auto-updates Disable auto updates of studio versions
-
-Examples
-  # Initialize a new project, prompt for required information along the way
-  sanity init
-
-  # Initialize a new project with a public dataset named "production"
-  sanity init --dataset-default
-
-  # Initialize a project with the given project ID and dataset to the given path
-  sanity init -y --project abc123 --dataset production --output-path ~/myproj
-
-  # Initialize a project with the given project ID and dataset using the moviedb
-  # template to the given path
-  sanity init -y --project abc123 --dataset staging --template moviedb --output-path .
-
-  # Create a brand new project with name "Movies Unlimited"
-  sanity init -y \\
-    --create-project "Movies Unlimited" \\
-    --dataset moviedb \\
-    --visibility private \\
-    --template moviedb \\
-    --output-path /Users/espenh/movies-unlimited
-`
-
-export interface InitFlags {
-  'y'?: boolean
-  'yes'?: boolean
-  'project'?: string
-  'dataset'?: string
-  'template'?: string
-  /**
-   * Used for accessing private GitHub repo templates
-   * @beta
-   */
-  'template-token'?: string
-
-  'visibility'?: string
-  'typescript'?: boolean
-  'auto-updates'?: boolean
-  /**
-   * Used for initializing a project from a server schema that is saved in the Journey API
-   * Overrides `project` option.
-   * Overrides `dataset` option.
-   * Overrides `template` option.
-   * Overrides `visibility` option.
-   * @beta
-   */
-  'quickstart'?: string
-  'bare'?: boolean
-  'env'?: boolean | string
-  'git'?: boolean | string
-
-  'output-path'?: string
-  'project-plan'?: string
-  'create-project'?: boolean | string
-  'dataset-default'?: boolean
-
-  'coupon'?: string
-  /**
-   * @deprecated `--reconfigure` is deprecated - manual configuration is now required
-   */
-  'reconfigure'?: boolean
-
-  'organization'?: string
-
-  'package-manager'?: PackageManager
-}
-
-const initCommand: CliCommandDefinition<InitFlags> = {
-  name: 'init',
-  signature: '',
-  description: 'Initializes a new Sanity Studio and/or project',
-  helpText,
-  action: async (args, context) => {
-    const [type] = args.argsWithoutOptions
-
-    // `sanity init whatever`
-    if (type) {
-      return Promise.reject(new Error(`Unknown init type "${type}"`))
-    }
-
-    const detectedFramework: Framework | null = await detectFrameworkRecord({
-      fs: new LocalFileSystemDetector(process.cwd()),
-      frameworkList: frameworks as readonly Framework[],
-    })
-
-    return initProject(args, {
-      ...context,
-      detectedFramework,
-    })
-  },
-}
-
-export default initCommand

package/src/commands/install/installCommand.ts

@@ -1,38 +0,0 @@
-import {
-  getPackageManagerChoice,
-  installDeclaredPackages,
-  installNewPackages,
-} from '../../packageManager'
-import {type CliCommandDefinition} from '../../types'
-
-const installCommand: CliCommandDefinition = {
-  name: 'install',
-  signature: '',
-  helpText: '',
-  description: 'Installs dependencies for Sanity Studio project',
-  action: async (args, context) => {
-    const {workDir, prompt, sanityMajorVersion} = context
-    const packages = args.argsWithoutOptions
-    if (packages.length > 0 && sanityMajorVersion === 2) {
-      /**
-       * Note: `@sanity/core` (only used in v2) takes over the `sanity install`
-       * command and provides the ability to install plugins. In v3, we don't
-       * want this, which is why this error differs based on major version.
-       **/
-      throw new Error('Re-run this command with `@sanity/core` installed')
-    }
-
-    const pkgManager = await getPackageManagerChoice(workDir, {prompt})
-
-    if (packages.length > 0) {
-      await installNewPackages(
-        {packageManager: pkgManager.chosen, packages: args.argsWithoutOptions},
-        context,
-      )
-    } else {
-      await installDeclaredPackages(workDir, pkgManager.chosen, context)
-    }
-  },
-}
-
-export default installCommand

package/src/commands/learn/learnCommand.ts

@@ -1,20 +0,0 @@
-import open from 'open'
-
-import {type CliCommandDefinition} from '../../types'
-
-const learnCommand: CliCommandDefinition = {
-  name: 'learn',
-  helpText: '',
-  signature: 'learn',
-  description: 'Opens Sanity Learn in your web browser',
-  async action(args, context) {
-    const {output} = context
-    const {print} = output
-    const url = 'https://www.sanity.io/learn'
-
-    print(`Opening ${url}`)
-    await open(url)
-  },
-}
-
-export default learnCommand

package/src/commands/login/loginCommand.ts

@@ -1,29 +0,0 @@
-import {login} from '../../actions/login/login'
-import {type CliCommandDefinition} from '../../types'
-
-const helpText = `
-Options
-  --sso <slug> Log in using Single Sign On, using the given slug
-  --provider <providerId> Authenticate against a specific provider
-  --no-open Do not open a browser window to log in, only print URL
-
-Examples
-  # Log in using default settings
-  sanity login
-
-  # Log in using Single Sign-On with the "my-organization" slug
-  sanity login --sso my-organization
-
-  # Login with GitHub provider, but do not open a browser window automatically
-  sanity login --provider github --no-open
-`
-
-const loginCommand: CliCommandDefinition = {
-  name: 'login',
-  signature: '[--sso <slug>] [--provider <providerId>] [--no-open]',
-  helpText,
-  description: 'Authenticates the CLI for access to Sanity projects',
-  action: login,
-}
-
-export default loginCommand

package/src/commands/logout/logoutCommand.ts

@@ -1,52 +0,0 @@
-import chalk from 'chalk'
-
-import {type CliCommandDefinition} from '../../types'
-import {TELEMETRY_CONSENT_CONFIG_KEY} from '../../util/createTelemetryStore'
-import {getUserConfig} from '../../util/getUserConfig'
-
-const helpText = `
-Examples
-  # Log out of the CLI
-  sanity logout
-`
-
-const logoutCommand: CliCommandDefinition = {
-  name: 'logout',
-  helpText,
-  signature: 'logout',
-  description: 'Logs out the CLI from the current user session',
-  async action(args, {output, apiClient}) {
-    const cfg = getUserConfig()
-
-    const token = cfg.get('authToken')
-    if (!token) {
-      output.print(chalk.red('No login credentials found'))
-      return
-    }
-
-    const client = apiClient({requireUser: true, requireProject: false})
-    try {
-      await client.request({uri: '/auth/logout', method: 'POST'})
-    } catch (err) {
-      const statusCode = err && err.response && err.response.statusCode
-
-      // In the case of session timeouts or missing sessions, we'll get a 401
-      // This is an acceptable situation seen from a logout perspective - all we
-      // need to do in this case is clear the session from the view of the CLI
-      if (statusCode !== 401) {
-        output.error(chalk.red(`Failed to communicate with the Sanity API:\n${err.message}`))
-        return
-      }
-    }
-
-    cfg.delete('authType')
-    cfg.delete('authToken')
-
-    // Clear cached telemetry consent
-    cfg.delete(TELEMETRY_CONSENT_CONFIG_KEY)
-
-    output.success('Logged out')
-  },
-}
-
-export default logoutCommand

package/src/commands/manage/manageCommand.ts

@@ -1,24 +0,0 @@
-import open from 'open'
-
-import {type CliCommandDefinition} from '../../types'
-
-const manageCommand: CliCommandDefinition = {
-  name: 'manage',
-  signature: 'manage',
-  helpText: '',
-  description: 'Opens project management interface in your web browser',
-  async action(args, context) {
-    const {output, cliConfig} = context
-    const {print} = output
-    const projectId = cliConfig?.api?.projectId
-
-    const url = projectId
-      ? `https://www.sanity.io/manage/project/${projectId}`
-      : 'https://www.sanity.io/manage/'
-
-    print(`Opening ${url}`)
-    await open(url)
-  },
-}
-
-export default manageCommand

package/src/commands/projects/listProjectsCommand.ts

@@ -1,62 +0,0 @@
-import {size, sortBy} from 'lodash'
-
-import {type CliCommandDefinition} from '../../types'
-
-const headings = ['id', 'members', 'name', 'url', 'created']
-const helpText = `
-Options
-  --sort <field> Sort output by specified column
-  --order <asc/desc> Sort output ascending/descending
-
-Examples
-  # List projects
-  sanity projects list
-
-  # List projects sorted by member count, ascending
-  sanity projects list --sort=members --order=asc
-`
-
-const defaultFlags = {
-  sort: 'created',
-  order: 'desc',
-}
-
-const listProjectsCommand: CliCommandDefinition = {
-  name: 'list',
-  group: 'projects',
-  signature: '',
-  helpText,
-  description: 'Lists projects connected to your user',
-  action: async (args, context) => {
-    const {apiClient, output, chalk} = context
-    const flags = {...defaultFlags, ...args.extOptions}
-    const client = apiClient({
-      requireUser: true,
-      requireProject: false,
-    })
-
-    const projects = await client.projects.list()
-    const ordered = sortBy(
-      projects.map(({displayName, id, members = [], createdAt}) => {
-        const manage = `https://www.sanity.io/manage/project/${id}`
-        return [id, members.length, displayName, manage, createdAt].map(String)
-      }),
-      [headings.indexOf(flags.sort)],
-    )
-
-    const rows = flags.order === 'asc' ? ordered : ordered.reverse()
-
-    const maxWidths = rows.reduce(
-      (max, row) => row.map((current, index) => Math.max(size(current), max[index])),
-      headings.map((str) => size(str)),
-    )
-
-    const printRow = (row: string[]) =>
-      row.map((col, i) => `${col}`.padEnd(maxWidths[i])).join('   ')
-
-    output.print(chalk.cyan(printRow(headings)))
-    rows.forEach((row) => output.print(printRow(row)))
-  },
-}
-
-export default listProjectsCommand

package/src/commands/projects/projectsGroup.ts

@@ -1,10 +0,0 @@
-import {type CliCommandGroupDefinition} from '../../types'
-
-const projectGroup: CliCommandGroupDefinition = {
-  name: 'projects',
-  signature: '[COMMAND]',
-  isGroupRoot: true,
-  description: 'Lists all projects associated with your logged-in account',
-}
-
-export default projectGroup

package/src/commands/telemetry/disableTelemetryCommand.ts

@@ -1,19 +0,0 @@
-import {createSetTelemetryConsentAction} from '../../actions/telemetry/setTelemetryConsent'
-import {type CliCommandDefinition} from '../../types'
-
-const helpText = `
-Examples
-  # Disable telemetry for your logged in user
-  sanity telemetry disable
-`
-
-const disableTelemetryCommand: CliCommandDefinition = {
-  name: 'disable',
-  group: 'telemetry',
-  helpText,
-  signature: '',
-  description: 'Disable telemetry for your logged in user',
-  action: createSetTelemetryConsentAction('denied'),
-}
-
-export default disableTelemetryCommand

package/src/commands/telemetry/enableTelemetryCommand.ts

@@ -1,19 +0,0 @@
-import {createSetTelemetryConsentAction} from '../../actions/telemetry/setTelemetryConsent'
-import {type CliCommandDefinition} from '../../types'
-
-const helpText = `
-Examples
-  # Enable telemetry for your logged in user
-  sanity telemetry enable
-`
-
-const enableTelemetryCommand: CliCommandDefinition = {
-  name: 'enable',
-  group: 'telemetry',
-  helpText,
-  signature: '',
-  description: 'Enable telemetry for your logged in user',
-  action: createSetTelemetryConsentAction('granted'),
-}
-
-export default enableTelemetryCommand

package/src/commands/telemetry/telemetryGroup.ts

@@ -1,10 +0,0 @@
-import {type CliCommandGroupDefinition} from '../../types'
-
-const telemetryGroup: CliCommandGroupDefinition = {
-  name: 'telemetry',
-  signature: '[COMMAND]',
-  isGroupRoot: true,
-  description: 'Manages telemetry settings, opting in or out of data collection',
-}
-
-export default telemetryGroup

package/src/commands/telemetry/telemetryStatusCommand.ts

@@ -1,89 +0,0 @@
-import {type ConsentStatus} from '@sanity/telemetry'
-
-import {type CliCommandContext, type CliCommandDefinition} from '../../types'
-import {resolveConsent} from '../../util/createTelemetryStore'
-
-const helpText = `
-Examples
-  # Check telemetry consent status for your logged in user
-  sanity telemetry status
-`
-
-export function telemetryStatusMessage(status: ConsentStatus, {chalk}: CliCommandContext): string {
-  switch (status) {
-    case 'granted':
-      return `Status: ${chalk.green('Enabled')}`
-    case 'denied':
-      return `Status: ${chalk.red('Disabled')}`
-    case 'unset':
-      return `Status: ${chalk.yellow('Not set')}`
-    default:
-      return ''
-  }
-}
-
-export function telemetryLearnMoreMessage(status: ConsentStatus): string {
-  const url = 'https://www.sanity.io/telemetry'
-
-  switch (status) {
-    case 'granted':
-      return `Learn more about the data being collected here:\n${url}`
-    default:
-      return `Learn more here:\n${url}`
-  }
-}
-
-const telemetryStatusCommand: CliCommandDefinition = {
-  name: 'status',
-  group: 'telemetry',
-  helpText,
-  signature: '',
-  description: 'Check telemetry consent status for your logged in user',
-  action: async (_, context) => {
-    const {chalk, output} = context
-    // eslint-disable-next-line no-process-env
-    const {status, reason} = await resolveConsent({env: process.env})
-
-    switch (true) {
-      case status === 'undetermined' && reason === 'unauthenticated':
-        output.print('You need to log in first to see telemetry status.')
-        break
-      case status === 'undetermined' && reason === 'fetchError':
-        output.print(chalk.yellow('Could not fetch telemetry consent status.'))
-        break
-      case status === 'denied' && reason === 'localOverride':
-        output.print(`${telemetryStatusMessage(status, context)}\n`)
-        output.print(
-          `You've opted out of telemetry data collection.\nNo data will be collected from your machine.\n`,
-        )
-        output.print(`Using ${chalk.cyan('DO_NOT_TRACK')} environment variable.`)
-        break
-      case status === 'denied':
-        output.print(`${telemetryStatusMessage(status, context)}\n`)
-        output.print(
-          `You've opted out of telemetry data collection.\nNo data will be collected from your Sanity account.`,
-        )
-        break
-      case status === 'granted':
-        output.print(`${telemetryStatusMessage(status, context)}\n`)
-        output.print(
-          'Telemetry data on general usage and errors is collected to help us improve Sanity.',
-        )
-        break
-      case status === 'unset':
-        output.print(`${telemetryStatusMessage(status, context)}\n`)
-        output.print(`You've not set your preference for telemetry collection.\n`)
-        output.print(`Run ${chalk.cyan('npx sanity telemetry enable/disable')} to opt in or out.`)
-        output.print(
-          `You can also use the ${chalk.cyan('DO_NOT_TRACK')} environment variable to opt out.`,
-        )
-        break
-      default:
-        break
-    }
-
-    output.print(`\n${telemetryLearnMoreMessage(status)}`)
-  },
-}
-
-export default telemetryStatusCommand