packages/language-service/testing/src/util.ts - main - githubmirror/angular

packages/language-service/testing/src/util.ts
169 строк6 KB
ivanwonder
feat(language-service): Support importing the external module's export about the angular metadata. (#61122)
04 июн 2025, 21:11
04 июн 2025, 21:11cf55d1b
/**
 * @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 ts from 'typescript';

import {LanguageServiceTestEnv} from './env';
import {Project, ProjectFiles, TestableOptions} from './project';

/**
 * Expect that a list of objects with a `fileName` property matches a set of expected files by only
 * comparing the file names and not any path prefixes.
 *
 * This assertion is independent of the order of either list.
 */
export function assertFileNames(refs: Array<{fileName: string}>, expectedFileNames: string[]) {
  const actualPaths = refs.map((r) => r.fileName);
  const actualFileNames = actualPaths.map((p) => last(p.split('/')));
  expect(new Set(actualFileNames)).toEqual(new Set(expectedFileNames));
}

/**
 * Expect that a list of objects with a `fileName` property matches a set
 * of file paths.
 *
 * This assertion is independent of the order of either list.
 */
export function assertFilePaths(refs: Array<{fileName: string}>, expectedPaths: RegExp[]) {
  const actualPaths = Array.from(new Set(refs.map((r) => r.fileName)));

  if (actualPaths.length !== expectedPaths.length) {
    expect(actualPaths.length)
      .withContext('Expected expected paths to be the same size.')
      .toBe(expectedPaths.length);
    return;
  }

  for (const pattern of expectedPaths) {
    const matching = actualPaths.findIndex((p) => pattern.test(p));
    if (matching !== -1) {
      actualPaths.splice(matching, 1);
    } else {
      expect(true)
        .withContext(
          `Expected ${pattern} to match a file path. ` +
            `Remaining unmatched paths: ${actualPaths.join(', ')}`,
        )
        .toBe(false);
      return;
    }
  }
}

export function assertTextSpans(items: Array<{textSpan: string}>, expectedTextSpans: string[]) {
  const actualSpans = items.map((item) => item.textSpan);
  expect(new Set(actualSpans)).toEqual(new Set(expectedTextSpans));
}

/**
 * Returns whether the given `ts.Diagnostic` is of a type only produced by the Angular compiler (as
 * opposed to being an upstream TypeScript diagnostic).
 *
 * Template type-checking diagnostics are not "ng-specific" in this sense, since they are plain
 * TypeScript diagnostics that are produced from expressions in the template by way of a TCB.
 */
export function isNgSpecificDiagnostic(diag: ts.Diagnostic): boolean {
  // Angular-specific diagnostics use a negative code space.
  return diag.code < 0;
}

function getFirstClassDeclaration(declaration: string) {
  const matches = declaration.match(/(?:export class )(\w+)(?:\s|\{|<)/);
  if (matches === null || matches.length !== 2) {
    throw new Error(`Did not find exactly one exported class in: ${declaration}`);
  }
  return matches[1].trim();
}

export function createModuleAndProjectWithDeclarations(
  env: LanguageServiceTestEnv,
  projectName: string,
  projectFiles: ProjectFiles,
  angularCompilerOptions: TestableOptions = {},
  standaloneFiles: ProjectFiles = {},
  tsCompilerOptions = {},
): Project {
  const externalClasses: string[] = [];
  const externalImports: string[] = [];
  for (const [fileName, fileContents] of Object.entries(projectFiles)) {
    if (!fileName.endsWith('.ts')) {
      continue;
    }
    const className = getFirstClassDeclaration(fileContents);
    externalClasses.push(className);
    externalImports.push(`import {${className}} from './${fileName.replace('.ts', '')}';`);
  }
  const moduleContents = `
        import {NgModule} from '@angular/core';
        import {CommonModule} from '@angular/common';
        ${externalImports.join('\n')}

        @NgModule({
          declarations: [${externalClasses.join(',')}],
          imports: [CommonModule],
        })
        export class AppModule {}
      `;
  projectFiles['app-module.ts'] = moduleContents;
  return env.addProject(
    projectName,
    {...projectFiles, ...standaloneFiles},
    angularCompilerOptions,
    tsCompilerOptions,
  );
}

export function createProjectWithStandaloneDeclarations(
  env: LanguageServiceTestEnv,
  projectName: string,
  projectFiles: ProjectFiles,
  angularCompilerOptions: TestableOptions = {},
  standaloneFiles: ProjectFiles = {},
): Project {
  const externalClasses: string[] = [];
  const externalImports: string[] = [];
  for (const [fileName, fileContents] of Object.entries(projectFiles)) {
    if (!fileName.endsWith('.ts')) {
      continue;
    }
    const className = getFirstClassDeclaration(fileContents);
    externalClasses.push(className);
    externalImports.push(`import {${className}} from './${fileName.replace('.ts', '')}';`);
  }
  return env.addProject(projectName, {...projectFiles, ...standaloneFiles}, angularCompilerOptions);
}

export function humanizeDocumentSpanLike<T extends ts.DocumentSpan>(
  item: T,
  env: LanguageServiceTestEnv,
): T & Stringy<ts.DocumentSpan> {
  return {
    ...item,
    textSpan: env.getTextFromTsSpan(item.fileName, item.textSpan),
    contextSpan: item.contextSpan
      ? env.getTextFromTsSpan(item.fileName, item.contextSpan)
      : undefined,
    originalTextSpan: item.originalTextSpan
      ? env.getTextFromTsSpan(item.fileName, item.originalTextSpan)
      : undefined,
    originalContextSpan: item.originalContextSpan
      ? env.getTextFromTsSpan(item.fileName, item.originalContextSpan)
      : undefined,
  };
}
type Stringy<T> = {[P in keyof T]: string};

export function getText(contents: string, textSpan: ts.TextSpan) {
  return contents.slice(textSpan.start, textSpan.start + textSpan.length);
}

function last<T>(array: T[]): T {
  if (array.length === 0) {
    throw new Error(`last() called on empty array`);
  }
  return array[array.length - 1];
}