Output to JSON? about grunt-jsdoc

[krampstudio]

I'm agree with you it could be a nice feature!

[rvangundy]

Another nice feature would be to keep track of inline comments. I can see this making it possible to document a lot more interesting things within code, and convert them in to an easy-to-read format. It also would help computers make inferences between computational procedures and verbal communication. Could be neat.

Are you spending much time on this project these days? I've been thinking for a while about a code documentation JSON Schema based on the jsdoc3 spec. I'd be willing to pitch in a few drafts.

[krampstudio]

Definitely agree.
I had also in mind to rewrite the jsdoc parser using node instead of rhino (and the complex legacy system that comes with jsdoc3), to be able to integrate some features like docco's code and comments layout and so on.

[Risto-Stevcev]

You can get the JSdoc JSON object by running jsdoc with the --explain flag.

[mboles]

I am trying to get the JSON file. I use the --explain flag and get the correct result without Grunt. Using Grunt and your plugin I get the standard JSDoc output, but as I said need the JSON file. I found in the cli.js file (line 388) this code where --explain is handled:

cli.processParseResults = function() {
    if (env.opts.explain) {
        cli.dumpParseResults();
    }
    else {
        cli.resolveTutorials();
        cli.generateDocs();
    }
    return cli;
};
cli.dumpParseResults = function() {
    global.dump(props.docs);
    return cli;
};

From that I thought I could just write the file like this using fs.writeFile:

cli.dumpParseResults = function() {
    var fs = require('fs');
    global.dump(props.docs);
    fs.writeFile('videojs-src/cumulative.json', props.docs);
    return cli;
};

The file was created, but it as empty. I tried to just write some simple text to the file fs.writeFile('videojs-src/cumulative.json', 'hello');, and that wouldn't write out either.

Any ideas? It seems something is interfering with the write.
Thanks-
Matt

[krampstudio]

Old issue, please reopen if needed (the plugin relies now of the node implementation)