refactor(all): ports progress from a recent project that better supports isomorphic rendering

Author: David Zukowski

.eslintrc

@@ -10,8 +10,10 @@
     "destructuring": 1
   },
   "globals": {
-    "__DEV__"  : false,
-    "__PROD__" : false
+    "__DEV__"    : false,
+    "__PROD__"   : false,
+    "__CLIENT__" : false,
+    "__SERVER__" : false
   },
   "plugins": [],
   "rules": {
@@ -67,7 +69,7 @@
     "no-labels": 2,
     "no-lone-blocks": 2,
     "no-loop-func": 2,
-    "no-multi-spaces": [1, {
+    "no-multi-spaces": [0, {
       "exceptions": {}
     }],
     "no-multi-str": 2,
@@ -104,7 +106,7 @@
     "no-undef": 2,
     "no-undef-init": 0,
     "no-undefined": 2,
-    "no-unused-vars": 1,
+    "no-unused-vars": 0,
     "no-use-before-define": 2,
 
     "array-bracket-spacing": 0,
@@ -149,7 +151,6 @@
     "no-spaced-func": 2,
     "no-ternary": 0,
     "no-trailing-spaces": 1,
-    "no-multiple-empty-lines": 1,
     "no-underscore-dangle": 0,
     "no-unneeded-ternary": 2,
     "object-curly-spacing": [1, "always"],
@@ -191,7 +192,7 @@
     "no-this-before-super": 2,
     "no-var": 0,
     "object-shorthand": 0,
-    "perfer-const": 1,
+    "prefer-const": 1,
 
     "max-depth": [2, 3],
     "max-len": [2, 80, 2],

.travis.yml

@@ -1,9 +1,10 @@
 language: node_js
 node_js:
+  - "0.12"
   - "iojs"
 
 install:
   - npm install
 
 script:
-  - npm run deploy
+  - NODE_ENV=production npm run deploy

LICENSE

@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,50 +1,2 @@
-< Wirk />
-=========
-[![Build Status](https://travis-ci.org/davezuko/wirk-starter.svg?branch=master)](https://travis-ci.org/davezuko/wirk-starter/)
-
-A basic starter kit that gives you just enough boilerplate to start building Isomorphic React applications with Koa.js, while staying out of your way.
-
-Requirements
-------------
-IO.js is recommended, with --harmony flag enabled if you're not using our predefined npm scripts.
-
-Features
---------
-* Webpack
-  * Separate client and server bundles
-  * Default loaders for `.js`, `.jsx` and `.css` (relax, it's with PostCSS)
-  * Hot Module Replacement with the help of React Hot Loader
-* Development scripts to enable live-reloading with hot module replacement
-* Koa.js as a back-end server
-* Jade for html pre-processing
-* Easy environment-specific configuration, which already includes:
-  * Client bundle splitting in production mode
-  * CSS Extraction in production mode
-
-Installation
--------------
-
-Install project dependencies with:
-```
-npm run setup
-```
-
-Once this is done, you can either run the development server with
-
-```
-npm run dev
-
-// or
-
-npm run dev:quiet // disables verbose debugging
-```
-
-or compile the application to disk for use with the server
-
-```
-npm run build && npm run server:start
-```
-
-Configuration
--------------
-Basic project configuration can be found in `~/confg/index.js` and includes options for source and dist directories, default ports, and a list of vendor dependencies (used for bundle splitting during client compilation). In the future this file will hopefully become more powerful so that the application can be more heavily tweaked without having to dig through the source.
+Isomorphic React Webpack Starter Kit
+====================================

app/components/app/index.jsx

@@ -0,0 +1,5 @@
+export default (config) => {
+  config.singleRun = false;
+
+  return config;
+};

app/entry-points/client.js

@@ -0,0 +1,12 @@
+import { DIST_DIRNAME } from '../../../config';
+
+export default (config) => {
+  config.singleRun = true;
+  config.reporters = ['spec', 'coverage'];
+  config.coverageReporter = {
+    type : 'html',
+    dir  : `${DIST_DIRNAME}/coverage/`
+  };
+
+  return config;
+};

app/entry-points/server.js

@@ -0,0 +1,47 @@
+import { NODE_ENV, SRC_DIRNAME } from '../../config';
+import makeWebpackConfig from '../webpack/make-config';
+
+const KARMA_ENTRY = 'karma.entry.js';
+const WEBPACK_CONFIG = makeWebpackConfig(
+  require('../webpack/client')('development')
+);
+
+function makeDefaultConfig () {
+  return {
+    files : [
+      './node_modules/phantomjs-polyfill/bind-polyfill.js',
+      `./${KARMA_ENTRY}`
+    ],
+    frameworks : ['chai', 'mocha'],
+    preprocessors : {
+      [KARMA_ENTRY] : ['webpack'],
+      [`${SRC_DIRNAME}/**/*.js`] : ['webpack']
+    },
+    reporters : ['spec'],
+    browsers : ['PhantomJS'],
+    webpack : {
+      devtool : 'inline-source-map',
+      resolve : WEBPACK_CONFIG.resolve,
+      module  : {
+        loaders : WEBPACK_CONFIG.module.loaders
+      }
+    },
+    webpackMiddleware : {
+      noInfo : true
+    },
+    plugins: [
+      require('karma-webpack'),
+      require('karma-mocha'),
+      require('karma-chai'),
+      require('karma-coverage'),
+      require('karma-phantomjs-launcher'),
+      require('karma-spec-reporter')
+    ]
+  };
+}
+
+export default function (karmaConfig) {
+  return karmaConfig.set(
+    require(`./configs/_${NODE_ENV}`)(makeDefaultConfig())
+  );
+};

app/styles/core.css

@@ -1,18 +1,15 @@
 import webpack from 'webpack';
 import ExtractTextPlugin from 'extract-text-webpack-plugin';
-import { VENDOR_DEPENDENCIES } from '../../../config';
 
 export default function (config) {
-  config.entry.vendor = VENDOR_DEPENDENCIES;
   config.plugins.push(
-    new webpack.optimize.CommonsChunkPlugin('vendor', '[name].[hash].js'),
     new ExtractTextPlugin('[name].[contenthash].css')
   );
 
   config.module.loaders = config.module.loaders.map(loader => {
 
     // Extract CSS to a file
-    if (/\.css/.test(loader.test)) {
+    if (/css/.test(loader.test)) {
       loader.loader = ExtractTextPlugin.extract(
         loader.loaders[0], loader.loaders.slice(1).join('!')
       );

build/karma/configs/_development.js

@@ -1,18 +1,16 @@
 import webpack from 'webpack';
-import autoprefixer from 'autoprefixer-core';
-import csswring from 'csswring';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
 import makeConfig from '../make-config';
-import { inSrc, inDist } from '../../../lib/path';
-import { NODE_ENV } from '../../../lib/environment';
+import { inSrc, inDist, NODE_ENV, VENDOR_DEPENDENCIES } from '../../../config';
 
 const config = makeConfig({
   name   : 'Client',
   target : 'web',
   entry  : {
     app : [
       inSrc('entry-points/client')
-    ]
+    ],
+    vendor : VENDOR_DEPENDENCIES
   },
   output : {
     filename : '[name].[hash].js',
@@ -31,18 +29,25 @@ config.plugins.push(
   new HtmlWebpackPlugin({
     template : inSrc('index.html'),
     hash     : true
-  })
+  }),
+  new webpack.optimize.CommonsChunkPlugin('vendor', '[name].[hash].js')
 );
 
 // ------------------------------------
 // Client-Specific Loaders
 // ------------------------------------
 config.module.loaders.push(
   {
-    test : /\.css$/,
-    loaders : ['style', 'css', 'postcss']
+    test : /\.scss$/,
+    loaders : [
+      'style-loader',
+      'css-loader',
+      'autoprefixer?browsers=last 2 version',
+      `sass-loader?includePaths[]=${inSrc('styles')}`
+    ]
   }
-)
-config.postcss = () => [autoprefixer, csswring]
+);
 
-export default require(`./_${NODE_ENV}`)(config);
+export default (configName) => {
+  return require(`./_${configName || NODE_ENV}`)(config);
+};

build/karma/configs/_production.js

@@ -1,7 +1,13 @@
 import assign from 'object-assign';
 import webpack from 'webpack';
-import { inProject, inSrc, inDist } from '../../lib/path';
-import { NODE_ENV, __DEV__, __PROD__ } from '../../lib/environment';
+import {
+  NODE_ENV,
+  inProject,
+  inSrc,
+  SRC_DIRNAME,
+  __DEV__,
+  __PROD__
+} from '../../config';
 
 function makeDefaultConfig () {
   const config = {
@@ -26,23 +32,25 @@ function makeDefaultConfig () {
         components  : inSrc('components'),
         constants   : inSrc('constants'),
         dispatchers : inSrc('dispatchers'),
+        layouts     : inSrc('layouts'),
         models      : inSrc('models'),
         services    : inSrc('services'),
         stores      : inSrc('stores'),
-        styles      : inSrc('styles')
+        styles      : inSrc('styles'),
+        views       : inSrc('views')
       }
     },
     module : {
       preLoaders : [
         {
-          test : [/\.js$/],
+          test : /\.(js|jsx)?$/,
           loaders : ['eslint-loader'],
-          exclude : /node_modules/
+          include : inProject(SRC_DIRNAME)
         }
       ],
       loaders : [{
-        test : [/\.(js|jsx)?$/],
-        include : inProject('app'),
+        test : /\.(js|jsx)?$/,
+        include : inProject(SRC_DIRNAME),
         loaders : ['babel?optional[]=runtime&stage=0']
       }]
     },

build/karma/make-config.js

@@ -1,10 +1,9 @@
 import webpack from 'webpack';
 import makeConfig from '../make-config';
-import { inSrc, inDist } from '../../../lib/path';
-import { NODE_ENV } from '../../../lib/environment';
+import { inSrc, inDist, NODE_ENV } from '../../../config';
 
 const config = makeConfig({
-  name   : 'Server',
+  name   : 'server',
   target : 'node',
   entry  : {
     app : [
@@ -15,7 +14,8 @@ const config = makeConfig({
     filename : 'index.js',
     path     : inDist('server'),
     libraryTarget : 'commonjs2'
-  }
+  },
+  preloaders : []
 });
 
 // ------------------------------------
@@ -28,4 +28,20 @@ config.plugins.push(
   })
 );
 
-export default require(`./_${NODE_ENV}`)(config);
+// ------------------------------------
+// Server-Specific Loaders
+// ------------------------------------
+config.module.loaders.push(
+  {
+    test : /\.scss$/,
+    loaders : [
+      'css/locals?module&localIdentName=[name]__[local]___[hash:base64:5]',
+      'autoprefixer?browsers=last 2 version',
+      `sass-loader?includePaths[]=${inSrc('styles')}`
+    ]
+  }
+);
+
+export default (configName) => {
+  return require(`./_${configName || NODE_ENV}`)(config);
+};