search

gruntjs / grunt-cli

Grunt's command line interface.
http://gruntjs.com/
MIT License
706 stars 248 forks source link

Consider changing messaging regarding installing grunt-cli globally as best practice #90

Closed MylesBorins closed 8 years ago

MylesBorins commented 8 years ago

Hey all. I'm a collaborator on the node project working on a smoke testing utility called "Canary in the Gold Mine"

https://github.com/nodejs/citgm

citgm is used to suck down projects, run the unit test suite, and make sure that changes to node core do not break heavily used modules in the ecosystem.

Without grunt-cli being included in the package.json we cannot run the unit test suite of projects relying on grunt. One such project moment has chosen to not add grunt-cli to the package.json quoting the grunt-cli docs as a source of truth.

https://github.com/moment/moment/pull/2830

This means we are unable to smoke test moment, which is truly unfortunate.

Would the project be open to changing the language in the documentation to outline cases where including grunt-cli as a dev-dep could be beneficial?

MylesBorins commented 8 years ago

/cc @rvagg @jasnell

vladikoff commented 8 years ago

Ref: https://github.com/gruntjs/grunt/issues/943

Without grunt-cli being included in the package.json

For the past few years including grunt-cli in package.json became standard, we should update our docs.

MylesBorins commented 8 years ago

@vladikoff I'd be more than happy to help with that if you can point me in the right direction. I'll do some digging right now and see if I can find it myself

cowboy commented 8 years ago

Agreed. Installing grunt-cli globally should only be done for convenience if one wishes to run Grunt commands via the grunt command and not through Npm scripts. Which most people will want to do locally for development, but not when deploying to a remote server.

shama commented 8 years ago

Fixed on e39fc61f1f41b0411620e274d12df76ff994c909

MylesBorins commented 8 years ago

Had the documentation been updated? On Jan 28, 2016 7:07 PM, "Kyle Robinson Young" notifications@github.com wrote:

Closed #90 https://github.com/gruntjs/grunt-cli/issues/90.

— Reply to this email directly or view it on GitHub https://github.com/gruntjs/grunt-cli/issues/90#event-530740455.

shama commented 8 years ago

@TheAlphaNerd The docs will be updated soon. It will part of the v1.0.0 release: https://github.com/gruntjs/grunt/issues/1430

In which we are also planning on including the bin directly in grunt and updating the documentation to show how one will only need to npm install grunt and "scripts": { "grunt": "grunt" }. Leaving npm i grunt-cli -g for those in favor of using the grunt command.

/cc @vladikoff