# webpack-addons

[![Build Status](https://travis-ci.org/webpack-contrib/webpack-addons.svg?branch=master)](https://travis-ci.org/webpack-contrib/webpack-addons)

This is the utility suite for creating a webpack `addon`. It contains utility functions to assist with inquirer prompting and scaffolding.

# API

## parseValue  

Param: `String`

Used when you cannot use regular conventions. Handy for examples like `RegExp` or `output.sourcePrefix`

```js
const parseValue = require('webpack-addons').parseValue;

this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue('\t')
// sourcePrefix: '\t'
```
## createArrowFunction

Param: `String`

Generally used when dealing with an entry point as an arrow function.

```js
const createArrowFunction = require('webpack-addons').createArrowFunction;

this.configuration.myScaffold.webpackOptions.entry = createArrowFunction('app.js')
// entry: () => 'app.js'
```

## createRegularFunction

Param: `String`

Used when creating a function that returns a single value.
```js
const createRegularFunction = require('webpack-addons').createRegularFunction;

this.configuration.myScaffold.webpackOptions.entry = createRegularFunction('app.js')
// entry: function() { return 'app.js' }
```
## createDynamicPromise

Param: `Array` | `String`

Used to create an dynamic entry point.

```js
const createDynamicPromise = require('webpack-addons').createDynamicPromise;

this.confguration.myScaffold.webpackOptions.entry = createDynamicPromise('app.js')
// entry: () => new Promise((resolve) => resolve('app.js'))

this.configuration.myScaffold.webpackOptions.entry = createDynamicPromise(['app.js', 'index.js'])
// entry: () => new Promise((resolve) => resolve(['app.js','index.js']))
```

## createAssetFilterFunction

Param: `String`

Used to create an [assetFilterFunction](https://webpack.js.org/configuration/performance/#performance-assetfilter)

```js
const createAssetFilterFunction = require('webpack-addons').createAssetFilterFunction;

this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction('js')
// assetFilter: function (assetFilename) { return assetFilename.endsWith('.js'); }
```

## createExternalFunction

Param: `String`

Used to create an [general function from Externals](https://webpack.js.org/configuration/externals/#function)

```js
const createExternalFunction = require('webpack-addons').createExternalFunction;

this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction('^yourregex$')]
/*
externals: [
  function(context, request, callback) {
    if (/^yourregex$/.test(request)){
      return callback(null, 'commonjs ' + request);
    }
    callback();
  }

*/
```
## createCommonsChunkPlugin

Param: `String`

Used to create a general [`CommonsChunkPlugin`](https://webpack.js.org/plugins/commons-chunk-plugin/).

```js
const createCommonsChunkPlugin = require('webpack-addons').createCommonsChunkPlugin;

this.configuration.myScaffold.webpackOptions.plugins = [createCommonsChunkPlugin('vendor')]
/*
plugins: [
 new webpack.optimize.CommonsChunkPlugin({
    name: 'vendor',
    filename: 'vendor-[hash].min.js',
  })
*/
```

## createRequire

Param: `String`

Used to create a module in `topScope`

```js
const createRequire = require('webpack-addons').createRequire;

this.configuration.myScaffold.topScope = [createRequire('webpack')]
// const webpack = require('webpack')
```

## [Inquirer](https://github.com/SBoudrias/Inquirer.js/#prompt-types)

### List

Param: `name<String>, message<String>, choices<Array>`

Creates a List from Inquirer
```js
List('entry', 'what kind of entry do you want?', ['Array', 'Function'])
```

### RawList 

Param: `name<String>, message<String>, choices<Array>`

Creates a RawList from Inquirer
```js
RawList('entry', 'what kind of entry do you want?', ['Array', 'Function'])
```

### CheckList

Param: `name<String>, message<String>, choices<Array>`

Creates a CheckList(`checkbox`) from Inquirer
```js
CheckList('entry', 'what kind of entry do you want?', ['Array', 'Function'])
```

### Input 

Param: `name<String>, message<String>`

Creates an Input from Inquirer
```js
Input('entry', 'what is your entry point?')
```

### InputValidate

Param: `name<String>, message<String>, validate<Function>`

Creates an Input from Inquirer
```js
const validation = (value) => {
    if(value.length > 4) {
        return true;
    } else {
        return 'Wow, that was short!'
    }
}
Input('entry', 'what is your entry point?', validation)
```

### Confirm

Param: `name<String>, message<String>`

Creates an Input from Inquirer
```js
Confirm('contextConfirm', 'Is this your context?')
```