@sanity/cli 3.92.1-next.4.fcba2d60c5 → 3.92.1-next.40.1f1bdfec39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.92.1-next.4.fcba2d60c5",
+  "version": "3.92.1-next.40.1f1bdfec39",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,12 +58,12 @@
   },
   "dependencies": {
     "@babel/traverse": "^7.23.5",
-    "@sanity/client": "^7.5.0",
-    "@sanity/codegen": "3.92.1-next.4.fcba2d60c5",
-    "@sanity/runtime-cli": "^8.0.0",
+    "@sanity/client": "^7.6.0",
+    "@sanity/codegen": "3.92.1-next.40.1f1bdfec39",
+    "@sanity/runtime-cli": "^8.1.0",
     "@sanity/telemetry": "^0.8.0",
     "@sanity/template-validator": "^2.4.3",
-    "@sanity/util": "3.92.1-next.4.fcba2d60c5",
+    "@sanity/util": "3.92.1-next.40.1f1bdfec39",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -83,7 +83,7 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.92.1-next.4.fcba2d60c5",
+    "@sanity/types": "3.92.1-next.40.1f1bdfec39",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "fcba2d60c5f93a92a4cf0cc53455e2a4e262a130"
+  "gitHead": "1f1bdfec39b18178f3fbb08586a63826845a7684"
 }

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

