Skip to content

Good First Contribution: Inconsistency between CLI and README #2749

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

Closed
evenstensberg opened this issue Jul 8, 2017 · 4 comments
Closed

Good First Contribution: Inconsistency between CLI and README #2749

evenstensberg opened this issue Jul 8, 2017 · 4 comments

Comments

@evenstensberg
Copy link

Is this a bug report?

No

This is what is suggested by the terminal:

skjermbilde 2017-07-08 kl 20 40 06

This is from the README

skjermbilde 2017-07-08 kl 20 41 54


As yarn is facebook made, I'd change the README example to use yarn instead of npm

@evenstensberg evenstensberg changed the title Good First Contribution: Inconsistency between suggested CLI output and README Good First Contribution: Inconsistency between CLI output and README Jul 8, 2017
@evenstensberg evenstensberg changed the title Good First Contribution: Inconsistency between CLI output and README Good First Contribution: Inconsistency between CLI and README Jul 8, 2017
@gaearon
Copy link
Contributor

gaearon commented Jul 8, 2017

The CLI has detected you already have Yarn on your system, so we suggested that. The README has least-effort instructions that should work for everybody, so we decided not to put Yarn there.

I hope this explains it!

@gaearon gaearon closed this as completed Jul 8, 2017
@evenstensberg
Copy link
Author

No worries! Got another suggestion, and that is to detect if serve is installed globally before outputting if they want to install it:

skjermbilde 2017-07-08 kl 21 08 23

Here I've already got serve installed, so it would be nice to just tell the users to run serve instead of installing it globally first

@gaearon
Copy link
Contributor

gaearon commented Jul 8, 2017

That would be great. Mind filing another issue?

Unfortunately I'm not sure if it's possible to detect it easily, but maybe we could try calling serve -v silently or something.

@evenstensberg
Copy link
Author

Don't mind at all. I think it's doable, just map process.argv back to where the global binpath is and add the module name, later checking if the directory exists. Alternatively, adding global-prefix is also a solution

@lock lock bot locked and limited conversation to collaborators Jan 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants