TypescriptAPIUtils.appendImport: resolve imports with typescript

davidkudera · davidkudera · commit c4f5c6677f70 · 2017-11-24T12:11:50.000+01:00
diff --git a/packages/typescript-api-utils/resolvers/requireResolver.ts b/packages/typescript-api-utils/resolvers/requireResolver.ts
@@ -36,16 +36,28 @@ export function resolveRawRequire(fromFile: string, file: string, moduleResoluti
 }
 
 
-export function resolveRequire(fromFile: string, file: string, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): RequiredFile|undefined
+export function resolveRequirePath(fromFile: string, file: string, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): string|undefined
 {
 	const module = <ts.ResolvedModuleWithFailedLookupLocations>ts.resolveModuleName(file, fromFile, compilerOptions, moduleResolutionHost);
 
 	if (!exists(module.resolvedModule)) {
 		return;
 	}
 
+	return module.resolvedModule.resolvedFileName;
+}
+
+
+export function resolveRequire(fromFile: string, file: string, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): RequiredFile|undefined
+{
+	const resolvedPath = resolveRequirePath(fromFile, file, compilerOptions, moduleResolutionHost);
+
+	if (!resolvedPath) {
+		return;
+	}
+
 	return {
-		path: module.resolvedModule.resolvedFileName,
-		source: moduleResolutionHost.readFile(module.resolvedModule.resolvedFileName),
+		path: resolvedPath,
+		source: moduleResolutionHost.readFile(resolvedPath),
 	};
 }
diff --git a/packages/typescript-api-utils/sourceFiles/appendImport.ts b/packages/typescript-api-utils/sourceFiles/appendImport.ts
@@ -1,9 +1,11 @@
 import {clone, exists, find} from '@slicky/utils';
 import {findNodesByType} from './findNodesByType';
+import {resolveRequirePath} from '../resolvers';
 import * as ts from 'typescript';
+import * as path from 'path';
 
 
-export function appendImport(moduleSpecifier: string, propertyName: string|undefined, name: string, sourceFile: ts.SourceFile, noImportReuseOnDifferentNames: boolean = false): string
+export function appendImport(moduleSpecifier: string, propertyName: string|undefined, name: string, sourceFile: ts.SourceFile, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost, noImportReuseOnDifferentNames: boolean = false): string
 {
 	const imports = findNodesByType<ts.ImportDeclaration>(ts.SyntaxKind.ImportDeclaration, sourceFile);
 	const pos = imports.length ? (sourceFile.statements.indexOf(imports[imports.length - 1]) + 1 || 0) : 0;
@@ -14,7 +16,7 @@ export function appendImport(moduleSpecifier: string, propertyName: string|undef
 			exists(existingImport.importClause.namedBindings) &&
 			ts.isNamedImports(existingImport.importClause.namedBindings) &&
 			ts.isStringLiteral(existingImport.moduleSpecifier) &&
-			(<ts.StringLiteral>existingImport.moduleSpecifier).text === moduleSpecifier
+			compareModuleSpecifiers(sourceFile.fileName, (<ts.StringLiteral>existingImport.moduleSpecifier).text, moduleSpecifier, compilerOptions, moduleResolutionHost)
 		);
 	});
 
@@ -69,6 +71,19 @@ export function appendImport(moduleSpecifier: string, propertyName: string|undef
 }
 
 
