docs: Use .mjs extension for library ESM bundle #7714
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As explained in #7609, when importing an ES module in Node.js, either its package needs to have `"type": "module"` set in its `package.json`, or its file extension needs to be `.mjs`. Otherwise the file will be interpreted as CommonJS and the import will fail. By changing the extension of the ESM bundle to `.mjs`, the library bundle can be successfully used both in Node.js and in frontend bundlers.
cdauth
changed the title
Niputi
added
feat: library mode
documentation
|
See #6827, we are going to merge it as part of Vite v3 because it has a potential breaking change. I think we should update the docs together with that change in Vite (that is already part of the PR) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As explained in #7609, when importing an ES module in Node.js, either its package needs to have
"type": "module"set in itspackage.json, or its file extension needs to be.mjs. Otherwise the file will be interpreted as CommonJS and the import will fail.The Library section of the Vite docs documents how to publish a library and also recommends to add an
exportssection topackage.json. As far as I am aware, this section tells Node.js which file to import, although I believe some frontend bundlers are also adding support for it these days. The current documentation encourages developers to publish their ESM bundles with a.es.jsextension, which will make the package impossible to be imported from an ESM Node.js project. Since not many Node.js projects use ESM yet, many developers are not aware of this problem.This pull request changes the documentation to recommend the use of the
.mjsextension for the generated bundle. This way the library bundle can be successfully used both in Node.js and in frontend bundlers.What is the purpose of this pull request?