grunt-init-pack
v0.3.0
Published
grunt-init template to create a project that has Node package and optionally Bower, Component, Duo, Jam and/or UMD package. Includes jshint, mocha+chai tests, jsdoc (optionally).
Downloads
33
Maintainers
Readme
grunt-init-pack
grunt-init template for a project that can have Node package and optionally Bower, Component, Duo, Jam and/or UMD package. Includes JSHint, Mocha+Chai tests, JSDoc (optionally).
Getting started
Installation
If you haven't already done so, install grunt-init.
npm install -g grunt-init
Once grunt-init is installed, place this template in your ~/.grunt-init/
directory.
It's recommended that you use git clone
to install this template into that directory as follows:
git clone https://github.com/gamtiq/grunt-init-pack.git ~/.grunt-init/pack
(Windows users should use %USERPROFILE%\.grunt-init\pack as the correct destination directory path)
To force grunt-init
to use custom default values, move the defaults.json
file to your ~/.grunt-init/
directory,
and customize the values in that file.
Note: you can make the template available as any name you choose by simply changing the name of the folder
that the template is installed into. So instead of ~/.grunt-init/pack
, you may change the name to ~/.grunt-init/foo
so that the template can be used with the following command: grunt-init foo
.
Also you can clone the template into any subdirectory outside of ~/.grunt-init/
directory. For example:
git clone https://github.com/gamtiq/grunt-init-pack.git path/to/grunt-init/templates/pack
In this case you will have to specify path to the template when running grunt-init
(see below).
Usage
At the command-line, cd into an empty directory, run this command and follow the prompts.
grunt-init pack
Or
grunt-init path/to/grunt-init/templates/pack
when the template was placed in subdirectory outside of ~/.grunt-init/
directory.
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.
You might want to test that it works before you begin customizing the project:
- run
npm install
to install the project's dependencies; it is necessary only if you have answeredno
to the corresponding question - run
grunt all
to build the project and test that it works
Redefining default prompt answers
You can redefine default prompt answers using defaults.json
file
(see here for details).
Below supported prompt names are listed:
name
- project namedescription
- project descriptionkeywords
- project keywordsversion
- initial versionrepository
- project repositoryhomepage
- URL of project home pagebugs
- URL of project issues trackerlicense
- project licenses (SPDX license ID or expression)author_name
- author nameauthor_email
- author emailauthor_url
- URL of author's sitenode_version
- minimal Node.js versionmain
- main filecli
- whether project should have command-line interfacenpm_test
- NPM test commandesnext
- whether project should be prepared for using of ECMAScript 2015 featuresbower
- whether project should have Bower packagecomponent
- whether project should have Component or Duo packagejam
- whether project should have Jam packageumd
- whether project should have AMD package or standalone script filejsdoc
- whether project should use JSDoctravis
- whether support for Travis CI should be addedtravis_badge
- whether Travis CI build status badge should be included intoREADME.md
npm_badge
- whether NPM version badge should be included intoREADME.md
grunt_badge
- whether Grunt badge should be included intoREADME.md
history_md
- to include or notHistory.md
in the project filesinclude_config
- to include or notpackage.json
/bower.json
/component.json
in Gruntfile configurationmatchdep
- to use or not matchdep module to simplify loading of plugins in Gruntfilerelease_task
- to include or not release tasks into Gruntfilenpm_install
- to run or notnpm install
command automatically
Related projects
License
MIT