Skip to content

Document JSON output or add shortcut for haruki templates #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tmcw opened this issue Jan 6, 2015 · 1 comment
Closed

Document JSON output or add shortcut for haruki templates #866

tmcw opened this issue Jan 6, 2015 · 1 comment

Comments

@tmcw
Copy link

tmcw commented Jan 6, 2015

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.

@hegemonic
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants