semantic-or-syntactic-errors.ts

import * as ts from 'typescript'; // leave this as * as ts so people using util package don't need syntheticDefaultImports

interface SemanticOrSyntacticError extends ts.Diagnostic {
  message: string;
}

/**
 * By default, diagnostics from the TypeScript compiler contain all errors - regardless of whether
 * they are related to generic ECMAScript standards, or TypeScript-specific constructs.
 *
 * Therefore, we filter out all diagnostics, except for the ones we explicitly want to consider when
 * the user opts in to throwing errors on semantic issues.
 */
export function getFirstSemanticOrSyntacticError(
  program: ts.Program,
  ast: ts.SourceFile,
): SemanticOrSyntacticError | undefined {
  try {
    const supportedSyntacticDiagnostics = whitelistSupportedDiagnostics(
      program.getSyntacticDiagnostics(ast),
    );
    if (supportedSyntacticDiagnostics.length) {
      return convertDiagnosticToSemanticOrSyntacticError(
        supportedSyntacticDiagnostics[0],
      );
    }
    const supportedSemanticDiagnostics = whitelistSupportedDiagnostics(
      program.getSemanticDiagnostics(ast),
    );
    if (supportedSemanticDiagnostics.length) {
      return convertDiagnosticToSemanticOrSyntacticError(
        supportedSemanticDiagnostics[0],
      );
    }
    return undefined;
  } catch (e) {
    /**
     * TypeScript compiler has certain Debug.fail() statements in, which will cause the diagnostics
     * retrieval above to throw.
     *
     * E.g. from ast-alignment-tests
     * "Debug Failure. Shouldn't ever directly check a JsxOpeningElement"
     *
     * For our current use-cases this is undesired behavior, so we just suppress it
     * and log a a warning.
     */
    /* istanbul ignore next */
    console.warn(`Warning From TSC: "${e.message}`); // eslint-disable-line no-console
    /* istanbul ignore next */
    return undefined;
  }
}

function whitelistSupportedDiagnostics(
  diagnostics: readonly (ts.DiagnosticWithLocation | ts.Diagnostic)[],
): readonly (ts.DiagnosticWithLocation | ts.Diagnostic)[] {
  return diagnostics.filter(diagnostic => {
    switch (diagnostic.code) {
      case 1013: // ts 3.2 "A rest parameter or binding pattern may not have a trailing comma."
      case 1014: // ts 3.2 "A rest parameter must be last in a parameter list."
      case 1044: // ts 3.2 "'{0}' modifier cannot appear on a module or namespace element."
      case 1045: // ts 3.2 "A '{0}' modifier cannot be used with an interface declaration."
      case 1048: // ts 3.2 "A rest parameter cannot have an initializer."
      case 1049: // ts 3.2 "A 'set' accessor must have exactly one parameter."
      case 1070: // ts 3.2 "'{0}' modifier cannot appear on a type member."
      case 1071: // ts 3.2 "'{0}' modifier cannot appear on an index signature."
      case 1085: // ts 3.2 "Octal literals are not available when targeting ECMAScript 5 and higher. Use the syntax '{0}'."
      case 1090: // ts 3.2 "'{0}' modifier cannot appear on a parameter."
      case 1096: // ts 3.2 "An index signature must have exactly one parameter."
      case 1097: // ts 3.2 "'{0}' list cannot be empty."
      case 1098: // ts 3.3 "Type parameter list cannot be empty."
      case 1099: // ts 3.3 "Type argument list cannot be empty."
      case 1117: // ts 3.2 "An object literal cannot have multiple properties with the same name in strict mode."
      case 1121: // ts 3.2 "Octal literals are not allowed in strict mode."
      case 1123: // ts 3.2: "Variable declaration list cannot be empty."
      case 1141: // ts 3.2 "String literal expected."
      case 1162: // ts 3.2 "An object member cannot be declared optional."
      case 1172: // ts 3.2 "'extends' clause already seen."
      case 1173: // ts 3.2 "'extends' clause must precede 'implements' clause."
      case 1175: // ts 3.2 "'implements' clause already seen."
      case 1176: // ts 3.2 "Interface declaration cannot have 'implements' clause."
      case 1190: // ts 3.2 "The variable declaration of a 'for...of' statement cannot have an initializer."
      case 1200: // ts 3.2 "Line terminator not permitted before arrow."
      case 1206: // ts 3.2 "Decorators are not valid here."
      case 1211: // ts 3.2 "A class declaration without the 'default' modifier must have a name."
      case 1242: // ts 3.2 "'abstract' modifier can only appear on a class, method, or property declaration."
      case 1246: // ts 3.2 "An interface property cannot have an initializer."
      case 1255: // ts 3.2 "A definite assignment assertion '!' is not permitted in this context."
      case 1308: // ts 3.2 "'await' expression is only allowed within an async function."
      case 2364: // ts 3.2 "The left-hand side of an assignment expression must be a variable or a property access."
      case 2369: // ts 3.2 "A parameter property is only allowed in a constructor implementation."
      case 2462: // ts 3.2 "A rest element must be last in a destructuring pattern."
      case 8017: // ts 3.2 "Octal literal types must use ES2015 syntax. Use the syntax '{0}'."
      case 17012: // ts 3.2 "'{0}' is not a valid meta-property for keyword '{1}'. Did you mean '{2}'?"
      case 17013: // ts 3.2 "Meta-property '{0}' is only allowed in the body of a function declaration, function expression, or constructor."
        return true;
    }
    return false;
  });
}

function convertDiagnosticToSemanticOrSyntacticError(
  diagnostic: ts.Diagnostic,
): SemanticOrSyntacticError {
  return {
    ...diagnostic,
    message: ts.flattenDiagnosticMessageText(
      diagnostic.messageText,
      ts.sys.newLine,
    ),
  };
}