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

The "Getting started" page should mention the coffee-script warning from npm. #237

Open
bdsexton opened this issue Jul 2, 2016 · 3 comments

Comments

@bdsexton
Copy link

bdsexton commented Jul 2, 2016

Including Grunt as a dev dependency in package.json causes npm to display a warning message regarding coffee-script upon running "npm install":

npm WARN prefer global [email protected] should be installed with -g

Ideally, it seems that a project-local installation should not include a dependency for which a global installation is preferred, but Grunt does, so it would be helpful for this to be mentioned on the "Getting started" page.

@AurelioDeRosa
Copy link

Personally, I don't think this is something Grunt should document. Things can change quickly and such warning could be removed at any point in time. So, it'd require another update or the inclusion of inaccurate information in the documentation. However, if there is a consensus to have such statement, I can submit a PR to address this issue.

@bdsexton
Copy link
Author

bdsexton commented Jul 4, 2016

It seems unlikely that the warning will be removed as long as Grunt depends upon coffee-script and npm installs coffee-script locally, but if it is removed, documentation changes can be removed as easily as they can be added or even more so since additions can be removed without needing new copy. However, instructions that lead new users to unexpected warning messages are likely to also lead those same users to think they have done something wrong. No matter what, there is going to be a bad user experience as long as the warning exists, but documenting the software portion of that bad user experience will mitigate it rather than exacerbate it.

@jhannwong
Copy link

jhannwong commented Nov 23, 2016

Just came across this warning, and it's confusing because it made me think I did something wrong.

That warning led me to spend quite some time installing packages globally, and then uninstalling them to test if I fixed anything, and so on.

Still, it might be worthwhile shooting a quick query to coffee-script maintainers to ask if their package will ever stop preferring to be installed globally. Or... npm/npm#8841?

I'm currently going to move ahead with this warning, seeing that npm/npm#8841 has been closed and not merged. I'm giving up trying to keep my project clean of such noise warning.

@Krinkle Krinkle transferred this issue from gruntjs/grunt-docs Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants