Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Grunt task for compiling Facebook React's .jsx templates into .js
JavaScript

Merge pull request #54 from asponring/patch-1

Added a semicolon to line of JS in Readme
latest commit 9726fcadb2
@ericclemmons authored

README.md

grunt-react

Build Status Dependencies devDependencies

Grunt task for compiling Facebook React's JSX templates into JavaScript.

It also works great with grunt-browserify!

Getting Started

This plugin requires Grunt ~0.4.0

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-react --save-dev

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

grunt.loadNpmTasks('grunt-react');

The "react" task

Overview

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

grunt.initConfig({
  react: {
    single_file_output: {
      files: {
        'path/to/output/dir/output.js': 'path/to/jsx/templates/dir/input.jsx'
      }
    },
    combined_file_output: {
      files: {
        'path/to/output/dir/combined.js': [
          'path/to/jsx/templates/dir/input1.jsx',
          'path/to/jsx/templates/dir/input2.jsx'
        ]
      }
    },
    dynamic_mappings: {
      files: [
        {
          expand: true,
          cwd: 'path/to/jsx/templates/dir',
          src: ['**/*.jsx'],
          dest: 'path/to/output/dir',
          ext: '.js'
        }
      ]
    }
  },
})

Options

These options are passed to react-tools.

options.extension

Type: String Default value: js

Extension of files to search for JSX-syntax & convert to JS.

options.ignoreMTime

Type: Boolean Default value: false

Speed up compilation of JSX files by skipping files not modified since last pass.

options.harmony

Type: Boolean Default value: false

Turns on JS transformations such as ES6 Classes.

options.sourceMap

Type: Boolean Default value: false

Append inline source map at the end of the transformed source

Turns on JS transformations such as ES6 Classes.

options.es6module

Type: Boolean Default value: false

Allows use of ES6 module syntax. This option does not affect ES6 transformations enabled or disabled by options.harmony.


Recommended Usage

Writing your applications in CommonJS format will allow you to use Browserify to concatenate your files. Plus, with grunt-react, your templates will be converted from JSX to JS automatically!

First, install grunt-browserify to your project:

npm install grunt-browserify --save-dev

Second, register grunt-browserify in your Gruntfile:

grunt.loadNpmTasks('grunt-browserify');

Finally, add the following task to your Gruntfile:

browserify:     {
  options:      {
    transform:  [ require('grunt-react').browserify ]
  },
  app:          {
    src:        'path/to/source/main.js',
    dest:       'path/to/target/output.js'
  }
}

You've successfully concatenated your JSX & JS files into one file!


Usage Examples

Recommended Options

I recommend naming your React Components with the .jsx extension:

/**
 * @jsx React.DOM
 */

var MyComponent = React.createClass({
  ...
  render: function() {
    return (
      <p>Howdy</p>
    );
  }
});

Then, set your Gruntfile to use:

grunt.initConfig({
  react: {
    files: {
      expand: true,
      cwd: 'path/to/jsx/templates/dir',
      src: ['**/*.jsx'],
      dest: 'path/to/output/dir',
      ext: '.js'
    }
  },
})

This will output the following:

/**
 * @jsx React.DOM
 */

var MyComponent = React.createClass({displayName: 'MyComponent',
  render: function() {
    return (
      React.DOM.p(null, "Howdy")
    );
  }
});

Troubleshooting

If you encounter a file compilation error, you can run grunt --verbose to see specifics about each file being transformed.

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

  • v0.12.2

    • Move verbose logging to grunt --verbose (#53)
  • v0.12.1

    • Fix issue with Browserify (#46)
  • v0.12.0

    • Update all dependencies & devDependencies
  • v0.11.0

    • Update react-tools to v0.13.0 (#45)
  • v0.10.0

  • v0.9.0

    • Continue compilation despite error. (#31)
  • v0.8.4
    • Add support for harmony via additional options. (#32)
  • v0.8.3
    • Update to react-tools at ^v0.11.0 (#33)
  • v0.8.2
    • Emit react.error for Growl & other notifications (#23)
  • v0.8.1
    • Throw a proper error when React fails (#25)
  • v0.8.0
    • Update to React v0.10.0 (#27)
  • v0.7.0
    • Update to React v0.9.0 (#24)
  • v0.6.0
    • Task changes to allow for flexible file options as found in the grunt-contrib-* projects.
    • Taking hints from grunt-contrib-less to allow for compiling single files separately, dynamic mappings and combining.
    • Removed extension option as this is determined by flexible file matching now.
    • Removed MT time ignoring, this can be easily done with the grunt-newer plugin.
    • Errors are ignored and skipped by default to match how other grunt plugins work.
  • v0.5.2
    • grunt.fail instead of throwing an error (#11)
  • v0.5.1
    • Add file name to errors (#15)
  • v0.5.0
    • Update to react-tools ~v0.5.0
  • v0.4.1
    • Add logging to make it easier catch errors, thanks to @lorefnon (#5)
  • v0.4.0
    • Update to react-tools ~0.4.0, thanks to @Agent-H (#3)
  • v0.3.0
    • No longer uses bin/jsx, thanks to @petehunt (#2)
  • Add ignoreMTime option
  • v0.2.0
    • Add require('grunt-react').browserify() and require('grunt-react').source() for compiling within Node
  • v0.1.0
    • Initial release

Bitdeli Badge

Something went wrong with that request. Please try again.