@sanity/cli 3.93.1-next.8.cf0bf8550a → 3.94.0

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

@@ -1,55 +0,0 @@
-import traverse from '@babel/traverse'
-import {parse, print} from 'recast'
-import * as parser from 'recast/parsers/typescript'
-
-interface TemplateOptions<T> {
-  template: string
-  variables: T
-  includeBooleanTransform?: boolean
-}
-
-export function processTemplate<T extends object>(options: TemplateOptions<T>): string {
-  const {template, variables, includeBooleanTransform = false} = options
-  const ast = parse(template.trimStart(), {parser})
-
-  traverse(ast, {
-    StringLiteral: {
-      enter({node}) {
-        const value = node.value
-        if (!value.startsWith('%') || !value.endsWith('%')) {
-          return
-        }
-        const variableName = value.slice(1, -1) as keyof T
-        if (!(variableName in variables)) {
-          throw new Error(`Template variable '${value}' not defined`)
-        }
-        const newValue = variables[variableName]
-        /*
-         * although there are valid non-strings in our config,
-         * they're not in StringLiteral nodes, so assume undefined
-         */
-        node.value = typeof newValue === 'string' ? newValue : ''
-      },
-    },
-    ...(includeBooleanTransform && {
-      Identifier: {
-        enter(path) {
-          if (!path.node.name.startsWith('__BOOL__')) {
-            return
-          }
-          const variableName = path.node.name.replace(/^__BOOL__(.+?)__$/, '$1') as keyof T
-          if (!(variableName in variables)) {
-            throw new Error(`Template variable '${variableName.toString()}' not defined`)
-          }
-          const value = variables[variableName]
-          if (typeof value !== 'boolean') {
-            throw new Error(`Expected boolean value for '${variableName.toString()}'`)
-          }
-          path.replaceWith({type: 'BooleanLiteral', value})
-        },
-      },
-    }),
-  })
-
-  return print(ast, {quote: 'single'}).code
-}

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

@@ -1,68 +0,0 @@
-import chalk from 'chalk'
-
-import {type CliPrompter} from '../../types'
-
-const MAX_DATASET_NAME_LENGTH = 64
-
-const datasetNameError =
-  'Dataset names can only contain lowercase characters,' +
-  'numbers, underscores and dashes' +
-  `and can be at most ${MAX_DATASET_NAME_LENGTH} characters.`
-
-export function promptForDatasetName(
-  prompt: CliPrompter,
-  options: {message?: string} = {},
-  existingDatasets: string[] = [],
-): Promise<string> {
-  return prompt.single({
-    type: 'input',
-    message: 'Dataset name:',
-    validate: (name) => {
-      if (existingDatasets.includes(name)) {
-        return 'Dataset name already exists'
-      }
-
-      if (!name || name.length < 2 || name.length > MAX_DATASET_NAME_LENGTH) {
-        return `Dataset name must be between 2 and ${MAX_DATASET_NAME_LENGTH} characters`
-      }
-
-      if (name.toLowerCase() !== name) {
-        return 'Dataset name must be lowercase'
-      }
-
-      if (name.replace(/\s/g, '') !== name) {
-        return 'Dataset name cannot contain whitespace'
-      }
-
-      if (/^[^a-z0-9]/.test(name)) {
-        return 'Dataset name must start with a character or letter'
-      }
-
-      if (/[-_]$/.test(name)) {
-        return 'Dataset name must not end with a dash or an underscore'
-      }
-
-      const isValid = /^[a-z0-9][-\w]+$/.test(name)
-      if (isValid) {
-        return true
-      }
-
-      const invalid = name.match(/[^-\w]/g) || []
-      return invalid.length > 0
-        ? `Disallowed characters found: ${formatInvalid(name, invalid)}`
-        : datasetNameError
-    },
-    ...options,
-  })
-}
-
-function formatInvalid(name: string, invalid: string[]): string {
-  return invalid.reduce(
-    (acc, char) => acc.replace(new RegExp(escapeRegex(char), 'g'), chalk.red.bold(char)),
-    name,
-  )
-}
-
-function escapeRegex(str: string): string {
-  return `${str}`.replace(/([?!${}*:()|=^[\]/\\.+])/g, '\\$1')
-}

