Skip to content

Proposal: Prioritize declaration file resolutions when declaration extension is explicitly specified #58700

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Proposal: Prioritize declaration file resolutions when declaration extension is explicitly specified #58700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 21 additions & 8 deletions src/compiler/moduleNameResolver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2123,19 +2123,26 @@ function tryAddingExtensions(candidate: string, extensions: Extensions, original
}
}

const prioritizeDeclarationFiles = isDeclarationFileName(originalExtension);
switch (originalExtension) {
case Extension.Mjs:
case Extension.Mts:
case Extension.Dmts:
return extensions & Extensions.TypeScript && tryExtension(Extension.Mts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts)
|| extensions & Extensions.Declaration && tryExtension(Extension.Dmts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts)
return (prioritizeDeclarationFiles
? extensions & Extensions.Declaration && tryExtension(Extension.Dmts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts)
|| extensions & Extensions.TypeScript && tryExtension(Extension.Mts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts)
: extensions & Extensions.TypeScript && tryExtension(Extension.Mts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts)
|| extensions & Extensions.Declaration && tryExtension(Extension.Dmts, originalExtension === Extension.Mts || originalExtension === Extension.Dmts))
|| extensions & Extensions.JavaScript && tryExtension(Extension.Mjs)
|| undefined;
case Extension.Cjs:
case Extension.Cts:
case Extension.Dcts:
return extensions & Extensions.TypeScript && tryExtension(Extension.Cts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts)
|| extensions & Extensions.Declaration && tryExtension(Extension.Dcts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts)
return (prioritizeDeclarationFiles
? extensions & Extensions.Declaration && tryExtension(Extension.Dcts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts)
|| extensions & Extensions.TypeScript && tryExtension(Extension.Cts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts)
: extensions & Extensions.TypeScript && tryExtension(Extension.Cts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts)
|| extensions & Extensions.Declaration && tryExtension(Extension.Dcts, originalExtension === Extension.Cts || originalExtension === Extension.Dcts))
|| extensions & Extensions.JavaScript && tryExtension(Extension.Cjs)
|| undefined;
case Extension.Json:
Expand All @@ -2147,16 +2154,22 @@ function tryAddingExtensions(candidate: string, extensions: Extensions, original
// basically idendical to the ts/js case below, but prefers matching tsx and jsx files exactly before falling back to the ts or js file path
// (historically, we disallow having both a a.ts and a.tsx file in the same compilation, since their outputs clash)
// TODO: We should probably error if `"./a.tsx"` resolved to `"./a.ts"`, right?
return extensions & Extensions.TypeScript && (tryExtension(Extension.Tsx, originalExtension === Extension.Tsx) || tryExtension(Extension.Ts, originalExtension === Extension.Tsx))
|| extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Tsx)
return (prioritizeDeclarationFiles
? extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Tsx)
|| extensions & Extensions.TypeScript && (tryExtension(Extension.Tsx, originalExtension === Extension.Tsx) || tryExtension(Extension.Ts, originalExtension === Extension.Tsx))
: extensions & Extensions.TypeScript && (tryExtension(Extension.Tsx, originalExtension === Extension.Tsx) || tryExtension(Extension.Ts, originalExtension === Extension.Tsx))
|| extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Tsx))
|| extensions & Extensions.JavaScript && (tryExtension(Extension.Jsx) || tryExtension(Extension.Js))
|| undefined;
case Extension.Ts:
case Extension.Dts:
case Extension.Js:
case "":
return extensions & Extensions.TypeScript && (tryExtension(Extension.Ts, originalExtension === Extension.Ts || originalExtension === Extension.Dts) || tryExtension(Extension.Tsx, originalExtension === Extension.Ts || originalExtension === Extension.Dts))
|| extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Ts || originalExtension === Extension.Dts)
return (prioritizeDeclarationFiles
? extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Ts || originalExtension === Extension.Dts)
|| extensions & Extensions.TypeScript && (tryExtension(Extension.Ts, originalExtension === Extension.Ts || originalExtension === Extension.Dts) || tryExtension(Extension.Tsx, originalExtension === Extension.Ts || originalExtension === Extension.Dts))
: extensions & Extensions.TypeScript && (tryExtension(Extension.Ts, originalExtension === Extension.Ts || originalExtension === Extension.Dts) || tryExtension(Extension.Tsx, originalExtension === Extension.Ts || originalExtension === Extension.Dts))
|| extensions & Extensions.Declaration && tryExtension(Extension.Dts, originalExtension === Extension.Ts || originalExtension === Extension.Dts))
|| extensions & Extensions.JavaScript && (tryExtension(Extension.Js) || tryExtension(Extension.Jsx))
|| state.isConfigLookup && tryExtension(Extension.Json)
|| undefined;
Expand Down
6 changes: 3 additions & 3 deletions tests/baselines/reference/allowsImportingTsExtension.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ import type { A } from "./a.d.ts"; // ok

