Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ro-ka/grunt-firefox-manifest

Create a Firefox manifest from your projects package.json.
https://github.com/ro-ka/grunt-firefox-manifest

firefox grunt grunt-plugins javascript manifest

Last synced: 8 days ago
JSON representation

Create a Firefox manifest from your projects package.json.

Host: GitHub
URL: https://github.com/ro-ka/grunt-firefox-manifest
Owner: ro-ka
License: mit
Created: 2013-11-26T14:30:47.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2016-02-20T22:49:57.000Z (over 8 years ago)
Last Synced: 2024-10-31T18:12:47.556Z (16 days ago)
Topics: firefox, grunt, grunt-plugins, javascript, manifest
Language: JavaScript
Size: 176 KB
Stars: 0
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT

Awesome Lists containing this project

README

# grunt-firefox-manifest

> Create a Firefox manifest from your projects package.json.

[![Build Status](https://travis-ci.org/ro-ka/grunt-firefox-manifest.png?branch=master)](https://travis-ci.org/ro-ka/grunt-firefox-manifest)

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-firefox-manifest --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-firefox-manifest');
```

## The "firefoxManifest" task

### Overview
In your project's Gruntfile, add a section named `firefoxManifest` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
firefoxManifest: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```

### Options

#### options.packageJson
Type: `String`
Default value: `'package.json '`

The location of the package.json to use as the data source.

#### options.manifest
Type: `String`
Default value: `'manifest.webapp'`

The location where to write the Firefox manifest to.

### Usage Examples

#### Default Options
Using the default options generates a `manifest.webapp` file next to your `package.json`.

```js
grunt.initConfig({
firefoxManifest: {
options: {}
},
});
```

#### Custom Options
If one of the files is located in a different location, pass the path to it as a param:

```js
grunt.initConfig({
firefoxManifest: {
options: {
packageJson: 'app/package.json',
manifest: ' dist/manifest.webapp',
}
},
});
```

## The package.json section

Add a section `firefoxManifest` to your `package.json` where you provide the needed information for the manifest. If you don't provide *name*, *description*, *version* or *developer* in the `firefoxManifest` section, then the fields of the `package.json` will be used instead (*developer* falls back to *author*).

Assume we have a package.json like the following:

```js
{
"name": "My App",
"description": "My App description",
"version": "0.4.0",
"author": {
"name": "The developer",
"email": "[email protected]",
"url": "http://example.com/"
},
"engines": {
"node": ">= 0.8.0"
},
"scripts": {
"test": "grunt test"
},
"firefoxManifest": {
"permissions": {
"geolocation": {
"description": "Required to locate you."
}
},
"icons": {
"128": "/img/icon-128.png"
},
"appcache_path": "/manifest.appcache",
"launch_path": "/"
}
}
```

This will generate the following `manifest.webapp`:

```js
{
"name": "My App",
"description": "My App description",
"version": "0.4.0",
"permissions": {
"geolocation": {
"description": "Required to locate you."
}
},
"icons": {
"128": "/img/icon-128.png"
},
"appcache_path": "/manifest.appcache",
"launch_path": "/",
"developer": {
"name": "The developer",
"email": "[email protected]",
"url": "http://example.com/"
}
}
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History

### 0.1.3
* Fix repository url

### 0.1.2
* Reduce Grunt depencdency version to 0.4.1

### 0.1.1
* Improve Readme

### 0.1.0
* Initial release