fix: correct optional peer dependencies #1238
Open
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.
Currently optional peer dependencies are not declared correctly, they are declared twice: as mandatory peer dependencies as well as optional direct dependencies.
This often causes false positives during security scans. E.g.:
preview-email
is not needed in production, however it has often been the cause of failing security audits.This PR aims to declare them according to the package.json spec, i.e. using
peerDependenciesMeta
. This is available since[email protected]
(August 2019), so any package manager in use nowadays should be able to handle this:With this change, apps relying on
@nestjs-modules/mailer
will be able to avoid installing some of these optional peer dependencies if they are not needed (e.g. viapnpm.ignoredOptionalDependencies
).