Skip to content

Commit

Permalink
Merge pull request #720 from rishabh3112/patch-7
Browse files Browse the repository at this point in the history
docs: update generators README
  • Loading branch information
evenstensberg committed Jan 3, 2019
2 parents 4d9c847 + 1f86c05 commit d82b016
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions packages/generators/README.md
Expand Up @@ -14,21 +14,22 @@ npm i -D webpack-cli @webpack-cli/generators

To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.

## Generators

- Plugin Generator
- Remove Generator
- Update Generator
- Loader Generator
- Init Generator
- Add Generator


### Node

```js
const { addGenerator, addonGenerator, initGenerator, loaderGenerator,
pluginGenerator, removeGenerator, updateGenerator
} = require("@webpack-cli/generators");
// ... compose with yeoman env or add a generator to your own yeoman project
```
```
## Generators

- [**Plugin Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/plugin-generator.ts) : Creates a webpack plugin project, add starter plugin code and runs `webpack-defaults`
- [**Remove Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/remove-generator.ts) : Removes properties from webpack configurations
- [**Update Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/update-generator.ts) : [WIP] Updates properties of webpack configurations
- [**Loader Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/loader-generator.ts) : Creates a webpack loader project, add starter loader code and runs `webpack-defaults`
- [**Init Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/init-generator.ts) : Generates new webapck configuration as per user requirements
- [**Add Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/add-generator.ts) : Add properties to webpack configurations
- [**Addon Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/addon-generator.ts) : Generates a webpack project conforming to `webpack-defaults`
---
[Back to Packages](https://github.com/webpack/webpack-cli/tree/master/packages)

0 comments on commit d82b016

Please sign in to comment.