CompilerError.ts — react Source File

Source Code

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import * as t from '@babel/types';
import {codeFrameColumns} from '@babel/code-frame';
import {type SourceLocation} from './HIR';
import {Err, Ok, Result} from './Utils/Result';
import {assertExhaustive} from './Utils/utils';
import invariant from 'invariant';

// Number of context lines to display above the source of an error
const CODEFRAME_LINES_ABOVE = 2;
// Number of context lines to display below the source of an error
const CODEFRAME_LINES_BELOW = 3;
/*
 * Max number of lines for the _source_ of an error, before we abbreviate
 * the display of the source portion
 */
const CODEFRAME_MAX_LINES = 10;
/*
 * When the error source exceeds the above threshold, how many lines of
 * the source should be displayed? We show:
 * - CODEFRAME_LINES_ABOVE context lines
 * - CODEFRAME_ABBREVIATED_SOURCE_LINES of the error
 * - '...' ellipsis
 * - CODEFRAME_ABBREVIATED_SOURCE_LINES of the error
 * - CODEFRAME_LINES_BELOW context lines
 *
 * This value must be at least 2 or else we'll cut off important parts of the error message
 */
const CODEFRAME_ABBREVIATED_SOURCE_LINES = 5;

export enum ErrorSeverity {
  /**
   * An actionable error that the developer can fix. For example, product code errors should be
   * reported as such.
   */
  Error = 'Error',
  /**
   * An error that the developer may not necessarily be able to fix. For example, syntax not
   * supported by the compiler does not indicate any fault in the product code.
   */
  Warning = 'Warning',
  /**
   * Not an error. These will not be surfaced in ESLint, but may be surfaced in other ways
   * (eg Forgive) where informational hints can be shown.
   */
  Hint = 'Hint',
  /**
   * These errors will not be reported anywhere. Useful for work in progress validations.
   */
  Off = 'Off',
}

export type CompilerDiagnosticOptions = {
  category: ErrorCategory;
// ... (1042 more lines)