justine-jsdoc2json

justine-jsdoc2json

This library converts JSDoc to Justine JSON.

Installation

yarn add justine-jsdoc2json

API

const justineJsdoc2json = require('justine-jsdoc2json');

const doclets = justineJsdoc2json(inputPath, packageJsonPath, readmeMdPath);

inputPath

• required
• it can be either a directory path or a file path
• in case it is a directory, the JSON will be generated from all JavaScript files in the directory and its subdirectories

packageJsonPath

• optional
• package.json information will be included in the output JSON if it is provided

readmeMdPath

• optional
• README.md information will be included in the output JSON if it is provided

returns

• doclets saved in Justine JSON-like format

Developers

yarn test
yarn test:verbose

Notes

I don't want to release 1.0.0 until Justine will be prepared for the first release. That's why I started with 0.1.0.