grunt-validate-webapp

Grunt task to validate a webapp manifest file


Keywords
gruntplugin, webapp, manifest, firefox
License
MPL-2.0
Install
npm install grunt-validate-webapp@0.1.4

Documentation

grunt-validate-webapp

Grunt task to validate a webapp manifest file

Getting Started

This plugin requires Grunt ~0.4.5

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, you may install this plugin with this command:

npm install grunt-validate-webapp --save-dev

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

grunt.loadNpmTasks('grunt-validate-webapp');

The "validatewebapp" task

Overview

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

grunt.initConfig({
  validatewebapp: {
    options: {
      absolute: false,
      packaged: false
    },
    your_target: {
      files: { src: /* list the manifests */ }
    },
  },
});

Options

options.absolute

Type: Bool Default value: false

Determines if icon URLs in the webapp manifest are assumed to be relative to the manifest's location or absolutely to the path the task is run from. Note that this does not affect the appcache manifest location check.

options.packaged

Type: Bool Default value: true

If true the manifest is validated for a packaged app, as in appcache manifests are disallowed.

options.listed

Type: Bool Default value: false

Whether or not this app will be listed on the Marketplace.

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.