grunt-jquerymanifest
Requires Grunt 0.4.0 or newer
Generate jQuery plugin manifest automatically from package.json values
Getting Started
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, install this plugin with this command:
npm install grunt-jquerymanifest --save-dev
Usage
Below is an example gruntfile configuration:
grunt; grunt; grunt;
Automatic Mappings
The following manifest properties are automatically mapped from package.json
:
name
andtitle
- Packagename
author
- Generatespeople
object using packageauthor
as object, or with name asauthor
if stringlicenses
- Generateslicenses
array using packagelicense
as object, or if string, with type aslicense
and url ashttp://opensource.org/licenses/<licensename>
(always check to ensure link is valid with license name)dependencies
- Defaults tojQuery: "*"
if not otherwise defined inpackage.json
Additionally, a number of properties will be copied verbatim if they are defined in package.json
:
version
homepage
description
keywords
docs
demo
download
bugs
maintainers
Options
source
- This will typically be your package.json file. Specify either with a string (i.e."package.json"
) or the object itself (i.e.grunt.file.readJSON('package.json')
)overrides
- An object containing custom values which will override any inferred value. For example, you might want to specify ahomepage
ordemo
URL here, since these are usually not defined as package.json properties
License
Copyright (c) 2014 Andrew Duthie
Released under the MIT License (see LICENSE.txt)