Function invalidRef

packages/compiler-cli/src/ngtsc/scope/src/local.ts:702–737

* Produce a `ts.Diagnostic` for an invalid import or export from an NgModule.

(
  decl: Reference<ClassDeclaration>,
  rawExpr: ts.Expression | null,
  type: 'import' | 'export',
)

 * Produce a `ts.Diagnostic` for an invalid import or export from an NgModule.
 */
function invalidRef(
  decl: Reference<ClassDeclaration>,
  rawExpr: ts.Expression | null,
  type: 'import' | 'export',
): ts.Diagnostic {
  const code =
    type === 'import' ? ErrorCode.NGMODULE_INVALID_IMPORT : ErrorCode.NGMODULE_INVALID_EXPORT;
  const resolveTarget = type === 'import' ? 'NgModule' : 'NgModule, Component, Directive, or Pipe';
  const message = `'${decl.node.name.text}' does not appear to be an ${resolveTarget} class.`;
  const library = decl.ownedByModuleGuess !== null ? ` (${decl.ownedByModuleGuess})` : '';
  const sf = decl.node.getSourceFile();

  let relatedMessage: string;

  // Provide extra context to the error for the user.
  if (!sf.isDeclarationFile) {
    // This is a file in the user's program. Highlight the class as undecorated.
    const annotationType = type === 'import' ? '@NgModule' : 'Angular';
    relatedMessage = `Is it missing an ${annotationType} annotation?`;
  } else if (sf.fileName.indexOf('node_modules') !== -1) {
    // This file comes from a third-party library in node_modules.
    relatedMessage =
      `This likely means that the library${library} which declares ${decl.debugName} is not ` +
      'compatible with Angular Ivy. Check if a newer version of the library is available, ' +
      "and update if so. Also consider checking with the library's authors to see if the " +
      'library is expected to be compatible with Ivy.';
  } else {
    // This is a monorepo style local dependency. Unfortunately these are too different to really
    // offer much more advice than this.
    relatedMessage = `This likely means that the dependency${library} which declares ${decl.debugName} is not compatible with Angular Ivy.`;
  }

  return makeDiagnostic(code, getDiagnosticNode(decl, rawExpr), message, [
    makeRelatedInformation(decl.node.name, relatedMessage),
  ]);
}

/**
 * Produce a `ts.Diagnostic` for an import or export which itself has errors.