jsdoc-babel

jsdoc-babel

A JSDoc plugin that transforms source files with Babel 6 before they are processed.

Installation

The jsdoc-babel plugin can be installed using NPM.

npm install jsdoc-babel --save-dev

Usage

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

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

Processing files with different extensions

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"]
    }
}

Passing options through Babel

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

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

Changelog

0.2.1 - 2016-06-30

• Move Babel to peer dependencies