grunt-requirejs-paths

A helper multitask to create your paths object in main.js for requirejs

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-requirejs-paths --save-dev

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

grunt.loadNpmTasks('grunt-requirejs-paths');

The "paths" task

Overview

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

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

Options

• pathsJson - the path or an array of paths to a json file describing part or all of the requirejs paths object. The json object is made of key value pairs where the value is a string or on object used to build the paths object. You can nest as much as you want, and keys ending in a + a prefixed to nested keys.

  {
      "example+" : {
          "View" : "app/view"
      },
      "template " "text!app/template.html"
  }
   
  // will produce
  paths : {
      'exampleView' : 'app/view'
      'template' : 'text!app/template.html'
  }

  • default : 'paths.json'

• pathsPrefix - An optional prefix to be added before each file path. This should allow you to use the same paths.json for both regular dev and tests. For example if app and tests are sibling directories and both have a main.js file, you can use pathsPrefix : '../app/' for your tests.

• mainTemplate - a template file used to generate your main.js, inside the template the variable paths is the outcome from pathsJson. Note that the template is put into a comment, so that jshint and syntax highlighting still work. When the template is processed, the paths object will come on the line after the comment.

  // sample usage
  (function () {
      'use strict';
   
      require.config({
          // < %= paths %>
      });
   
      require([
          'backbone',
          'routers/router',
          'guideView'
      ], function (Backbone, Router, GuideView) {
          new GuideView().start();
          new Router();
          Backbone.history.start();
      });
  }());

  • default - main.template.js

• main - The path to where you want the final version of the main file to go.

  • default - main.js

• prefixComma - Whether you want a comma prefixed to your paths object. For example if it comes after packages.

  • default - false

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

• 0.0.0 - 2014-03-06 - initial release
• 0.1.0 - 2014-03-06 - features
• 0.1.1 - 2014-03-06 - patches
• 0.1.2 - 2014-03-08 - patches

Compiled file. Do not modify directly. Created: 2014-03-08 07:22:55