f5982fd746
Adds a schematic that will remove the explicit `static: false` flag from dynamic queries. E.g.
```ts
import { Directive, ViewChild, ContentChild, ElementRef } from '@angular/core';
@Directive()
export class MyDirective {
@ViewChild('child', { static: false }) child: any;
@ViewChild('secondChild', { read: ElementRef, static: false }) secondChild: ElementRef;
@ContentChild('thirdChild', { static: false }) thirdChild: any;
}
```
```ts
import { Directive, ViewChild, ContentChild, ElementRef } from '@angular/core';
@Directive()
export class MyDirective {
@ViewChild('child') child: any;
@ViewChild('secondChild', { read: ElementRef }) secondChild: ElementRef;
@ContentChild('thirdChild') thirdChild: any;
}
```
PR Close #32231
86 lines
3.3 KiB
TypeScript
86 lines
3.3 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 {Rule, SchematicContext, SchematicsException, Tree} from '@angular-devkit/schematics';
|
|
import {dirname, relative} from 'path';
|
|
import * as ts from 'typescript';
|
|
|
|
import {getProjectTsConfigPaths} from '../../utils/project_tsconfig_paths';
|
|
import {parseTsconfigFile} from '../../utils/typescript/parse_tsconfig';
|
|
import {identifyDynamicQueryNodes, removeOptionsParameter, removeStaticFlag} from './util';
|
|
|
|
|
|
/**
|
|
* Runs the dynamic queries migration for all TypeScript projects in the current CLI workspace.
|
|
*/
|
|
export default function(): Rule {
|
|
return (tree: Tree, ctx: SchematicContext) => {
|
|
const {buildPaths, testPaths} = getProjectTsConfigPaths(tree);
|
|
const basePath = process.cwd();
|
|
const allPaths = [...buildPaths, ...testPaths];
|
|
|
|
ctx.logger.info('------ Dynamic queries migration ------');
|
|
|
|
if (!allPaths.length) {
|
|
throw new SchematicsException(
|
|
'Could not find any tsconfig file. Cannot migrate dynamic queries.');
|
|
}
|
|
|
|
for (const tsconfigPath of allPaths) {
|
|
runDynamicQueryMigration(tree, tsconfigPath, basePath);
|
|
}
|
|
};
|
|
}
|
|
|
|
function runDynamicQueryMigration(tree: Tree, tsconfigPath: string, basePath: string) {
|
|
const parsed = parseTsconfigFile(tsconfigPath, dirname(tsconfigPath));
|
|
const host = ts.createCompilerHost(parsed.options, true);
|
|
|
|
// We need to overwrite the host "readFile" method, as we want the TypeScript
|
|
// program to be based on the file contents in the virtual file tree. Otherwise
|
|
// if we run the migration for multiple tsconfig files which have intersecting
|
|
// source files, it can end up updating query definitions multiple times.
|
|
host.readFile = fileName => {
|
|
const buffer = tree.read(relative(basePath, fileName));
|
|
// Strip BOM as otherwise TSC methods (Ex: getWidth) will return an offset which
|
|
// which breaks the CLI UpdateRecorder.
|
|
// See: https://github.com/angular/angular/pull/30719
|
|
return buffer ? buffer.toString().replace(/^\uFEFF/, '') : undefined;
|
|
};
|
|
|
|
const program = ts.createProgram(parsed.fileNames, parsed.options, host);
|
|
const typeChecker = program.getTypeChecker();
|
|
const sourceFiles = program.getSourceFiles().filter(
|
|
f => !f.isDeclarationFile && !program.isSourceFileFromExternalLibrary(f));
|
|
const printer = ts.createPrinter();
|
|
|
|
sourceFiles.forEach(sourceFile => {
|
|
const result = identifyDynamicQueryNodes(typeChecker, sourceFile);
|
|
|
|
if (result.removeProperty.length || result.removeParameter.length) {
|
|
const update = tree.beginUpdate(relative(basePath, sourceFile.fileName));
|
|
|
|
result.removeProperty.forEach(node => {
|
|
update.remove(node.getStart(), node.getWidth());
|
|
update.insertRight(
|
|
node.getStart(),
|
|
printer.printNode(ts.EmitHint.Unspecified, removeStaticFlag(node), sourceFile));
|
|
});
|
|
|
|
result.removeParameter.forEach(node => {
|
|
update.remove(node.getStart(), node.getWidth());
|
|
update.insertRight(
|
|
node.getStart(),
|
|
printer.printNode(ts.EmitHint.Unspecified, removeOptionsParameter(node), sourceFile));
|
|
});
|
|
|
|
tree.commitUpdate(update);
|
|
}
|
|
});
|
|
}
|