Repository navigation
fix(typescript-nestjs): import ModuleMetadata and Type from the @nestjs/common root - #25565
Open
reichhartd wants to merge 1 commit into
Open
reichhartd wants to merge 1 commit into
reichhartd wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
Fixes #25564.
The bug:
configuration.tsimportsModuleMetadataandTypefrom@nestjs/common/interfaces.@nestjs/common12 has anexportsmap that turns this into./interfaces.js, which doesn't exist, so withmoduleResolution: nodenextthe generated client fails withTS2307: Cannot find module '@nestjs/common/interfaces'.The fix: for
nestVersion8 and up the two types are now imported from@nestjs/commonitself, where they have been exported since 7.x. ThenestVersion=6.0.0output keeps the old import on purpose, the 6.x root doesn't exportModuleMetadataand the v6 sample would stop compiling. That's why the import moved into the existinguseAxiosHttpModuleblocks instead of being changed in place.I generated the petstore client before and after and compiled it against
@nestjs/common12.3.3 with TypeScript 6 andnodenext: TS2307 before, clean after. The v6 and v8 samples still passtsc --noEmitthe waybin/ts-typecheck-all.shruns it../bin/generate-samples.sh bin/configs/typescript-nestjs*.yamlchanges one line in two samples, the v6 sample is untouched.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
cc @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha @KannaKim
Summary by cubic
Fixes TS2307 errors in generated TypeScript NestJS clients by importing
ModuleMetadataandTypefrom the@nestjs/commonroot instead of the@nestjs/common/interfacessubpath, which no longer resolves under@nestjs/common12 withmoduleResolution: nodenext.nestVersion8+ outputs.nestVersion=6.0.0output keeps the old subpath import on purpose because the 6.x root doesn't exportModuleMetadata.@nestjs/common12.3.3 with TypeScript 6 andnodenext; the v6 and v8 samples still pass typechecking.Written for commit a69ef57. Summary will update on new commits.