package/src/actions/init-project/prompts/index.ts

@@ -1,51 +0,0 @@
-import {type CliOutputter, type CliPrompter} from '../../../types'
-
-export function promptForTypeScript(prompt: CliPrompter): Promise<boolean> {
-  return prompt.single({
-    type: 'confirm',
-    message: 'Do you want to use TypeScript?',
-    default: true,
-  })
-}
-
-export function promptForDefaultConfig(prompt: CliPrompter): Promise<boolean> {
-  return prompt.single({
-    type: 'confirm',
-    message: 'Use the default dataset configuration?',
-    default: true,
-  })
-}
-
-export function promptImplicitReconfigure(prompt: CliPrompter): Promise<boolean> {
-  return prompt.single({
-    type: 'confirm',
-    message:
-      'The current folder contains a configured Sanity studio. Would you like to reconfigure it?',
-    default: true,
-  })
-}
-
-export async function promptForAclMode(prompt: CliPrompter, output: CliOutputter): Promise<string> {
-  const mode = await prompt.single({
-    type: 'list',
-    message: 'Choose dataset visibility – this can be changed later',
-    choices: [
-      {
-        value: 'public',
-        name: 'Public (world readable)',
-      },
-      {
-        value: 'private',
-        name: 'Private (authenticated requests only)',
-      },
-    ],
-  })
-
-  if (mode === 'private') {
-    output.print(
-      'Please note that while documents are private, assets (files and images) are still public\n',
-    )
-  }
-
-  return mode
-}

package/src/actions/init-project/prompts/nextjs.ts

@@ -1,59 +0,0 @@
-import {type CliPrompter} from '../../../types'
-
-export function promptForEmbeddedStudio(prompt: CliPrompter): Promise<string> {
-  return prompt.single({
-    type: 'confirm',
-    message: `Would you like an embedded Sanity Studio?`,
-    default: true,
-  })
-}
-
-export function promptForStudioPath(prompt: CliPrompter): Promise<string> {
-  return prompt.single({
-    type: 'input',
-    message: 'What route do you want to use for the Studio?',
-    default: '/studio',
-    validate(input) {
-      if (!input.startsWith('/')) {
-        return 'Must start with /'
-      }
-
-      if (input.endsWith('/')) {
-        return 'Must not end with /'
-      }
-
-      // a-Z, 0-9, -, _ and /
-      if (!/^[a-zA-Z0-9-_\\/]+$/.test(input)) {
-        return 'Must only contain a-Z, 0-9, -, _ and /'
-      }
-
-      return true
-    },
-  })
-}
-
-export function promptForNextTemplate(prompt: CliPrompter): Promise<'clean' | 'blog'> {
-  return prompt.single({
-    message: 'Select project template to use',
-    type: 'list',
-    choices: [
-      {
-        value: 'blog',
-        name: 'Blog (schema)',
-      },
-      {
-        value: 'clean',
-        name: 'Clean project with no predefined schema types',
-      },
-    ],
-    default: 'blog',
-  })
-}
-
-export function promptForAppendEnv(prompt: CliPrompter, envFilename: string): Promise<string> {
-  return prompt.single({
-    type: 'confirm',
-    message: `Would you like to add the project ID and dataset to your ${envFilename} file?`,
-    default: true,
-  })
-}

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

@@ -1,17 +0,0 @@
-import fs from 'node:fs'
-
-import {type PackageJson} from '../../types'
-
-/**
- * Read the `package.json` file at the given path
- *
- * @param filePath - Path to package.json to read
- * @returns The parsed package.json
- */
-export function readPackageJson(filePath: string): PackageJson | undefined {
-  try {
-    return JSON.parse(fs.readFileSync(filePath, 'utf8'))
-  } catch {
-    return undefined
-  }
-}

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

