@sanity/cli/src/commands/functions/devFunctionsCommand.ts

Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets

import open from 'open'

import {type CliCommandDefinition} from '../../types'

const helpText = `
Options
  --port <port> Port to start emulator on
  --open Open dev server in a new browser tab

Examples
  # Start dev server on default port
  sanity functions dev

  # Start dev server on specific port
  sanity functions dev --port 3333

  # Start dev server and open a new browser tab
  sanity functions dev --open
`

export interface FunctionsDevFlags {
  open?: boolean
  port?: number
}

const defaultFlags: FunctionsDevFlags = {
  open: false,
  port: 8080,
}

const devFunctionsCommand: CliCommandDefinition<FunctionsDevFlags> = {
  name: 'dev',
  group: 'functions',
  helpText,
  signature: '[--port <port> --open]',
  description: 'Start the Sanity Function emulator',
  async action(args, context) {
    const {apiClient, output} = context
    const flags = {...defaultFlags, ...args.extOptions}
    const {open: shouldOpen} = flags

    const client = apiClient({requireUser: true, requireProject: false})
    const {token} = client.config()

    if (!token) throw new Error('No API token found. Please run `sanity login`.')

    const {initBlueprintConfig} = await import('@sanity/runtime-cli/cores')
    const {functionDevCore} = await import('@sanity/runtime-cli/cores/functions')

    const cmdConfig = await initBlueprintConfig({
      bin: 'sanity',
      log: (message) => output.print(message),
      token,
    })

    if (!cmdConfig.ok) throw new Error(cmdConfig.error)

    const {success, error} = await functionDevCore({
      ...cmdConfig.value,
      flags: {
        port: flags.port,
      },
    })

    if (!success) throw new Error(error)

    if (shouldOpen) {
      open(`http://localhost:${flags.port}`)
    }
  },
}

export default devFunctionsCommand