# esdoc-babel-plugin

> Simple esdoc plugin to run certain babel transformations on code before handing it to esdoc

Latest version **1.0.1** (published 2017-11-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-11-26 |
| First published | 2017-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.4.4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Michiel Helvensteijn |
| Maintainers | mhelvens |
| Keywords | esdoc, babel |

## Links

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

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-11-26
- 1.0.0 — 2017-11-26
- 0.1.0 — 2017-04-12

## README

# esdoc-babel-plugin

This plugin will run code through a certain set of babel plugins before giving it back to esdoc.
This can be used, for example, to remove certain syntax not supported by esdoc.

## Install and usage

```sh
npm install --save-dev mhelvens/esdoc-babel-plugin
```

Make sure you also install `babel-core` (version 6 or higher) and
the babel plugins you want to use. For example:

```sh
npm install --save-dev babel-core babel-plugin-angular2-annotations babel-plugin-transform-decorators-legacy babel-plugin-transform-flow-strip-types
```

Configure esdoc to use this plugin, and specify the set of babel plugins you wish to run,
in `.esdoc.json`:

```javascript
{
  // ...
  "plugins": [
    // ...
    {
      "name": "esdoc-babel-plugin",
      "option": {
        "plugins": [
          "angular2-annotations",
          "transform-decorators-legacy",
          "transform-flow-strip-types"
        ]
      }
    }
  ]
}
```

Note that the `"option"` object is passed directly to babel, so it supports all options
that babel supports.

Execute ESDoc:

```sh
esdoc
```

## License

MIT

## Authors

Maintained by [Michiel Helvensteijn](http://www.mhelvens.net).

Originally based on `esdoc-flow-plugin` by [Edgardo Avilés @eaviles](https://twitter.com/eaviles).

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