The json-to-jsdoc from eek

json-to-jsdoc's People

Contributors

Stargazers

Watchers

json-to-jsdoc's Issues

web page header link broken

the link in your web page's header (https://eek.ro/json2jsdoc) leads to a 404.

NPM package

Can you also make a npm package out of it? 😁

Broken link on website

The banner link on the homepage is broken. It links to https://eek.ro/json2jsdoc instead of https://eek.ro/json-to-jsdoc/

Empty value should not return empty property

* @property {}

should be

* @property {*}

Multiple inner objects with the same properties should be moved to a new typeDef

Things like

[ { "color": "red", "value": "#f00" }, { "color": "green", "value": "#0f0" }, { "color": "blue", "value": "#00f" }, { "color": "cyan", "value": "#0ff" }, { "color": "magenta", "value": "#f0f" }, { "color": "yellow", "value": "#ff0" }, { "color": "black", "value": "#000" } ]

should be

/** @typedef {object} jsonObj
  * @property {string} color
  * @property {string} value
  */

/**
  * @property {jsonObj[]} json 
  */

Instead of

/** @typedef {array} json 
  * @property {object} 0 
  * @property {string} 0.color 
  * @property {string} 0.value 
  * @property {object} 1 
  * @property {string} 1.color 
  * @property {string} 1.value 
  * @property {object} 2 
  * @property {string} 2.color 
  * @property {string} 2.value 
  * @property {object} 3 
  * @property {string} 3.color 
  * @property {string} 3.value 
  * @property {object} 4 
  * @property {string} 4.color 
  * @property {string} 4.value 
  * @property {object} 5 
  * @property {string} 5.color 
  * @property {string} 5.value 
  * @property {object} 6 
  * @property {string} 6.color 
  * @property {string} 6.value 
  */