fix(core): Adds express/fastify to peer dependency list and makes them optional #1008
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
Adds express to peer dependency to fix a problem with yarn pnp workspaces and resolving dependencies from @nestjs/common through @nestjs/serve-static.
|
@kamilmysliwiec, since this is my first PR, I am not sure if I filled it out correctly. Let me know if I missed anything. |
micalevisk
reviewed
Oct 7, 2022
package.json
Outdated
| @@ -19,7 +19,8 @@ | |||
| }, | |||
| "peerDependencies": { | |||
| "@nestjs/common": "^9.0.0", | |||
| "@nestjs/core": "^9.0.0" | |||
| "@nestjs/core": "^9.0.0", | |||
| "express": "^4.8.1" | |||
There was a problem hiding this comment.
express is optional here because this package could be used with fastiy.
You could add fastify as well and mark both of them as optional with https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependenciesmeta
There was a problem hiding this comment.
Great idea. I'll do that and test it out with yarn pnp workspaces.
There was a problem hiding this comment.
@micalevisk I updated with the following:
- I had the wrong express version, so fixed that.
- Added fastify and fastify/static.
- Added all 3 to peerDependenciesMeta so they are optional
As far as I can tell it is working well when I consume it using yarn v3.2.4 + pnp.
kamronbatman
changed the title
|
lgtm |
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.
Adds express/fastify to the peer dependency list to fix a problem with yarn pnp workspaces and resolving dependencies from @nestjs/common through @nestjs/serve-static.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
fix: Fixes a Nestjs runtime error saying it cannot find express when using yarn pnp workspaces.
What is the current behavior?
Receive the error: "The "express" package is missing. Please, make sure to install this library ($ npm install express) to take advantage of ServeStaticModule."
Issue Number: N/A
What is the new behavior?
The
ServeStaticModuleloads properly and this error does not show up.Does this PR introduce a breaking change?
Other information