# esdoc-es7-plugin

> ES7 Plugin For ESDoc

Latest version **0.0.3** (published 2015-11-02) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-11-02 |
| First published | 2015-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | h13i32maru |
| Maintainers | h13i32maru |
| Keywords | esdoc, es7, es6+ |

## Links

- npm: https://www.npmjs.com/package/esdoc-es7-plugin
- Repository: https://github.com/esdoc/esdoc-es7-plugin
- Issues: https://github.com/esdoc/esdoc-es7-plugin/issues
- npm.io page: https://npm.io/package/esdoc-es7-plugin

## Dependencies (3)

- [babylon](https://npm.io/package/babylon.md) 5.8.20
- [core-js](https://npm.io/package/core-js.md) 1.0.1
- [estraverse](https://npm.io/package/estraverse.md) 4.1.0

## Recent versions

- 0.0.3 (latest) — 2015-11-02
- 0.0.2 — 2015-08-15
- 0.0.1 — 2015-08-09

## README

[![Build Status](https://travis-ci.org/esdoc/esdoc-es7-plugin.svg?branch=master)](https://travis-ci.org/esdoc/esdoc-es7-plugin)
[![Coverage Status](https://coveralls.io/repos/esdoc/esdoc-es7-plugin/badge.svg)](https://coveralls.io/r/esdoc/esdoc-es7-plugin)
[![Document](https://doc.esdoc.org/github.com/esdoc/esdoc-es7-plugin/badge.svg)](https://doc.esdoc.org/github.com/esdoc/esdoc-es7-plugin)

# ESDoc ES7 Plugin
**This is an experimental plugin.**

This plugin only **ignores ES7 syntax**(does not optimize) to produce the documentation.
So, ES7 information(ClassProperties, AsyncFunctions and etc...) is not presented in the documentation.

Now, ignore the following syntax.

- es7.comprehensions
- es7.classProperties
- es7.functionBind
- es7.asyncFunctions
- es7.decorators
- es7.exportExtensions
- es7.objectRestSpread
- es7.trailingFunctionCommas
- es7.exponentiationOperator

FYI: https://babeljs.io/docs/usage/experimental/

# Install and Usage
```sh
npm install esdoc-es7-plugin
```

setup ``plugin`` property in ``esdoc.json``

```json
{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {"name": "esdoc-es7-plugin"}
  ]
}
```

execute ESDoc

```json
esdoc -c esdoc.json
```

# LICENSE
MIT

# Author
[Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)

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