@@ -1,23 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const appTemplate: ProjectTemplate = {
-  dependencies: {
-    '@sanity/sdk': '^2',
-    '@sanity/sdk-react': '^2',
-    'react': '^19',
-    'react-dom': '^19',
-  },
-  devDependencies: {
-    '@types/react': '^19',
-    'sanity': '^3',
-    'typescript': '^5.1.6',
-  },
-  entry: './src/App.tsx',
-  scripts: {
-    dev: 'sanity dev',
-    build: 'sanity build',
-    start: 'sanity start',
-  },
-}
-
-export default appTemplate

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

@@ -1,25 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const appSanityUiTemplate: ProjectTemplate = {
-  dependencies: {
-    '@sanity/sdk': '^2',
-    '@sanity/sdk-react': '^2',
-    '@sanity/ui': '^2',
-    'react': '^19',
-    'react-dom': '^19',
-    'styled-components': '^6.1.17',
-  },
-  devDependencies: {
-    '@types/react': '^19',
-    'sanity': '^3',
-    'typescript': '^5.1.6',
-  },
-  entry: './src/App.tsx',
-  scripts: {
-    dev: 'sanity dev',
-    build: 'sanity build',
-    start: 'sanity start',
-  },
-}
-
-export default appSanityUiTemplate

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

@@ -1,5 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const blogTemplate: ProjectTemplate = {}
-
-export default blogTemplate

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

@@ -1,5 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const cleanTemplate: ProjectTemplate = {}
-
-export default cleanTemplate

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

@@ -1,37 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const configTemplate = `
-import {defineConfig, isDev} from 'sanity'
-import {visionTool} from '@sanity/vision'
-import {structureTool} from 'sanity/structure'
-import {schemaTypes} from './schemaTypes'
-import {getStartedPlugin} from './plugins/sanity-plugin-tutorial'
-
-const devOnlyPlugins = [getStartedPlugin()]
-
-export default defineConfig({
-  name: '%sourceName%',
-  title: '%projectName%',
-
-  projectId: '%projectId%',
-  dataset: '%dataset%',
-
-  plugins: [structureTool(), visionTool(), ...(isDev ? devOnlyPlugins : [])],
-
-  schema: {
-    types: schemaTypes,
-  },
-})
-
-`
-
-const getStartedTemplate: ProjectTemplate = {
-  configTemplate,
-  typescriptOnly: true,
-  dependencies: {
-    '@sanity/icons': '^2.11.0',
-    '@sanity/ui': '^2.0.0',
-  },
-}
-
-export default getStartedTemplate

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

@@ -1,24 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-import appTemplate from './appQuickstart'
-import appSanityUiTemplate from './appSanityUi'
-import blog from './blog'
-import clean from './clean'
-import getStartedTemplate from './getStarted'
-import moviedb from './moviedb'
-import quickstart from './quickstart'
-import shopify from './shopify'
-import shopifyOnline from './shopifyOnline'
-
-const templates: Record<string, ProjectTemplate | undefined> = {
-  blog,
-  clean,
-  'app-quickstart': appTemplate,
-  'app-sanity-ui': appSanityUiTemplate,
-  'get-started': getStartedTemplate,
-  moviedb,
-  shopify,
-  'shopify-online-storefront': shopifyOnline,
-  quickstart, // empty project that dynamically imports its own schema
-}
-
-export default templates

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

@@ -1,35 +0,0 @@
-import {type ProjectTemplate} from '../initProject'
-
-const configTemplate = `
-import {defineConfig} from 'sanity'
-import {structureTool} from 'sanity/structure'
-import {visionTool} from '@sanity/vision'
-import {schemaTypes} from './schemaTypes'
-
-export default defineConfig({
-  name: '%sourceName%',
-  title: '%projectName%',
-
-  projectId: '%projectId%',
-  dataset: '%dataset%',
-
-  plugins: [
-    structureTool(),
-    visionTool(),
-  ],
-
-  schema: {
-    types: schemaTypes,
-  },
-})
-`
-
-const movieTemplate: ProjectTemplate = {
-  configTemplate,
-  importPrompt: 'Add a sampling of sci-fi movies to your dataset on the hosted backend?',
-  datasetUrl: 'https://public.sanity.io/moviesdb-2018-03-06.tar.gz',
-  dependencies: {
-    'react-icons': '^3.11.0',
-  },
-}
-export default movieTemplate

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

