@halberd/dynamo
v0.1.4-beta
Published
Create Killer API over Webpackv4 configuration
Downloads
6
Maintainers
Readme
_____
| __ \
| | | |_ _ _ __ __ _ _ __ ___ ___
| | | | | | | '_ \ / _` | '_ ` _ \ / _ \
| |__| | |_| | | | | (_| | | | | | | (_) |
|_____/ \__, |_| |_|\__,_|_| |_| |_|\___/
__/ |
|___/
Killer API over Webpack Configuration
Dynamo provides a chainable API over your webpack configuration which lets you do more with your Webpack. With support for webpack4
API
- addHashImports
- setOutput
- setEntry
- addCommonsChunk
- extendConfiguration
- addGlobals
- addPlugins
- setEnvironment
- checkDuplicatePackages
- tap
- addBabelSupport
- dev
- build
- createConfiguration
addHashImports
Add Short Path for Importing Local Modules
Parameters
hashImportsObject
Object with different Keys as Hashed Imports
Examples
new Dynamo
.addHashImports({ Components: './src/components.js' });
Returns Dynamo returns the Dynamo with Alias added.
setOutput
Sets the Output path
Parameters
output
Object Output Object
Examples
new Dynamo
.setOutput({
path: path.join(process.cwd(), './build'),
filename: '[name].js',
libraryTarget: 'commonjs2',
});
Returns Dynamo returns the Dynamo with Output added.
setEntry
Sets the Entry Point
Parameters
entry
Object Entry Object for Configuration
Returns Dynamo with Entry.
addCommonsChunk
Used to add a common chunk to avoid duplicate dependencies across modules
Parameters
chunkregex
Regex Regex test for common chunk
Examples
new Dynamo
.addCommonsChunk(/react|redux/);
Returns Dynamo with modified configurations.
extendConfiguration
Can be used to extend the Configuration
Parameters
configurationModifier
Function Function with Configuration exposed as first Arg
Examples
new Dynamo
.extendConfiguration(config => config.entry = ['./src/client.js']);
Returns Dynamo with modified configurations.
addGlobals
Set Global Variables across the build
Parameters
globals
Object globals and their values, as keys and values
Examples
new Dynamo
.addGlobals({
__CLIENT__: true
});
Returns Dynamo returns the Dynamo with Globals added.
addPlugins
Add Webpack Plugins to Webpack Configuration
Parameters
plugin
Object to add.
Examples
new Dynamo.addPlugins(new UglifyJsPlugin());
Returns Dynamo with plugin added.
setEnvironment
Set Environment Vars across the build
Parameters
args
checkDuplicatePackages
Show warning in case of duplicate packages
tap
Call the passed Callback fn with Dynamo instance as the first Argument
Parameters
fn
addBabelSupport
Adds Support for Babel Transpilation
dev
Run the Webpack Dev Server, must be started with NODE_ENV:development
build
Run the Webpack Build, must be started with NODE_ENV:production
createConfiguration
Used to create Dynamo Configuration, if you don't have webpack installed Useful for updated webpack plugins and configuration
Parameters
createConfigFn
Function Function with first arg as Webpack
Examples
Dynamo.createConfiguration(webpack => configuration(webpack))
Returns Dynamo configurations.