@sanity/cli 3.92.1-next.9.9ecd386f43 → 3.93.1-bump-pkg-utils.10.412e2ab170

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/commands/init/initCommand.ts

@@ -95,7 +95,7 @@ export interface InitFlags {
   'package-manager'?: PackageManager
 }
 
-export const initCommand: CliCommandDefinition<InitFlags> = {
+const initCommand: CliCommandDefinition<InitFlags> = {
   name: 'init',
   signature: '',
   description: 'Initializes a new Sanity Studio and/or project',

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/src/util/cliWorker.ts

@@ -28,7 +28,7 @@ export async function getCliWorkerPath(workerPath: string): Promise<string> {
   const resolvedPath = path.resolve(cliDir, 'lib', 'workers', workerPath)
   try {
     return require.resolve(resolvedPath)
-  } catch (err) {
+  } catch {
     throw new Error(`Unable to resolve path for worker: ${workerPath}`)
   }
 }

package/src/util/clientWrapper.ts

@@ -86,8 +86,8 @@ export function getClientWrapper(
     const token = getCliToken()
     const apiHost = apiHosts[sanityEnv]
     const apiConfig = {
-      ...(cliApiConfig || {}),
-      ...(api || {}),
+      ...cliApiConfig,
+      ...api,
     }
 
     if (apiHost) {

package/src/util/getCliConfig.ts

@@ -35,14 +35,15 @@ export async function getCliConfig(
   if (forked) {
     try {
       return await getCliConfigForked(cwd)
-    } catch (err) {
+    } catch {
       // Intentional noop - try unforked variant
     }
   }
 
   const {unregister} = __DEV__
     ? {unregister: () => undefined}
-    : require('esbuild-register/dist/node').register({supported: {'dynamic-import': true}})
+    : // eslint-disable-next-line @typescript-eslint/no-require-imports
+      require('esbuild-register/dist/node').register({supported: {'dynamic-import': true}})
 
   try {
     const v3Config = getSanityCliConfig(cwd)
@@ -68,7 +69,6 @@ async function getCliConfigForked(cwd: string): Promise<CliConfigResult | null>
   return new Promise((resolve, reject) => {
     const worker = new Worker(workerPath, {
       workerData: cwd,
-      // eslint-disable-next-line no-process-env
       env: process.env,
     })
     worker.on('message', (message) => {

package/src/util/getLocalVersion.ts

@@ -29,7 +29,7 @@ function tryGetVersion(modulePath: string): string | undefined {
     const fileContent = readFileSync(modulePath, 'utf8')
     const manifest = JSON.parse(fileContent)
     return manifest.version
-  } catch (err) {
+  } catch {
     return undefined
   }
 }

package/src/util/journeyConfig.ts

@@ -154,7 +154,7 @@ export async function fetchJourneyConfig(
       schemaUrl: response.schemaUrl,
       isFirstProject: true,
     }
-  } catch (err) {
+  } catch {
     throw new Error(`Failed to fetch remote schema config: ${projectId}`)
   }
 }
@@ -169,7 +169,7 @@ async function fetchJourneySchema(schemaUrl: string): Promise<DocumentOrObject[]
   try {
     const response = await import(schemaUrl)
     return response.default
-  } catch (err) {
+  } catch {
     throw new Error(`Failed to fetch remote schema: ${schemaUrl}`)
   }
 }

package/src/util/remoteTemplate.ts

@@ -264,7 +264,7 @@ export async function applyEnvVariables(
     }
 
     await writeFile(join(root, targetName), envContent)
-  } catch (err) {
+  } catch {
     throw new Error(
       'Failed to set environment variables. This could be due to file permissions or the .env file format. See https://www.sanity.io/docs/environment-variables for details on environment variable setup.',
     )
@@ -278,7 +278,7 @@ export async function tryApplyPackageName(root: string, name: string): Promise<v
     pkg.name = name
 
     await writeFile(join(root, 'package.json'), JSON.stringify(pkg, null, 2))
-  } catch (err) {
+  } catch {
     // noop
   }
 }

package/src/workers/typegenGenerate.ts

@@ -12,7 +12,6 @@ import createDebug from 'debug'
 import {typeEvaluate, type TypeNode} from 'groq-js'
 
 const $info = createDebug('sanity:codegen:generate:info')
-const $warn = createDebug('sanity:codegen:generate:warn')
 
 export interface TypegenGenerateTypesWorkerData {
   workDir: string

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)

package/templates/.eslintrc

@@ -1,8 +0,0 @@
-{
-  "root": true,
-  "extends": "@sanity/eslint-config-studio",
-  "rules": {
-    "import/no-unresolved": "off",
-    "no-restricted-imports": "off"
-  }
-}