@sanity/cli 3.50.0 → 3.50.1-detect-context-errors.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.50.0",
+  "version": "3.50.1-detect-context-errors.9+f64d68cae7",
   "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.21.0",
-    "@sanity/codegen": "3.50.0",
+    "@sanity/codegen": "3.50.1-detect-context-errors.9+f64d68cae7",
     "@sanity/telemetry": "^0.7.7",
-    "@sanity/util": "3.50.0",
+    "@sanity/util": "3.50.1-detect-context-errors.9+f64d68cae7",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -82,7 +82,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.50.0",
+    "@sanity/types": "3.50.1-detect-context-errors.9+f64d68cae7",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "49f278adb11869e91b7582e80cba0c548444d7be"
+  "gitHead": "f64d68cae702cf3269a370e1537c9da87a92df92"
 }

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

@@ -329,14 +329,16 @@ export default async function initSanity(
     const fileExtension = useTypeScript ? 'ts' : 'js'
 
     const embeddedStudio = unattended ? true : await promptForEmbeddedStudio(prompt)
+    let hasSrcFolder = false
 
     if (embeddedStudio) {
       // find source path (app or src/app)
-      const srcDir = 'app'
-      let srcPath = path.join(workDir, srcDir)
+      const appDir = 'app'
+      let srcPath = path.join(workDir, appDir)
 
       if (!existsSync(srcPath)) {
-        srcPath = path.join(workDir, 'src', srcDir)
+        srcPath = path.join(workDir, 'src', appDir)
+        hasSrcFolder = true
         if (!existsSync(srcPath)) {
           await fs
             .mkdir(srcPath, {recursive: true})
@@ -369,7 +371,7 @@ export default async function initSanity(
       const sanityConfigPath = path.join(workDir, `sanity.config.${fileExtension}`)
       await writeOrOverwrite(
         sanityConfigPath,
-        sanityConfigTemplate
+        sanityConfigTemplate(hasSrcFolder)
           .replace(':route:', embeddedStudioRouteFilePath.slice(workDir.length).replace('src/', ''))
           .replace(':basePath:', studioPath),
       )
@@ -382,18 +384,27 @@ export default async function initSanity(
     const writeSourceFiles = async (
       files: Record<string, string | Record<string, string>>,
       folderPath?: string,
+      srcFolderPrefix?: boolean,
     ) => {
       for (const [filePath, content] of Object.entries(files)) {
         // check if file ends with full stop to indicate it's file and not directory (this only works with our template tree structure)
         if (filePath.includes('.') && typeof content === 'string') {
           await writeOrOverwrite(
-            path.join(workDir, 'sanity', folderPath || '', `${filePath}${fileExtension}`),
+            path.join(
+              workDir,
+              srcFolderPrefix ? 'src' : '',
+              'sanity',
+              folderPath || '',
+              `${filePath}${fileExtension}`,
+            ),
             content,
           )
         } else {
-          await fs.mkdir(path.join(workDir, 'sanity', filePath), {recursive: true})
+          await fs.mkdir(path.join(workDir, srcFolderPrefix ? 'src' : '', 'sanity', filePath), {
+            recursive: true,
+          })
           if (typeof content === 'object') {
-            await writeSourceFiles(content, filePath)
+            await writeSourceFiles(content, filePath, srcFolderPrefix)
           }
         }
       }
@@ -402,7 +413,7 @@ export default async function initSanity(
     // ask what kind of schema setup the user wants
     const templateToUse = unattended ? 'clean' : await promptForNextTemplate(prompt)
 
-    await writeSourceFiles(sanityFolder(useTypeScript, templateToUse))
+    await writeSourceFiles(sanityFolder(useTypeScript, templateToUse), undefined, hasSrcFolder)
 
     // set tsconfig.json target to ES2017
     const tsConfigPath = path.join(workDir, 'tsconfig.json')
@@ -459,8 +470,7 @@ export default async function initSanity(
       `\n${chalk.green('Success!')} Your Sanity configuration files has been added to this project`,
     )
 
-    // eslint-disable-next-line no-process-exit
-    process.exit(0)
+    return
   }
 
   // eslint-disable-next-line @typescript-eslint/no-shadow

package/src/actions/init-project/templates/nextjs/index.ts

@@ -1,6 +1,6 @@
 import {blogSchemaFolder, blogSchemaJS, blogSchemaTS} from './schemaTypes/blog'
 
-export const sanityConfigTemplate = `'use client'
+export const sanityConfigTemplate = (hasSrcFolder = false): string => `'use client'
 
 /**
  * This configuration is used to for the Sanity Studio that’s mounted on the \`:route:\` route
@@ -11,8 +11,8 @@ import {defineConfig} from 'sanity'
 import {structureTool} from 'sanity/structure'
 
 // Go to https://www.sanity.io/docs/api-versioning to learn how API versioning works
-import {apiVersion, dataset, projectId} from './sanity/env'
-import {schema} from './sanity/schema'
+import {apiVersion, dataset, projectId} from ${hasSrcFolder ? "'./src/sanity/env'" : "'./sanity/env'"}
+import {schema} from ${hasSrcFolder ? "'./src/sanity/schema'" : "'./sanity/schema'"}
 
 export default defineConfig({
   basePath: ':basePath:',
@@ -75,8 +75,6 @@ export const projectId = assertValue(
   'Missing environment variable: NEXT_PUBLIC_SANITY_PROJECT_ID'
 )
 
-export const useCdn = false
-
 function assertValue<T>(v: T | undefined, errorMessage: string): T {
   if (v === undefined) {
     throw new Error(errorMessage)
@@ -91,7 +89,6 @@ const envJS = `export const apiVersion =
 
 export const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET;
 export const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID;
-export const useCdn = false
 `
 
 const schemaTS = `import { type SchemaTypeDefinition } from 'sanity'
@@ -108,29 +105,26 @@ const schemaJS = `export const schema = {
 
 const client = `import { createClient } from 'next-sanity'
 
-import { apiVersion, dataset, projectId, useCdn } from '../env'
+import { apiVersion, dataset, projectId } from '../env'
 
 export const client = createClient({
   projectId,
   dataset,
   apiVersion,
-  useCdn,
-  perspective: 'published',
+  useCdn: true, // Set to false if statically generating pages, using ISR or tag-based revalidation
 })
 `
 
 const imageTS = `import createImageUrlBuilder from '@sanity/image-url'
-import type { Image } from 'sanity'
+import { SanityImageSource } from "@sanity/image-url/lib/types/types";
 
 import { dataset, projectId } from '../env'
 
-const imageBuilder = createImageUrlBuilder({
-  projectId: projectId || '',
-  dataset: dataset || '',
-})
+// https://www.sanity.io/docs/image-url
+const builder = createImageUrlBuilder({ projectId, dataset })
 
-export const urlForImage = (source: Image) => {
-  return imageBuilder?.image(source).auto('format').fit('max').url()
+export const urlFor = (source: SanityImageSource) => {
+  return builder.image(source)
 }
 `
 
@@ -138,13 +132,11 @@ const imageJS = `import createImageUrlBuilder from '@sanity/image-url'
 
 import { dataset, projectId } from '../env'
 
-const imageBuilder = createImageUrlBuilder({
-  projectId: projectId || '',
-  dataset: dataset || '',
-})
+// https://www.sanity.io/docs/image-url
+const builder = createImageUrlBuilder({ projectId, dataset })
 
-export const urlForImage = (source) => {
-  return imageBuilder?.image(source).auto('format').fit('max').url()
+export const urlFor = (source) => {
+  return builder.image(source)
 }
 `
 

package/src/actions/init-project/templates/nextjs/schemaTypes/blog.ts

@@ -2,19 +2,17 @@
 
 const authorTS = `import {defineField, defineType} from 'sanity'
 
-export default defineType({
+export const authorType = defineType({
   name: 'author',
   title: 'Author',
   type: 'document',
   fields: [
     defineField({
       name: 'name',
-      title: 'Name',
       type: 'string',
     }),
     defineField({
       name: 'slug',
-      title: 'Slug',
       type: 'slug',
       options: {
         source: 'name',
@@ -23,7 +21,6 @@ export default defineType({
     }),
     defineField({
       name: 'image',
-      title: 'Image',
       type: 'image',
       options: {
         hotspot: true,
@@ -38,11 +35,9 @@ export default defineType({
     }),
     defineField({
       name: 'bio',
-      title: 'Bio',
       type: 'array',
       of: [
         {
-          title: 'Block',
           type: 'block',
           styles: [{title: 'Normal', value: 'normal'}],
           lists: [],
@@ -59,19 +54,17 @@ export default defineType({
 })
 `
 
-const authorJS = `export const author = {
+const authorJS = `export const authorType = {
   name: 'author',
   title: 'Author',
   type: 'document',
   fields: [
     {
       name: 'name',
-      title: 'Name',
       type: 'string',
     },
     {
       name: 'slug',
-      title: 'Slug',
       type: 'slug',
       options: {
         source: 'name',
@@ -80,7 +73,6 @@ const authorJS = `export const author = {
     },
     {
       name: 'image',
-      title: 'Image',
       type: 'image',
       options: {
         hotspot: true,
@@ -95,11 +87,9 @@ const authorJS = `export const author = {
     },
     {
       name: 'bio',
-      title: 'Bio',
       type: 'array',
       of: [
         {
-          title: 'Block',
           type: 'block',
           styles: [{title: 'Normal', value: 'normal'}],
           lists: [],
@@ -117,6 +107,7 @@ const authorJS = `export const author = {
 `
 
 const blockContentTS = `import {defineType, defineArrayMember} from 'sanity'
+import {ImageIcon} from '@sanity/icons'
 
 /**
  * This is the schema type for block content used in the post document type
@@ -129,13 +120,12 @@ const blockContentTS = `import {defineType, defineArrayMember} from 'sanity'
  *  }
  */
 
-export default defineType({
+export const blockContentType = defineType({
   title: 'Block Content',
   name: 'blockContent',
   type: 'array',
   of: [
     defineArrayMember({
-      title: 'Block',
       type: 'block',
       // Styles let you define what blocks can be marked up as. The default
       // set corresponds with HTML tags, but you can set any title or value
@@ -180,6 +170,7 @@ export default defineType({
     // as a block type.
     defineArrayMember({
       type: 'image',
+      icon: ImageIcon,
       options: {hotspot: true},
       fields: [
         {
@@ -193,7 +184,9 @@ export default defineType({
 })
 `
 
-const blockContentJS = `/**
+const blockContentJS = `import {ImageIcon} from '@sanity/icons'
+
+/**
  * This is the schema type for block content used in the post document type
  * Importing this type into the studio configuration's \`schema\` property
  * lets you reuse it in other document types with:
@@ -204,7 +197,7 @@ const blockContentJS = `/**
  *  }
  */
 
-export const blockContent = {
+export const blockContentType = {
   title: 'Block Content',
   name: 'blockContent',
   type: 'array',
@@ -255,6 +248,7 @@ export const blockContent = {
     // as a block type.
     {
       type: 'image',
+      icon: ImageIcon,
       options: {hotspot: true},
       fields: [
         {
@@ -270,38 +264,33 @@ export const blockContent = {
 
 const categoryTS = `import {defineField, defineType} from 'sanity'
 
-export default defineType({
+export const categoryType = defineType({
   name: 'category',
-  title: 'Category',
   type: 'document',
   fields: [
     defineField({
       name: 'title',
-      title: 'Title',
       type: 'string',
     }),
     defineField({
       name: 'description',
-      title: 'Description',
       type: 'text',
     }),
   ],
 })
 `
 
-const categoryJS = `export const category = {
+const categoryJS = `export const categoryType = {
   name: 'category',
   title: 'Category',
   type: 'document',
   fields: [
     {
       name: 'title',
-      title: 'Title',
       type: 'string',
     },
     {
       name: 'description',
-      title: 'Description',
       type: 'text',
     },
   ],
@@ -310,19 +299,17 @@ const categoryJS = `export const category = {
 
 const postTS = `import {defineField, defineType} from 'sanity'
 
-export default defineType({
+export const postType = defineType({
   name: 'post',
   title: 'Post',
   type: 'document',
   fields: [
     defineField({
       name: 'title',
-      title: 'Title',
       type: 'string',
     }),
     defineField({
       name: 'slug',
-      title: 'Slug',
       type: 'slug',
       options: {
         source: 'title',
@@ -331,13 +318,11 @@ export default defineType({
     }),
     defineField({
       name: 'author',
-      title: 'Author',
       type: 'reference',
       to: {type: 'author'},
     }),
     defineField({
       name: 'mainImage',
-      title: 'Main image',
       type: 'image',
       options: {
         hotspot: true,
@@ -346,28 +331,24 @@ export default defineType({
         {
           name: 'alt',
           type: 'string',
-          title: 'Alternative Text',
+          title: 'Alternative text',
         }
       ]
     }),
     defineField({
       name: 'categories',
-      title: 'Categories',
       type: 'array',
       of: [{type: 'reference', to: {type: 'category'}}],
     }),
     defineField({
       name: 'publishedAt',
-      title: 'Published at',
       type: 'datetime',
     }),
     defineField({
       name: 'body',
-      title: 'Body',
       type: 'blockContent',
     }),
   ],
-
   preview: {
     select: {
       title: 'title',
@@ -382,19 +363,17 @@ export default defineType({
 })
 `
 
-const postJS = `export const post = {
+const postJS = `export const postType = {
   name: 'post',
   title: 'Post',
   type: 'document',
   fields: [
     {
       name: 'title',
-      title: 'Title',
       type: 'string',
     },
     {
       name: 'slug',
-      title: 'Slug',
       type: 'slug',
       options: {
         source: 'title',
@@ -403,13 +382,11 @@ const postJS = `export const post = {
     },
     {
       name: 'author',
-      title: 'Author',
       type: 'reference',
       to: {type: 'author'},
     },
     {
       name: 'mainImage',
-      title: 'Main image',
       type: 'image',
       options: {
         hotspot: true,
@@ -418,28 +395,24 @@ const postJS = `export const post = {
         {
           name: 'alt',
           type: 'string',
-          title: 'Alternative Text',
+          title: 'Alternative text',
         }
       ]
     },
     {
       name: 'categories',
-      title: 'Categories',
       type: 'array',
       of: [{type: 'reference', to: {type: 'category'}}],
     },
     {
       name: 'publishedAt',
-      title: 'Published at',
       type: 'datetime',
     },
     {
       name: 'body',
-      title: 'Body',
       type: 'blockContent',
     },
   ],
-
   preview: {
     select: {
       title: 'title',
@@ -458,31 +431,31 @@ const postJS = `export const post = {
 
 export const blogSchemaTS = `import { type SchemaTypeDefinition } from 'sanity'
 
-import blockContent from './schemaTypes/blockContent'
-import category from './schemaTypes/category'
-import post from './schemaTypes/post'
-import author from './schemaTypes/author'
+import {blockContentType} from './schemaTypes/blockContentType'
+import {categoryType} from './schemaTypes/categoryType'
+import {postType} from './schemaTypes/postType'
+import {authorType} from './schemaTypes/authorType'
 
 export const schema: { types: SchemaTypeDefinition[] } = {
-  types: [post, author, category, blockContent],
+  types: [blockContentType, categoryType, postType, authorType],
 }
 `
 
-export const blogSchemaJS = `import {blockContent} from './schemaTypes/blockContent'
-import {category} from './schemaTypes/category'
-import {post} from './schemaTypes/post'
-import {author} from './schemaTypes/author'
+export const blogSchemaJS = `import {blockContentType} from './schemaTypes/blockContentType'
+import {categoryType} from './schemaTypes/categoryType'
+import {postType} from './schemaTypes/postType'
+import {authorType} from './schemaTypes/authorType'
 
 export const schema = {
-  types: [post, author, category, blockContent],
+  types: [blockContentType, categoryType, postType, authorType],
 }
 `
 
 export const blogSchemaFolder = (useTypeScript: boolean): Record<string, string> => {
   return {
-    'author.': useTypeScript ? authorTS : authorJS,
-    'blockContent.': useTypeScript ? blockContentTS : blockContentJS,
-    'category.': useTypeScript ? categoryTS : categoryJS,
-    'post.': useTypeScript ? postTS : postJS,
+    'authorType.': useTypeScript ? authorTS : authorJS,
+    'blockContentType.': useTypeScript ? blockContentTS : blockContentJS,
+    'categoryType.': useTypeScript ? categoryTS : categoryJS,
+    'postType.': useTypeScript ? postTS : postJS,
   }
 }