@sanity/cli 3.93.1-next.9.198ab74452 → 3.94.0

package/src/actions/typegen/generateAction.ts

@@ -1,210 +0,0 @@
-import {constants, mkdir, open, stat} from 'node:fs/promises'
-import {dirname, join} from 'node:path'
-import {Worker} from 'node:worker_threads'
-
-import {readConfig} from '@sanity/codegen'
-import {format as prettierFormat, resolveConfig as resolvePrettierConfig} from 'prettier'
-
-import {type CliCommandArguments, type CliCommandContext} from '../../types'
-import {getCliWorkerPath} from '../../util/cliWorker'
-import {
-  type TypegenGenerateTypesWorkerData,
-  type TypegenGenerateTypesWorkerMessage,
-} from '../../workers/typegenGenerate'
-import {TypesGeneratedTrace} from './generate.telemetry'
-
-export interface TypegenGenerateTypesCommandFlags {
-  'config-path'?: string
-}
-
-const generatedFileWarning = `/**
- * ---------------------------------------------------------------------------------
- * This file has been generated by Sanity TypeGen.
- * Command: \`sanity typegen generate\`
- *
- * Any modifications made directly to this file will be overwritten the next time
- * the TypeScript definitions are generated. Please make changes to the Sanity
- * schema definitions and/or GROQ queries if you need to update these types.
- *
- * For more information on how to use Sanity TypeGen, visit the official documentation:
- * https://www.sanity.io/docs/sanity-typegen
- * ---------------------------------------------------------------------------------
- */\n\n`
-
-export default async function typegenGenerateAction(
-  args: CliCommandArguments<TypegenGenerateTypesCommandFlags>,
-  context: CliCommandContext,
-): Promise<void> {
-  const flags = args.extOptions
-  const {output, workDir, telemetry} = context
-
-  const trace = telemetry.trace(TypesGeneratedTrace)
-  trace.start()
-
-  const codegenConfig = await readConfig(flags['config-path'] || 'sanity-typegen.json')
-
-  try {
-    const schemaStats = await stat(codegenConfig.schema)
-    if (!schemaStats.isFile()) {
-      throw new Error(`Schema path is not a file: ${codegenConfig.schema}`)
-    }
-  } catch (err) {
-    if (err.code === 'ENOENT') {
-      // If the user has not provided a specific schema path (eg we're using the default), give some help
-      const hint =
-        codegenConfig.schema === './schema.json' ? ` - did you run "sanity schema extract"?` : ''
-      throw new Error(`Schema file not found: ${codegenConfig.schema}${hint}`)
-    }
-    throw err
-  }
-
-  const outputPath = join(process.cwd(), codegenConfig.generates)
-  const outputDir = dirname(outputPath)
-  await mkdir(outputDir, {recursive: true})
-  const workerPath = await getCliWorkerPath('typegenGenerate')
-
-  const spinner = output.spinner({}).start('Generating types')
-
-  const worker = new Worker(workerPath, {
-    workerData: {
-      workDir,
-      schemaPath: codegenConfig.schema,
-      searchPath: codegenConfig.path,
-      overloadClientMethods: codegenConfig.overloadClientMethods,
-    } satisfies TypegenGenerateTypesWorkerData,
-    // eslint-disable-next-line no-process-env
-    env: process.env,
-  })
-
-  const typeFile = await open(
-    outputPath,
-    // eslint-disable-next-line no-bitwise
-    constants.O_TRUNC | constants.O_CREAT | constants.O_WRONLY,
-  )
-
-  typeFile.write(generatedFileWarning)
-
-  const stats = {
-    queryFilesCount: 0,
-    errors: 0,
-    queriesCount: 0,
-    schemaTypesCount: 0,
-    unknownTypeNodesGenerated: 0,
-    typeNodesGenerated: 0,
-    emptyUnionTypeNodesGenerated: 0,
-    size: 0,
-  }
-
-  await new Promise<void>((resolve, reject) => {
-    worker.addListener('message', (msg: TypegenGenerateTypesWorkerMessage) => {
-      if (msg.type === 'error') {
-        if (msg.fatal) {
-          trace.error(msg.error)
-          reject(msg.error)
-          return
-        }
-        const errorMessage = msg.filename
-          ? `${msg.error.message} in "${msg.filename}"`
-          : msg.error.message
-        spinner.fail(errorMessage)
-        stats.errors++
-        return
-      }
-      if (msg.type === 'complete') {
-        resolve()
-        return
-      }
-
-      if (msg.type === 'typemap') {
-        let typeMapStr = `// Query TypeMap\n`
-        typeMapStr += msg.typeMap
-        typeFile.write(typeMapStr)
-        stats.size += Buffer.byteLength(typeMapStr)
-        return
-      }
-
-      let fileTypeString = `// Source: ${msg.filename}\n`
-
-      if (msg.type === 'schema') {
-        stats.schemaTypesCount += msg.length
-        fileTypeString += msg.schema
-        typeFile.write(fileTypeString)
-        return
-      }
-
-      if (msg.type === 'types') {
-        stats.queryFilesCount++
-        for (const {
-          queryName,
-          query,
-          type,
-          typeNodesGenerated,
-          unknownTypeNodesGenerated,
-          emptyUnionTypeNodesGenerated,
-        } of msg.types) {
-          fileTypeString += `// Variable: ${queryName}\n`
-          fileTypeString += `// Query: ${query.replace(/(\r\n|\n|\r)/gm, '').trim()}\n`
-          fileTypeString += type
-          stats.queriesCount++
-          stats.typeNodesGenerated += typeNodesGenerated
-          stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated
-          stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated
-        }
-        typeFile.write(`${fileTypeString}\n`)
-        stats.size += Buffer.byteLength(fileTypeString)
-      }
-    })
-    worker.addListener('error', reject)
-  })
-
-  await typeFile.close()
-
-  const prettierConfig = codegenConfig.formatGeneratedCode
-    ? await resolvePrettierConfig(outputPath).catch((err) => {
-        output.warn(`Failed to load prettier config: ${err.message}`)
-        return null
-      })
-    : null
-
-  if (prettierConfig) {
-    const formatFile = await open(outputPath, constants.O_RDWR)
-    try {
-      const code = await formatFile.readFile()
-      const formattedCode = await prettierFormat(code.toString(), {
-        ...prettierConfig,
-        parser: 'typescript' as const,
-      })
-      await formatFile.truncate()
-      await formatFile.write(formattedCode, 0)
-
-      spinner.info('Formatted generated types with Prettier')
-    } catch (err) {
-      output.warn(`Failed to format generated types with Prettier: ${err.message}`)
-    } finally {
-      await formatFile.close()
-    }
-  }
-
-  trace.log({
-    outputSize: stats.size,
-    queriesCount: stats.queriesCount,
-    schemaTypesCount: stats.schemaTypesCount,
-    queryFilesCount: stats.queryFilesCount,
-    filesWithErrors: stats.errors,
-    typeNodesGenerated: stats.typeNodesGenerated,
-    unknownTypeNodesGenerated: stats.unknownTypeNodesGenerated,
-    unknownTypeNodesRatio:
-      stats.typeNodesGenerated > 0 ? stats.unknownTypeNodesGenerated / stats.typeNodesGenerated : 0,
-    emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated,
-    configOverloadClientMethods: codegenConfig.overloadClientMethods,
-  })
-
-  trace.complete()
-  if (stats.errors > 0) {
-    spinner.warn(`Encountered errors in ${stats.errors} files while generating types`)
-  }
-
-  spinner.succeed(
-    `Generated TypeScript types for ${stats.schemaTypesCount} schema types and ${stats.queriesCount} GROQ queries in ${stats.queryFilesCount} files into: ${codegenConfig.generates}`,
-  )
-}

