gem-hunter
Language: JavaScript
[DEPRECATED] Grunt task for compiling Facebook React's .jsx templates into .js
Grunt task for compiling Facebook React's JSX templates into JavaScript.
It also works great with grunt-browserify!
On June 12th, 2015, the React team has deprecated JSTransform and react-tools, which this project uses:
http://facebook.github.io/react/blog/2015/06/12/deprecating-jstransform-and-react-tools.html
Please use grunt-babel instead.
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');
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' } ] } }, })
These options are passed to react-tools.
Type: String
Default value: js
Extension of files to search for JSX-syntax & convert to JS.
Type: Boolean
Default value: false
Speed up compilation of JSX files by skipping files not modified since last pass.
Type: Boolean
Default value: false
Turns on JS transformations such as ES6 Classes.
Type: Boolean
Default value: false
Append inline source map at the end of the transformed source
Turns on JS transformations such as ES6 Classes.
Type: Boolean
Default value: false
Allows use of ES6 module syntax. This option does not affect ES6 transformations enabled or disabled by options.harmony.
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!
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") ); } });
If you encounter a file compilation error, you can run grunt --verbose to see specifics about each file being transformed.
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.
v0.12.2
grunt --verbose (#53)v0.12.1
v0.12.0
dependencies & devDependenciesv0.11.0
react-tools to v0.13.0 (#45)v0.10.0
react-tools to v0.12.0 (#40).
(See release notes: http://facebook.github.io/react/blog/2014/10/28/react-v0.12.html)v0.9.0
v0.8.4
harmony via additional options. (#32)v0.8.3
react-tools at ^v0.11.0 (#33)v0.8.2
react.error for Growl & other notifications (#23)v0.8.1
v0.8.0
v0.7.0
v0.6.0
grunt-contrib-* projects.grunt-contrib-less to allow for compiling single files separately, dynamic mappings and combining.extension option as this is determined by flexible file matching now.grunt-newer plugin.v0.5.2
grunt.fail instead of throwing an error (#11)v0.5.1
v0.5.0
react-tools ~v0.5.0v0.4.1
v0.4.0
v0.3.0
bin/jsx, thanks to @petehunt (#2)Add ignoreMTime option
v0.2.0
require('grunt-react').browserify() and require('grunt-react').source() for compiling within Nodev0.1.0