grunt-play-routes-json

Convert your play routes file to a nicer json formas

Getting Started

This plugin requires Grunt.

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-play-routes-json --save-dev

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

grunt.loadNpmTasks('grunt-play-routes-json');

The "play_routes_json" task

Overview

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

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

Options

options.toJSON

Type: Boolean

Convert a routes file to JSON.

options.fromJSON

Type: Boolean

Convert a json file to routes.

Usage Examples

toJSON

grunt.initConfig({
  play_routes_json: {
    options: {
        toJSON: true
    },
    files: {
      'dest/routes.json': ['routes'],
    },
  },
})

fromJSON

grunt.initConfig({
  play_routes_json: {
    options: {
      fromJSON: true
    },
    files: {
      'dest/routes': ['routes.json'],
    },
  },
})

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

(Nothing yet)

License

Copyright (c) 2014 charliedowler. Licensed under the MIT license.