docs: modify misleading doc about package.json:bin #5529
Merged
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.
closes #3788
What / Why
The documentation about bin field configuration in package.json does not clarify how it works on windows (which is by creating cmd files which executes the provided script file). As it only states,
which is simply not true in case of windows, where it uses the
cmd-shim
module to create cmd files that are usually stored asC:\Users\{Username}\AppData\Roaming\npm\xxxx.cmd
and can be executed in the Windows PowerShell asxxxx.cmd
This PR aims to solve this by appending these information to the doc
References
Closes #3788