-
Notifications
You must be signed in to change notification settings - Fork 13.1k
--moduleResolution bundler (formerly known as hybrid)
#51669
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
--moduleResolution bundler (formerly known as hybrid)
#51669
Conversation
|
@andrewbranch why does I've been trying to make a package with conditional exports that use And |
|
It doesn’t; #52940 removed it. I’ll update the PR description since docs still aren’t on the website (😬) |
|
Okay great! Thanks for letting me know |
|
@jedwards1211 No problem. I assume you’re aware that Webpack, and I assume other bundlers too, do apply the |
|
@andrewbranch so I've learned recently...and even Deno does, somewhat surprisingly |
|
I found this setting fixed a long running problem I had (yay!). In trying to learn more about it I checked out https://www.typescriptlang.org/tsconfig#moduleResolution , https://www.typescriptlang.org/docs/handbook/modules.html , and https://www.typescriptlang.org/docs/handbook/module-resolution.html and none of them cover it. What's the best reference for details (this PR discussion is rather long)? Hopefully the docs will be updated soon. Thanks! |
The release notes for TypeScript 5.0 recommend using "bundler" when using tools like Vite, esbuild, Webpack, and so on. - Docs (which unfortunately don't say much): https://www.typescriptlang.org/tsconfig#moduleResolution - See also this PR: microsoft/TypeScript#51669
This PR introduces a new
moduleResolutionsetting value calledhybridbundler(see #51714), designed primarily for bundlers and runtimes that include a range of Node-like resolution features and ESM syntax, but do not enforce the strict resolution rules that accompany ES modules in Node or in the browser. Special consideration has also been given for bundlers and runtimes that understand TypeScript natively and do not require compilation to JavaScript bytscbefore consumption. Additionally, resolution of package.jsonexportsandimportscan be enabled/disabled/customized in configuration options. This should allow users of different bundlers and runtimes with slight variations in resolution features to customize TypeScript’s resolution settings underbundleras appropriate.--moduleResolution hybridandrewbranch/TypeScript#2 for a diff between those two branchesexportsoutside of Node #50794moduleResolutionsetting be called? #51714Who should use this mode?
tscthat will run in Node or the browser without further bundling or processingtscthat will run in Deno without further bundling or processingComparison with existing module resolution settings
node_modulespackages*.tsimportsexportsexportsconditionsnode,types;importfrom ESM,requirefrom CJS;custom additions
types,import;custom additions
Module syntax restrictions
--moduleResolution bundlerdoes not support resolution ofrequirecalls. In TypeScript files, this means theimport mod = require("foo")syntax is forbidden; in JavaScript files,requirecalls are not errors but only ever return the typeany(or whatever an ambient declaration of a globalrequirefunction is declared to return).New compiler options
allowImportingTsExtensions: Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.resolvePackageJsonExports: Use the package.json 'exports' field when resolving package imports. Enabled by default innode16,nodenext, andbundler.resolvePackageJsonImports: Use the package.json 'imports' field when resolving imports. Enabled by default innode16,nodenext, andbundler.customConditions: Conditions to set in addition to the resolver-specific defaults when resolving imports. Valid innode16,nodenext, andbundler.Open questions
resolvePackageJsonExportsandresolvePackageJsonImportsbe disableable innode16andnodenext? I see no valid reason to disable them in those modes, but I haven’t yet prohibited it.*.tsimports to resolve in every module resolution mode, or at leastnode16andnodenext, to improve consistency and (importantly) portability of .d.ts files between modes. I think @weswigham has already done this in another open PR, so perhaps it won’t be too controversial.bundlerbecome the new default resolution mode for--module commonjs? I would like to renamenodetonode10in a follow-up PR, and stop maintaining it going forward. It is not a good choice for anyone since Node 10 is long out of service.