e6850a3c51
Previously, if `UmdRenderingFormatter#addImports()` was called with an empty list of imports to add (i.e. no new imports were needed), it would add trailing commas in several locations (arrays, function arguments, function parameters), thus making the code imcompatible with legacy browsers such as IE11. This commit fixes it by ensuring that no trailing commas are added if `addImports()` is called with an empty list of imports. This is a follow-up to #34353. Fixes #34525 PR Close #34545
302 lines
12 KiB
TypeScript
302 lines
12 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 {Statement} from '@angular/compiler';
|
|
import MagicString from 'magic-string';
|
|
import * as ts from 'typescript';
|
|
import {relative, dirname, AbsoluteFsPath, absoluteFromSourceFile} from '../../../src/ngtsc/file_system';
|
|
import {NOOP_DEFAULT_IMPORT_RECORDER, Reexport} from '../../../src/ngtsc/imports';
|
|
import {Import, ImportManager, translateStatement} from '../../../src/ngtsc/translator';
|
|
import {isDtsPath} from '../../../src/ngtsc/util/src/typescript';
|
|
import {CompiledClass} from '../analysis/types';
|
|
import {NgccReflectionHost, POST_R3_MARKER, PRE_R3_MARKER, SwitchableVariableDeclaration} from '../host/ngcc_host';
|
|
import {ModuleWithProvidersInfo} from '../analysis/module_with_providers_analyzer';
|
|
import {ExportInfo} from '../analysis/private_declarations_analyzer';
|
|
import {RenderingFormatter, RedundantDecoratorMap} from './rendering_formatter';
|
|
import {stripExtension} from './utils';
|
|
import {isAssignment} from '../host/esm2015_host';
|
|
|
|
/**
|
|
* A RenderingFormatter that works with ECMAScript Module import and export statements.
|
|
*/
|
|
export class EsmRenderingFormatter implements RenderingFormatter {
|
|
protected printer = ts.createPrinter({newLine: ts.NewLineKind.LineFeed});
|
|
|
|
constructor(protected host: NgccReflectionHost, protected isCore: boolean) {}
|
|
|
|
/**
|
|
* Add the imports at the top of the file, after any imports that are already there.
|
|
*/
|
|
addImports(output: MagicString, imports: Import[], sf: ts.SourceFile): void {
|
|
if (imports.length === 0) {
|
|
return;
|
|
}
|
|
|
|
const insertionPoint = this.findEndOfImports(sf);
|
|
const renderedImports =
|
|
imports.map(i => `import * as ${i.qualifier} from '${i.specifier}';\n`).join('');
|
|
output.appendLeft(insertionPoint, renderedImports);
|
|
}
|
|
|
|
/**
|
|
* Add the exports to the end of the file.
|
|
*/
|
|
addExports(
|
|
output: MagicString, entryPointBasePath: AbsoluteFsPath, exports: ExportInfo[],
|
|
importManager: ImportManager, file: ts.SourceFile): void {
|
|
exports.forEach(e => {
|
|
let exportFrom = '';
|
|
const isDtsFile = isDtsPath(entryPointBasePath);
|
|
const from = isDtsFile ? e.dtsFrom : e.from;
|
|
|
|
if (from) {
|
|
const basePath = stripExtension(from);
|
|
const relativePath = './' + relative(dirname(entryPointBasePath), basePath);
|
|
exportFrom = entryPointBasePath !== basePath ? ` from '${relativePath}'` : '';
|
|
}
|
|
|
|
const exportStr = `\nexport {${e.identifier}}${exportFrom};`;
|
|
output.append(exportStr);
|
|
});
|
|
}
|
|
|
|
|
|
/**
|
|
* Add plain exports to the end of the file.
|
|
*
|
|
* Unlike `addExports`, direct exports go directly in a .js and .d.ts file and don't get added to
|
|
* an entrypoint.
|
|
*/
|
|
addDirectExports(
|
|
output: MagicString, exports: Reexport[], importManager: ImportManager,
|
|
file: ts.SourceFile): void {
|
|
for (const e of exports) {
|
|
const exportStatement = `\nexport {${e.symbolName} as ${e.asAlias}} from '${e.fromModule}';`;
|
|
output.append(exportStatement);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the constants directly after the imports.
|
|
*/
|
|
addConstants(output: MagicString, constants: string, file: ts.SourceFile): void {
|
|
if (constants === '') {
|
|
return;
|
|
}
|
|
const insertionPoint = this.findEndOfImports(file);
|
|
|
|
// Append the constants to the right of the insertion point, to ensure they get ordered after
|
|
// added imports (those are appended left to the insertion point).
|
|
output.appendRight(insertionPoint, '\n' + constants + '\n');
|
|
}
|
|
|
|
/**
|
|
* Add the definitions directly after their decorated class.
|
|
*/
|
|
addDefinitions(output: MagicString, compiledClass: CompiledClass, definitions: string): void {
|
|
const classSymbol = this.host.getClassSymbol(compiledClass.declaration);
|
|
if (!classSymbol) {
|
|
throw new Error(`Compiled class does not have a valid symbol: ${compiledClass.name}`);
|
|
}
|
|
const insertionPoint = classSymbol.declaration.valueDeclaration.getEnd();
|
|
output.appendLeft(insertionPoint, '\n' + definitions);
|
|
}
|
|
|
|
/**
|
|
* Add the adjacent statements after all static properties of the class.
|
|
*/
|
|
addAdjacentStatements(output: MagicString, compiledClass: CompiledClass, statements: string):
|
|
void {
|
|
const classSymbol = this.host.getClassSymbol(compiledClass.declaration);
|
|
if (!classSymbol) {
|
|
throw new Error(`Compiled class does not have a valid symbol: ${compiledClass.name}`);
|
|
}
|
|
const endOfClass = this.host.getEndOfClass(classSymbol);
|
|
output.appendLeft(endOfClass.getEnd(), '\n' + statements);
|
|
}
|
|
|
|
/**
|
|
* Remove static decorator properties from classes.
|
|
*/
|
|
removeDecorators(output: MagicString, decoratorsToRemove: RedundantDecoratorMap): void {
|
|
decoratorsToRemove.forEach((nodesToRemove, containerNode) => {
|
|
if (ts.isArrayLiteralExpression(containerNode)) {
|
|
const items = containerNode.elements;
|
|
if (items.length === nodesToRemove.length) {
|
|
// Remove the entire statement
|
|
const statement = findStatement(containerNode);
|
|
if (statement) {
|
|
if (ts.isExpressionStatement(statement)) {
|
|
// The statement looks like: `SomeClass = __decorate(...);`
|
|
// Remove it completely
|
|
output.remove(statement.getFullStart(), statement.getEnd());
|
|
} else if (
|
|
ts.isReturnStatement(statement) && statement.expression &&
|
|
isAssignment(statement.expression)) {
|
|
// The statement looks like: `return SomeClass = __decorate(...);`
|
|
// We only want to end up with: `return SomeClass;`
|
|
const startOfRemoval = statement.expression.left.getEnd();
|
|
const endOfRemoval = getEndExceptSemicolon(statement);
|
|
output.remove(startOfRemoval, endOfRemoval);
|
|
}
|
|
}
|
|
} else {
|
|
nodesToRemove.forEach(node => {
|
|
// remove any trailing comma
|
|
const nextSibling = getNextSiblingInArray(node, items);
|
|
let end: number;
|
|
|
|
if (nextSibling !== null &&
|
|
output.slice(nextSibling.getFullStart() - 1, nextSibling.getFullStart()) === ',') {
|
|
end = nextSibling.getFullStart() - 1 + nextSibling.getLeadingTriviaWidth();
|
|
} else if (output.slice(node.getEnd(), node.getEnd() + 1) === ',') {
|
|
end = node.getEnd() + 1;
|
|
} else {
|
|
end = node.getEnd();
|
|
}
|
|
output.remove(node.getFullStart(), end);
|
|
});
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Rewrite the the IVY switch markers to indicate we are in IVY mode.
|
|
*/
|
|
rewriteSwitchableDeclarations(
|
|
outputText: MagicString, sourceFile: ts.SourceFile,
|
|
declarations: SwitchableVariableDeclaration[]): void {
|
|
declarations.forEach(declaration => {
|
|
const start = declaration.initializer.getStart();
|
|
const end = declaration.initializer.getEnd();
|
|
const replacement = declaration.initializer.text.replace(PRE_R3_MARKER, POST_R3_MARKER);
|
|
outputText.overwrite(start, end, replacement);
|
|
});
|
|
}
|
|
|
|
|
|
/**
|
|
* Add the type parameters to the appropriate functions that return `ModuleWithProviders`
|
|
* structures.
|
|
*
|
|
* This function will only get called on typings files.
|
|
*/
|
|
addModuleWithProvidersParams(
|
|
outputText: MagicString, moduleWithProviders: ModuleWithProvidersInfo[],
|
|
importManager: ImportManager): void {
|
|
moduleWithProviders.forEach(info => {
|
|
const ngModuleName = info.ngModule.node.name.text;
|
|
const declarationFile = absoluteFromSourceFile(info.declaration.getSourceFile());
|
|
const ngModuleFile = absoluteFromSourceFile(info.ngModule.node.getSourceFile());
|
|
const importPath = info.ngModule.viaModule ||
|
|
(declarationFile !== ngModuleFile ?
|
|
stripExtension(`./${relative(dirname(declarationFile), ngModuleFile)}`) :
|
|
null);
|
|
const ngModule = generateImportString(importManager, importPath, ngModuleName);
|
|
|
|
if (info.declaration.type) {
|
|
const typeName = info.declaration.type && ts.isTypeReferenceNode(info.declaration.type) ?
|
|
info.declaration.type.typeName :
|
|
null;
|
|
if (this.isCoreModuleWithProvidersType(typeName)) {
|
|
// The declaration already returns `ModuleWithProvider` but it needs the `NgModule` type
|
|
// parameter adding.
|
|
outputText.overwrite(
|
|
info.declaration.type.getStart(), info.declaration.type.getEnd(),
|
|
`ModuleWithProviders<${ngModule}>`);
|
|
} else {
|
|
// The declaration returns an unknown type so we need to convert it to a union that
|
|
// includes the ngModule property.
|
|
const originalTypeString = info.declaration.type.getText();
|
|
outputText.overwrite(
|
|
info.declaration.type.getStart(), info.declaration.type.getEnd(),
|
|
`(${originalTypeString})&{ngModule:${ngModule}}`);
|
|
}
|
|
} else {
|
|
// The declaration has no return type so provide one.
|
|
const lastToken = info.declaration.getLastToken();
|
|
const insertPoint = lastToken && lastToken.kind === ts.SyntaxKind.SemicolonToken ?
|
|
lastToken.getStart() :
|
|
info.declaration.getEnd();
|
|
outputText.appendLeft(
|
|
insertPoint,
|
|
`: ${generateImportString(importManager, '@angular/core', 'ModuleWithProviders')}<${ngModule}>`);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Convert a `Statement` to JavaScript code in a format suitable for rendering by this formatter.
|
|
*
|
|
* @param stmt The `Statement` to print.
|
|
* @param sourceFile A `ts.SourceFile` that provides context for the statement. See
|
|
* `ts.Printer#printNode()` for more info.
|
|
* @param importManager The `ImportManager` to use for managing imports.
|
|
*
|
|
* @return The JavaScript code corresponding to `stmt` (in the appropriate format).
|
|
*/
|
|
printStatement(stmt: Statement, sourceFile: ts.SourceFile, importManager: ImportManager): string {
|
|
const node = translateStatement(
|
|
stmt, importManager, NOOP_DEFAULT_IMPORT_RECORDER, ts.ScriptTarget.ES2015);
|
|
const code = this.printer.printNode(ts.EmitHint.Unspecified, node, sourceFile);
|
|
|
|
return code;
|
|
}
|
|
|
|
protected findEndOfImports(sf: ts.SourceFile): number {
|
|
for (const stmt of sf.statements) {
|
|
if (!ts.isImportDeclaration(stmt) && !ts.isImportEqualsDeclaration(stmt) &&
|
|
!ts.isNamespaceImport(stmt)) {
|
|
return stmt.getStart();
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Check whether the given type is the core Angular `ModuleWithProviders` interface.
|
|
* @param typeName The type to check.
|
|
* @returns true if the type is the core Angular `ModuleWithProviders` interface.
|
|
*/
|
|
private isCoreModuleWithProvidersType(typeName: ts.EntityName|null) {
|
|
const id =
|
|
typeName && ts.isIdentifier(typeName) ? this.host.getImportOfIdentifier(typeName) : null;
|
|
return (
|
|
id && id.name === 'ModuleWithProviders' && (this.isCore || id.from === '@angular/core'));
|
|
}
|
|
}
|
|
|
|
function findStatement(node: ts.Node) {
|
|
while (node) {
|
|
if (ts.isExpressionStatement(node) || ts.isReturnStatement(node)) {
|
|
return node;
|
|
}
|
|
node = node.parent;
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
function generateImportString(
|
|
importManager: ImportManager, importPath: string | null, importName: string) {
|
|
const importAs = importPath ? importManager.generateNamedImport(importPath, importName) : null;
|
|
return importAs ? `${importAs.moduleImport}.${importAs.symbol}` : `${importName}`;
|
|
}
|
|
|
|
function getNextSiblingInArray<T extends ts.Node>(node: T, array: ts.NodeArray<T>): T|null {
|
|
const index = array.indexOf(node);
|
|
return index !== -1 && array.length > index + 1 ? array[index + 1] : null;
|
|
}
|
|
|
|
function getEndExceptSemicolon(statement: ts.Statement): number {
|
|
const lastToken = statement.getLastToken();
|
|
return (lastToken && lastToken.kind === ts.SyntaxKind.SemicolonToken) ? statement.getEnd() - 1 :
|
|
statement.getEnd();
|
|
}
|