Package Exports

esdoc-sucrase-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-sucrase-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-sucrase-plugin

Transpile sources with sucrase before passing them to esdoc.

Note: Event though you can use TypeScript and Flow with this plugin, it doesn't add any type info to your docs.

Installation

Run npm i --save-dev esdoc-sucrase-plugin.

Usage

Add the plugin to your esdoc.json file and specify which sucrase transforms to use:

{
  "source": "./src",
  ...
  "plugins": [
    ...
    {
      "name": "esdoc-sucrase-plugin",
      "option": { "transforms": ["typescript"] }
    },
  ]
}

Note: We test only with TypeScript, but flow should work as well.