Package Exports

esdoc-babel-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc-babel-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

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:

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:

{
  // ...
  "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:

esdoc

License

MIT

Authors

Maintained by Michiel Helvensteijn.

Originally based on esdoc-flow-plugin by Edgardo Avilés @eaviles.