generator-react-webpack

Yeoman generator for ReactJS - lets you quickly set up a project including karma test runner and Webpack module system.

Usage

Install generator-react-webpack:

npm install -g generator-react-webpack

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run yo react-webpack, optionally passing an app name:

yo react-webpack [app-name]

Run grunt build for building and grunt serve for preview in the browser at localhost.

Generators

Available generators:

• react-webpack (aka react-webpack:app)
• react-webpack:component

and for Flux or Reflux :

• react-webpack:action
• react-webpack:store

App

Sets up a new ReactJS app, generating all the boilerplate you need to get started. The app generator also facilitates the following:

1. Configures a Gruntfile to run the app on a local server.
2. Configures Webpack to modularise the app enabling loading of various file formats e.g. JSON, CSS, PNG, etc.
3. Configures Karma to run all tests.
4. Watches for changes and recompiles JS and refreshes the browser.

Example:

yo react-webpack

Component

Generates a JSX component in src/components, its corresponding test in test/spec/components and its style in src/styles.

Example:

yo react-webpack:component foo  //or just: yo react-webpack:c foo

Produces src/components/Foo.js (javascript - JSX):

'use strict';

var React = require('react/addons');

require('styles/componentName.css'); //or .sass,.less etc...

var Foo = React.createClass({
  render: function () {
    return (
        <div>
          <p>Content for Foo</p>
        </div>
      )
  }
});

module.exports = Foo;

