grunt-public-js

grunt-public-js

Automated tasks for public.js

Getting Started

This plugin requires Grunt ~0.4.1

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-public-js --save-dev

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

grunt.loadNpmTasks('grunt-public-js');

The "public-js" task

Overview

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

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

Options

options.type

Type: String

A string with the value of scaffold or lint depending on the use.

options.template

Type: String

A path to your template file representing the test runner code you want to target.

Usage Examples

Default Options

In this example, we want to load Backbone.js, with Underscore.js as a dependency, and then have a qunit test scaffold created, using a QUnit test template.

grunt.initConfig({
  scaffold: {
    options: {
      template: 'test/fixtures/qunit.tmpl',
      source: 'test/fixtures/backbone.js',
      type: 'scaffold'
    },
    files: {
      'dest/backbone_tests.js': [ 'test/fixtures/underscore.js'],
    },
  },
})

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.

Release History

BETA release. Please help this project become more stable.