package/src/actions/versions/findSanityModuleVersions.ts

@@ -1,185 +0,0 @@
-import {readFileSync} from 'node:fs'
-import {join as joinPath} from 'node:path'
-
-import getLatestVersion from 'get-latest-version'
-import promiseProps from 'promise-props-recursive'
-import semver from 'semver'
-import semverCompare from 'semver-compare'
-
-import {type CliCommandContext, type PackageJson} from '../../types'
-import {getCliVersion} from '../../util/getCliVersion'
-import {getLocalVersion} from '../../util/getLocalVersion'
-
-/*
- * The `sanity upgrade` command should only be responsible for upgrading the
- * _studio_ related dependencies. Modules like @sanity/block-content-to-react
- * shouldn't be upgraded using the same tag/range as the other studio modules.
- *
- * We don't have a guaranteed list of the "studio modules", so instead we
- * explicitly exclude certain modules from being upgraded.
- */
-const PACKAGES_TO_EXCLUDE = [
-  '@sanity/block-content-to-html',
-  '@sanity/block-content-to-react',
-  '@sanity/client',
-]
-
-const defaultOptions: FindModuleVersionOptions = {
-  includeCli: true,
-}
-
-interface PromisedModuleVersionInfo {
-  name: string
-  declared: string
-  installed: string | undefined
-  latest: Promise<string | undefined>
-  latestInRange: Promise<string | undefined>
-  isPinned: boolean
-  isGlobal: boolean
-}
-
-interface ModuleVersionInfo {
-  name: string
-  declared: string
-  installed: string | undefined
-  latest: string
-  latestInRange: string
-  isPinned: boolean
-  isGlobal: boolean
-}
-
-export interface ModuleVersionResult extends ModuleVersionInfo {
-  needsUpdate: boolean
-}
-
-export interface FindModuleVersionOptions {
-  includeCli?: boolean
-  target?: string
-}
-
-export async function findSanityModuleVersions(
-  context: CliCommandContext,
-  options: FindModuleVersionOptions = {},
-): Promise<ModuleVersionResult[]> {
-  const {spinner} = context.output
-  const {target, includeCli} = {...defaultOptions, ...options}
-  const cliVersion = await getCliVersion()
-
-  // Declared @sanity modules and their wanted version ranges in package.json
-  const sanityModules = filterSanityModules(getLocalManifest(context.workDir))
-
-  // Figure out the latest versions which match the wanted range
-  const resolveOpts = {includeCli, target}
-  const spin = spinner('Resolving latest versions').start()
-  const versions = await promiseProps<ModuleVersionInfo[]>(
-    buildPackageArray(sanityModules, context.workDir, resolveOpts, cliVersion),
-  )
-
-  const packages = Object.values(versions)
-  spin.stop()
-
-  return packages.map((mod) => {
-    const current = mod.installed || semver.minVersion(mod.declared)?.toString() || ''
-    const needsUpdate =
-      target === 'latest'
-        ? semverCompare(current, mod.latest) === -1
-        : typeof mod.latestInRange !== 'undefined' && mod.installed !== mod.latestInRange
-
-    return {...mod, needsUpdate}
-  })
-}
-
-function getLocalManifest(workDir: string): Partial<PackageJson> {
-  try {
-    const fileContent = readFileSync(joinPath(workDir, 'package.json'), 'utf8')
-    return JSON.parse(fileContent)
-  } catch {
-    return {}
-  }
-}
-
-function filterSanityModules(manifest: Partial<PackageJson>): Record<string, string> {
-  const dependencies = {
-    ...manifest.dependencies,
-    ...manifest.devDependencies,
-  }
-
-  return Object.keys(dependencies)
-    .filter((mod) => mod.startsWith('@sanity/') || mod === 'sanity')
-    .filter((mod) => !PACKAGES_TO_EXCLUDE.includes(mod))
-    .sort()
-    .reduce(
-      (versions, dependency) => {
-        versions[dependency] = dependencies[dependency]
-        return versions
-      },
-      {} as Record<string, string>,
-    )
-}
-
-function buildPackageArray(
-  packages: Record<string, string>,
-  workDir: string,
-  options: FindModuleVersionOptions = {},
-  cliVersion: string,
-): PromisedModuleVersionInfo[] {
-  const {includeCli, target} = options
-
-  const modules = []
-  if (includeCli) {
-    const [cliMajor] = cliVersion.split('.')
-    const latest = tryFindLatestVersion('@sanity/cli', target || `^${cliMajor}`)
-    modules.push({
-      name: '@sanity/cli',
-      declared: `^${cliVersion}`,
-      installed: trimHash(cliVersion),
-      latest: latest.then((versions) => versions.latest),
-      latestInRange: latest.then((versions) => versions.latestInRange),
-      isPinned: false,
-      isGlobal: true,
-    })
-  }
-
-  return [
-    ...modules,
-    ...Object.keys(packages).map((pkgName) => {
-      const latest = tryFindLatestVersion(pkgName, target || packages[pkgName] || 'latest')
-      const localVersion = getLocalVersion(pkgName, workDir)
-      return {
-        name: pkgName,
-        declared: packages[pkgName],
-        installed: localVersion ? trimHash(localVersion) : undefined,
-        latest: latest.then((versions) => versions.latest),
-        latestInRange: latest.then((versions) => versions.latestInRange),
-        isPinned: isPinnedVersion(packages[pkgName]),
-        isGlobal: false,
-      }
-    }),
-  ]
-}
-
-async function tryFindLatestVersion(pkgName: string, range: string) {
-  try {
-    const {latest, inRange} = await getLatestVersion(pkgName, {range, includeLatest: true})
-    return {latest, latestInRange: inRange}
-  } catch (err) {
-    if (!(err instanceof Error) || !err.message.includes('No version exists')) {
-      throw err
-    }
-
-    const latest = await getLatestVersion(pkgName)
-    return {latest, latestInRange: undefined}
-  }
-}
-
-function isPinnedVersion(version: string): boolean {
-  return /^\d+\.\d+\.\d+/.test(version)
-}
-
-/**
- * `2.27.3-cookieless-auth.34+8ba9c1504` →
- * `2.27.3-cookieless-auth.34`
- */
-function trimHash(version: string) {
-  return version.replace(/\+[a-z0-9]{8,}$/, '')
-}

