You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For someone who wants to "create JSON output from jsdoc", guessing that they way to do that is via a template, and then that the "haruki" template might fit the task (what does haruki mean?) is not very obvious. It would be useful if haruki was renamed JSON, or mentioned in the README or cli help.
The text was updated successfully, but these errors were encountered:
The haruki template has that name for odd historical reasons that predate my work on JSDoc. At this point, I'd prefer not to rename it, because that would break things for people who are already using it.
The haruki template produces somewhat incomplete JSON output (again, for odd historical reasons). It would be worth making the output more complete, and there's an open pull request that makes some changes along those lines. However, fixing this isn't an immediate priority.
You can get more complete JSON output by running JSDoc with the -X option, which dumps all the parse results to the console and exits. The jsdoc3-parser module provides an easy-to-use wrapper around this process.
I filed jsdoc/jsdoc.github.io#96 to address this issue in the documentation, so I'm closing this issue.
For someone who wants to "create JSON output from jsdoc", guessing that they way to do that is via a template, and then that the "haruki" template might fit the task (what does haruki mean?) is not very obvious. It would be useful if
haruki
was renamedJSON
, or mentioned in the README or cli help.The text was updated successfully, but these errors were encountered: