react-noparse
Experimental
This is a webpack configuration helper that aims to improve build times by providing an simple way to exclude large dependencies in development environments. Instead of having webpack load and parse the entire module (and dependency tree), we just use the distributable UMD build instead, like loading from a CDN except it's right on our disk.
I wanted to make this extremely easy to drop into your project, quickly evaluate the impact and remove just as easily.
This tool can be added with a single line of code and removed just as easily. The source is extensively commented, and the tests demonstrate the different configuration options.
How it works:
There are several steps to setting up this configuration:
- Tell webpack to exclude the module (see
module.noParse) - Configure a resolver, so we can still use
requireandimport(seeresolve.alias) - Optionally expose
React, if needed (seeimports-loader)
This module returns a function that will handle the above mutations on your webpack configuration.
Installation
npm install --save-dev react-noparse
Basic Usage
Please see the tests and example. Adding react-noparse to your project is dead simple:
const path = require('path')
const webpack = require('webpack')
const noParse = require('react-noparse').noParse // 1. Grab module
const config = {
devtool: 'cheap-module-eval-source-map',
entry: [
'webpack-hot-middleware/client',
'./src/index'
],
output: {
path: path.join(__dirname, 'dist'),
filename: 'bundle.js',
publicPath: '/dist/'
},
plugins: [
webpack.HotModuleReplacementPlugin(),
webpack.NoErrorsPlugin()
],
module: {
loader: [{
test: /\.js$/,
loaders: ['babel'],
include: path.join(__dirname, 'src')
}]
}
}
module.exports = noParse(true)(config) // 2. Use defaults: React, ReactDOM, ReactRouter
// 3. That's it!
Output:
{
devtool: 'cheap-module-eval-source-map',
entry: [
'webpack-hot-middleware/client',
'./src/index'
],
output: {
path: '<path-to-project>/dist',
filename: 'bundle.js',
publicPath: '/dist/'
},
plugins: [
webpack.HotModuleReplacementPlugin(),
webpack.NoErrorsPlugin()
],
module: {
loaders: [{
test: /\.js$/,
loader: ['babel'],
include: '<path-to-project>/src'
}, {
test: /(react-dom|react-router)\.js$/, // expose React
loader: 'imports?React=react'
}],
noParse: [
/\/react\//g,
/\/react-dom\//g,
/\/react-router\//g
]
},
resolve: {
alias: {
'react
Configuration
In the example above we're using a shorcut syntax with noParse by passing true, which uses the built-in defaults object:
// ...
module.exports = noParse([
React: {
distPath: 'react/dist/react.js',
},
ReactDOM: {
distPath: 'react-dom/dist/react-dom.js',
importReact: true
},
ReactRouter: {
distPath: 'react-router/umd/ReactRouter.js',
importReact: true
}
])(config)
The defaults can be used individually, for example if you only needed React + ReactDOM:
const defaults = required('react-noparse').defaults
// ...
module.exports = noParse([
defaults.React,
defaults.ReactDOM
])(config)
Notes
- the
distPath must point to a UMD build
- you cannot
import x from 'module/x', you must import { x } from 'module'
API
noParse(libs, useMin) : mutatorFn(WebpackConfig) : WebpackConfig
Process libs and return a function that accepts a webpack configuration and appliesmutatations
Param
Type
Description
libs
bool | Array<Object> | Array<String>
All, Path, or Array of Paths(s) to UMD builds
libs[].distPath
string
String of path to dist (required)
libs[].importReact
boolean
Whether or not to expose react
useMin
boolean
Use minified (default=true in production)
defaults : Object
Provide some common configuration defaults:
React: { distPath: 'react/dist/react.js' }
ReactDOM: { distPath: 'react-dom/dist/react-dom.js', importReact: true }
ReactRouter: { distPath: 'react-router/umd/ReactRouter.js', importReact: true }
2016 Justin Greenberg MIT License
: '/node_modules/react/dist/react.js',
'react-dom
Configuration
In the example above we're using a shorcut syntax with __INLINE_CODE_7__ by passing __INLINE_CODE_8__, which uses the built-in __INLINE_CODE_9__ object:
__CODE_BLOCK_3__
The defaults can be used individually, for example if you only needed React + ReactDOM:
__CODE_BLOCK_4__
Notes
- the __INLINE_CODE_10__ must point to a UMD build
- you cannot __INLINE_CODE_11__, you must __INLINE_CODE_12__
API
__INLINE_CODE_13__ : __INLINE_CODE_14__ : __INLINE_CODE_15__
Process libs and return a function that accepts a webpack configuration and appliesmutatations
Param
Type
Description
__INLINE_CODE_16__
__INLINE_CODE_17__ | __INLINE_CODE_18__ | __INLINE_CODE_19__
All, Path, or Array of Paths(s) to UMD builds
__INLINE_CODE_20__
__INLINE_CODE_21__
String of path to dist (required)
__INLINE_CODE_22__
__INLINE_CODE_23__
Whether or not to expose react
__INLINE_CODE_24__
__INLINE_CODE_25__
Use minified (default=__INLINE_CODE_26__ in __INLINE_CODE_27__)
__INLINE_CODE_28__ : __INLINE_CODE_29__
Provide some common configuration defaults:
- __INLINE_CODE_30__: __INLINE_CODE_31__
- __INLINE_CODE_32__: __INLINE_CODE_33__
- __INLINE_CODE_34__: __INLINE_CODE_35__
2016 Justin Greenberg MIT License
: '/node_modules/react-dom/dist/react-dom.js',
'react-router
Configuration
In the example above we're using a shorcut syntax with __INLINE_CODE_7__ by passing __INLINE_CODE_8__, which uses the built-in __INLINE_CODE_9__ object:
__CODE_BLOCK_3__
The defaults can be used individually, for example if you only needed React + ReactDOM:
__CODE_BLOCK_4__
Notes
- the __INLINE_CODE_10__ must point to a UMD build
- you cannot __INLINE_CODE_11__, you must __INLINE_CODE_12__
API
__INLINE_CODE_13__ : __INLINE_CODE_14__ : __INLINE_CODE_15__
Process libs and return a function that accepts a webpack configuration and appliesmutatations
Param
Type
Description
__INLINE_CODE_16__
__INLINE_CODE_17__ | __INLINE_CODE_18__ | __INLINE_CODE_19__
All, Path, or Array of Paths(s) to UMD builds
__INLINE_CODE_20__
__INLINE_CODE_21__
String of path to dist (required)
__INLINE_CODE_22__
__INLINE_CODE_23__
Whether or not to expose react
__INLINE_CODE_24__
__INLINE_CODE_25__
Use minified (default=__INLINE_CODE_26__ in __INLINE_CODE_27__)
__INLINE_CODE_28__ : __INLINE_CODE_29__
Provide some common configuration defaults:
- __INLINE_CODE_30__: __INLINE_CODE_31__
- __INLINE_CODE_32__: __INLINE_CODE_33__
- __INLINE_CODE_34__: __INLINE_CODE_35__
2016 Justin Greenberg MIT License
: '/node_modules/react-router/umd/ReactRouter.js'
}
}
}
Configuration
In the example above we're using a shorcut syntax with __INLINE_CODE_7__ by passing __INLINE_CODE_8__, which uses the built-in __INLINE_CODE_9__ object:
__CODE_BLOCK_3__The defaults can be used individually, for example if you only needed React + ReactDOM:
__CODE_BLOCK_4__Notes
- the __INLINE_CODE_10__ must point to a UMD build
- you cannot __INLINE_CODE_11__, you must __INLINE_CODE_12__
API
__INLINE_CODE_13__ : __INLINE_CODE_14__ : __INLINE_CODE_15__Process libs and return a function that accepts a webpack configuration and appliesmutatations
| Param | Type | Description |
|---|---|---|
| __INLINE_CODE_16__ | __INLINE_CODE_17__ | __INLINE_CODE_18__ | __INLINE_CODE_19__ | All, Path, or Array of Paths(s) to UMD builds |
| __INLINE_CODE_20__ | __INLINE_CODE_21__ | String of path to dist (required) |
| __INLINE_CODE_22__ | __INLINE_CODE_23__ | Whether or not to expose react |
| __INLINE_CODE_24__ | __INLINE_CODE_25__ | Use minified (default=__INLINE_CODE_26__ in __INLINE_CODE_27__) |
Provide some common configuration defaults:
- __INLINE_CODE_30__: __INLINE_CODE_31__
- __INLINE_CODE_32__: __INLINE_CODE_33__
- __INLINE_CODE_34__: __INLINE_CODE_35__
2016 Justin Greenberg MIT License