package/src/actions/yarn/events.ts

@@ -1,73 +0,0 @@
-export interface YarnErrorEvent {
-  type: 'error'
-  data: string
-}
-
-export interface YarnWarningEvent {
-  type: 'warning'
-}
-
-export interface YarnStepEvent {
-  type: 'step'
-  data: {message: string}
-}
-
-export interface YarnActivityStartEvent {
-  type: 'activityStart'
-}
-
-export interface YarnActivityTickEvent {
-  type: 'activityTick'
-  data: {
-    name: string
-  }
-}
-
-export interface YarnActivitySetEndEvent {
-  type: 'activitySetEnd'
-}
-
-export interface YarnActivityEndEvent {
-  type: 'activityEnd'
-}
-
-export interface YarnProgressStartEvent {
-  type: 'progressStart'
-  data: {
-    total: number
-  }
-}
-
-export interface YarnProgressTickEvent {
-  type: 'progressTick'
-  data: {
-    current: number
-  }
-}
-
-export interface YarnProgressFinishEvent {
-  type: 'progressFinish'
-}
-
-export interface YarnSuccessEvent {
-  type: 'success'
-}
-
-export interface YarnFinishedEvent {
-  type: 'finished'
-  data: number
-}
-
-export type YarnEvent =
-  | YarnErrorEvent
-  | YarnWarningEvent
-  | YarnStepEvent
-  | YarnActivityStartEvent
-  | YarnActivityTickEvent
-  | YarnActivitySetEndEvent
-  | YarnActivityEndEvent
-  | YarnProgressStartEvent
-  | YarnProgressTickEvent
-  | YarnProgressFinishEvent
-  | YarnSuccessEvent
-  | YarnFinishedEvent