Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support tsConfig paths aliases during move operations #1495

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion packages/ts-morph/src/compiler/ast/module/SourceFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1023,7 +1023,26 @@ export class SourceFile extends SourceFileBase<ts.SourceFile> {

function updateStringLiteralReferences(nodeReferences: ReadonlyArray<[StringLiteral, SourceFile]>) {
for (const [stringLiteral, sourceFile] of nodeReferences) {
if (ModuleUtils.isModuleSpecifierRelative(stringLiteral.getLiteralText()))
const compilerOptions = stringLiteral._context.compilerOptions.get()
const literalText = stringLiteral.getLiteralText();
const paths = compilerOptions?.paths;
// See https://www.typescriptlang.org/docs/handbook/modules/reference.html#paths
if (paths) {
// Check if the string literal is a path alias specifier
for (const [path, mappings] of Object.entries(paths)) {
const hasWildCard = path.endsWith('*');
const [alias] = path.split('*');
if (literalText.startsWith(alias) && hasWildCard) {
const pathAfterAlias = FileUtils.pathJoin(
stringLiteral._sourceFile.getDirectoryPath(),
stringLiteral._sourceFile.getRelativePathAsModuleSpecifierTo(sourceFile)
);
stringLiteral.setLiteralValue(FileUtils.pathJoin(alias, pathAfterAlias));
break;
}
}
}
Comment on lines +1028 to +1044
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very naive right now and only works with wildcard paths (most common use-case afaik). If we want to productionize this approach we should create new helpers in ModuleUtils and/or SourceFile to more deeply support paths aliases, instead of reaching directly for FileUtils here.

if (ModuleUtils.isModuleSpecifierRelative(literalText))
stringLiteral.setLiteralValue(stringLiteral._sourceFile.getRelativePathAsModuleSpecifierTo(sourceFile));
}
}
Expand Down
42 changes: 42 additions & 0 deletions packages/ts-morph/src/tests/issues/1494tests.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { ts } from "@ts-morph/common";
import { expect } from "chai";
import { Project } from "../../Project";

describe("tests for my issue", () => {
it("should update specifiers with path aliases during move", () => {
const project = new Project({
useInMemoryFileSystem: true,
compilerOptions: {
baseUrl: '.',
paths: {
'Root/*': ['./*']
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to move ahead with this PR we should add a lot more tests for paths.

  • With and without wildcard value
  • More nested mappings

}
}
});

const fileAtRoot = project.createSourceFile("a.ts", `export function foo() {}`);
const fileAtNestedFolder = project.createSourceFile("nested/deep/a.ts", `export function nested() {}`);

const relImportRoot = project.createSourceFile("b.ts", `import { foo } from "./a";`);
const relImportFolder = project.createSourceFile("/b/b.ts", `import { foo } from "../a";`);

const aliasImport = project.createSourceFile("c.ts", `import { foo } from "Root/a";`);
const aliasExport = project.createSourceFile("d.ts", `export { foo } from "Root/a";`);
const aliasImportFolder = project.createSourceFile("/c/c.ts", `import { foo } from "Root/a";`);
const aliasToNestedFolder = project.createSourceFile("/d/d.ts", `import { nested } from "Root/nested/deep/a";`);


const dir = project.createDirectory('./a');
const deepDir = project.createDirectory('./nested/deep/deeper');
fileAtRoot.moveToDirectory(dir)
fileAtNestedFolder.moveToDirectory(deepDir)

expect(relImportRoot.getFullText()).to.equal(`import { foo } from "./a/a";`);
expect(relImportFolder.getFullText()).to.equal(`import { foo } from "../a/a";`);

expect(aliasImport.getFullText()).to.equal(`import { foo } from "Root/a/a";`);
expect(aliasImportFolder.getFullText()).to.equal(`import { foo } from "Root/a/a";`);
expect(aliasToNestedFolder.getFullText()).to.equal(`import { nested } from "Root/nested/deep/deeper/a";`);
expect(aliasExport.getFullText()).to.equal(`export { foo } from "Root/a/a";`);
});
});