Create a Node.js module with grunt-init, including mocha unit tests.
JavaScript Shell
Clone or download
Pull request Compare This branch is 162 commits ahead, 7 commits behind gruntjs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
licenses
root
test
.eslintrc.js
.gitignore
.travis.yml
CHANGELOG.md
README.md
package.json
rename.json
symlink.sh
template.js

README.md

grunt-init-node Build status

Create a Node.js module with grunt-init, including mocha unit tests.

This is a personal fork from https://github.com/gruntjs/grunt-init-node. Highlights are:

  • mocha tests over nodeunit tests
  • Create CHANGELOG.md
  • Prompt for keywords
  • Include donatons section
  • Removed Travis CI badge for now (will prob come back when I decide to start using Travis religiously)
  • Added UNLICENSE to available licenses (default)
  • Added SPDX license handling
  • Added foundry release integration (git + npm)

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:

# Clone repository
git clone git@github.com:twolfson/grunt-init-node.git ~/.grunt-init/node
cd ~/.grunt-init/node

# Install dependencies
npm install

(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 node

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.