feat: make generated require() ESM compatible#3362
Merged
kamilmysliwiec merged 2 commits intonestjs:masterfrom Apr 11, 2025
CatsMiaow:fix/esm-compatible
Merged
feat: make generated require() ESM compatible#3362kamilmysliwiec merged 2 commits intonestjs:masterfrom CatsMiaow:fix/esm-compatible
kamilmysliwiec merged 2 commits intonestjs:masterfrom
CatsMiaow:fix/esm-compatible
Conversation
Member
|
LGTM |
Member
|
@CatsMiaow could you create a PR to the docs? Mentioning the new configuration attribute |
12 tasks
Contributor
Author
|
While testing the applied code before proceeding with the documentation, I encountered an error in another environment and wrote an additional PR: #3399 |
10 tasks
This file contains hidden or 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
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number
This is a PR that improves the work that was reverted in the above issue.
I think NestJS is now generally usable in ESM projects.
However, when using dynamic
require(import)like@nestjs/swaggermodule, if the extension is not present, build errors or runtime errors will occur.This cannot be solved externally and the module needs to be modified.
What is the new behavior?
I added the
esmCompatibleoption to make it work in a custom way, as it shouldn't affect non-ESM projects or other projects.Does this PR introduce a breaking change?
Other information
050ff34
npm install github:CatsMiaow/swagger#fix/esm-compatiblenpm testpassed, and although it is not minimal, I tested that it works in two environments.commonjs+tscnestjs-project-structure#swaggeresm+swcnestjs-project-performance#swagger