@sanity/cli 3.88.3 → 3.89.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.88.3",
+  "version": "3.89.0",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,18 +58,18 @@
   },
   "dependencies": {
     "@babel/traverse": "^7.23.5",
-    "@sanity/client": "^7.2.1",
-    "@sanity/codegen": "3.88.3",
-    "@sanity/runtime-cli": "^6.1.1",
+    "@sanity/client": "^7.2.2",
+    "@sanity/codegen": "3.89.0",
+    "@sanity/runtime-cli": "^7.3.2",
     "@sanity/telemetry": "^0.8.0",
     "@sanity/template-validator": "^2.4.3",
-    "@sanity/util": "3.88.3",
+    "@sanity/util": "3.89.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
     "esbuild": "0.25.4",
     "esbuild-register": "^3.5.0",
-    "get-it": "^8.6.8",
+    "get-it": "^8.6.9",
     "groq-js": "^1.16.1",
     "pkg-dir": "^5.0.0",
     "prettier": "^3.3.0",
@@ -77,13 +77,13 @@
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
-    "@repo/package.config": "3.88.3",
-    "@repo/test-config": "3.88.3",
+    "@repo/package.config": "3.89.0",
+    "@repo/test-config": "3.89.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.88.3",
+    "@sanity/types": "3.89.0",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "156e8fa482703d99219f08da7bacb384517f1513"
+  "gitHead": "88e2dda0aa6048eed31625c477c72814833a5443"
 }

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

@@ -132,6 +132,7 @@ export async function bootstrapLocalTemplate(
     dependencies,
     devDependencies,
     scripts: template.scripts,
+    isAppTemplate,
   })
 
   // ...and a studio config (`sanity.config.[ts|js]`)
@@ -163,10 +164,14 @@ export async function bootstrapLocalTemplate(
       ],
       writeFileIfNotExists(`sanity.cli.${codeExt}`, cliConfig),
       writeFileIfNotExists('package.json', packageManifest),
-      writeFileIfNotExists(
-        'eslint.config.mjs',
-        `import studio from '@sanity/eslint-config-studio'\n\nexport default [...studio]\n`,
-      ),
+      ...[
+        isAppTemplate
+          ? Promise.resolve(null)
+          : writeFileIfNotExists(
+              'eslint.config.mjs',
+              `import studio from '@sanity/eslint-config-studio'\n\nexport default [...studio]\n`,
+            ),
+      ],
     ].filter(Boolean),
   )
 

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

