Skip to content

Commit 64881a8

Browse files
nonaranonara
committed
feat: Rewrote resolution strategy + various improvements (see notes)
- Several improvements were made for speed and efficiency. - Now accommodating for new TS empty baseURL provision (closes #109) - Pre-checking necessity before overwriting paths (closes #110) - Rewrote core resolution methodology to: - Properly handle implicit indexes (closes #106) - Properly handle implicit sub-package indexes set via package.json 'main' #108) - Not follow symlinks (#107) - Resolve from output path as opposed to SourceFile path (#103)
1 parent 2699abd commit 64881a8

File tree

22 files changed

+360
-135
lines changed

22 files changed

+360
-135
lines changed

‎src/transformer.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
import {} from "ts-expose-internals";
33
import path from "path";
44
import ts from "typescript";
5-
import { cast, getImplicitExtensions } from "./utils";
5+
import { cast } from "./utils";
66
import { TsTransformPathsConfig, TsTransformPathsContext, TypeScriptThree, VisitorContext } from "./types";
77
import { nodeVisitor } from "./visitor";
88
import { createHarmonyFactory } from "./utils/harmony-factory";
99
import { Minimatch } from "minimatch";
10+
import { createParsedCommandLineForProgram } from "./utils/ts-helpers";
1011

1112
/* ****************************************************************************************************************** *
1213
* Transformer
@@ -20,27 +21,31 @@ export default function transformer(
2021
if (!tsInstance) tsInstance = ts;
2122

2223
const compilerOptions = program.getCompilerOptions();
23-
const implicitExtensions = getImplicitExtensions(compilerOptions);
2424
const rootDirs = compilerOptions.rootDirs?.filter(path.isAbsolute);
2525

2626
return (transformationContext: ts.TransformationContext) => {
27+
const pathsBasePath = compilerOptions.pathsBasePath ?? compilerOptions.baseUrl;
28+
29+
if (!pathsBasePath || !compilerOptions.paths) return (sourceFile: ts.SourceFile) => sourceFile;
30+
2731
const tsTransformPathsContext: TsTransformPathsContext = {
2832
compilerOptions,
2933
config,
3034
elisionMap: new Map(),
3135
tsFactory: transformationContext.factory,
32-
implicitExtensions,
3336
program,
3437
rootDirs,
3538
transformationContext,
3639
tsInstance,
40+
pathsBasePath,
41+
getCanonicalFileName: tsInstance.createGetCanonicalFileName(tsInstance.sys.useCaseSensitiveFileNames),
3742
tsThreeInstance: cast<TypeScriptThree>(tsInstance),
3843
excludeMatchers: config.exclude?.map((globPattern) => new Minimatch(globPattern, { matchBase: true })),
44+
parsedCommandLine: createParsedCommandLineForProgram(tsInstance, program),
45+
outputFileNamesCache: new Map(),
3946
};
4047

4148
return (sourceFile: ts.SourceFile) => {
42-
if (!compilerOptions.baseUrl || !compilerOptions.paths) return sourceFile;
43-
4449
const visitorContext: VisitorContext = {
4550
...tsTransformPathsContext,
4651
sourceFile,

‎src/types.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import tsThree from "./declarations/typescript3";
2-
import ts, { CompilerOptions } from "typescript";
2+
import ts, { CompilerOptions, GetCanonicalFileName, ParsedCommandLine } from 'typescript';
33
import { PluginConfig } from "ts-patch";
44
import { HarmonyFactory } from "./utils/harmony-factory";
55
import { IMinimatch } from "minimatch";
@@ -42,12 +42,15 @@ export interface TsTransformPathsContext {
4242
readonly tsFactory?: ts.NodeFactory;
4343
readonly program: ts.Program | tsThree.Program;
4444
readonly config: TsTransformPathsConfig;
45-
readonly implicitExtensions: readonly string[];
4645
readonly compilerOptions: CompilerOptions;
4746
readonly elisionMap: Map<ts.SourceFile, Map<ImportOrExportDeclaration, ImportOrExportDeclaration>>;
4847
readonly transformationContext: ts.TransformationContext;
4948
readonly rootDirs?: string[];
5049
readonly excludeMatchers: IMinimatch[] | undefined;
50+
readonly parsedCommandLine: ParsedCommandLine;
51+
readonly outputFileNamesCache: Map<string, string>;
52+
readonly pathsBasePath: string;
53+
readonly getCanonicalFileName: GetCanonicalFileName;
5154
}
5255

5356
export interface VisitorContext extends TsTransformPathsContext {

‎src/utils/general-utils.ts

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import ts from "typescript";
21
import url from "url";
32
import path from "path";
43

@@ -7,21 +6,8 @@ import path from "path";
76
* ****************************************************************************************************************** */
87

98
export const isURL = (s: string): boolean => !!s && (!!url.parse(s).host || !!url.parse(s).hostname);
10-
export const isBaseDir = (base: string, dir: string) => path.relative(base, dir)?.[0] !== ".";
119
export const cast = <T>(v: any): T => v;
12-
13-
/**
14-
* @returns Array of implicit extensions, given CompilerOptions
15-
*/
16-
export function getImplicitExtensions(options: ts.CompilerOptions) {
17-
let res: string[] = [".ts", ".d.ts"];
18-
19-
let { allowJs, jsx } = options;
20-
const allowJsx = !!jsx && (<any>jsx !== ts.JsxEmit.None);
21-
22-
allowJs && res.push(".js", ".cjs", ".mjs");
23-
allowJsx && res.push(".tsx");
24-
allowJs && allowJsx && res.push(".jsx");
25-
26-
return res;
27-
}
10+
export const isBaseDir = (baseDir: string, testDir: string): boolean => {
11+
const relative = path.relative(baseDir, testDir);
12+
return relative ? !relative.startsWith("..") && !path.isAbsolute(relative) : true;
13+
};

‎src/utils/resolve-module-name.ts

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
import { VisitorContext } from "../types";
2+
import { isBaseDir, isURL } from "./general-utils";
3+
import * as path from "path";
4+
import { removeFileExtension, removeSuffix, ResolvedModuleFull } from "typescript";
5+
import { getOutputFile } from "./ts-helpers";
6+
7+
/* ****************************************************************************************************************** */
8+
// region: Types
9+
/* ****************************************************************************************************************** */
10+
11+
export interface ResolvedModule {
12+
/**
13+
* Absolute path to resolved module
14+
*/
15+
resolvedPath: string | undefined;
16+
/**
17+
* Output path
18+
*/
19+
outputPath: string;
20+
/**
21+
* Resolved to URL
22+
*/
23+
isURL: boolean;
24+
}
25+
26+
enum IndexType {
27+
NonIndex,
28+
Explicit,
29+
Implicit,
30+
ImplicitPackage,
31+
}
32+
33+
// endregion
34+
35+
/* ****************************************************************************************************************** */
36+
// region: Helpers
37+
/* ****************************************************************************************************************** */
38+
39+
function getPathDetail(moduleName: string, resolvedModule: ResolvedModuleFull) {
40+
let resolvedFileName = resolvedModule.originalPath ?? resolvedModule.resolvedFileName;
41+
const implicitPackageIndex = resolvedModule.packageId?.subModuleName;
42+
43+
const resolvedDir = implicitPackageIndex
44+
? removeSuffix(resolvedFileName, `/${implicitPackageIndex}`)
45+
: path.dirname(resolvedFileName);
46+
const resolvedBaseName = implicitPackageIndex ? void 0 : path.basename(resolvedFileName);
47+
const resolvedBaseNameNoExtension = resolvedBaseName && removeFileExtension(resolvedBaseName);
48+
const resolvedExtName = resolvedBaseName && path.extname(resolvedFileName);
49+
50+
const baseName = !implicitPackageIndex ? path.basename(moduleName) : void 0;
51+
const baseNameNoExtension = baseName && removeFileExtension(baseName);
52+
const extName = baseName && path.extname(moduleName);
53+
54+
// prettier-ignore
55+
const indexType =
56+
implicitPackageIndex ? IndexType.ImplicitPackage :
57+
baseNameNoExtension === 'index' && resolvedBaseNameNoExtension === 'index' ? IndexType.Explicit :
58+
baseNameNoExtension !== 'index' && resolvedBaseNameNoExtension === 'index' ? IndexType.Implicit :
59+
IndexType.NonIndex;
60+
61+
return {
62+
baseName,
63+
baseNameNoExtension,
64+
extName,
65+
resolvedBaseName,
66+
resolvedBaseNameNoExtension,
67+
resolvedExtName,
68+
resolvedDir,
69+
indexType,
70+
implicitPackageIndex,
71+
resolvedFileName,
72+
};
73+
}
74+
75+
// endregion
76+
77+
/* ****************************************************************************************************************** */
78+
// region: Utils
79+
/* ****************************************************************************************************************** */
80+
81+
/**
82+
* Resolve a module name
83+
*/
84+
export function resolveModuleName(context: VisitorContext, moduleName: string): ResolvedModule | undefined {
85+
const { tsInstance, compilerOptions, sourceFile, config, rootDirs } = context;
86+
const { removeSuffix } = tsInstance;
87+
88+
// Attempt to resolve with TS Compiler API
89+
const { resolvedModule, failedLookupLocations } = tsInstance.resolveModuleName(
90+
moduleName,
91+
sourceFile.fileName,
92+
compilerOptions,
93+
tsInstance.sys
94+
);
95+
96+
// Handle non-resolvable module
97+
if (!resolvedModule) {
98+
const maybeURL = failedLookupLocations[0];
99+
if (!isURL(maybeURL)) return void 0;
100+
return {
101+
isURL: true,
102+
resolvedPath: void 0,
103+
outputPath: maybeURL,
104+
};
105+
}
106+
107+
const {
108+
indexType,
109+
resolvedBaseNameNoExtension,
110+
resolvedFileName,
111+
implicitPackageIndex,
112+
extName,
113+
resolvedDir,
114+
} = getPathDetail(moduleName, resolvedModule);
115+
116+
/* Determine output filename */
117+
let outputBaseName = resolvedBaseNameNoExtension ?? "";
118+
119+
if (indexType === IndexType.Implicit) outputBaseName = removeSuffix(outputBaseName, "/index");
120+
if (outputBaseName && extName) outputBaseName = `${outputBaseName}${extName}`;
121+
122+
/* Determine output dir */
123+
let srcFileOutputDir = path.dirname(getOutputFile(context, sourceFile.fileName));
124+
let moduleFileOutputDir = implicitPackageIndex ? resolvedDir : path.dirname(getOutputFile(context, resolvedFileName));
125+
126+
// Handle rootDirs remapping
127+
if (config.useRootDirs && rootDirs) {
128+
let fileRootDir = "";
129+
let moduleRootDir = "";
130+
for (const rootDir of rootDirs) {
131+
if (isBaseDir(rootDir, moduleFileOutputDir) && rootDir.length > moduleRootDir.length) moduleRootDir = rootDir;
132+
if (isBaseDir(rootDir, srcFileOutputDir) && rootDir.length > fileRootDir.length) fileRootDir = rootDir;
133+
}
134+
135+
/* Remove base dirs to make relative to root */
136+
if (fileRootDir && moduleRootDir) {
137+
srcFileOutputDir = path.relative(fileRootDir, srcFileOutputDir);
138+
moduleFileOutputDir = path.relative(moduleRootDir, moduleFileOutputDir);
139+
}
140+
}
141+
142+
const outputDir = path.relative(srcFileOutputDir, moduleFileOutputDir);
143+
144+
/* Compose final output path */
145+
let outputPath = tsInstance.normalizePath(path.join(outputDir, outputBaseName));
146+
outputPath = outputPath[0] === "." ? outputPath : `./${outputPath}`;
147+
148+
return { isURL: false, outputPath, resolvedPath: resolvedFileName };
149+
}
150+
151+
// endregion

0 commit comments

Comments
 (0)