@sanity/cli 3.59.2-canary.33 → 3.59.2-corel-presentation-lcapi.562

package/src/commands/index.ts

@@ -5,6 +5,7 @@ import docsCommand from './docs/docsCommand'
 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'
@@ -16,7 +17,6 @@ import telemetryGroup from './telemetry/telemetryGroup'
 import telemetryStatusCommand from './telemetry/telemetryStatusCommand'
 import generateTypegenCommand from './typegen/generateTypesCommand'
 import typegenGroup from './typegen/typegenGroup'
-import upgradeCommand from './upgrade/upgradeCommand'
 import versionsCommand from './versions/versionsCommand'
 
 export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[] = [
@@ -24,13 +24,13 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   loginCommand,
   logoutCommand,
   installCommand,
-  upgradeCommand,
   versionsCommand,
   docsCommand,
   manageCommand,
   debugCommand,
   helpCommand,
   projectsGroup,
+  learnCommand,
   listProjectsCommand,
   codemodCommand,
   telemetryGroup,

package/src/commands/init/initCommand.ts

@@ -1,7 +1,6 @@
 import {type Framework, frameworks} from '@vercel/frameworks'
 import {detectFrameworkRecord, LocalFileSystemDetector} from '@vercel/fs-detectors'
 
-import initPlugin from '../../actions/init-plugin/initPlugin'
 import initProject from '../../actions/init-project/initProject'
 import {
   allowedPackageManagersString,
@@ -58,6 +57,11 @@ export interface InitFlags {
   'project'?: string
   'dataset'?: string
   'template'?: string
+  /**
+   * Used for accessing private GitHub repo templates
+   * @beta
+   */
+  'template-token'?: string
 
   'visibility'?: string
   'typescript'?: boolean
@@ -97,87 +101,23 @@ export const initCommand: CliCommandDefinition<InitFlags> = {
   description: 'Initializes a new Sanity Studio and/or project',
   helpText,
   action: async (args, context) => {
-    const {output, chalk, prompt} = context
+    const {output, chalk} = context
     const [type] = args.argsWithoutOptions
-    const unattended = args.extOptions.y || args.extOptions.yes
-
-    const warn = (msg: string) => output.warn(chalk.yellow.bgBlack(msg))
-
-    // `sanity init plugin`
-    if (type === 'plugin') {
-      return context.sanityMajorVersion === 2
-        ? // don't bother with telemetry here, as it's not supported in v3
-          initPlugin(args, context)
-        : Promise.reject(new Error(`'sanity init plugin' is not available in modern studios`))
-    }
 
     // `sanity init whatever`
     if (type) {
       return Promise.reject(new Error(`Unknown init type "${type}"`))
     }
 
-    // `npm create sanity` (regular v3 init)
-
     const detectedFramework: Framework | null = await detectFrameworkRecord({
       fs: new LocalFileSystemDetector(process.cwd()),
       frameworkList: frameworks as readonly Framework[],
     })
 
-    if (
-      args.argv.includes('--from-create') ||
-      args.argv.includes('--env') ||
-      args.argv.includes('--bare') ||
-      detectedFramework?.slug === 'nextjs'
-    ) {
-      return initProject(args, {
-        ...context,
-        detectedFramework,
-      })
-    }
-
-    // `sanity init` (v2 style)
-    warn('╭────────────────────────────────────────────────────────────╮')
-    warn('│                                                            │')
-    warn("│  Welcome to Sanity! It looks like you're following         │")
-    warn('│  instructions for Sanity Studio v2, but the version you    │')
-    warn('│  have installed is the latest - Sanity Studio v3.          │')
-    warn('│                                                            │')
-    warn('│  In Sanity Studio v3, new projects are created by running  │')
-    warn('│  [npm create sanity@latest]. For more information, see     │')
-    warn('│   https://www.sanity.io/help/studio-v2-vs-v3               │')
-    warn('│                                                            │')
-    warn('╰────────────────────────────────────────────────────────────╯')
-    warn('') // Newline to separate from other output
-    const continueV3Init = unattended
-      ? true
-      : await prompt.single({
-          message: 'Continue creating a Sanity Studio v3 project?',
-          type: 'confirm',
-        })
-
-    // Fall back
-    if (!continueV3Init) {
-      // Indicate that the operation did not succeed as expected
-      // eslint-disable-next-line no-process-exit
-      process.exit(1)
-    }
-
-    const returnVal = await initProject(args, {
+    return initProject(args, {
       ...context,
       detectedFramework,
-    }).catch((err) => {
-      return Promise.reject(err)
     })
-
-    warn('╭────────────────────────────────────────────────────────────╮')
-    warn('│                                                            │')
-    warn('│  To learn how commands have changed from Studio v2 to v3,  │')
-    warn('│  see https://www.sanity.io/help/studio-v2-vs-v3            │')
-    warn('│                                                            │')
-    warn('╰────────────────────────────────────────────────────────────╯')
-    warn('') // Newline to separate from other output
-
-    return returnVal
   },
 }
 

package/src/commands/learn/learnCommand.ts

@@ -0,0 +1,20 @@
+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/logout/logoutCommand.ts

@@ -45,7 +45,7 @@ const logoutCommand: CliCommandDefinition = {
     // Clear cached telemetry consent
     cfg.delete(TELEMETRY_CONSENT_CONFIG_KEY)
 
-    output.print(chalk.green('Logged out'))
+    output.success('Logged out')
   },
 }
 

package/src/outputters/cliOutputter.ts

@@ -2,6 +2,10 @@
 import chalk from 'chalk'
 import ora, {type Options, type Ora} from 'ora'
 
+const SYMBOL_CHECK = chalk.green('✓')
+const SYMBOL_WARN = chalk.yellow('⚠')
+const SYMBOL_FAIL = chalk.red('✗')
+
 let isFirstClear = true
 
 export default {
@@ -9,15 +13,19 @@ export default {
     console.log(...args)
   },
 
-  warn(...args: unknown[]): void {
-    console.warn(...args)
+  success(firstPartOfMessage: unknown, ...args: unknown[]): void {
+    console.log(`${SYMBOL_CHECK} ${firstPartOfMessage}`, ...args)
+  },
+
+  warn(firstPartOfMessage: unknown, ...args: unknown[]): void {
+    console.warn(`${SYMBOL_WARN} ${firstPartOfMessage}`, ...args)
   },
 
-  error(...args: unknown[]): void {
-    if (args[0] instanceof Error) {
-      console.error(chalk.red(args[0].stack))
+  error(firstPartOfMessage: unknown, ...args: unknown[]): void {
+    if (firstPartOfMessage instanceof Error) {
+      console.error(`${SYMBOL_FAIL} ${chalk.red(firstPartOfMessage.stack)}`)
     } else {
-      console.error(...args)
+      console.error(`${SYMBOL_FAIL} ${firstPartOfMessage}`, ...args)
     }
   },
 
@@ -28,7 +36,12 @@ export default {
     isFirstClear = false
   },
 
-  spinner(options: Options | string): Ora {
-    return ora(options)
+  spinner(options: Options): Ora {
+    const spinner = ora(options)
+    // Override the default status methods to use custom symbols instead of emojis
+    spinner.succeed = (text?: string) => spinner.stopAndPersist({text, symbol: SYMBOL_CHECK})
+    spinner.warn = (text?: string) => spinner.stopAndPersist({text, symbol: SYMBOL_WARN})
+    spinner.fail = (text?: string) => spinner.stopAndPersist({text, symbol: SYMBOL_FAIL})
+    return spinner
   },
 }

package/src/studioDependencies.ts

@@ -18,7 +18,7 @@ export const studioDependencies = {
     '@sanity/eslint-config-studio': 'latest',
     // When using typescript, we'll want the these types too, so might as well install them
     '@types/react': '^18.0.25',
-    'eslint': '^8.6.0',
+    'eslint': '^9.9.0',
     'prettier': '^3.0.2',
     'typescript': '^5.1.6', // Peer dependency of eslint-config-studio (implicitly)
   },

package/src/types.ts

@@ -82,7 +82,6 @@ export interface CliBaseCommandContext {
   output: CliOutputter
   prompt: CliPrompter
   apiClient: CliApiClient
-  yarn: CliStubbedYarn
   sanityMajorVersion: 2 | 3
   cliConfigPath?: string
   cliRoot: string
@@ -151,6 +150,7 @@ export interface CommandRunnerOptions {
 
 export interface CliOutputter {
   print: (...args: unknown[]) => void
+  success: (...args: unknown[]) => void
   warn: (...args: unknown[]) => void
   error: (...args: unknown[]) => void
   clear: () => void
@@ -286,6 +286,30 @@ export interface GraphQLAPIConfig {
   filterSuffix?: string
 }
 
+/**
+ * Until these types are on npm: https://github.com/facebook/react/blob/0bc30748730063e561d87a24a4617526fdd38349/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L39-L122
+ * @beta
+ */
+export interface ReactCompilerConfig {
+  /**
+   * @see https://react.dev/learn/react-compiler#existing-projects
+   */
+  sources?: Array<string> | ((filename: string) => boolean) | null
+
+  /**
+   * The minimum major version of React that the compiler should emit code for. If the target is 19
+   * or higher, the compiler emits direct imports of React runtime APIs needed by the compiler. On
+   * versions prior to 19, an extra runtime package react-compiler-runtime is necessary to provide
+   * a userspace approximation of runtime APIs.
+   * @see https://react.dev/learn/react-compiler#using-react-compiler-with-react-17-or-18
+   */
+  target: '18' | '19'
+
+  panicThreshold?: 'ALL_ERRORS' | 'CRITICAL_ERRORS' | 'NONE'
+
+  compilationMode?: 'infer' | 'syntax' | 'annotation' | 'all'
+}
+
 export interface CliConfig {
   api?: CliApiConfig
 
@@ -301,6 +325,13 @@ export interface CliConfig {
    */
   reactStrictMode?: boolean
 
+  /**
+   * The React Compiler is currently in beta, and is disabled by default.
+   * @see https://react.dev/learn/react-compiler
+   * @beta
+   */
+  reactCompiler?: ReactCompilerConfig
+
   server?: {
     hostname?: string
     port?: number
@@ -318,3 +349,12 @@ export interface CliConfig {
 export type UserViteConfig =
   | InlineConfig
   | ((config: InlineConfig, env: ConfigEnv) => InlineConfig | Promise<InlineConfig>)
+
+export type SanityUser = {
+  id: string
+  name: string
+  email: string
+  profileImage?: string
+  tosAcceptedAt?: string
+  provider: 'google' | 'github' | 'sanity' | `saml-${string}`
+}

package/src/util/frameworkPort.ts

@@ -0,0 +1,63 @@
+const FALLBACK_PORT = 3000
+
+const portMap: Record<string, number> = {
+  'nextjs': 3000,
+  'blitzjs': 3000,
+  'gatsby': 8000,
+  'remix': 3000,
+  'astro': 3000,
+  'hexo': 4000,
+  'eleventy': 8080,
+  'docusaurus': 3000,
+  'docusaurus-2': 3000,
+  'preact': 8080,
+  'solidstart': 3000,
+  'solidstart-1': 3000,
+  'dojo': 3000,
+  'ember': 4200,
+  'vue': 8080,
+  'scully': 1668,
+  'ionic-angular': 4200,
+  'angular': 4200,
+  'polymer': 8081,
+  'svelte': 5000,
+  'sveltekit': 5173,
+  'sveltekit-1': 5173,
+  'ionic-react': 3000,
+  'create-react-app': 3000,
+  'gridsome': 8080,
+  'umijs': 8000,
+  'saber': 3000,
+  'stencil': 3333,
+  'nuxtjs': 3000,
+  'redwoodjs': 8910,
+  'hugo': 1313,
+  'jekyll': 4000,
+  'brunch': 3333,
+  'middleman': 4567,
+  'zola': 1111,
+  'hydrogen': 3000,
+  'vite': 5173,
+  'vitepress': 5173,
+  'vuepress': 8080,
+  'parcel': 1234,
+  'fasthtml': 8000,
+  'sanity': 3333,
+  'sanity-v3': 3333,
+  'storybook': 6006,
+}
+
+/**
+ * Returns the default development port for a given framework.
+ * Contains default ports for all frameworks supported by `@vercel/frameworks`.
+ * Falls back to port 3000 if framework is not found or not specified.
+ *
+ * @see https://github.com/vercel/vercel/blob/main/packages/frameworks/src/frameworks.ts
+ * for the complete list of supported frameworks
+ *
+ * @param frameworkSlug - The framework identifier from `@vercel/frameworks`
+ * @returns The default port number for the framework
+ */
+export function getDefaultPortForFramework(frameworkSlug?: string | null): number {
+  return portMap[frameworkSlug ?? ''] ?? FALLBACK_PORT
+}

package/src/util/generateCommandsDocumentation.ts

@@ -22,12 +22,15 @@ export function generateCommandsDocumentation(
   const prefix = group === 'default' ? '' : ` ${group}`
 
   const rows = [
-    `usage: sanity${prefix} [--default] [-v|--version] [-d|--debug] [-h|--help] <command> [<args>]`,
+    `usage: npx sanity${prefix} [--default] [-v|--version] [-d|--debug] [-h|--help] <command> [<args>]`,
     '',
     'Commands:',
   ]
     .concat(commands.map((cmd) => `   ${padEnd(cmd.name, cmdLength + 1)} ${cmd.description}`))
-    .concat(['', `See 'sanity help${prefix} <command>' for specific information on a subcommand.`])
+    .concat([
+      '',
+      `See 'npx sanity help${prefix} <command>' for specific information on a subcommand.`,
+    ])
 
   return rows.join('\n')
 }
@@ -43,14 +46,14 @@ export function generateCommandDocumentation(
   if (!command) {
     throw new Error(
       subCommand
-        ? `"${subCommand}" is not a subcommand of "${group}". See 'sanity help ${group}'`
+        ? `"${subCommand}" is not a subcommand of "${group}". See 'npx sanity help ${group}'`
         : getNoSuchCommandText(group || command),
     )
   }
 
   const cmdParts = [group || command.name, subCommand].filter(Boolean).join(' ')
   return [
-    `usage: sanity ${cmdParts} ${command.signature}`,
+    `usage: npx sanity ${cmdParts} ${command.signature}`,
     '',
     `   ${command.description}`,
     '',

package/src/util/getCliConfig.ts

@@ -42,7 +42,7 @@ export async function getCliConfig(
 
   const {unregister} = __DEV__
     ? {unregister: () => undefined}
-    : require('esbuild-register/dist/node').register()
+    : require('esbuild-register/dist/node').register({supported: {'dynamic-import': true}})
 
   try {
     const v3Config = getSanityCliConfig(cwd)

package/src/util/getProviderName.ts

@@ -0,0 +1,9 @@
+import {type SanityUser} from '../types'
+
+export function getProviderName(provider: SanityUser['provider']) {
+  if (provider === 'google') return 'Google'
+  if (provider === 'github') return 'GitHub'
+  if (provider === 'sanity') return 'Email'
+  if (provider.startsWith('saml-')) return 'SAML'
+  return provider
+}