@angular/cdk
Version:
Angular Material Component Development Kit
36 lines (35 loc) • 1.68 kB
TypeScript
/**
* @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 { workspaces } from '@angular-devkit/core';
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: workspaces.ProjectDefinition;
/** Whether the migrations run for a test target. */
isTestTarget: boolean;
};
export declare abstract class DevkitMigration<Data> extends Migration<Data, DevkitContext> {
/** Prints an informative message with context on the current target. */
protected printInfo(text: string): void;
/**
* 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];
};