README
webpack-scaffold
This is the utility suite for creating a webpack scaffold
, it contains utility functions to help you work with Inquirer prompting and scaffolding.
Installation
npm i -D webpack-cli @webpack-cli/webpack-scaffold
API
- parseValue
- createArrowFunction
- createRegularFunction
- createDynamicPromise
- createAssetFilterFunction
- createExternalFunction
- createRequire
- Inquirer
parseValue
Param: String
Used when you cannot use regular conventions. Handy for examples like RegExp
or output.sourcePrefix
const parseValue = require('@webpack-cli/webpack-scaffold').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
const createArrowFunction = require('@webpack-cli/webpack-scaffold').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
const createRegularFunction = require('@webpack-cli/webpack-scaffold').createRegularFunction;
this.configuration.myScaffold.webpackOptions.entry = createRegularFunction('app.js');
// entry: function() { return 'app.js' }
createDynamicPromise
Param: Array
| String
Used to create a dynamic entry point
const createDynamicPromise = require('@webpack-cli/webpack-scaffold').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
const createAssetFilterFunction = require('@webpack-cli/webpack-scaffold').createAssetFilterFunction;
this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction('js');
// assetFilter: function (assetFilename) { return assetFilename.endsWith('.js'); }
createExternalFunction
Param: String
Used to create a general function from Externals
const createExternalFunction = require('@webpack-cli/webpack-scaffold').createExternalFunction;
this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction('^yourregex