microsoft / microsoft/TypeScript
[API] No module resolution API: no counterpart to ts.resolveModuleName
@andrewbranch 已经在做这个了。
开始于 2026年8月28日。
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
Description
The 7.x API has no counterpart to ts.resolveModuleName, and no other way to ask "what does this specifier resolve to from this file?". The compiler does the resolution internally when it builds a program, but a consumer cannot invoke it on its own.
That matters for tools that resolve outside of, or ahead of, a program:
- Finding a package's declaration entry from its directory, so that
exportsconditions,typesVersionsand thetypes/typingsfallbacks all apply — the thingts.resolveModuleName(manifest.name, path.join(dir, "__entry__.ts"), options, host)answered in one call. - Reporting where an import would resolve to, without materialising a program for it.
- Deciding which files to load before opening a project.
The roadmap in #63875 covers createProgram, createSourceFile, transpileModule and parseCommandLine under "top-level utility APIs", but resolution is not among them. microsoft/typescript-go#455 named "resolution behavior" as one of the critical use cases the API was meant to serve, so I may simply have missed where this is tracked — if there is an existing issue, this can be closed as a duplicate.
Why a workaround isn't sufficient
Reimplementing it means reimplementing Node's exports algorithm. I have done so for the narrow case of a package resolving its own name, and it is about 40 lines that handle condition maps, arrays and the ./subpath split:
function selectExportTarget(target: unknown, conditions: ReadonlySet<string>): string | undefined {
if (typeof target === "string") return target;
if (Array.isArray(target)) {
for (const alternative of target) {
const selected = selectExportTarget(alternative, conditions);
if (selected) return selected;
}
return undefined;
}
if (target && typeof target === "object") {
for (const [condition, value] of Object.entries(target)) {
if (conditions.has(condition)) {
const selected = selectExportTarget(value, conditions);
if (selected) return selected;
}
}
}
return undefined;
}
That covers the fixtures I have and nothing more. It does not handle typesVersions, symlink realpath resolution (pnpm layouts), extension substitution, or paths. Every consumer that needs resolution will write a different subset, each wrong in a different way, and none will agree with the compiler that ultimately type-checks the code.
Suggested shape
Something close to the 6.x signature, answering from the same implementation the compiler uses:
resolveModuleName(
moduleName: string,
containingFile: string,
compilerOptions: CompilerOptions,
): { resolvedFileName: string; isExternalLibraryImport: boolean; extension: string } | undefined
A snapshot-scoped variant (project.resolveModuleName(...)) would work equally well for my case and might fit the existing model better, since options and the file system are already established there.
Use case
Porting OpenRewrite's JavaScript/TypeScript parser from the 6.x API. One component enumerates the public types a package exports, and locates each package's declaration entry by resolving the package's own name from inside its directory. On 6.x that is a single resolveModuleName call; on 7.x it is the hand-rolled subset above, which loses exports maps that name declarations only under a condition the subset does not model.
Verified against 7.0.2 and typescript@next (7.1.0-dev.20260827.1).
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
评估
这个 Issue 还没有评估数据。