@sanity/cli 3.65.2-corel.472 → 3.66.0

package/lib/index.d.mts

@@ -21,7 +21,6 @@ export declare interface CliBaseCommandContext {
   output: CliOutputter
   prompt: CliPrompter
   apiClient: CliApiClient
-  yarn: CliStubbedYarn
   sanityMajorVersion: 2 | 3
   cliConfigPath?: string
   cliRoot: string

package/lib/index.d.ts

@@ -21,7 +21,6 @@ export declare interface CliBaseCommandContext {
   output: CliOutputter
   prompt: CliPrompter
   apiClient: CliApiClient
-  yarn: CliStubbedYarn
   sanityMajorVersion: 2 | 3
   cliConfigPath?: string
   cliRoot: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.65.2-corel.472+f3a73ebb6f",
+  "version": "3.66.0",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,9 +58,9 @@
   "dependencies": {
     "@babel/traverse": "^7.23.5",
     "@sanity/client": "^6.24.1",
-    "@sanity/codegen": "3.65.2-corel.472+f3a73ebb6f",
+    "@sanity/codegen": "3.66.0",
     "@sanity/telemetry": "^0.7.7",
-    "@sanity/util": "3.65.2-corel.472+f3a73ebb6f",
+    "@sanity/util": "3.66.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -76,13 +76,13 @@
     "yaml": "^2.6.1"
   },
   "devDependencies": {
-    "@repo/package.config": "3.65.1",
-    "@repo/test-config": "3.65.1",
+    "@repo/package.config": "3.66.0",
+    "@repo/test-config": "3.66.0",
     "@rexxars/gitconfiglocal": "^3.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.65.2-corel.472+f3a73ebb6f",
+    "@sanity/types": "3.66.0",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -136,5 +136,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "f3a73ebb6fcc6dc002e1b38d009c024e52989909"
+  "gitHead": "aeff5521ef6c5e440baf8bfd31349d0a823c74cd"
 }

package/src/CommandRunner.ts

@@ -4,7 +4,7 @@ import {cloneDeep, sortBy} from 'lodash'
 import {baseCommands} from './commands'
 import {debug} from './debug'
 import cliOutputter from './outputters/cliOutputter'
-import {cliPackageManager, getYarnStub} from './packageManager'
+import {cliPackageManager} from './packageManager'
 import {prompt as cliPrompter} from './prompters/cliPrompter'
 import {
   type CliCommandArguments,
@@ -96,7 +96,6 @@ export class CommandRunner {
       cliPackageManager,
       ...commandOptions,
       commandRunner: this,
-      yarn: getYarnStub({output, workDir: commandOptions.workDir}),
       ...getVersionedContextParams(cliConfig),
     }
 

package/src/actions/init-project/bootstrapRemoteTemplate.ts

@@ -5,6 +5,7 @@ import {debug} from '../../debug'
 import {type CliCommandContext} from '../../types'
 import {
   applyEnvVariables,
+  checkNeedsReadToken,
   downloadAndExtractRepo,
   generateSanityApiReadToken,
   getMonoRepo,
@@ -23,7 +24,6 @@ export interface BootstrapRemoteOptions {
   bearerToken?: string
   packageName: string
   variables: GenerateConfigOptions['variables']
-  isCI?: boolean
 }
 
 const INITIAL_COMMIT_MESSAGE = 'Initial commit from Sanity CLI'
@@ -32,7 +32,7 @@ export async function bootstrapRemoteTemplate(
   opts: BootstrapRemoteOptions,
   context: CliCommandContext,
 ): Promise<void> {
-  const {outputPath, repoInfo, bearerToken, variables, packageName, isCI} = opts
+  const {outputPath, repoInfo, bearerToken, variables, packageName} = opts
   const {output, apiClient} = context
   const name = [repoInfo.username, repoInfo.name, repoInfo.filePath].filter(Boolean).join('/')
   const spinner = output.spinner(`Bootstrapping files from template "${name}"`).start()
@@ -47,12 +47,15 @@ export async function bootstrapRemoteTemplate(
   debug('Downloading and extracting repo to %s', outputPath)
   await downloadAndExtractRepo(outputPath, repoInfo, bearerToken)
 
+  debug('Checking if template needs read token')
+  const needsReadToken = await Promise.all(
+    (packages ?? ['']).map((pkg) => checkNeedsReadToken(join(outputPath, pkg))),
+  ).then((results) => results.some(Boolean))
+
   debug('Applying environment variables')
-  const readToken = await generateSanityApiReadToken(
-    isCI ? 'ci-remote-template-test-token-please-add-email-filter' : 'API Read Token',
-    variables.projectId,
-    apiClient,
-  )
+  const readToken = needsReadToken
+    ? await generateSanityApiReadToken('API Read Token', variables.projectId, apiClient)
+    : undefined
   const isNext = await isNextJsTemplate(outputPath)
   const envName = isNext ? '.env.local' : '.env'
 

package/src/actions/init-project/initProject.ts

@@ -62,7 +62,6 @@ import {
   promptForStudioPath,
 } from './prompts/nextjs'
 import {readPackageJson} from './readPackageJson'
-import {reconfigureV2Project} from './reconfigureV2Project'
 import templates from './templates'
 import {
   sanityCliTemplate,
@@ -115,16 +114,7 @@ export default async function initSanity(
     detectedFramework: Awaited<ReturnType<typeof detectFrameworkRecord>>
   },
 ): Promise<void> {
-  const {
-    output,
-    prompt,
-    workDir,
-    apiClient,
-    chalk,
-    sanityMajorVersion,
-    telemetry,
-    detectedFramework,
-  } = context
+  const {output, prompt, workDir, apiClient, chalk, telemetry, detectedFramework} = context
 
   const trace = telemetry.trace(CLIInitStepCompleted)
 
@@ -165,11 +155,6 @@ export default async function initSanity(
     },
   })
 
-  if (sanityMajorVersion === 2) {
-    await reconfigureV2Project(args, context)
-    return
-  }
-
   if (detectedFramework && detectedFramework.slug !== 'sanity' && remoteTemplateInfo) {
     throw new Error(
       `A remote template cannot be used with a detected framework. Detected: ${detectedFramework.name}`,
@@ -1127,7 +1112,6 @@ export default async function initSanity(
           repoInfo: remoteTemplateInfo,
           bearerToken: cliFlags['template-token'],
           variables: bootstrapVariables,
-          isCI,
         },
         context,
       )

package/src/commands/index.ts

@@ -17,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)[] = [
@@ -25,7 +24,6 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   loginCommand,
   logoutCommand,
   installCommand,
-  upgradeCommand,
   versionsCommand,
   docsCommand,
   manageCommand,

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,
@@ -105,14 +104,6 @@ export const initCommand: CliCommandDefinition<InitFlags> = {
     const {output, chalk} = context
     const [type] = args.argsWithoutOptions
 
-    // `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}"`))

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

package/src/util/remoteTemplate.ts

@@ -420,6 +420,22 @@ export async function isNextJsTemplate(root: string): Promise<boolean> {
   }
 }
 
+export async function checkNeedsReadToken(root: string): Promise<boolean> {
+  try {
+    const templatePath = await Promise.any(
+      ENV_TEMPLATE_FILES.map(async (file) => {
+        await access(join(root, file))
+        return file
+      }),
+    )
+
+    const templateContent = await readFile(join(root, templatePath), 'utf8')
+    return templateContent.includes(ENV_VAR.READ_TOKEN)
+  } catch {
+    return false
+  }
+}
+
 export async function applyEnvVariables(
   root: string,
   envData: EnvData,

package/src/actions/init-plugin/initPlugin.ts

@@ -1,119 +0,0 @@
-import fs from 'node:fs/promises'
-import path from 'node:path'
-
-import {type InitFlags} from '../../commands/init/initCommand'
-import {debug} from '../../debug'
-import {type CliCommandArguments, type CliCommandContext, type SanityJson} from '../../types'
-import {bootstrapFromTemplate} from './bootstrapFromTemplate'
-import {pluginTemplates} from './pluginTemplates'
-
-export default async function initPlugin(
-  args: CliCommandArguments<InitFlags>,
-  context: CliCommandContext,
-): Promise<void> {
-  const {output, prompt} = context
-  const [, specifiedTemplateUrl] = args.argsWithoutOptions
-
-  output.print('This utility will walk you through creating a new Sanity plugin.')
-  output.print('Press ^C at any time to quit.\n')
-
-  const hasTemplateUrl = /^https?:\/\//.test(specifiedTemplateUrl || '')
-
-  if (hasTemplateUrl) {
-    debug('User provided template URL: %s', specifiedTemplateUrl)
-    return bootstrapFromUrl(context, specifiedTemplateUrl)
-  }
-
-  let specifiedTemplate = null
-  if (specifiedTemplateUrl) {
-    specifiedTemplate = pluginTemplates.find((tpl) => tpl.value === specifiedTemplateUrl)
-  }
-
-  if (specifiedTemplate) {
-    debug(
-      'User wanted template "%s", match found at %s',
-      specifiedTemplateUrl,
-      specifiedTemplate.url,
-    )
-
-    return bootstrapFromUrl(context, specifiedTemplate.url)
-  } else if (specifiedTemplateUrl) {
-    throw new Error(`Cannot find template with name "${specifiedTemplateUrl}"`)
-  }
-
-  const templateChoices = pluginTemplates.map(({value, name}) => ({value, name}))
-  const selected = await prompt.single({
-    message: 'Select template to use',
-    type: 'list',
-    choices: templateChoices,
-  })
-
-  specifiedTemplate = pluginTemplates.find((tpl) => tpl.value === selected)
-  if (!specifiedTemplate) {
-    throw new Error('No template selected')
-  }
-
-  debug('User selected template URL: %s', specifiedTemplate.url)
-  return bootstrapFromUrl(context, specifiedTemplate.url)
-}
-
-async function bootstrapFromUrl(context: CliCommandContext, url: string): Promise<void> {
-  const {output, prompt, yarn, workDir} = context
-
-  debug('Bootstrapping from URL: %s', url)
-  const {name, outputPath, inPluginsPath, dependencies} = await bootstrapFromTemplate(context, url)
-
-  if (inPluginsPath) {
-    const addIt = await prompt.single({
-      type: 'confirm',
-      message: 'Enable plugin in current Sanity installation?',
-      default: true,
-    })
-
-    if (addIt) {
-      await addPluginToManifest(workDir, name.replace(/^sanity-plugin-/, ''))
-    }
-  }
-
-  if (dependencies) {
-    const dependencyString = JSON.stringify(dependencies, null, 2)
-      .split('\n')
-      .slice(1, -1)
-      .join('\n')
-      .replace(/"/g, '')
-
-    output.print('\nThe following dependencies are required for this template:')
-    output.print(`${dependencyString}\n`)
-  }
-
-  if (dependencies && inPluginsPath) {
-    const addDeps = await prompt.single({
-      type: 'confirm',
-      message: 'Install dependencies in current project?',
-      default: true,
-    })
-
-    if (addDeps) {
-      const deps = Object.keys(dependencies).map((dep) => `${dep}@${dependencies[dep]}`)
-      await yarn(['add'].concat(deps), {...output, rootDir: workDir})
-
-      output.print('Dependencies installed.')
-      output.print('Remember to remove them from `package.json` if you no longer need them!')
-    }
-  }
-
-  output.print(`\nSuccess! Plugin initialized at ${outputPath}`)
-}
-
-async function addPluginToManifest(sanityDir: string, pluginName: string): Promise<SanityJson> {
-  const manifestPath = path.join(sanityDir, 'sanity.json')
-  const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'))
-
-  manifest.plugins = manifest.plugins || []
-  if (manifest.plugins.indexOf(pluginName) === -1) {
-    manifest.plugins.push(pluginName)
-  }
-
-  await fs.writeFile(manifestPath, JSON.stringify(manifest, null, 2))
-  return manifest
-}

package/src/actions/init-plugin/pluginTemplates.ts

@@ -1,38 +0,0 @@
-export interface PluginTemplate {
-  value: string
-  name: string
-  url: string
-}
-
-export const pluginTemplates: PluginTemplate[] = [
-  {
-    value: 'logo',
-    name: 'Studio logo',
-    url: 'https://github.com/sanity-io/plugin-template-logo/archive/master.zip',
-  },
-  {
-    value: 'tool',
-    name: 'Basic, empty tool',
-    url: 'https://github.com/sanity-io/plugin-template-tool/archive/master.zip',
-  },
-  {
-    value: 'toolWithRouting',
-    name: 'Tool with basic routing',
-    url: 'https://github.com/sanity-io/plugin-template-tool-with-routing/archive/master.zip',
-  },
-  {
-    value: 'chessInput',
-    name: 'Chess board input component w/ block preview',
-    url: 'https://github.com/sanity-io/plugin-template-chess-input/archive/master.zip',
-  },
-  {
-    value: 'dashboardWidget',
-    name: 'A Dashboard widget with cats',
-    url: 'https://github.com/sanity-io/plugin-template-dashboard-widget-cats/archive/master.zip',
-  },
-  {
-    value: 'assetSource',
-    name: 'Custom asset source plugin',
-    url: 'https://github.com/sanity-io/plugin-template-asset-source/archive/master.zip',
-  },
-]