Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: modify misleading doc about package.json:bin #5529

Merged
merged 1 commit into from
Sep 21, 2022
Merged

docs: modify misleading doc about package.json:bin #5529

merged 1 commit into from
Sep 21, 2022

Conversation

Hafizur046
Copy link
Contributor

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,

_To use this, supply a bin field in your package.json which is a map of command name to local file name. When this package is installed globally, that file will be linked where global bins go so it is available to run by name.

which is simply not true in case of windows, where it uses the cmd-shim module to create cmd files that are usually stored as C:\Users\{Username}\AppData\Roaming\npm\xxxx.cmd and can be executed in the Windows PowerShell as xxxx.cmd

This PR aims to solve this by appending these information to the doc

References

Closes #3788

@Hafizur046 Hafizur046 requested a review from a team as a code owner September 18, 2022 19:10
@Hafizur046 Hafizur046 changed the title docs: modify Misleading doc about bins docs: modify misleading doc about package.json:bin Sep 18, 2022
Copy link
Member

@wraithgar wraithgar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After re-reading it my initial comment wasn't needed. This wording makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Misleading documentation on package.json:bin
3 participants