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

doc: add preferDev and update preferGlobal #143

Closed
wants to merge 2 commits into from

Conversation

larsgw
Copy link
Contributor

@larsgw larsgw commented Jan 19, 2019

@larsgw larsgw requested a review from a team as a code owner January 19, 2019 15:52
@@ -733,12 +733,16 @@ The host architecture is determined by `process.arch`

## preferGlobal

**DEPRECATED**
Inform that this package is usually installed globally.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why would this no longer be deprecated? I can’t think of any reason that a package should decide that it’s preferred globally; that always depends on the installer’s use case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we're having preferDev as guidance towards devDependencies, I though it might be weird if preferGlobal had the same effect but was considered deprecated. I realise installing globally isn't a meaningful distinction given npx and npm run-script, but I meant it more like a property saying "this is a CLI".

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think preferDev makes perfect sense (and preferPeer, tbh) because the action they recommend is a best practice for that package. preferGlobal is, at best, recommending a bad practice that’s blessed by that package’s authors.

@darcyclarke
Copy link
Contributor

Unfortunately preferDev isn't implemented today. Updating the docs would be inaccurate. Definitely feel free to create an RFC for this.

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.

None yet

5 participants