Skip to content

Commit

Permalink
docs: add Index and minor changes
Browse files Browse the repository at this point in the history
Update webpack-addon to `@webpack-cli/webpack-scaffold`
Left installation part for *First-time contributors*
  • Loading branch information
rishabh3112 committed Dec 17, 2018
1 parent ad02e26 commit 3920314
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion packages/webpack-scaffold/README.md
@@ -1,17 +1,26 @@
# webpack-scaffold

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

# API

1. [parseValue()](#parsevalue)
2. [createArrowFunction()](#createarrowfunction)
3. [createRegularFunction()](#createregularfunction)
4. [createDynamicPromise()](#createdynamicpromise)
5. [createAssetFilterFunction()](#createassetfilterfunction)
6. [createExternalFunction()](#createexternalfunction)
7. [createRequire()](#createrequire)
8. Inquirer: [List](#list), [RawList](#rawlist), [CheckList](#checklist), [Input](#input), [InputValidate](#inputvalidate), [Confirm](#confirm)
## 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;
const parseValue = require('@webpack-cli/webpack-scaffold').parseValue;

this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue('\t')
// sourcePrefix: '\t'
Expand Down

0 comments on commit 3920314

Please sign in to comment.