nestjs / terminus

Terminus module for Nest framework (node.js) :robot:
https://nestjs.com/
MIT License
675 stars 100 forks source link

Consider removing certain peerDependencies #186

Closed willsoto closed 5 years ago

willsoto commented 5 years ago

I'm submitting a...


[ ] Regression 
[x] Bug report
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Performing a yarn install outputs several "missing peerDependency" warnings.

Example:

@nestjs/terminus@6.1.4" has unmet peer dependency "@grpc/proto-loader@^0.5.0".
@nestjs/terminus@6.1.4" has unmet peer dependency "@nestjs/mongoose@^6.1.2".
@nestjs/terminus@6.1.4" has unmet peer dependency "@nestjs/platform-fastify@^6.0.0".
@nestjs/terminus@6.1.4" has unmet peer dependency "@nestjs/typeorm@^6.0.0".
@nestjs/terminus@6.1.4" has unmet peer dependency "amqp-connection-manager@^2.3.1".
@nestjs/terminus@6.1.4" has unmet peer dependency "amqplib@^0.5.3".
@nestjs/terminus@6.1.4" has unmet peer dependency "grpc@^1.20.0".
@nestjs/terminus@6.1.4" has unmet peer dependency "mongoose@^5.5.2".
@nestjs/terminus@6.1.4" has unmet peer dependency "nats@^1.2.10".
@nestjs/terminus@6.1.4" has unmet peer dependency "redis@^2.8.0".
@nestjs/terminus@6.1.4" has unmet peer dependency "typeorm@^0.2.16".

Expected behavior

I should be able to run the installation instructions and get no warnings during installation.

There is nothing "broken" about this - technically - but getting warnings for packages that I might never install and are not strictly required in order to make the package work should exist in optionalDependencies in my opinion.

Minimal reproduction of the problem with instructions

Simply run the installation instructions in a fresh NestJS app.

What is the motivation / use case for changing the behavior?

See "Expected behavior"

Environment


Nest version: 6.1.1


For Tooling issues:
- Node version: 10.15.3
- Platform:  MacOS, Alpine Linux

Others:
- Yarn version: 1.16.0
BrunnerLivio commented 5 years ago

Thanks for reporting! Fixed with #194. You can use it with @nestjs/terminus@6.2.0-rc.0 or wait for 6.2.0 which will feature #191