# esdoc-webpack-plugin

> Webpack plugin to run esdoc on files

Latest version **1.0.3** (published 2020-12-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install esdoc-webpack-plugin
pnpm add esdoc-webpack-plugin
yarn add esdoc-webpack-plugin
bun add esdoc-webpack-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-12-02 |
| First published | 2020-11-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 14.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Carwin Young |
| Maintainers | cyoung |
| Keywords | esdoc, webpack |

## Links

- npm: https://www.npmjs.com/package/esdoc-webpack-plugin
- Repository: https://github.com/carwin/esdoc-webpack-plugin
- Homepage: https://github.com/carwin/esdoc-webpack-plugin#readme
- Issues: https://github.com/carwin/esdoc-webpack-plugin/issues
- npm.io page: https://npm.io/package/esdoc-webpack-plugin

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [esdoc](https://npm.io/package/esdoc.md) ^1.1.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [esdoc-node](https://npm.io/package/esdoc-node.md) ^1.0.5
- [schema-utils](https://npm.io/package/schema-utils.md) ^1.0.0
- [esdoc-standard-plugin](https://npm.io/package/esdoc-standard-plugin.md) ^1.0.0
- [webpack-watch-files-plugin](https://npm.io/package/webpack-watch-files-plugin.md) ^1.1.0
- [esdoc-ecmascript-proposal-plugin](https://npm.io/package/esdoc-ecmascript-proposal-plugin.md) ^1.0.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-12-02
- 1.0.2 — 2020-12-02
- 1.0.1 — 2020-12-01
- 1.0.0 — 2020-11-30

## README

# esdoc-webpack-plugin
[![Downloads](https://badgen.net/npm/dt/esdoc-webpack-plugin)](https://www.npmjs.com/package/esdoc-webpack-plugin)
[![npm dependents](https://badgen.net/npm/dependents/esdoc-webpack-plugin)](https://www.npmjs.com/package/esdoc-webpack-plugin)

Run [`ESDoc`](https://esdoc.org) with Webpack!

## Installation
```
npm install --save-dev esdoc-webpack-plugin
```

## Configuration

`esdoc-webpack-plugin` has a handful of configuration options for itself, and
also accepts options to pass directly to ESDoc itself, though it will try to
read your configuration file if you've got one and fill in any gaps.

```js
// webpack.config.js
const ESDocPlugin = require('esdoc-webpack-plugin');

// ...

plugins: [
    new ESDocPlugin({
        cwd: '.'
        showOutput: false,
        source: './src',
        destination: './docs',
    })
]

// ...
```

### Options

Option          | Type    | Purpose
--------------- | ------- | --------------------------------------------------------------
conf            | string  | The configuration filename to look for.
cwd             | string  | Where to start looking for the ESDoc executable.
preserveTmpFile | boolean | The plugin creates a temporary file to use for configuration during ESDoc runtime based on options from Webpack and your config. Set this to true if you want to keep it around.
showOutput      | boolean | Prints ESDoc output if true.

---
_Source: https://npm.io/package/esdoc-webpack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._