Function validateConfig

packages/cli/src/util/validate-config.ts:631–764

(config: VercelConfig)

}

export function validateConfig(config: VercelConfig): NowBuildError | null {
  const validate = getConfigValidator();
  if (!validate(config)) {
    if (validate.errors && validate.errors[0]) {
      const error = validate.errors[0];
      const fileName = config[fileNameSymbol] || 'vercel.json';
      const niceError = getPrettyError(error);
      niceError.message = `Invalid ${fileName} - ${niceError.message}`;
      return niceError;
    }
  }

  if (config.functions && config.builds) {
    return new NowBuildError({
      code: 'FUNCTIONS_AND_BUILDS',
      message:
        'The `functions` property cannot be used in conjunction with the `builds` property. Please remove one of them.',
      link: 'https://vercel.link/functions-and-builds',
    });
  }

  const hasExperimentalServices = Boolean(config.experimentalServices);

  if (hasExperimentalServices && config.builds) {
    return new NowBuildError({
      code: 'EXPERIMENTAL_SERVICES_AND_BUILDS',
      message:
        'The `experimentalServices` property cannot be used in conjunction with the `builds` property. Please remove one of them.',
    });
  }

  if (hasExperimentalServices && config.functions) {
    return new NowBuildError({
      code: 'EXPERIMENTAL_SERVICES_AND_FUNCTIONS',
      message:
        'The `experimentalServices` property cannot be used in conjunction with the `functions` property. Please remove one of them.',
    });
  }

  if (config.experimentalServiceGroups && !config.experimentalServices) {
    return new NowBuildError({
      code: 'SERVICE_GROUPS_WITHOUT_SERVICES',
      message:
        'The `experimentalServiceGroups` property requires `experimentalServices` to be defined. Service groups reference services by name.',
    });
  }

  const hasServices = config.services != null;
  const hasExperimentalServicesV2 = config.experimentalServicesV2 != null;

  if (hasServices && hasExperimentalServicesV2) {
    return new NowBuildError({
      code: 'SERVICES_AND_EXPERIMENTAL_SERVICES_V2',
      message:
        'The `services` property cannot be used in conjunction with its deprecated alias `experimentalServicesV2`. Please use only `services`.',
    });
  }