import {} from "./a.d.ts"; // error
import { type A as _A } from "./a.d.ts"; // error
>A : Symbol(A, Decl(a.ts, 0, 0))
>A : Symbol(A, Decl(a.d.ts, 0, 0))
>_A : Symbol(_A, Decl(c.ts, 2, 8))

type __A = import("./a.d.ts").A; // ok
>__A : Symbol(__A, Decl(c.ts, 2, 40))
>A : Symbol(A, Decl(a.ts, 0, 0))
>A : Symbol(A, Decl(a.d.ts, 0, 0))

const aPromise = import("./a.d.ts"); // error
>aPromise : Symbol(aPromise, Decl(c.ts, 4, 5))
>"./a.d.ts" : Symbol("a", Decl(a.ts, 0, 0))
>"./a.d.ts" : Symbol("a", Decl(a.d.ts, 0, 0))

5 changes: 3 additions & 2 deletions ...rence/bundlerImportTsExtensions(allowimportingtsextensions=false,noemit=false).trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/b.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/b.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/b.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.ts'. ========",
"File '/project/b.d.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.d.ts'. ========",
"======== Resolving module './c.ts' from '/project/main.ts'. ========",
"Explicitly specified module resolution kind: 'Bundler'.",
"Resolving in CJS mode with conditions 'import', 'types'.",
Expand Down Expand Up @@ -130,6 +130,7 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/a.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/a.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/a.d.ts' does not exist.",
"File '/project/a.ts' exists - use it as a name resolution result.",
"======== Module name './a.d.ts' was successfully resolved to '/project/a.ts'. ========",
"File '/.ts/package.json' does not exist.",
Expand Down
5 changes: 3 additions & 2 deletions ...erence/bundlerImportTsExtensions(allowimportingtsextensions=false,noemit=true).trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/b.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/b.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/b.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.ts'. ========",
"File '/project/b.d.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.d.ts'. ========",
"======== Resolving module './c.ts' from '/project/main.ts'. ========",
"Explicitly specified module resolution kind: 'Bundler'.",
"Resolving in CJS mode with conditions 'import', 'types'.",
Expand Down Expand Up @@ -130,6 +130,7 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/a.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/a.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/a.d.ts' does not exist.",
"File '/project/a.ts' exists - use it as a name resolution result.",
"======== Module name './a.d.ts' was successfully resolved to '/project/a.ts'. ========",
"File '/.ts/package.json' does not exist.",
Expand Down
5 changes: 3 additions & 2 deletions ...erence/bundlerImportTsExtensions(allowimportingtsextensions=true,noemit=false).trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/b.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/b.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/b.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.ts'. ========",
"File '/project/b.d.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.d.ts'. ========",
"======== Resolving module './c.ts' from '/project/main.ts'. ========",
"Explicitly specified module resolution kind: 'Bundler'.",
"Resolving in CJS mode with conditions 'import', 'types'.",
Expand Down Expand Up @@ -130,6 +130,7 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/a.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/a.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/a.d.ts' does not exist.",
"File '/project/a.ts' exists - use it as a name resolution result.",
"======== Module name './a.d.ts' was successfully resolved to '/project/a.ts'. ========",
"File '/.ts/package.json' does not exist.",
Expand Down
5 changes: 3 additions & 2 deletions ...ference/bundlerImportTsExtensions(allowimportingtsextensions=true,noemit=true).trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/b.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/b.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/b.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.ts'. ========",
"File '/project/b.d.ts' exists - use it as a name resolution result.",
"======== Module name './b.d.ts' was successfully resolved to '/project/b.d.ts'. ========",
"======== Resolving module './c.ts' from '/project/main.ts'. ========",
"Explicitly specified module resolution kind: 'Bundler'.",
"Resolving in CJS mode with conditions 'import', 'types'.",
Expand Down Expand Up @@ -130,6 +130,7 @@
"Resolving in CJS mode with conditions 'import', 'types'.",
"Loading module as file / folder, candidate module location '/project/a.d.ts', target file types: TypeScript, JavaScript, Declaration, JSON.",
"File name '/project/a.d.ts' has a '.d.ts' extension - stripping it.",
"File '/project/a.d.ts' does not exist.",
"File '/project/a.ts' exists - use it as a name resolution result.",
"======== Module name './a.d.ts' was successfully resolved to '/project/a.ts'. ========",
"File '/.ts/package.json' does not exist.",
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/moduleResolution_packageJson_yesAtPackageRoot.trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"Loading module as file / folder, candidate module location '/node_modules/foo/bar/types.d.ts', target file types: TypeScript, Declaration.",
"File name '/node_modules/foo/bar/types.d.ts' has a '.d.ts' extension - stripping it.",
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"File '/node_modules/foo/bar/types.ts' does not exist.",
"File '/node_modules/foo/bar/types.tsx' does not exist.",
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.ts' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.tsx' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.d.ts' does not exist.",
Expand Down Expand Up @@ -48,9 +48,9 @@
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"Loading module as file / folder, candidate module location '/node_modules/foo/bar/types.d.ts', target file types: TypeScript, Declaration.",
"File name '/node_modules/foo/bar/types.d.ts' has a '.d.ts' extension - stripping it.",
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"File '/node_modules/foo/bar/types.ts' does not exist.",
"File '/node_modules/foo/bar/types.tsx' does not exist.",
"File '/node_modules/foo/bar/types.d.ts' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.ts' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.tsx' does not exist.",
"File '/node_modules/foo/bar/types.d.ts.d.ts' does not exist.",
Expand Down
4 changes: 2 additions & 2 deletions ...ines/reference/moduleResolution_packageJson_yesAtPackageRoot_fakeScopedPackage.trace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"Loading module as file / folder, candidate module location '/node_modules/foo/@bar/types.d.ts', target file types: TypeScript, Declaration.",
"File name '/node_modules/foo/@bar/types.d.ts' has a '.d.ts' extension - stripping it.",
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"File '/node_modules/foo/@bar/types.ts' does not exist.",
"File '/node_modules/foo/@bar/types.tsx' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.ts' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.tsx' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.d.ts' does not exist.",
Expand Down Expand Up @@ -48,9 +48,9 @@
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"Loading module as file / folder, candidate module location '/node_modules/foo/@bar/types.d.ts', target file types: TypeScript, Declaration.",
"File name '/node_modules/foo/@bar/types.d.ts' has a '.d.ts' extension - stripping it.",
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"File '/node_modules/foo/@bar/types.ts' does not exist.",
"File '/node_modules/foo/@bar/types.tsx' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.ts' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.tsx' does not exist.",
"File '/node_modules/foo/@bar/types.d.ts.d.ts' does not exist.",
Expand Down
Loading