+function compareModuleSpecifiers(file: string, a: string, b: string, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): boolean
+{
+	if (a === b) {
+		return true;
+	}
+
+	a = resolveRequirePath(file, a, compilerOptions, moduleResolutionHost);
+	b = resolveRequirePath(file, b, compilerOptions, moduleResolutionHost);
+
+	return a === b;
+}
+
+
 function createNewImportDeclaration(moduleSpecifier: string, propertyName: string|undefined, name: string): ts.ImportDeclaration
 {
 	return ts.createImportDeclaration(
diff --git a/packages/typescript-api-utils/sourceFiles/appendImportsBuffer.ts b/packages/typescript-api-utils/sourceFiles/appendImportsBuffer.ts
@@ -28,10 +28,10 @@ export class AppendImportsBuffer
 	}
 
 
-	public applyImports(sourceFile: ts.SourceFile): void
+	public applyImports(sourceFile: ts.SourceFile, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): void
 	{
 		forEach(this.imports, (newImport: ImportItem) => {
-			appendImport(newImport.moduleSpecifier, newImport.propertyName, newImport.name, sourceFile, true);
+			appendImport(newImport.moduleSpecifier, newImport.propertyName, newImport.name, sourceFile, compilerOptions, moduleResolutionHost, true);
 		});
 	}
 
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_11.original.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_11.original.ts
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_11.updated.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_11.updated.ts
@@ -0,0 +1 @@
+import { A } from "./import";
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.import.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.import.ts
@@ -0,0 +1 @@
+export const A = '';
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.original.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.original.ts
@@ -0,0 +1 @@
+import {A} from './valid_12.import';
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.updated.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_12.updated.ts
@@ -0,0 +1 @@
+import { A } from "./valid_12.import";
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.import_1.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.import_1.ts
@@ -0,0 +1 @@
+export const A = '';
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.import_2.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.import_2.ts
@@ -0,0 +1 @@
+export const B = '';
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.original.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.original.ts
@@ -1 +1 @@
-import {A} from '/import_1';
+import {A} from './valid_9.import_1';
diff --git a/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.updated.ts b/packages/typescript-api-utils/tests/data/sourceFiles/appendImport/valid_9.updated.ts
@@ -1,2 +1,2 @@
-import { A } from "/import_1";
-import { B } from "/import_2";
+import { A } from "./valid_9.import_1";
+import { B } from "./valid_9.import_2";
diff --git a/packages/typescript-api-utils/tests/tests/sourceFiles/appendImport.ts b/packages/typescript-api-utils/tests/tests/sourceFiles/appendImport.ts
@@ -1,4 +1,4 @@
-import {appendImport} from '../../../';
+import {appendImport as _appendImport, fsModuleResolutionHost} from '../../../';
 import {expect} from 'chai';
 import * as ts from 'typescript';
 import * as path from 'path';
@@ -30,6 +30,12 @@ function compareSourceFile(name: string, sourceFile: ts.SourceFile): void
 }
 
 
+function appendImport(moduleSpecifier: string, propertyName: string|undefined, name: string, sourceFile: ts.SourceFile, noImportReuseOnDifferentNames: boolean = false): string
+{
+	return _appendImport(moduleSpecifier, propertyName, name, sourceFile, {}, fsModuleResolutionHost(), noImportReuseOnDifferentNames);
+}
+
+
 describe('#sourceFiles/appendImport', () => {
 
 	describe('appendImport()', () => {
@@ -108,7 +114,7 @@ describe('#sourceFiles/appendImport', () => {
 
 		it('should add import after the last one', () => {
 			const sourceFile = getFileSource('valid_9.original');
-			const imported = appendImport('/import_2', undefined, 'B', sourceFile);
+			const imported = appendImport('./valid_9.import_2', undefined, 'B', sourceFile);
 
 			expect(imported).to.be.equal('B');
 			compareSourceFile('valid_9.updated', sourceFile);
@@ -122,6 +128,22 @@ describe('#sourceFiles/appendImport', () => {
 			compareSourceFile('valid_10.updated', sourceFile);
 		});
 
+		it('should add relative path import', () => {
+			const sourceFile = getFileSource('valid_11.original');
+			const imported = appendImport('./import', undefined, 'A', sourceFile);
+
+			expect(imported).to.be.equal('A');
+			compareSourceFile('valid_11.updated', sourceFile);
+		});
+
+		it('should reuse different form of relative path import', () => {
+			const sourceFile = getFileSource('valid_12.original');
+			const imported = appendImport('./a/../valid_12.import', undefined, 'A', sourceFile);
+
+			expect(imported).to.be.equal('A');
+			compareSourceFile('valid_12.updated', sourceFile);
+		});
+
 	});
 
 });

Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,10 @@ export class AppendImportsBuffer`
`28`	`28`	`}`
`29`	`29`
`30`	`30`
`31`		`- public applyImports(sourceFile: ts.SourceFile): void`
	`31`	`+ public applyImports(sourceFile: ts.SourceFile, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): void`
`32`	`32`	`{`
`33`	`33`	`forEach(this.imports, (newImport: ImportItem) => {`
`34`		`- appendImport(newImport.moduleSpecifier, newImport.propertyName, newImport.name, sourceFile, true);`
	`34`	`+ appendImport(newImport.moduleSpecifier, newImport.propertyName, newImport.name, sourceFile, compilerOptions, moduleResolutionHost, true);`
`35`	`35`	`});`
`36`	`36`	`}`
`37`	`37`