And test/spec/components/Foo.js (javascript - jasmine, as seen on http://simonsmith.io/unit-testing-react-components-without-a-dom/):

'use strict';

// Uncomment the following lines to use the react test utilities
// import React from 'react/addons';
// const TestUtils = React.addons.TestUtils;

import createComponent from 'helpers/createComponent';
import Foo from 'components/Foo.js';

describe('Foo', () => {

    let FooComponent;

    beforeEach(() => {
        FooComponent = createComponent(Foo);
    });

    it('should have its component name as default className', () => {
        expect(FooComponent._store.props.className).toBe('Foo');
    });
});

And src/styles/Foo.css (or .sass, .less etc...) :

.Foo {
  border: 1px dashed #f00;
}

rich flag

For all you lazy programmers out there, we've added another shortcut - rich flag:

yo react-webpack:c foofoo --rich

This will give you all of react component's most common stuff :

var React = require('react/addons');

require('styles/Foofoo.sass');

var Foofoo = React.createClass({
  mixins: [],
  getInitialState: function() {
    return {};
  },
  getDefaultProps: function() {},
  componentWillMount: function() {},
  componentDidMount: function() {},
  shouldComponentUpdate: function() {},
  componentDidUpdate: function() {},
  componentWillUnmount: function() {},

  render: function () {
    return (
        <div>
          <p>Content for Foofoo</p>
        </div>
      );
  }
});

module.exports = Foofoo;

Just remove those you don't need, then fill and space out the rest.

Action

When using Flux or Reflux architecture, it generates an actionCreator in src/actions and it's corresponding test in src/spec/actions.

Example:

yo react-webpack:action bar //or just: yo react-webpack:a bar

Will create a file - src/actions/BarActionCreators.js

if 'architecture' is Flux, it Produces :

'use strict';

var BarActionCreators = {

}

module.exports = BarActionCreators;

And if it's Reflux:

'use strict';

var Reflux = require('reflux');

var BarActionCreators  =  Reflux.createActions([

]);


module.exports = BarActionCreators;

and same test for both architectures:

'use strict';

describe('BarActionCreators', () => {
  let action;

  beforeEach(function() {
    action = require('actions/BarActionCreators.js');
  });

  it('should be defined', () => {
    expect(action).toBeDefined();
  });
});

Store

When using Flux or Reflux architecture, it generates a store in src/stores and it's corresponding test in src/spec/stores.

Example:

yo react-webpack:store baz //or just: yo react-webpack:s baz

Will create a file - src/stores/BazStore.js

if 'architecture' is Flux, it Produces :

'use strict';

var EventEmitter = require('events').EventEmitter;
var assign = require('object-assign');
var MainAppDispatcher = require('../dispatcher/MainAppDispatcher');

var BazStore = assign({}, EventEmitter.prototype, {

});

BazStore.dispatchToken = MainAppDispatcher.register(function(action) {

  switch(action.type) {
    default:
  }

});

module.exports = BazStore;

And if it's Reflux:

'use strict';

var Reflux = require('reflux');
//var Actions = require('actions/..');


var BazStore = Reflux.createStore({
  listenables: Actions,


});

module.exports = BazStore;

and same test for both architectures:

'use strict';

describe('BazStore', () => {
  let store;

  beforeEach(() => {
    store = require('stores/BazStore.js');
  });

  it('should be defined', () => {
    expect(store).toBeDefined();
  });
});

Options

Options are available as additional installs to the initial application generation phase.

ReactRouter

A complete routing library for React. This option only adds the basic hooks to get started with react router.

styles language

css, sass, scss, less or stylus

Sets the style file's template and extension

component suffix

js or jsx

Sets the file suffix for generated components. Defaults to "js". Please note that you need to require files including the file ending when using jsx as suffix. Example:

var MyJSComponent = require('./MyJSComponent');
var MyJSX = require('./MyJSX.jsx');

architecture

flux or reflux

es6

If you are using es6, and want to use its export functionality (and not webpack's), just add --es6 flag when you create a component, action or store.

Testing

Running grunt test will run the unit tests with karma. Tests are written using Jasmine by default.

Further Information

Project Structure

The react-webpack generator automates the setup of a ReactJS project using the specific structure detailed below:

project
  - src
    -components
      MainApp.js
      Foo.js
      AnotherComponent.js

    //for flux/reflux
    -actions
      BarActionCreators.js
    -stores
      BazStore.js
    //for flux
    -dispatcher
      FooAppDispatcher

    - styles
      main.css
    index.html
  - test
    - spec
      - components
         MainApp.js
         Foo.js
         AnotherComponent.js

      //for flux/reflux
      -actions
        BarActionCreators.js
      -stores
        BazStore.js

    - helpers
      - react
        addons.js
      phantomjs-shims.js
  Gruntfile.js
  karma.conf.js
  package.json
  webpack.config.js
  webpack.dist.config.js

I have tried to keep the project structure as simple as possible and understand it may not suit everyone.

Naming Components

I have opted to follow @floydophone convention of uppercase for component file naming e.g. Component.js. I am open to suggestions if there is a general objection to this decision.

Modules

Each component is a module and can be required using the Webpack module system. Webpack uses Loaders which means you can also require CSS and a host of other file types. Read the Webpack documentation to find out more.

Grunt

Out the box the Gruntfile is configured with the following:

1. webpack: uses the grunt-webpack plugin to load all required modules and output to a single JS file src/main.js. This is included in the src/index.html file by default and will reload in the browser as and when it is recompiled.
2. webpack-dev-server: uses the webpack-dev-server to watch for file changes and also serve the webpack app in development.
3. connect: uses the grunt-connect plugin to start a webserver at localhost.
4. karma: uses the grunt-karma plugin to load the Karma configuration file karma.conf.js located in the project root. This will run all tests using PhantomJS by default but supports many other browsers. Please note that karma-launchers other than PhantomJS must be installed separately and configured in karma.conf.js.

CSS

Included in the project is the normalize.css script. There is also a src/styles/main.css script that's required by the core src/components/App.js component using Webpack.

Linting

Webpack is automatically configured to run esLint (http://eslint.org) on every file change or build. The configuration can be found in PROJECTROOT/.eslintrc. There are plugins for different editors that use this tool directly:

• linter-eslint for Atom
• Sublime-Linter-eslint for Sublime

You could also use jsxhint, the corresponding rules file is located in PROJECTROOT/.jshintrc. However, the support for jsxhint is planned to be dropped in a later release and only available for backwards compatibility.

Props

Thanks to all who contributed to generator-angular as the majority of code here has been shamelessy sourced from that repos.

Thanks to Edd Hannay for his Webpack optimisations, my local merge and testing meant his additions lost his signature (my fault sorry) so big thanks Edd.

Contribute

Contributions are welcomed. When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

Running Tests

node node_modules/.bin/mocha

License

BSD license