probablyup / jsdoc-babel Goto Github PK

A JSDoc plugin that transforms ES6 source files with Babel before they are processsed.

The jsdoc-babel plugin can be installed using NPM.

npm install jsdoc-babel --save-dev

To use plugin you should include the plugin module in the plugins array of JSDoc's configuration file.

{
    "plugins": ["node_modules/jsdoc-babel"]
}

By default, the plugin only processes files that have a .js extension. You could enable transformation for other file extensions by adding the following settings to your JSDoc configuration file:

{
    "plugins": ["node_modules/jsdoc-babel"],
    "babel": {
        "extensions": ["js", "es6", "jsx"]
    }
}

You can define options to be passed through Babel by adding them to your JSDoc configuration file:

{
    "plugins": ["node_modules/jsdoc-babel"],
    "babel": {
        "optional": ["runtime"]
    }
}