esdoc-sucrase-plugin
v0.1.0
Published
Transpile sources with sucrase before passing them to esdoc
Downloads
5
Maintainers
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.