@sanity/cli 3.92.1-next.31.52ea1d6df9 → 3.92.1-next.33.093bcb6a02

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.92.1-next.31.52ea1d6df9",
+  "version": "3.92.1-next.33.093bcb6a02",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -59,11 +59,11 @@
   "dependencies": {
     "@babel/traverse": "^7.23.5",
     "@sanity/client": "^7.6.0",
-    "@sanity/codegen": "3.92.1-next.31.52ea1d6df9",
-    "@sanity/runtime-cli": "^8.0.0",
+    "@sanity/codegen": "3.92.1-next.33.093bcb6a02",
+    "@sanity/runtime-cli": "^8.1.0",
     "@sanity/telemetry": "^0.8.0",
     "@sanity/template-validator": "^2.4.3",
-    "@sanity/util": "3.92.1-next.31.52ea1d6df9",
+    "@sanity/util": "3.92.1-next.33.093bcb6a02",
     "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.31.52ea1d6df9",
+    "@sanity/types": "3.92.1-next.33.093bcb6a02",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "52ea1d6df9f4ada9eb472d1cea718ac5aedbc929"
+  "gitHead": "093bcb6a023c98e6f22fb74ab797b7bb8ff3b78f"
 }

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,