Skip to content

wix-incubator/grunt-react-templates

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM version build status

grunt-react-templates

React Templates grunt task

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:

Installation

npm install grunt-react-templates --save-dev

Usage

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

grunt.loadNpmTasks('grunt-react-templates');

Once you define a target inside the task, e.g. dist, you can run

$ grunt reactTemplates:dist

or:

$ grunt react-templates:dist

Configuration

In your project's Gruntfile, add a section named reactTemplates to the data object passed into grunt.initConfig(). The options (and defaults) are:

grunt.initConfig({
  reactTemplates: {
    dist: {
      src: ['**/*.rt'] //glob patterns of files to be processed
      options: {
        modules: 'none',  //possible values: (amd|commonjs|es6|typescript|none)
        format: 'stylish' //possible values: (stylish|json)
      }
    }
  }
})

for more options, see the react-templates cli docs.

License

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