packages/language-service/src/codefixes/fix_missing_member.ts - main - githubmirror/angular

packages/language-service/src/codefixes/fix_missing_member.ts
124 строки4 KB
Andrew Scott
refactor(language-service): Update getTcbNodesOfTemplateAtPosition to be usable without compiler (#67898)
27 мар 2026, 00:32
27 мар 2026, 00:327234432
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import type ts from 'typescript';

import {getTcbNodesOfTemplateAtPosition} from '../template_target';
import {getTypeCheckInfoAtPosition} from '../utils';

import {CodeActionMeta, convertFileTextChangeInTcb, FixIdForCodeFixesAll} from './utils';

const errorCodes: number[] = [
  2551, // https://github.com/microsoft/TypeScript/blob/8e6e87fea6463e153822e88431720f846c3b8dfa/src/compiler/diagnosticMessages.json#L2493
  2339, // https://github.com/microsoft/TypeScript/blob/8e6e87fea6463e153822e88431720f846c3b8dfa/src/compiler/diagnosticMessages.json#L1717
];

/**
 * This code action will fix the missing member of a type. For example, add the missing member to
 * the type or try to get the spelling suggestion for the name from the type.
 */
export const missingMemberMeta: CodeActionMeta = {
  errorCodes,
  getCodeActions: function ({
    typeCheckInfo,
    start,
    compiler,
    formatOptions,
    preferences,
    errorCode,
    tsLs,
  }) {
    if (typeCheckInfo === null) {
      return [];
    }
    const tcb = compiler.getTemplateTypeChecker().getTypeCheckBlock(typeCheckInfo.declaration);
    if (tcb === null) {
      return [];
    }
    const tcbNodesInfo = getTcbNodesOfTemplateAtPosition(typeCheckInfo.nodes, start, tcb);
    if (tcbNodesInfo === null) {
      return [];
    }

    const codeActions: ts.CodeFixAction[] = [];
    for (const tcbNode of tcbNodesInfo.nodes) {
      const tsLsCodeActions = tsLs.getCodeFixesAtPosition(
        tcb.getSourceFile().fileName,
        tcbNode.getStart(),
        tcbNode.getEnd(),
        [errorCode],
        formatOptions,
        preferences,
      );
      codeActions.push(...tsLsCodeActions);
    }
    return codeActions.map((codeAction) => {
      return {
        fixName: codeAction.fixName,
        fixId: codeAction.fixId,
        fixAllDescription: codeAction.fixAllDescription,
        description: codeAction.description,
        changes: convertFileTextChangeInTcb(codeAction.changes, compiler),
        commands: codeAction.commands,
      };
    });
  },
  fixIds: [FixIdForCodeFixesAll.FIX_SPELLING, FixIdForCodeFixesAll.FIX_MISSING_MEMBER],
  getAllCodeActions: function ({
    tsLs,
    scope,
    fixId,
    formatOptions,
    preferences,
    compiler,
    diagnostics,
  }) {
    const changes: ts.FileTextChanges[] = [];
    const seen: Set<ts.ClassDeclaration> = new Set();
    for (const diag of diagnostics) {
      if (!errorCodes.includes(diag.code)) {
        continue;
      }

      const fileName = diag.file?.fileName;
      if (fileName === undefined) {
        continue;
      }
      if (diag.start === undefined) {
        continue;
      }
      const declaration = getTypeCheckInfoAtPosition(fileName, diag.start, compiler)?.declaration;
      if (declaration === undefined) {
        continue;
      }
      if (seen.has(declaration)) {
        continue;
      }
      seen.add(declaration);

      const tcb = compiler.getTemplateTypeChecker().getTypeCheckBlock(declaration);
      if (tcb === null) {
        continue;
      }

      const combinedCodeActions = tsLs.getCombinedCodeFix(
        {
          type: scope.type,
          fileName: tcb.getSourceFile().fileName,
        },
        fixId,
        formatOptions,
        preferences,
      );
      changes.push(...combinedCodeActions.changes);
    }
    return {
      changes: convertFileTextChangeInTcb(changes, compiler),
    };
  },
};