sanity/src/_internal/cli/util/shouldAutoUpdate.ts

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches

import {type CliConfig} from '@sanity/cli'

import {type BuildSanityStudioCommandFlags} from '../actions/build/buildAction'

interface AutoUpdateSources {
  flags: BuildSanityStudioCommandFlags
  cliConfig?: CliConfig
}

/**
 * Compares parameters from various sources to determine whether or not to auto-update
 * @param sources - The sources of the auto-update parameter, including CLI flags and the CLI config
 * @returns boolean
 * @internal
 */
export function shouldAutoUpdate({flags, cliConfig}: AutoUpdateSources): boolean {
  // cli flags (for example, '--no-auto-updates') should take precedence
  if ('auto-updates' in flags) {
    return Boolean(flags['auto-updates'])
  }

  if (cliConfig && 'autoUpdates' in cliConfig) {
    return Boolean(cliConfig.autoUpdates)
  }

  return false
}