@@ -1,238 +0,0 @@
-import {blogSchemaFolder, blogSchemaJS, blogSchemaTS} from './schemaTypes/blog'
-
-export const sanityConfigTemplate = (hasSrcFolder = false): string => `'use client'
-
-/**
- * This configuration is used to for the Sanity Studio that’s mounted on the \`:route:\` route
- */
-
-import {visionTool} from '@sanity/vision'
-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 ${hasSrcFolder ? "'./src/sanity/env'" : "'./sanity/env'"}
-import {schema} from ${hasSrcFolder ? "'./src/sanity/schemaTypes'" : "'./sanity/schemaTypes'"}
-import {structure} from ${hasSrcFolder ? "'./src/sanity/structure'" : "'./sanity/structure'"}
-
-export default defineConfig({
-  basePath: ':basePath:',
-  projectId,
-  dataset,
-  // Add and edit the content schema in the './sanity/schemaTypes' folder
-  schema,
-  plugins: [
-    structureTool({structure}),
-    // Vision is for querying with GROQ from inside the Studio
-    // https://www.sanity.io/docs/the-vision-plugin
-    visionTool({defaultApiVersion: apiVersion}),
-  ],
-})
-`
-
-export const sanityCliTemplate = `/**
-* This configuration file lets you run \`$ sanity [command]\` in this folder
-* Go to https://www.sanity.io/docs/cli to learn more.
-**/
-import { defineCliConfig } from 'sanity/cli'
-
-const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID
-const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET
-
-export default defineCliConfig({ api: { projectId, dataset } })
-`
-
-export const sanityStudioTemplate = `/**
- * This route is responsible for the built-in authoring environment using Sanity Studio.
- * All routes under your studio path is handled by this file using Next.js' catch-all routes:
- * https://nextjs.org/docs/routing/dynamic-routes#catch-all-routes
- *
- * You can learn more about the next-sanity package here:
- * https://github.com/sanity-io/next-sanity
- */
-
-import { NextStudio } from 'next-sanity/studio'
-import config from ':configPath:'
-
-export const dynamic = 'force-static'
-
-export { metadata, viewport } from 'next-sanity/studio'
-
-export default function StudioPage() {
-  return <NextStudio config={config} />
-}
-`
-
-// Format today's date like YYYY-MM-DD
-const envTS = `export const apiVersion =
-  process.env.NEXT_PUBLIC_SANITY_API_VERSION || '${new Date().toISOString().split('T')[0]}'
-
-export const dataset = assertValue(
-  process.env.NEXT_PUBLIC_SANITY_DATASET,
-  'Missing environment variable: NEXT_PUBLIC_SANITY_DATASET'
-)
-
-export const projectId = assertValue(
-  process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,
-  'Missing environment variable: NEXT_PUBLIC_SANITY_PROJECT_ID'
-)
-
-function assertValue<T>(v: T | undefined, errorMessage: string): T {
-  if (v === undefined) {
-    throw new Error(errorMessage)
-  }
-
-  return v
-}
-`
-
-const envJS = `export const apiVersion =
-  process.env.NEXT_PUBLIC_SANITY_API_VERSION || '${new Date().toISOString().split('T')[0]}'
-
-export const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET;
-export const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID;
-`
-
-const schemaTS = `import { type SchemaTypeDefinition } from 'sanity'
-
-export const schema: { types: SchemaTypeDefinition[] } = {
-  types: [],
-}
-`
-
-const schemaJS = `export const schema = {
-  types: [],
-}
-`
-
-const blogStructureTS = `import type {StructureResolver} from 'sanity/structure'
-
-// https://www.sanity.io/docs/structure-builder-cheat-sheet
-export const structure: StructureResolver = (S) =>
-  S.list()
-    .title('Blog')
-    .items([
-      S.documentTypeListItem('post').title('Posts'),
-      S.documentTypeListItem('category').title('Categories'),
-      S.documentTypeListItem('author').title('Authors'),
-      S.divider(),
-      ...S.documentTypeListItems().filter(
-        (item) => item.getId() && !['post', 'category', 'author'].includes(item.getId()!),
-      ),
-    ])
-`
-
-const blogStructureJS = `// https://www.sanity.io/docs/structure-builder-cheat-sheet
-export const structure = (S) =>
-  S.list()
-    .title('Blog')
-    .items([
-      S.documentTypeListItem('post').title('Posts'),
-      S.documentTypeListItem('category').title('Categories'),
-      S.documentTypeListItem('author').title('Authors'),
-      S.divider(),
-      ...S.documentTypeListItems().filter(
-        (item) => item.getId() && !['post', 'category', 'author'].includes(item.getId()),
-      ),
-    ])
-`
-
-const structureTS = `import type {StructureResolver} from 'sanity/structure'
-
-// https://www.sanity.io/docs/structure-builder-cheat-sheet
-export const structure: StructureResolver = (S) =>
-  S.list()
-    .title('Content')
-    .items(S.documentTypeListItems())
-`
-
-const structureJS = `// https://www.sanity.io/docs/structure-builder-cheat-sheet
-export const structure = (S) =>
-  S.list()
-    .title('Content')
-    .items(S.documentTypeListItems())
-`
-
-const client = `import { createClient } from 'next-sanity'
-
-import { apiVersion, dataset, projectId } from '../env'
-
-export const client = createClient({
-  projectId,
-  dataset,
-  apiVersion,
-  useCdn: true, // Set to false if statically generating pages, using ISR or tag-based revalidation
-})
-`
-
-const live = `// Querying with "sanityFetch" will keep content automatically updated
-// Before using it, import and render "<SanityLive />" in your layout, see
-// https://github.com/sanity-io/next-sanity#live-content-api for more information.
-import { defineLive } from "next-sanity";
-import { client } from './client'
-
-export const { sanityFetch, SanityLive } = defineLive({ 
-  client: client.withConfig({ 
-    // Live content is currently only available on the experimental API
-    // https://www.sanity.io/docs/api-versioning
-    apiVersion: 'vX' 
-  }) 
-});
-`
-
-const imageTS = `import createImageUrlBuilder from '@sanity/image-url'
-import { SanityImageSource } from "@sanity/image-url/lib/types/types";
-
-import { dataset, projectId } from '../env'
-
-// https://www.sanity.io/docs/image-url
-const builder = createImageUrlBuilder({ projectId, dataset })
-
-export const urlFor = (source: SanityImageSource) => {
-  return builder.image(source)
-}
-`
-
-const imageJS = `import createImageUrlBuilder from '@sanity/image-url'
-
-import { dataset, projectId } from '../env'
-
-// https://www.sanity.io/docs/image-url
-const builder = createImageUrlBuilder({ projectId, dataset })
-
-export const urlFor = (source) => {
-  return builder.image(source)
-}
-`
-
-type FolderStructure = Record<string, string | Record<string, string>>
-
-export const sanityFolder = (
-  useTypeScript: boolean,
-  template?: 'clean' | 'blog',
-): FolderStructure => {
-  // Files used in both templates
-  const structure: FolderStructure = {
-    'env.': useTypeScript ? envTS : envJS,
-    'lib': {
-      'client.': client,
-      'live.': live,
-      'image.': useTypeScript ? imageTS : imageJS,
-    },
-  }
-
-  if (template === 'blog') {
-    structure.schemaTypes = {
-      ...blogSchemaFolder,
-      'index.': useTypeScript ? blogSchemaTS : blogSchemaJS,
-    }
-    structure['structure.'] = useTypeScript ? blogStructureTS : blogStructureJS
-  } else {
-    structure.schemaTypes = {
-      'index.': useTypeScript ? schemaTS : schemaJS,
-    }
-    structure['structure.'] = useTypeScript ? structureTS : structureJS
-  }
-
-  return structure
-}