# grunt-jquerymanifest

> Generate jQuery plugin manifest automatically from package.json values

Latest version **0.1.4** (published 2013-12-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-jquerymanifest
pnpm add grunt-jquerymanifest
yarn add grunt-jquerymanifest
bun add grunt-jquerymanifest
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2013-12-30 |
| First published | 2013-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Andrew Duthie |
| Maintainers | aduth |
| Keywords | jquery, manifest, gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-jquerymanifest
- Repository: https://github.com/aduth/grunt-jquerymanifest
- Issues: https://github.com/aduth/grunt-jquerymanifest/issues
- npm.io page: https://npm.io/package/grunt-jquerymanifest

## Dependencies (1)

- [string-format](https://npm.io/package/string-format.md) ~0.2.1

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2013-12-30
- 0.1.3 — 2013-09-01
- 0.1.2 — 2013-08-24
- 0.1.0 — 2013-01-23

## README

# 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](http://gruntjs.com/) before, be sure to check out the [Getting Started](https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md) 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:

```shell
npm install grunt-jquerymanifest --save-dev
```

## Usage

Below is an example gruntfile configuration:

```javascript
grunt.initConfig({
    jquerymanifest: {
        options: {
            source: grunt.file.readJSON('package.json'),
            overrides: {
                name: "myPlugin",
                title: "jquery.myPlugin",
                author: {
                    name: "Andrew Duthie",
                    email: "andrew@andrewduthie.com",
                    url: "http://www.andrewduthie.com"
                },
                homepage: "http://github.com/aduth/grunt-jquerymanifest",
                demo: "http://github.com/aduth/grunt-jquerymanifest"
            }
        }
    }
});

grunt.loadNpmTasks('grunt-jquerymanifest');

grunt.registerTask('default', ['jquerymanifest']);

```

## Automatic Mappings

The following manifest properties are automatically mapped from `package.json`:

* `name` and `title` - Package `name`
* `author` - Generates `people` object using package `author` as object, or with name as `author` if string
* `licenses` - Generates `licenses` array using package `license` as object, or if string, with type as `license` and url as `http://opensource.org/licenses/<licensename>` (always check to ensure link is valid with license name)
* `dependencies` - Defaults to `jQuery: "*"` if not otherwise defined in `package.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 a `homepage` or `demo` 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)

---
_Source: https://npm.io/package/grunt-jquerymanifest · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._