esdoc-es7-plugin

0.0.3 • Public • Published

Build Status Coverage Status Document

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

npm install esdoc-es7-plugin

setup plugin property in esdoc.json

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

execute ESDoc

esdoc -c esdoc.json

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.0.3
    3,087
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.0.3
    3,087
  • 0.0.2
    7
  • 0.0.1
    1

Package Sidebar

Install

npm i esdoc-es7-plugin

Weekly Downloads

563

Version

0.0.3

License

MIT

Last publish

Collaborators

  • h13i32maru