gruntjs / grunt-init-gruntplugin Goto Github PK

View Code? Open in Web Editor NEW

79.0 9.0 42.0 13 KB

Create a gruntplugin module with grunt-init, including Nodeunit unit tests.

JavaScript 100.00%

grunt-init-gruntplugin's Introduction

grunt-init-gruntplugin

Create a gruntplugin module with grunt-init, including Nodeunit unit tests.

Installation

If you haven't already done so, install grunt-init.

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git to clone this template into that directory, as follows:

git clone https://github.com/gruntjs/grunt-init-gruntplugin.git ~/.grunt-init/gruntplugin

(Windows users, see the documentation for the correct destination directory path)

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

grunt-init gruntplugin

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

grunt-init-gruntplugin's People

Contributors

Stargazers

Watchers

grunt-init-gruntplugin's Issues

npm install broken

Using:

$ npm -v
1.3.1
$ grunt --version
grunt-cli v0.1.9
$ grunt-init --version
grunt-init v0.2.1
grunt v0.4.1

to reproduce:

$ mkdir plugin-test
$ cd plugin-test
$ grunt-init gruntplugin
$ npm install 
npm http GET https://registry.npmjs.org/grunt-contrib-clean
npm http GET https://registry.npmjs.org/grunt
npm http GET https://registry.npmjs.org/grunt-contrib-nodeunit
npm http GET https://registry.npmjs.org/grunt-contrib-jshint
npm http 304 https://registry.npmjs.org/grunt-contrib-clean
npm http 304 https://registry.npmjs.org/grunt
npm http 304 https://registry.npmjs.org/grunt-contrib-jshint
npm ERR! TypeError: Invalid Version: 0.1.1rc6
npm ERR!     at new SemVer (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:257:11)
npm ERR!     at compare (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:410:10)
npm ERR!     at rcompare (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:420:10)
npm ERR!     at Array.sort (native)
npm ERR!     at Function.maxSatisfying (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:838:6)
npm ERR!     at next (/usr/local/lib/node_modules/npm/lib/cache.js:699:21)
npm ERR!     at /usr/local/lib/node_modules/npm/lib/cache.js:678:5
npm ERR!     at saved (/usr/local/lib/node_modules/npm/node_modules/npm-registry-client/lib/get.js:138:7)
npm ERR!     at Object.oncomplete (fs.js:107:15)
npm ERR! If you need help, you may report this log at:
npm ERR!     <http://github.com/isaacs/npm/issues>
npm ERR! or email it to:
npm ERR!     <[email protected]>

npm ERR! System Darwin 12.4.0
npm ERR! command "node" "/usr/local/bin/npm" "install"
npm ERR! cwd /Users/Lloyd/Documents/Kunai/plugin-test
npm ERR! node -v v0.10.12
npm ERR! npm -v 1.3.1
npm http 304 https://registry.npmjs.org/grunt-contrib-nodeunit
npm ERR! TypeError: Invalid Version: 0.1.2rc6
npm ERR!     at new SemVer (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:257:11)
npm ERR!     at compare (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:410:10)
npm ERR!     at rcompare (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:420:10)
npm ERR!     at Array.sort (native)
npm ERR!     at Function.maxSatisfying (/usr/local/lib/node_modules/npm/node_modules/semver/semver.js:838:6)
npm ERR!     at next (/usr/local/lib/node_modules/npm/lib/cache.js:699:21)
npm ERR!     at /usr/local/lib/node_modules/npm/lib/cache.js:678:5
npm ERR!     at saved (/usr/local/lib/node_modules/npm/node_modules/npm-registry-client/lib/get.js:138:7)
npm ERR!     at Object.oncomplete (fs.js:107:15)
npm ERR! If you need help, you may report this log at:
npm ERR!     <http://github.com/isaacs/npm/issues>
npm ERR! or email it to:
npm ERR!     <[email protected]>

npm ERR! System Darwin 12.4.0
npm ERR! command "node" "/usr/local/bin/npm" "install"
npm ERR! cwd /Users/Lloyd/Documents/Kunai/plugin-test
npm ERR! node -v v0.10.12
npm ERR! npm -v 1.3.1
npm ERR! 
npm ERR! Additional logging details can be found in:
npm ERR!     /Users/Lloyd/Documents/Kunai/plugin-test/npm-debug.log
npm ERR! not ok code 0

Update devDependencies

Please, replace in template.js by the last version of grunt-contrib-jshint, grunt-contrib-clean, grunt-contrib-nodeunit to get the last version of the plugins.

  'grunt-contrib-jshint': '~0.6.0', //by 0.8.0
  'grunt-contrib-clean': '~0.4.0', //by 0.5.0
  'grunt-contrib-nodeunit': '~0.2.0', //by 0.3.0

gruntplugin README boilerplate improvements

@cowboy

The gruntplugin scaffolding is awesome but there is a problem with the README.
I have seen many complaints about this in the Grunt community and stumble over this issue myself a lot.

Most gruntplugin README start with this at the top:

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-contrib-compass --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-contrib-compass');

I find this confusing because I would like to see what the plugin does at the top of the README. I would also argue that most people who look for gruntplugins know what Grunt is. So just a link to the Grunt site would suffice.

It would also be great if the README would try to encourage MORE documentation of the gruntplugin and even screenshots and screencasts if suitable.

Thoughts?

Migrate from dest-as-targets

According to gruntjs docs (link), seems it's recommended that dest-as-target format is to be avoided.

Needless dependency on globally installed grunt-cli

Travis CI doesn't pre-install grunt-cli in current versions of Node.js, which makes npm test fail for the current test script (grunt test).

It's very easy to avoid the problem by adding grunt-cli as a dev dependency and making npm test call Grunt using npm run, which has node_modules/.bin in $PATH. For example like I did here: dancek/grunt-more-css@dba41c9

The related Travis CI bug: travis-ci/travis-ci#3231

Generates deprecated licenses field

As per https://docs.npmjs.com/files/package.json#license.

Fatal Error

> grunt-init gruntplugin

...


Writing .gitignore...OK
Writing .jshintrc...OK
Writing Gruntfile.js...OK
Writing README.md...OK
Writing tasks/gh_pages_easy.js...OK
Writing test/expected/custom_options...OK
Writing test/expected/default_options...OK
Writing test/fixtures/123...OK
Writing test/fixtures/testing...OK
Writing test/gh_pages_easy_test.js...OK
Fatal error: Arguments to path.join must be strings

Based on instructions

gruntjs / grunt-init-gruntplugin Goto Github PK

grunt-init-gruntplugin's Introduction

grunt-init-gruntplugin

Installation

Usage

grunt-init-gruntplugin's People

Contributors

Stargazers

Watchers

Forkers

grunt-init-gruntplugin's Issues

Getting Started

Recommend Projects

Recommend Topics

Recommend Org