@@ -679,24 +679,36 @@ export default async function initSanity(
   const devCommand = devCommandMap[pkgManager]
 
   const isCurrentDir = outputPath === process.cwd()
-  if (isCurrentDir) {
-    print(`\n${chalk.green('Success!')} Now, use this command to continue:\n`)
+  const goToProjectDir = `(${chalk.cyan(`cd ${outputPath}`)} to navigate to your new project directory)`
+
+  if (isAppTemplate) {
+    //output for custom apps here
+    print(`✅ ${chalk.green.bold('Success!')} Your custom app has been scaffolded.`)
+    if (!isCurrentDir) print(goToProjectDir)
     print(
-      `${chalk.cyan(devCommand)} - to run ${isAppTemplate ? 'your Sanity application' : 'Sanity Studio'}\n`,
+      `\n${chalk.bold('Next')}, configure the project(s) and dataset(s) your app should work with.`,
     )
+    print('\nGet started in `src/App.tsx`, or refer to our documentation for a walkthrough:')
+    print(chalk.blue.underline('https://www.sanity.io/docs/app-sdk/sdk-configuration'))
+    print('\n')
+    print(`Other helpful commands:`)
+    print(`npx sanity docs       to open the documentation in a browser`)
+    print(`npx sanity dev        to start the development server for your app`)
+    print(`npx sanity deploy     to deploy your app`)
   } else {
-    print(`\n${chalk.green('Success!')} Now, use these commands to continue:\n`)
-    print(`First: ${chalk.cyan(`cd ${outputPath}`)} - to enter project's directory`)
+    //output for Studios here
+    print(`✅ ${chalk.green.bold('Success!')} Your Studio has been created.`)
+    if (!isCurrentDir) print(goToProjectDir)
     print(
-      `Then: ${chalk.cyan(devCommand)} -to run ${isAppTemplate ? 'your Sanity application' : 'Sanity Studio'}\n`,
+      `Get started by running ${chalk.cyan(devCommand)} to launch your Studio’s development server`,
     )
+    print('\n')
+    print(`Other helpful commands:`)
+    print(`npx sanity docs     to open the documentation in a browser`)
+    print(`npx sanity manage   to open the project settings in a browser`)
+    print(`npx sanity help     to explore the CLI manual`)
   }
 
-  print(`Other helpful commands`)
-  print(`npx sanity docs - to open the documentation in a browser`)
-  print(`npx sanity manage - to open the project settings in a browser`)
-  print(`npx sanity help - to explore the CLI manual`)
-
   if (isFirstProject) {
     trace.log({step: 'sendCommunityInvite', selectedOption: 'yes'})
 

package/src/cli.ts

@@ -157,6 +157,9 @@ export async function runCli(cliRoot: string, {cliVersion}: {cliVersion: string}
       const error = typeof err.details === 'string' ? err.details : err
       // eslint-disable-next-line no-console
       console.error(`\n${error.stack ? neatStack(err) : error}`)
+      if (err.cause) {
+        console.error(`\nCaused by:\n\n${err.cause.stack ? neatStack(err.cause) : err.cause}`)
+      }
       // eslint-disable-next-line no-process-exit
       cliCommandTrace.error(error)
       process.exit(1)

package/src/commands/blueprints/addBlueprintsCommand.ts

@@ -25,6 +25,9 @@ Examples:
   # Add a Function with a specific type
   sanity blueprints add function --fn-type document-publish
 
+  # Add a Function using an example
+  sanity blueprints add function --example example-name
+
   # Add a JavaScript Function
   sanity blueprints add function --js
 
@@ -36,6 +39,8 @@ Examples:
 `
 
 export interface BlueprintsAddFlags {
+  'example'?: string
+
   'name'?: string
   'n'?: string
 
@@ -44,8 +49,8 @@ export interface BlueprintsAddFlags {
   'fn-language'?: string
   'lang'?: string
 
-  'js'?: boolean
   'javascript'?: boolean
+  'js'?: boolean
 
   'fn-helpers'?: boolean
   'helpers'?: boolean
@@ -73,7 +78,31 @@ const addBlueprintsCommand: CliCommandDefinition<BlueprintsAddFlags> = {
 
   async action(args, context) {
     const {output, apiClient} = context
-    const flags = {...defaultFlags, ...args.extOptions}
+    const {extOptions} = args
+
+    if (extOptions.example) {
+      // example is exclusive to 'name', 'fn-type', 'fn-language', 'javascript', 'fn-helpers', 'fn-installer'
+      // check before merging default flags
+      const conflictingFlags: (keyof BlueprintsAddFlags)[] = [
+        'name',
+        'n',
+        'fn-type',
+        'fn-language',
+        'lang',
+        'javascript',
+        'js',
+        'fn-helpers',
+        'helpers',
+        'fn-installer',
+        'installer',
+      ]
+      const foundConflict = conflictingFlags.find((key) => extOptions[key])
+      if (foundConflict) {
+        throw new Error(`--example can't be used with --${foundConflict}`)
+      }
+    }
+
+    const flags = {...defaultFlags, ...extOptions}
 
     const client = apiClient({
       requireUser: true,
@@ -108,6 +137,7 @@ const addBlueprintsCommand: CliCommandDefinition<BlueprintsAddFlags> = {
       ...cmdConfig.value,
       args: {type: resourceType},
       flags: {
+        'example': flags.example,
         'name': flags.n ?? flags.name,
         'fn-type': flags['fn-type'],
         'language': flags.lang ?? flags['fn-language'],

package/src/commands/blueprints/initBlueprintsCommand.ts

@@ -9,14 +9,18 @@ Options
   --project-id <id>                  Project ID to use
 
 Examples:
-  # Create a new Blueprint manifest file in the current directory
+  # Create a new Blueprint project in the current directory
   sanity blueprints init
 
-  # Create a new Blueprint manifest file in a specific directory
+  # Create a new Blueprint project in a specific directory
   sanity blueprints init my-sanity-project --type json
+
+  # Create a new Blueprint project in a specific directory with an example
+  sanity blueprints init --example example-name
 `
 
 export interface BlueprintsInitFlags {
+  'example'?: string
   'dir'?: string
   'blueprint-type'?: string
   'type'?: string
@@ -56,6 +60,22 @@ const initBlueprintsCommand: CliCommandDefinition<BlueprintsInitFlags> = {
 
     const {blueprintInitCore} = await import('@sanity/runtime-cli/cores/blueprints')
 
+    if (flags.example) {
+      const conflictingFlags: (keyof BlueprintsInitFlags)[] = [
+        'blueprint-type',
+        'type',
+        'stack-id',
+        'stackId',
+        'stack',
+        'stack-name',
+        'name',
+      ]
+      const foundConflict = conflictingFlags.find((key) => flags[key])
+      if (foundConflict) {
+        throw new Error(`--example can't be used with --${foundConflict}`)
+      }
+    }
+
     const {success, error} = await blueprintInitCore({
       bin: 'sanity',
       log: (message) => output.print(message),
@@ -64,6 +84,7 @@ const initBlueprintsCommand: CliCommandDefinition<BlueprintsInitFlags> = {
         dir: dir ?? flags.dir,
       },
       flags: {
+        'example': flags.example,
         'blueprint-type': flags['blueprint-type'] ?? flags.type,
         'project-id': flags['project-id'] ?? flags.projectId ?? flags.project,
         'stack-id': flags['stack-id'] ?? flags.stackId ?? flags.stack,

package/src/packageManager/installPackages.ts

@@ -18,32 +18,44 @@ export async function installDeclaredPackages(
     encoding: 'utf8',
     env: getPartialEnvWithNpmPath(cwd),
     cwd,
-    stdio: 'inherit',
+    stdio: 'pipe',
   }
 
-  const npmArgs = ['install', '--legacy-peer-deps']
+  // results of running execa with the selected package manager
   let result: ExecaReturnValue<string> | undefined
-  if (packageManager === 'npm') {
-    output.print(`Running 'npm ${npmArgs.join(' ')}'`)
-    result = await execa('npm', npmArgs, execOptions)
-  } else if (packageManager === 'yarn') {
-    const yarnArgs = ['install']
-    output.print(`Running 'yarn ${yarnArgs.join(' ')}'`)
-    result = await execa('yarn', yarnArgs, execOptions)
-  } else if (packageManager === 'pnpm') {
-    const pnpmArgs = ['install']
-    output.print(`Running 'pnpm ${pnpmArgs.join(' ')}'`)
-    result = await execa('pnpm', pnpmArgs, execOptions)
-  } else if (packageManager === 'bun') {
-    const bunArgs = ['install']
-    output.print(`Running 'bun ${bunArgs.join(' ')}'`)
-    result = await execa('bun', bunArgs, execOptions)
-  } else if (packageManager === 'manual') {
-    output.print(`Manual installation selected - run 'npm ${npmArgs.join(' ')}' or similar`)
+
+  type PackageManagerLibs = Exclude<PackageManager, 'manual'>
+  type InstallerArgs = {[key in PackageManagerLibs]: string[]}
+
+  const installerArgs: InstallerArgs = {
+    npm: ['install', '--legacy-peer-deps'],
+    yarn: ['install'],
+    pnpm: ['install'],
+    bun: ['install'],
   }
 
-  if (result?.exitCode || result?.failed) {
-    throw new Error('Dependency installation failed')
+  async function handleInstall(cmd: PackageManager, args: InstallerArgs[PackageManagerLibs]) {
+    // Start a spinner for the install process
+    const progress = output.spinner(`Running ${cmd} ${args.join(' ')}\n`).start()
+
+    // Perform the install command with execa
+    result = await execa(cmd, args, execOptions)
+
+    // If the install fails, log execa's stdout and throw…
+    if (result?.exitCode || result?.failed) {
+      progress.fail()
+      output.print(result.stdout)
+      throw new Error('Dependency installation failed')
+    } else {
+      // …otherwise, just mark the install as successful
+      progress.succeed()
+    }
+  }
+
+  if (packageManager === 'manual') {
+    output.print(`Manual installation selected — run 'npm ${installerArgs.npm} or equivalent'`)
+  } else {
+    await handleInstall(packageManager, installerArgs[packageManager])
   }
 }
 

package/templates/blog/README.md

@@ -7,5 +7,5 @@ Now you can do the following things:
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
 - Check out the example frontend: [React/Next.js](https://github.com/sanity-io/tutorial-sanity-blog-react-next)
 - [Read the blog post about this template](https://www.sanity.io/blog/build-your-own-blog-with-sanity-and-next-js?utm_source=readme)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/clean/README.md

@@ -5,5 +5,5 @@ Congratulations, you have now installed the Sanity Content Studio, an open-sourc
 Now you can do the following things:
 
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/ecommerce/README.md

@@ -7,5 +7,5 @@ Now you can do the following things:
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
 - Check out the example frontend: [Vue/Nuxt.js](https://github.com/sanity-io/example-ecommerce-snipcart-vue)
 - [Read the blog post about this template](https://www.sanity.io/blog/e-commerce-vue-nuxt-snipcart?uutm_source=readme)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/get-started/README.md

@@ -5,5 +5,5 @@ Congratulations, you have now installed the Sanity Content Studio, an open-sourc
 Now you can do the following things:
 
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/moviedb/README.md

@@ -6,5 +6,5 @@ Now you can do the following things:
 
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
 - Check out one of the example frontends: [React](https://github.com/sanity-io/example-frontend-next-js) | [React Native](https://github.com/sanity-io/example-app-react-native) | [Vue](https://github.com/sanity-io/example-frontend-vue-js) | [PHP](https://github.com/sanity-io/example-frontend-silex-twig)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/quickstart/README.md

@@ -5,5 +5,5 @@ Congratulations, you have now installed Sanity Studio, an open-source real-time
 Now you can do the following things:
 
 - [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
-- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Join the community Slack](https://snty.link/community/?utm_source=readme)
 - [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)