DEPRECATED. Adds React.js support to brunch.
Switch branches/tags
Nothing to show
Clone or download
Latest commit b4c792e Jan 26, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib v1.0.9 Apr 3, 2015
src Support babel to transform jsx Apr 3, 2015
test Support babel to transform jsx Apr 3, 2015
.gitignore Initial version: 1.0.0 Oct 24, 2013
.npmignore Initial version: 1.0.0 Oct 24, 2013
CHANGELOG.md v1.0.9 Apr 3, 2015
Makefile Added support for optionally automatically inserting the JSX comment … Oct 24, 2013
README.md Update README.md Jan 26, 2017
package.json v1.0.9 Apr 3, 2015

README.md

🚧 This Plugin Is Deprecated 🚧

This plugin is deprecated in favor of babel-brunch.

react-brunch

Adds React support to brunch by automatically compiling *.jsx files.

Optional

Example config.coffee:

exports.config =
  plugins:
    react:
      transformOptions:
        # options passed through to `react-tools.main.transformWithDetails()`
        harmony: yes    # include some es6 transforms
        sourceMap: no   # generate inline source maps
        stripTypes: no  # strip type annotations
      # if you use babel to transform jsx, transformOptions would be passed though to `babel.transform()`
      # See: http://babeljs.io/docs/usage/options/
      babel: false
  # Usual brunch config stuf...
  files:
    javascripts:
      joinTo: 'app.js'
    stylesheets:
      joinTo: 'app.css'
    templates:
      joinTo: 'app.js'

Notes

react-brunch only supports compiling *.jsx files. It doesn't peek at *.js to see if they have the React-ify comment header. I doubt it ever will. Here's why:

Any .js file should be browser loadable. Embedding JSX will break in any JS environment. Therefore, I chose to have react-brunch only pre-processes .jsx files.

Usage

Install the plugin via npm with npm install --save-dev react-brunch.

Or, do manual install:

  • Add "react-brunch": "x.y.z" to package.json of your brunch app. Pick a plugin version that corresponds to your minor (y) brunch version.
  • If you want to use git version of plugin, add "react-brunch": "git+ssh://git@github.com:brunch/react-brunch.git".

Credit

This is based on Paul Miller's javascript-brunch project and adjusted to compile React (.jsx) files.

License

The MIT License (MIT)

Copyright (c) 2017 Matt McCray

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.