Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

justine-jsdoc2json

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

justine-jsdoc2json

Convert JSDoc to Justine JSON

  • 0.1.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
increased by300%
Maintainers
1
Weekly downloads
 
Created
Source

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.

FAQs

Package last updated on 18 Mar 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc