80394ce08b
fix(@schematics/angular): TypeScript related migrations should cater for BOM In the CLI `UpdateRecorder` methods such as `insertLeft`, `remove` etc.. accepts positions which are not offset by a BOM. This is because when a file has a BOM a different recorder will be used https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/schematics/src/tree/recorder.ts#L72 which caters for an addition offset/delta. The main reason for this is that when a developer is writing a schematic they shouldn't need to compute the offset based if a file has a BOM or not and is handled out of the box. Example ```ts recorder.insertLeft(5, 'true'); ``` However this is unfortunate in the case if a ts SourceFile is used and one uses `getWidth` and `getStart` method they will already be offset by 1, which at the end it results in a double offset and hence the problem. Fixes #30713 PR Close #30719
103 lines
4.1 KiB
TypeScript
103 lines
4.1 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 {logging, normalize} from '@angular-devkit/core';
|
|
import {Rule, SchematicContext, SchematicsException, Tree} from '@angular-devkit/schematics';
|
|
import {dirname, relative} from 'path';
|
|
import * as ts from 'typescript';
|
|
|
|
import {NgComponentTemplateVisitor} from '../../utils/ng_component_template';
|
|
import {getProjectTsConfigPaths} from '../../utils/project_tsconfig_paths';
|
|
import {parseTsconfigFile} from '../../utils/typescript/parse_tsconfig';
|
|
|
|
import {analyzeResolvedTemplate} from './analyze_template';
|
|
|
|
type Logger = logging.LoggerApi;
|
|
|
|
const README_URL = 'https://v8.angular.io/guide/deprecations#cannot-assign-to-template-variables';
|
|
const FAILURE_MESSAGE = `Found assignment to template variable.`;
|
|
|
|
/** Entry point for the V8 template variable assignment schematic. */
|
|
export default function(): Rule {
|
|
return (tree: Tree, context: SchematicContext) => {
|
|
const {buildPaths, testPaths} = getProjectTsConfigPaths(tree);
|
|
const basePath = process.cwd();
|
|
|
|
if (!buildPaths.length && !testPaths.length) {
|
|
throw new SchematicsException(
|
|
'Could not find any tsconfig file. Cannot check templates for template variable ' +
|
|
'assignments.');
|
|
}
|
|
|
|
for (const tsconfigPath of [...buildPaths, ...testPaths]) {
|
|
runTemplateVariableAssignmentCheck(tree, tsconfigPath, basePath, context.logger);
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Runs the template variable assignment check. Warns developers
|
|
* if values are assigned to template variables within output bindings.
|
|
*/
|
|
function runTemplateVariableAssignmentCheck(
|
|
tree: Tree, tsconfigPath: string, basePath: string, logger: Logger) {
|
|
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.
|
|
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 templateVisitor = new NgComponentTemplateVisitor(typeChecker);
|
|
const sourceFiles = program.getSourceFiles().filter(
|
|
f => !f.isDeclarationFile && !program.isSourceFileFromExternalLibrary(f));
|
|
|
|
// Analyze source files by detecting HTML templates.
|
|
sourceFiles.forEach(sourceFile => templateVisitor.visitNode(sourceFile));
|
|
|
|
const {resolvedTemplates} = templateVisitor;
|
|
const collectedFailures: string[] = [];
|
|
|
|
// Analyze each resolved template and print a warning for property writes to
|
|
// template variables.
|
|
resolvedTemplates.forEach(template => {
|
|
const filePath = template.filePath;
|
|
const nodes = analyzeResolvedTemplate(template);
|
|
|
|
if (!nodes) {
|
|
return;
|
|
}
|
|
|
|
const displayFilePath = normalize(relative(basePath, filePath));
|
|
|
|
nodes.forEach(n => {
|
|
const {line, character} = template.getCharacterAndLineOfPosition(n.start);
|
|
collectedFailures.push(`${displayFilePath}@${line + 1}:${character + 1}: ${FAILURE_MESSAGE}`);
|
|
});
|
|
});
|
|
|
|
if (collectedFailures.length) {
|
|
logger.info('---- Template Variable Assignment schematic ----');
|
|
logger.info('Assignments to template variables will no longer work with Ivy as');
|
|
logger.info('template variables are effectively constants in Ivy. Read more about');
|
|
logger.info(`this change here: ${README_URL}`);
|
|
logger.info('');
|
|
logger.info('The following template assignments were found:');
|
|
collectedFailures.forEach(failure => logger.warn(`⮑ ${failure}`));
|
|
logger.info('------------------------------------------------');
|
|
}
|
|
}
|