src/cdk/schematics/ng-update/devkit-migration.ts - main - githubmirror/components

src/cdk/schematics/ng-update/devkit-migration.ts

47 строк2 KB

Charles Lyding

refactor(cdk/schematics): use `@schematics/angular/utility` for workspace helpers

25 апр 2025, 08:49

25 апр 2025, 08:4993e2aab

/**
 * @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 {SchematicContext, Tree} from '@angular-devkit/schematics';
import {ProjectDefinition} from '@schematics/angular/utility';
import {Constructor, Migration, PostMigrationAction} from '../update-tool/migration';
import {TargetVersion} from '../update-tool/target-version';

export type DevkitContext = {
  /** Devkit tree for the current migrations. Can be used to insert/remove files. */
  tree: Tree;
  /** Name of the project the migrations run against. */
  projectName: string;
  /** Workspace project the migrations run against. */
  project: ProjectDefinition;
  /** Whether the migrations run for a test target. */
  isTestTarget: boolean;
};

export abstract class DevkitMigration<Data> extends Migration<Data, DevkitContext> {
  /** Prints an informative message with context on the current target. */
  protected printInfo(text: string) {
    const targetName = this.context.isTestTarget ? 'test' : 'build';
    this.logger.info(`- ${this.context.projectName}@${targetName}: ${text}`);
  }

  /**
   * Optional static method that will be called once the migration of all project
   * targets has been performed. This method can be used to make changes respecting the
   * migration result of all individual targets. e.g. removing HammerJS if it
   * is not needed in any project target.
   */
  static globalPostMigration?(
    tree: Tree,
    targetVersion: TargetVersion,
    context: SchematicContext,
  ): PostMigrationAction;
}

export type DevkitMigrationCtor<Data> = Constructor<DevkitMigration<Data>> & {
  [m in keyof typeof DevkitMigration]: (typeof DevkitMigration)[m];
};