This is the readme for version 3.0.0. For the 1.0 readme visit here.
Install this grunt plugin next to your project's Gruntfile.js. You also need to install webpack yourself, this grunt plugin does not install webpack itself.
yarn add webpack grunt-webpack --dev
You can still use npm
npm i webpack grunt-webpack --save-dev
If you also want to use the webpack-dev-server task you also need to install webpack-dev-server
yarn add webpack-dev-server --dev
Then add this line to your project's Gruntfile.js
gruntfile:
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({ ... });
grunt.loadNpmTasks('grunt-webpack');
};
webpack-grunt
offers two different tasks webpack
and webpack-dev-server
. Both support all webpack options as
can be seen in the webpack documentation. For exceptions and additions see this list.
Type: bool
Default: true
(false
if no TTY present)
Activates or deactivates the progress output of webpack.
Type: bool
Default: false
(true
if watch mode is used and for webpack-dev-server
task)
When set to true the grunt process/task will be kept alive after webpack task is finished. This is especially useful for watch
and webpack-dev-server
as these usually need to run as long as not manually killed.
Type: bool
Default: undefined
Turn on watch mode. This means that after the initial build, webpack will continue to watch for changes in any of the resolved files.
Turning on watch mode also sets the following defaults:
- Default
cache
totrue
- Default
keepalive
totrue
- Default
failOnError
tofalse
Type: bool
Default: true
(false
if watch mode is used)
Will terminate the grunt process when an error happens if set to true
. If set to false
the grunt process will not be immediately terminated on error and instead continue to run.
Type: string
Default: null
When set the stats from webpack will be written to a variable with the name provided in this option. The variable can later be used inside of other grunt tasks with template tags <%= %>
.
...
storeStatsTo: "webpackStats"
...
<%= webpackStats.hash %>
...
For more information about grunt template tags have a look at the grunt docs.
The webpack-dev-server options host
, hotOnly
, inline
, port
and public
which are usually only available in the CLI can also be used in this grunt-plugin.
This is a simple example that requires the webpack config from the config file. It also disables stats in non 'development' environments and enables watch in development.
const webpackConfig = require('./webpack.config');
module.exports = function(grunt) {
grunt.initConfig({
webpack: {
options: {
stats: !process.env.NODE_ENV || process.env.NODE_ENV === 'development'
},
prod: webpackConfig,
dev: Object.assign({ watch: true }, webpackConfig)
}
});
grunt.loadNpmTasks('grunt-webpack');
};
The webpack task in this example has two targets called
prod
anddev
. They can be renamed to everything besidesoptions
. See the grunt docs for more information about targets.
On the command line you can then do the following.
# Run webpack with the `prod` target
> NODE_ENV='production' grunt webpack:prod
# Run webpack with the `dev` target
> grunt webpack:dev
# Run webpack for all targets
> grunt webpack
For more examples and information have a look at the webpack documentation which mostly also applies here besides the noted differences above.
If you encounter this message it means that one of the plugins which are present in your config have circular references. This is totally fine for webpack, but sadly grunt cannot handle these.
To workaround this problem use lazy config loading, by wrapping your config inside a function.
module.exports = function(grunt) {
grunt.initConfig({
webpack: {
myconfig: function() {
return {
plugins: [...]
};
}
}
});
grunt.loadNpmTasks('grunt-webpack');
};
Daniel Tschinder |
Juho Vepsäläinen |
Joshua Wiens |
Kees Kluskens |
Sean Larkin |