createDiagnostic() — react Function Reference

Source Code

compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts lines 1053–1112

function createDiagnostic(
  category:
    | ErrorCategory.MemoDependencies
    | ErrorCategory.EffectExhaustiveDependencies,
  missing: Array<InferredDependency>,
  extra: Array<ManualMemoDependency>,
  suggestion: CompilerSuggestion | null,
): CompilerDiagnostic {
  let reason: string;
  let description: string;

  function joinMissingExtraDetail(
    missingString: string,
    extraString: string,
    joinStr: string,
  ): string {
    return [
      missing.length !== 0 ? missingString : null,
      extra.length !== 0 ? extraString : null,
    ]
      .filter(Boolean)
      .join(joinStr);
  }

  switch (category) {
    case ErrorCategory.MemoDependencies: {
      reason = `Found ${joinMissingExtraDetail('missing', 'extra', '/')} memoization dependencies`;
      description = joinMissingExtraDetail(
        'Missing dependencies can cause a value to update less often than it should, resulting in stale UI',
        'Extra dependencies can cause a value to update more often than it should, resulting in performance' +
          ' problems such as excessive renders or effects firing too often',
        '. ',
      );
      break;
    }
    case ErrorCategory.EffectExhaustiveDependencies: {
      reason = `Found ${joinMissingExtraDetail('missing', 'extra', '/')} effect dependencies`;
      description = joinMissingExtraDetail(
        'Missing dependencies can cause an effect to fire less often than it should',
        'Extra dependencies can cause an effect to fire more often than it should, resulting' +
          ' in performance problems such as excessive renders and side effects',
        '. ',
      );
      break;
    }
    default: {
      CompilerError.invariant(false, {
        reason: `Unexpected error category: ${category}`,
        loc: GeneratedSource,
      });
    }
  }

  return CompilerDiagnostic.create({
    category,
    reason,
    description,
    suggestions: suggestion != null ? [suggestion] : null,
  });
}