The following is appended to the core Rump API:
This module adds the following tasks:
build:scriptswill process and build scripts with Webpack. For more information on source and destination paths see
rump.configure()below. This task is also added to the
buildtask for single builds as well as the
watchtask for continuous builds.
info:scriptswill display information on what this specific module does, specifically the source and destination paths as well as what files would get processed. This task is also added to the
Redefine options for Rump and Rump modules to follow. In addition to what options Rump and other Rump modules offer, the following options are available alongside default values:
This is the directory where scripts to be processed are contained. This path is
relative to the root source path. (If the default root and scripts path is
used, then the path would be
This is the directory where processed scripts are copied to. This path is
relative to the root destination path. (If the default root and scripts path is
used, then the path would be
This specifies which scripts to process. By default it at least processes all JS files in the top level directory of the root source path for scripts. See the Loaders section below for information on any other extensions are set.
options.environment === 'production')
This specifies whether to minify and uglify generated JS. (minified if
By default JS is minified only if the environment is set to production. (visit
the main Rump repository for more information on environment)
options.environment === 'development')
This specifies whether to include inline source maps to generated JS. (source
maps included if
true) By default source maps are included only if the
environment is set to development. (visit the main Rump repository for more
information on environment)
This specifies identifiers that get injected into scripts as it is getting
processed. By default the only value injected is
process.env.NODE_ENV as a
convenience to only run code in certain environments. Pass in key-value pairs
to define more macros. In fact, this is a convenience for Webpack's
This specifies module names to redefine in scripts as it is getting processed.
Pass in an object with key-value pairs to redefine module names. In fact, this
is a convenience for Webpack's
option. See the Loaders section below for information on any aliases already
This specifies whether to gather common modules that are shared across multiple
generated scripts and place them in a new JS file or add it to an existing JS
file. If value is set to
true, then either a new
common.js file is created
or is appended to an existing
common.js file. If value is a string instead,
then that is the name used instead, whether creating a new file or using an
existing one. (an example is specifying the value
'shared' will result in a
shared.js file) In fact, this is a convenience for Webpack's
This specifies whether to expose exported modules for scripts at the top level
source directory using UMD. If value is set to
true, then exports are
exposed. If value is set to a string, then that string is used to attach to
global namespaces such as the
window property in browsers.
This specifies Webpack loaders to apply to scripts. This is useful for when you
want to add support for things like other languages. Pass in an array of
objects to specify which loaders to apply. In fact, this is a convenience for
Read more about using Webpack loaders
here. See the Loaders
section below for information on any loaders already set.
This specifies any options you want to override in Webpack. This is best if you want to fully make changes in Webpack's configuration.
This specifies options that are sent to UglifyJS through Webpack when minifying. The default options set are:
output:comments: falsecompress:drop_console: truedrop_debugger: true
This contains the generated options that are passed to Webpack and UglifyJS, (from Webpack) respectively, in the Gulp task. This is a good way to see what options are generated based on defaults and overrides.
Rump Scripts will detect loaders available in the project and append items as needed:
json-loaderwill add support for JSON files.
coffee-loaderwill add support for CoffeeScript files. (
html-loaderwill add support to expose HTML files as a string.
babel-loaderwill add support for transpiling JS and JSX using Babel. (
Want support for another loader? Open an issue/PR.