docs: add comments to install all modules when devDeps is ignored by default #1448
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.
Why this changes
When we want to reduce the image size of a NodeJS project and set the
NODE_ENV
toproduction
before install, the package manager will ignoredevDependencies
. This is in line with expected behavior.However, in the current JavaScript ecosystem, where most projects require the use of scaffolding from
devDependencies
for the bundle (or compile), ignoring dependencies when building images can cause user deployments to fail. For users who lack experience with package managers, this cause is hard to spot.Description of the changes
Reducing the size of the image reduces the deployment time for users and for some users does not require any changes in settings, which is correct, no changes are required.
Add additional comments to get a hint when the user tries to change the Dockerfile to resolve the error.
Needs to review
I'm not quite sure if the comments in the template will respect the conditional statement, if it doesn't work we can remove the conditional statement.
Refs