feat: make generated require() ESM compatible #3235
Merged
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
bdezso
force-pushed
the
esm-compatible-require
branch
from
4b17f42 to
12cc1cf
Compare
bdezso
changed the title
micalevisk
suggested changes
Jan 14, 2025
bdezso
force-pushed
the
esm-compatible-require
branch
from
12cc1cf to
43eb567
Compare
|
I removed package-lock.json from my commit. |
|
LGTM |
2 tasks
|
Reverting as it introduced a major regression #3251 |
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?
NestJS does not officially support ESM. I have a project that successfully uses ESM with a custom fork, but in this Swagger plugin, the only incompatibility I found is that the generated code uses
requirewithout file extensions.requirecould not import ES modules.requirecan import ES modules, but missing file extensions continue to cause issues.Issue Number: N/A
What is the new behavior?
This PR adds the appropriate file extension in the generated code based on the input extension (.cts, .mts, or .ts), thereby improving compatibility with ESM.
Does this PR introduce a breaking change?
Other information
I am a new NestJS user who has integrated it into an existing ESM-based project. Currently, I rely on a monkey-patch workaround, but I would prefer to avoid such hacky solutions. This PR addresses that concern by providing a more robust and maintainable approach.