A simple CLI tool, that wraps https://gitlab.com/nvidia1997/json-to-jsdoc-converter.

Find a file

Michel Fedde f600d858ba Adds application		2025-12-09 20:23:40 +01:00
build	Adds application	2025-12-09 20:23:40 +01:00
source	Adds application	2025-12-09 20:23:40 +01:00
.gitignore	Adds application	2025-12-09 20:23:40 +01:00
package-lock.json	Adds application	2025-12-09 20:23:40 +01:00
package.json	Adds application	2025-12-09 20:23:40 +01:00
README.md	Adds application	2025-12-09 20:23:40 +01:00

README.md

JSON to JSDoc Converter

A simple CLI tool, that wraps Rumen Krastev Shishkov's JSON to JSDoc Converter.

Installation

To install it, simply clone, build, and install the package globally.

git clone https://git.iedsoftworks.com/Neintonine/json2jsdoc.git
cd json2jsdoc
npm run build
npm install -g . # depending where your global is located, you may need sudo.

Usage

Usage: json2jsdoc [options] <typename> [origin]

Arguments:
  typename    Prefix / Type name
  origin      Defines where the file with the json is located at. If empty it will try to use stdin and display an editor for you to enter the
              data, if stdin is not available.

Options:
  -h, --help  display help for command

Remarks

When using an editor for origin, its not recommended to also append a stdout pipe. Reason being, that some editors might run in the CLI.