1.4.0

Use defaultConfig.port in dev env instead of hard coded 8000

CHANGELOG.md

@@ -1,5 +1,23 @@
 # react-webpack-template - Changelog
 
+## 1.4.0:
+
+1. Refactored webpack config to use Object.assign instead of lodash
+2. Added dynamic port for webpack dev server (provided by [kashiif](https://github.com/kashiif))
+
+## 1.3.1:
+
+1. Removed karma-phantomjs-shim (with PhantomJS 2 there is no need for shims anymore)
+
+## 1.3.0:
+
+1. Updated phantomjs to 2.0
+
+## 1.2.1:
+
+1. Updated lodash to latest stable version
+2. Cleaned up formatting of unittests
+
 ## 1.2.0:
 
 1. Updated core-js to new 2.0 stable

README.md

@@ -9,15 +9,12 @@ The following features are currently included:
 
 - [x] Webpack and Webpack-Dev-Server, including hot-loader
 - [x] Babel and JSX
-- [x] Mocha Unit tests (*optional*)
+- [x] Mocha Unit tests
 - [x] esLint Support
 - [x] No dependency on grunt, gulp or the next hot taskrunner!
 - [x] Support for environment-specific configuration files
 - [x] Support for code coverage via [isparta-loader](https://github.com/deepsweet/isparta-loader)
 
-## Todo
-- [ ] Better performance for webpack builds
-
 ## What is it for?
 This template can be used directly for the creation of new projects. When using it like this, make sure to ___not___ install it via npm but download it directly. The template is (nearly) useless for itself when downloaded via npm!
 
@@ -111,3 +108,4 @@ react-webpack-template is available under MIT-License and can therefore be used
 - Christian Schilling (cs@weblogixx.de)
 - Martin Jul (martin@mjul.com)
 - Stephan Herzog (sthzgvie@gmail.com)
+- Kashif Iqbal Khan

cfg/base.js

@@ -1,9 +1,6 @@
 'use strict';
 let path = require('path');
-
-let port = 8000;
-let srcPath = path.join(__dirname, '/../src');
-let publicPath = '/assets/';
+let defaultSettings = require('./defaults');
 
 // Additional npm or bower modules to include in builds
 // Add all foreign plugins you may need into this array
@@ -14,65 +11,32 @@ let additionalPaths = [];
 
 module.exports = {
   additionalPaths: additionalPaths,
-  port: port,
+  port: defaultSettings.port,
   debug: true,
+  devtool: 'eval',
   output: {
     path: path.join(__dirname, '/../dist/assets'),
     filename: 'app.js',
-    publicPath: publicPath
+    publicPath: defaultSettings.publicPath
   },
   devServer: {
     contentBase: './src/',
     historyApiFallback: true,
     hot: true,
-    port: port,
-    publicPath: publicPath,
+    port: defaultSettings.port,
+    publicPath: defaultSettings.publicPath,
     noInfo: false
   },
   resolve: {
     extensions: ['', '.js', '.jsx'],
     alias: {
-      actions: srcPath + '/actions/',
-      components: srcPath + '/components/',
-      sources: srcPath + '/sources/',
-      stores: srcPath + '/stores/',
-      styles: srcPath + '/styles/',
-      config: srcPath + '/config/' + process.env.REACT_WEBPACK_ENV
+      actions: `${defaultSettings.srcPath}/actions/`,
+      components: `${defaultSettings.srcPath}/components/`,
+      sources: `${defaultSettings.srcPath}/sources/`,
+      stores: `${defaultSettings.srcPath}/stores/`,
+      styles: `${defaultSettings.srcPath}/styles/`,
+      config: `${defaultSettings.srcPath}/config/` + process.env.REACT_WEBPACK_ENV
     }
   },
-  module: {
-    preLoaders: [
-      {
-        test: /\.(js|jsx)$/,
-        include: srcPath,
-        loader: 'eslint-loader'
-      }
-    ],
-    loaders: [
-      {
-        test: /\.css$/,
-        loader: 'style-loader!css-loader'
-      },
-      {
-        test: /\.sass/,
-        loader: 'style-loader!css-loader!sass-loader?outputStyle=expanded&indentedSyntax'
-      },
-      {
-        test: /\.scss/,
-        loader: 'style-loader!css-loader!sass-loader?outputStyle=expanded'
-      },
-      {
-        test: /\.less/,
-        loader: 'style-loader!css-loader!less-loader'
-      },
-      {
-        test: /\.styl/,
-        loader: 'style-loader!css-loader!stylus-loader'
-      },
-      {
-        test: /\.(png|jpg|gif|woff|woff2)$/,
-        loader: 'url-loader?limit=8192'
-      }
-    ]
-  }
+  module: {}
 };

cfg/defaults.js

@@ -0,0 +1,60 @@
+/**
+ * Function that returns default values.
+ * Used because Object.assign does a shallow instead of a deep copy.
+ * Using [].push will add to the base array, so a require will alter
+ * the base array output.
+ */
+'use strict';
+
+const path = require('path');
+const srcPath = path.join(__dirname, '/../src');
+const dfltPort = 8000;
+
+/**
+ * Get the default modules object for webpack
+ * @return {Object}
+ */
+function getDefaultModules() {
+  return {
+    preLoaders: [
+      {
+        test: /\.(js|jsx)$/,
+        include: srcPath,
+        loader: 'eslint-loader'
+      }
+    ],
+    loaders: [
+      {
+        test: /\.css$/,
+        loader: 'style-loader!css-loader'
+      },
+      {
+        test: /\.sass/,
+        loader: 'style-loader!css-loader!sass-loader?outputStyle=expanded&indentedSyntax'
+      },
+      {
+        test: /\.scss/,
+        loader: 'style-loader!css-loader!sass-loader?outputStyle=expanded'
+      },
+      {
+        test: /\.less/,
+        loader: 'style-loader!css-loader!less-loader'
+      },
+      {
+        test: /\.styl/,
+        loader: 'style-loader!css-loader!stylus-loader'
+      },
+      {
+        test: /\.(png|jpg|gif|woff|woff2)$/,
+        loader: 'url-loader?limit=8192'
+      }
+    ]
+  };
+}
+
+module.exports = {
+  srcPath: srcPath,
+  publicPath: '/assets/',
+  port: dfltPort,
+  getDefaultModules: getDefaultModules
+};

cfg/dev.js

@@ -2,31 +2,31 @@
 
 let path = require('path');
 let webpack = require('webpack');
-let _ = require('lodash');
-
 let baseConfig = require('./base');
+let defaultSettings = require('./defaults');
 
 // Add needed plugins here
 let BowerWebpackPlugin = require('bower-webpack-plugin');
 
-let config = _.merge({
+let config = Object.assign({}, baseConfig, {
   entry: [
-    'webpack-dev-server/client?http://127.0.0.1:8000',
+    'webpack-dev-server/client?http://127.0.0.1:' + defaultSettings.port,
     'webpack/hot/only-dev-server',
     './src/index'
   ],
   cache: true,
-  devtool: 'eval',
+  devtool: 'eval-source-map',
   plugins: [
     new webpack.HotModuleReplacementPlugin(),
     new webpack.NoErrorsPlugin(),
     new BowerWebpackPlugin({
       searchResolveModulesDirectories: false
     })
-  ]
-}, baseConfig);
+  ],
+  module: defaultSettings.getDefaultModules()
+});
 
-// Add needed loaders
+// Add needed loaders to the defaults here
 config.module.loaders.push({
   test: /\.(js|jsx)$/,
   loader: 'react-hot!babel-loader',

cfg/dist.js

@@ -2,14 +2,14 @@
 
 let path = require('path');
 let webpack = require('webpack');
-let _ = require('lodash');
 
 let baseConfig = require('./base');
+let defaultSettings = require('./defaults');
 
 // Add needed plugins here
 let BowerWebpackPlugin = require('bower-webpack-plugin');
 
-let config = _.merge({
+let config = Object.assign({}, baseConfig, {
   entry: path.join(__dirname, '../src/index'),
   cache: false,
   devtool: 'sourcemap',
@@ -25,9 +25,11 @@ let config = _.merge({
     new webpack.optimize.OccurenceOrderPlugin(),
     new webpack.optimize.AggressiveMergingPlugin(),
     new webpack.NoErrorsPlugin()
-  ]
-}, baseConfig);
+  ],
+  module: defaultSettings.getDefaultModules()
+});
 
+// Add needed loaders to the defaults here
 config.module.loaders.push({
   test: /\.(js|jsx)$/,
   loader: 'babel',

karma.conf.js

@@ -9,7 +9,7 @@ module.exports = function(config) {
     ],
     port: 8080,
     captureTimeout: 60000,
-    frameworks: [ 'phantomjs-shim', 'mocha', 'chai' ],
+    frameworks: [ 'mocha', 'chai' ],
     client: {
       mocha: {}
     },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-webpack-template",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "A base skeleton template for react and webpack without task runners",
   "main": "server.js",
   "scripts": {
@@ -56,16 +56,14 @@
     "karma-coverage": "^0.5.3",
     "karma-mocha": "^0.2.0",
     "karma-mocha-reporter": "^1.1.1",
-    "karma-phantomjs-launcher": "^0.2.1",
-    "karma-phantomjs-shim": "^1.1.1",
+    "karma-phantomjs-launcher": "^1.0.0",
     "karma-sourcemap-loader": "^0.3.5",
     "karma-webpack": "^1.7.0",
-    "lodash": "^3.10.1",
     "minimist": "^1.2.0",
     "mocha": "^2.2.5",
     "null-loader": "^0.1.1",
     "open": "0.0.5",
-    "phantomjs": "^1.9.18",
+    "phantomjs-prebuilt": "^2.0.0",
     "react-addons-test-utils": "^0.14.0",
     "react-hot-loader": "^1.2.9",
     "rimraf": "^2.4.3",

server.js

@@ -1,12 +1,13 @@
 /*eslint no-console:0 */
+'use strict';
 require('core-js/fn/object/assign');
-var webpack = require('webpack');
-var WebpackDevServer = require('webpack-dev-server');
-var config = require('./webpack.config');
-var open = require('open');
+const webpack = require('webpack');
+const WebpackDevServer = require('webpack-dev-server');
+const config = require('./webpack.config');
+const open = require('open');
 
 new WebpackDevServer(webpack(config), config.devServer)
-.listen(config.port, 'localhost', function(err) {
+.listen(config.port, 'localhost', (err) => {
   if (err) {
     console.log(err);
   }

src/config/base.js

@@ -1,6 +1,5 @@
 'use strict';
 
-
 // Settings configured here will be merged into the final config object.
 export default {
 }

src/config/dev.js

@@ -2,7 +2,6 @@
 
 import baseConfig from './base';
 
-
 let config = {
   appEnv: 'dev'  // feel free to remove the appEnv property here
 };

src/config/dist.js

@@ -2,10 +2,8 @@
 
 import baseConfig from './base';
 
-
 let config = {
   appEnv: 'dist'  // feel free to remove the appEnv property here
 };
 
 export default Object.freeze(Object.assign({}, baseConfig, config));
-

src/config/test.js

@@ -2,10 +2,8 @@
 
 import baseConfig from './base';
 
-
 let config = {
   appEnv: 'test'  // don't remove the appEnv property here
 };
 
 export default Object.freeze(Object.assign(baseConfig, config));
-

test/components/MainTest.js

@@ -11,13 +11,13 @@ import createComponent from 'helpers/shallowRenderHelper';
 import Main from 'components/Main';
 
 describe('MainComponent', () => {
-    let MainComponent;
+  let MainComponent;
 
-    beforeEach(() => {
-      MainComponent = createComponent(Main);
-    });
+  beforeEach(() => {
+    MainComponent = createComponent(Main);
+  });
 
-    it('should have its component name as default className', () => {
-      expect(MainComponent.props.className).to.equal('index');
-    });
+  it('should have its component name as default className', () => {
+    expect(MainComponent.props.className).to.equal('index');
+  });
 });

webpack.config.js

@@ -1,10 +1,10 @@
 'use strict';
 
-var path = require('path');
-var args = require('minimist')(process.argv.slice(2));
+const path = require('path');
+const args = require('minimist')(process.argv.slice(2));
 
 // List of allowed environments
-var allowedEnvs = ['dev', 'dist', 'test'];
+const allowedEnvs = ['dev', 'dist', 'test'];
 
 // Set the correct environment
 var env;
@@ -18,31 +18,22 @@ if(args._.length > 0 && args._.indexOf('start') !== -1) {
 process.env.REACT_WEBPACK_ENV = env;
 
 // Get available configurations
-var configs = {
+const configs = {
   base: require(path.join(__dirname, 'cfg/base')),
   dev: require(path.join(__dirname, 'cfg/dev')),
   dist: require(path.join(__dirname, 'cfg/dist')),
   test: require(path.join(__dirname, 'cfg/test'))
 };
 
-/**
- * Get an allowed environment
- * @param  {String}  env
- * @return {String}
- */
-function getValidEnv(env) {
-  var isValid = env && env.length > 0 && allowedEnvs.indexOf(env) !== -1;
-  return isValid ? env : 'dev';
-}
-
 /**
  * Build the webpack configuration
- * @param  {String} env Environment to use
+ * @param  {String} wantedEnv The wanted environment
  * @return {Object} Webpack config
  */
-function buildConfig(env) {
-  var usedEnv = getValidEnv(env);
-  return configs[usedEnv];
+function buildConfig(wantedEnv) {
+  let isValid = wantedEnv && wantedEnv.length > 0 && allowedEnvs.indexOf(wantedEnv) !== -1;
+  let validEnv = isValid ? wantedEnv : 'dev';
+  return configs[validEnv];
 }
 
 module.exports = buildConfig(env);