1.0.1 • Published 6 years ago

@runner/generator-webpack v1.0.1

Weekly downloads
1
License
GPL-3.0
Repository
github
Last release
6 years ago

Tasks generator for Webpack

build status npm version dependencies status devDependencies status Gitter RunKit

Installation

npm install @runner/generator-webpack

Usage

Add to the scope:

var generator = require('@runner/generator-webpack');

Generate tasks according to the given config:

var tasks = generator({
    mode: 'development',
    entry: 'src/js/main.js',
    output: {
        filename: 'develop.js',
        path: path.resolve('build')
    },
    devtool: 'source-map',
    plugins: [
        new webpack.optimize.OccurrenceOrderPlugin()
    ]
});

Add generated tasks to the runner instance:

var runner = require('@runner/core');

Object.assign(runner.tasks, tasks);

The following tasks will become available:

Task nameDescription
webpack:configprints the current configuration used for generated tasks
webpack:buildperforms webpack compilation
webpack:modulesprints detailed info on files used in the latest compilation
webpack:clearremoves compiled file (source map as well)
webpack:watchstarts file changes monitoring and rebuilds when necessary
webpack:unwatchstops monitoring

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's a Webpack config passed to the compiller instance.

Additional options

It's an object with the following properties:

NameDescription
prefixan affix placed before a task name (default is webpack:)
suffixa string added at the end of a task name (empty by default)

So it's possible to change generated tasks names:

Object.assign(runner.tasks,
    generator(config, {
        prefix: 'js:',
        suffix: ':develop'
    })
);

It will add the following tasks:

  • js:config:develop
  • js:build:develop
  • js:modules:develop
  • js:clear:develop
  • js:watch:develop
  • js:unwatch:develop

Contribution

If you have any problems or suggestions please open an issue according to the contribution rules.

License

@runner/generator-webpack is released under the GPL-3.0 License.