webpack/webpack-cli

View on GitHub
packages/generators/README.md

Summary

Maintainability
Test Coverage
# webpack-cli generators

[![NPM Downloads][downloads]][downloads-url]

## Description

This package contains all webpack-cli related yeoman generators.

## Installation

```bash
npm i -D webpack-cli @webpack-cli/generators
```

## Usage

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

### Node

```js
const {
  addonGenerator,
  initGenerator,
  loaderGenerator,
  pluginGenerator,
} = 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/src/plugin-generator.ts) : Creates a webpack plugin project, add starter plugin code
- [**Loader Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/src/loader-generator.ts) : Creates a webpack loader project, add starter loader code
- [**Init Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/src/init-generator.ts) : Generates new webpack configuration as per user requirements
- [**Addon Generator**](https://github.com/webpack/webpack-cli/blob/master/packages/generators/src/addon-generator.ts) : Generates a webpack project conforming to `webpack-defaults`

---

[Back to Packages](https://github.com/webpack/webpack-cli/tree/master/packages)

[downloads]: https://img.shields.io/npm/dm/@webpack-cli/generators.svg
[downloads-url]: https://www.npmjs.com/package/@webpack-cli/generators