31b9492951
A class that is provided as Angular service is required to have an `@Injectable()` decorator so that the compiler generates its injectable definition for the runtime. Applications are automatically migrated using the "missing-injectable" schematic, however libraries built for older version of Angular may not yet satisfy this requirement. This commit ports the "missing-injectable" schematic to a migration that is ran when ngcc is processing a library. This ensures that any service that is provided from an NgModule or Directive/Component will have an `@Injectable()` decorator. PR Close #33362
85 lines
2.9 KiB
TypeScript
85 lines
2.9 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. 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.io/license
|
|
*/
|
|
import * as ts from 'typescript';
|
|
import {Reference} from '../../../src/ngtsc/imports';
|
|
import {ClassDeclaration, Decorator, isNamedClassDeclaration, isNamedFunctionDeclaration, isNamedVariableDeclaration} from '../../../src/ngtsc/reflection';
|
|
import {MigrationHost} from './migration';
|
|
|
|
export function isClassDeclaration(clazz: ts.Declaration): clazz is ClassDeclaration {
|
|
return isNamedClassDeclaration(clazz) || isNamedFunctionDeclaration(clazz) ||
|
|
isNamedVariableDeclaration(clazz);
|
|
}
|
|
|
|
/**
|
|
* Returns true if the `clazz` is decorated as a `Directive` or `Component`.
|
|
*/
|
|
export function hasDirectiveDecorator(host: MigrationHost, clazz: ClassDeclaration): boolean {
|
|
return host.metadata.getDirectiveMetadata(new Reference(clazz)) !== null;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the `clazz` has its own constructor function.
|
|
*/
|
|
export function hasConstructor(host: MigrationHost, clazz: ClassDeclaration): boolean {
|
|
return host.reflectionHost.getConstructorParameters(clazz) !== null;
|
|
}
|
|
|
|
/**
|
|
* Create an empty `Directive` decorator that will be associated with the `clazz`.
|
|
*/
|
|
export function createDirectiveDecorator(clazz: ClassDeclaration): Decorator {
|
|
const selectorArg = ts.createObjectLiteral([
|
|
// TODO: At the moment ngtsc does not accept a directive with no selector
|
|
ts.createPropertyAssignment('selector', ts.createStringLiteral('NGCC_DUMMY')),
|
|
]);
|
|
const decoratorType = ts.createIdentifier('Directive');
|
|
const decoratorNode = ts.createObjectLiteral([
|
|
ts.createPropertyAssignment('type', decoratorType),
|
|
ts.createPropertyAssignment('args', ts.createArrayLiteral([selectorArg])),
|
|
]);
|
|
|
|
setParentPointers(clazz.getSourceFile(), decoratorNode);
|
|
|
|
return {
|
|
name: 'Directive',
|
|
identifier: decoratorType,
|
|
import: {name: 'Directive', from: '@angular/core'},
|
|
node: decoratorNode,
|
|
args: [selectorArg],
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Create an empty `Injectable` decorator that will be associated with the `clazz`.
|
|
*/
|
|
export function createInjectableDecorator(clazz: ClassDeclaration): Decorator {
|
|
const decoratorType = ts.createIdentifier('Injectable');
|
|
const decoratorNode = ts.createObjectLiteral([
|
|
ts.createPropertyAssignment('type', decoratorType),
|
|
ts.createPropertyAssignment('args', ts.createArrayLiteral([])),
|
|
]);
|
|
|
|
setParentPointers(clazz.getSourceFile(), decoratorNode);
|
|
|
|
return {
|
|
name: 'Injectable',
|
|
identifier: decoratorType,
|
|
import: {name: 'Injectable', from: '@angular/core'},
|
|
node: decoratorNode,
|
|
args: [],
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Ensure that a tree of AST nodes have their parents wired up.
|
|
*/
|
|
export function setParentPointers(parent: ts.Node, child: ts.Node): void {
|
|
child.parent = parent;
|
|
ts.forEachChild(child, grandchild => setParentPointers(child, grandchild));
|
|
}
|