@@ -17,13 +17,28 @@ const manifestPropOrder = [
 ]
 
 export function createPackageManifest(
-  data: Omit<PackageJson, 'version'> & {gitRemote?: string},
+  data: Omit<PackageJson, 'version'> & {gitRemote?: string} & {isAppTemplate?: boolean},
 ): string {
+  const {isAppTemplate} = data
+
   const dependencies = data.dependencies ? {dependencies: sortObject(data.dependencies)} : {}
+
   const devDependencies = data.devDependencies
     ? {devDependencies: sortObject(data.devDependencies)}
     : {}
 
+  // Don't write a prettier config for SDK apps; we want to allow developers to use their own
+  const prettierConfig = isAppTemplate
+    ? {}
+    : {
+        prettier: {
+          semi: false,
+          printWidth: 100,
+          bracketSpacing: false,
+          singleQuote: true,
+        },
+      }
+
   const pkg = {
     ...getCommonManifest(data),
 
@@ -39,13 +54,7 @@ export function createPackageManifest(
 
     ...dependencies,
     ...devDependencies,
-
-    prettier: {
-      semi: false,
-      printWidth: 100,
-      bracketSpacing: false,
-      singleQuote: true,
-    },
+    ...prettierConfig,
   }
 
   return serializeManifest(pkg)

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

@@ -294,7 +294,7 @@ export default async function initSanity(
 
   const flags = await prepareFlags()
 
-  // We're authenticated, now lets select or create a project (for studios) or org (for core apps)
+  // We're authenticated, now lets select or create a project (for studios) or org (for custom apps)
   const {projectId, displayName, isFirstProject, datasetName, schemaUrl, organizationId} =
     await getProjectDetails()
 

package/src/actions/init-project/templates/appQuickstart.ts

@@ -8,14 +8,7 @@ const appTemplate: ProjectTemplate = {
     'react-dom': '^19',
   },
   devDependencies: {
-    /*
-     * this will be changed to eslint-config sanity,
-     *  eslint.config generation will be a fast follow
-     */
-    '@sanity/eslint-config-studio': '^5.0.1',
     '@types/react': '^18.0.25',
-    'eslint': '^9.9.0',
-    'prettier': '^3.0.2',
     'sanity': '^3',
     'typescript': '^5.1.6',
   },

package/src/actions/init-project/templates/appSanityUi.ts

@@ -10,14 +10,7 @@ const appSanityUiTemplate: ProjectTemplate = {
     'styled-components': '^6.1.17',
   },
   devDependencies: {
-    /*
-     * this will be changed to eslint-config sanity,
-     *  eslint.config generation will be a fast follow
-     */
-    '@sanity/eslint-config-studio': '^5.0.1',
     '@types/react': '^18.0.25',
-    'eslint': '^9.9.0',
-    'prettier': '^3.0.2',
     'sanity': '^3',
     'typescript': '^5.1.6',
   },

package/src/commands/blueprints/addBlueprintsCommand.ts

@@ -5,37 +5,62 @@ Arguments
   <type>  Type of Resource to add (currently only 'function' is supported)
 
 Options
-  --name <name>                Name of the Resource
-  --fn-type <type>             Type of Function Resource to add (e.g. document-publish)
-  --fn-lang, --lang <ts|js>    Language of the Function Resource
-  --js, --javascript           Use JavaScript for the Function Resource
+  --name, -n <name>              Name of the Resource
+  --fn-type <type>               Type of Function to add (e.g. document-publish)
+  --fn-language, --lang <ts|js>  Language of the Function. Default: "ts"
+  --js, --javascript             Shortcut for --fn-language=js
+  --fn-helpers, --helpers        Add helpers to the Function
+  --no-fn-helpers                Do not add helpers to the Function
+  --fn-installer,                Package manager to use for Function helpers
+    --installer <npm|pnpm|yarn>    sets --fn-helpers to true
+  --install, -i                  Shortcut for --fn-installer=npm
 
 Examples:
-  # Add a Function Resource (TypeScript by default)
+  # Add a Function (TypeScript by default)
   sanity blueprints add function
 
-  # Add a Function Resource with a specific name
-  sanity blueprints add function --name my-function
+  # Add a Function with a specific name and install helpers with npm
+  sanity blueprints add function --name my-function -i
 
-  # Add a Function Resource with a specific type
-  sanity blueprints add function --name my-function --fn-type document-publish
+  # Add a Function with a specific type
+  sanity blueprints add function --fn-type document-publish
 
-  # Add a Function Resource in JavaScript
-  sanity blueprints add function --name my-function --fn-type document-publish --js
+  # Add a JavaScript Function
+  sanity blueprints add function --js
+
+  # Add a Function without helpers
+  sanity blueprints add function --no-fn-helpers
+
+  # Add a document-publish .js Function with helpers and install with npm
+  sanity blueprints add function -n roboto --fn-type document-publish --js -i
 `
 
 export interface BlueprintsAddFlags {
   'name'?: string
+  'n'?: string
+
   'fn-type'?: string
-  'fn-lang'?: string
-  'language'?: string
+
+  'fn-language'?: string
   'lang'?: string
+
   'js'?: boolean
   'javascript'?: boolean
+
+  'fn-helpers'?: boolean
+  'helpers'?: boolean
+  'no-fn-helpers'?: boolean
+
+  'fn-installer'?: string
+  'installer'?: string
+
+  'install'?: boolean
+  'i'?: boolean
 }
 
 const defaultFlags: BlueprintsAddFlags = {
-  //
+  'fn-language': 'ts',
+  // 'fn-helpers': true, // ask, for now
 }
 
 const addBlueprintsCommand: CliCommandDefinition<BlueprintsAddFlags> = {
@@ -47,9 +72,17 @@ const addBlueprintsCommand: CliCommandDefinition<BlueprintsAddFlags> = {
   description: 'Add a Resource to a Blueprint',
 
   async action(args, context) {
-    const {output} = context
+    const {output, apiClient} = context
     const flags = {...defaultFlags, ...args.extOptions}
 
+    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 [resourceType] = args.argsWithoutOptions
 
     if (!resourceType) {
@@ -57,16 +90,31 @@ const addBlueprintsCommand: CliCommandDefinition<BlueprintsAddFlags> = {
       return
     }
 
+    const {initBlueprintConfig} = await import('@sanity/runtime-cli/cores')
     const {blueprintAddCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {success, error} = await blueprintAddCore({
+
+    const cmdConfig = await initBlueprintConfig({
       bin: 'sanity',
-      log: (msg) => output.print(msg),
+      log: (message) => output.print(message),
+      token,
+    })
+
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
+
+    let userWantsFnHelpers = flags.helpers || flags['fn-helpers']
+    if (flags['no-fn-helpers'] === true) userWantsFnHelpers = false // override
+
+    const {success, error} = await blueprintAddCore({
+      ...cmdConfig.value,
       args: {type: resourceType},
       flags: {
-        'name': flags.name,
+        'name': flags.n ?? flags.name,
         'fn-type': flags['fn-type'],
-        'language': flags['fn-lang'] ?? flags.language ?? flags.lang,
+        'language': flags.lang ?? flags['fn-language'],
         'javascript': flags.js || flags.javascript,
+        'fn-helpers': userWantsFnHelpers,
+        'fn-installer': flags.installer ?? flags['fn-installer'],
+        'install': flags.i || flags.install,
       },
     })
 

package/src/commands/blueprints/configBlueprintsCommand.ts

@@ -57,21 +57,19 @@ const configBlueprintsCommand: CliCommandDefinition<BlueprintsConfigFlags> = {
 
     if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
+    const {initBlueprintConfig} = await import('@sanity/runtime-cli/cores')
     const {blueprintConfigCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, issues} = await getBlueprintAndStack({token})
+    const cmdConfig = await initBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    if (issues) {
-      // print issues and continue
-      output.print(display.errors.presentBlueprintIssues(issues))
-    }
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
     const {success, error} = await blueprintConfigCore({
-      bin: 'sanity',
-      log: (message) => output.print(message),
-      blueprint: localBlueprint,
+      ...cmdConfig.value,
       token,
       flags: {
         'project-id': flags['project-id'] ?? flags.projectId ?? flags.project,

package/src/commands/blueprints/deployBlueprintsCommand.ts

@@ -38,28 +38,19 @@ const deployBlueprintsCommand: CliCommandDefinition<BlueprintsDeployFlags> = {
     const {token} = client.config()
     if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
+    const {initDeployedBlueprintConfig} = await import('@sanity/runtime-cli/cores')
     const {blueprintDeployCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, deployedStack, issues} = await getBlueprintAndStack({token})
-
-    if (issues) {
-      output.print(display.errors.presentBlueprintIssues(issues))
-      throw new Error('Unable to parse Blueprint file.')
-    }
+    const cmdConfig = await initDeployedBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    const {projectId, stackId} = localBlueprint
-    const auth = {token, projectId}
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
     const {success, error} = await blueprintDeployCore({
-      bin: 'sanity',
-      log: (message) => output.print(message),
-      auth,
-      projectId,
-      stackId,
-      deployedStack,
-      blueprint: localBlueprint,
+      ...cmdConfig.value,
       flags: {
         'no-wait': flags['no-wait'],
       },

package/src/commands/blueprints/destroyBlueprintsCommand.ts

@@ -50,16 +50,19 @@ const destroyBlueprintsCommand: CliCommandDefinition<BlueprintsDestroyFlags> = {
     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 {blueprintDestroyCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
 
-    const {localBlueprint} = await getBlueprintAndStack({token})
-
-    const {success, error} = await blueprintDestroyCore({
+    const cmdConfig = await initBlueprintConfig({
       bin: 'sanity',
       log: (message) => output.print(message),
       token,
-      blueprint: localBlueprint,
+    })
+
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
+
+    const {success, error} = await blueprintDestroyCore({
+      ...cmdConfig.value,
       flags: {
         'no-wait': flags['no-wait'],
         'force': flags.force ?? flags.f,

package/src/commands/blueprints/infoBlueprintsCommand.ts

@@ -32,26 +32,19 @@ const infoBlueprintsCommand: CliCommandDefinition<BlueprintsInfoFlags> = {
     const {token} = client.config()
     if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
+    const {initDeployedBlueprintConfig} = await import('@sanity/runtime-cli/cores')
     const {blueprintInfoCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, deployedStack, issues} = await getBlueprintAndStack({token})
-
-    if (issues) {
-      output.print(display.errors.presentBlueprintIssues(issues))
-      throw new Error('Unable to parse Blueprint file.')
-    }
+    const cmdConfig = await initDeployedBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    const {projectId, stackId} = localBlueprint
-    const auth = {token, projectId}
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
     const {success, error} = await blueprintInfoCore({
-      bin: 'sanity',
-      log: (message) => output.print(message),
-      auth,
-      stackId,
-      deployedStack,
+      ...cmdConfig.value,
       flags,
     })
 

package/src/commands/blueprints/logsBlueprintsCommand.ts

@@ -39,26 +39,19 @@ const logsBlueprintsCommand: CliCommandDefinition<BlueprintsLogsFlags> = {
     const {token} = client.config()
     if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
+    const {initDeployedBlueprintConfig} = await import('@sanity/runtime-cli/cores')
     const {blueprintLogsCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, deployedStack, issues} = await getBlueprintAndStack({token})
-
-    if (issues) {
-      output.print(display.errors.presentBlueprintIssues(issues))
-      throw new Error('Unable to parse Blueprint file.')
-    }
+    const cmdConfig = await initDeployedBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    const {projectId, stackId} = localBlueprint
-    const auth = {token, projectId}
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
     const {success, streaming, error} = await blueprintLogsCore({
-      bin: 'sanity',
-      log: (message) => output.print(message),
-      auth,
-      stackId,
-      deployedStack,
+      ...cmdConfig.value,
       flags: {
         watch: flags.watch ?? flags.w,
       },

package/src/commands/blueprints/planBlueprintsCommand.ts

@@ -29,21 +29,19 @@ const planBlueprintsCommand: CliCommandDefinition<BlueprintsPlanFlags> = {
     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 {blueprintPlanCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, issues} = await getBlueprintAndStack({token})
+    const cmdConfig = await initBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    if (issues) {
-      // print issues and continue
-      output.print(display.errors.presentBlueprintIssues(issues))
-    }
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
     const {success, error} = await blueprintPlanCore({
-      bin: 'sanity',
-      log: (message) => output.print(message),
-      blueprint: localBlueprint,
+      ...cmdConfig.value,
     })
 
     if (!success) throw new Error(error)

package/src/commands/blueprints/stacksBlueprintsCommand.ts

@@ -41,22 +41,19 @@ const stacksBlueprintsCommand: CliCommandDefinition<BlueprintsStacksFlags> = {
     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 {blueprintStacksCore} = await import('@sanity/runtime-cli/cores/blueprints')
-    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {localBlueprint, issues} = await getBlueprintAndStack({token})
-
-    if (issues) {
-      // print issues and continue
-      output.print(display.errors.presentBlueprintIssues(issues))
-    }
-
-    const {success, error} = await blueprintStacksCore({
+    const cmdConfig = await initBlueprintConfig({
       bin: 'sanity',
       log: (message) => output.print(message),
       token,
-      blueprint: localBlueprint,
+    })
+
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
+
+    const {success, error} = await blueprintStacksCore({
+      ...cmdConfig.value,
       flags: {
         projectId: flags['project-id'] ?? flags.projectId ?? flags.project,
       },

package/src/commands/functions/devFunctionsCommand.ts

@@ -14,25 +14,49 @@ Examples
   sanity functions dev --port 3333
 `
 
-const defaultFlags = {
+export interface FunctionsDevFlags {
+  port?: number
+}
+
+const defaultFlags: FunctionsDevFlags = {
   port: 8080,
 }
 
-const devFunctionsCommand: CliCommandDefinition = {
+const devFunctionsCommand: CliCommandDefinition<FunctionsDevFlags> = {
   name: 'dev',
   group: 'functions',
   helpText,
   signature: '[--port <port>]',
   description: 'Start the Sanity Function emulator',
   async action(args, context) {
-    const {output} = context
-    const {print} = output
+    const {apiClient, output} = context
     const flags = {...defaultFlags, ...args.extOptions}
 
-    const {dev: devAction} = await import('@sanity/runtime-cli/actions/functions')
-    devAction.dev(flags.port)
+    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)
 
-    print(`Server is running on port ${flags.port}\n`)
     open(`http://localhost:${flags.port}`)
   },
 }