packages/core/schematics/utils/load_esm.ts - main - githubmirror/angular

packages/core/schematics/utils/load_esm.ts
57 строк2 KB
Joey Perrott
refactor: update license text to point to angular.dev (#57901)
24 сен 2024, 16:33
24 сен 2024, 16:339dbe6fc
/**
 * @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 {URL} from 'url';

/**
 * This uses a dynamic import to load a module which may be ESM.
 * CommonJS code can load ESM code via a dynamic import. Unfortunately, TypeScript
 * will currently, unconditionally downlevel dynamic import into a require call.
 * require calls cannot load ESM code and will result in a runtime error. To workaround
 * this, a Function constructor is used to prevent TypeScript from changing the dynamic import.
 * Once TypeScript provides support for keeping the dynamic import this workaround can
 * be dropped.
 * This is only intended to be used with Angular framework packages.
 *
 * @param modulePath The path of the module to load.
 * @returns A Promise that resolves to the dynamically imported module.
 */
export async function loadEsmModule<T>(modulePath: string | URL): Promise<T> {
  const namespaceObject = await new Function('modulePath', `return import(modulePath);`)(
    modulePath,
  );

  // If it is not ESM then the values needed will be stored in the `default` property.
  // TODO_ESM: This can be removed once `@angular/*` packages are ESM only.
  if (namespaceObject.default) {
    return namespaceObject.default;
  } else {
    return namespaceObject;
  }
}

/**
 * Attempt to load the new `@angular/compiler-cli/private/migrations` entry. If not yet present
 * the previous deep imports are used to constructor an equivalent object.
 *
 * @returns A Promise that resolves to the dynamically imported compiler-cli private migrations
 * entry or an equivalent object if not available.
 */
export async function loadCompilerCliMigrationsModule(): Promise<
  typeof import('@angular/compiler-cli/private/migrations')
> {
  try {
    return await loadEsmModule('@angular/compiler-cli/private/migrations');
  } catch {
    // rules_nodejs currently does not support exports field entries. This is a temporary workaround
    // that leverages devmode currently being CommonJS. If that changes before rules_nodejs supports
    // exports then this workaround needs to be reworked.
    // TODO_ESM: This can be removed once Bazel supports exports fields.
    return require('@angular/compiler-cli/private/migrations.js');
  }
}