Skip to content

Switch from jsdoc-parse to jsdoc-to-markdown #3

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Switch from jsdoc-parse to jsdoc-to-markdown #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 19 additions & 33 deletions lib/jsdoc-to-json-schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,36 @@
var string2stream = require('string-to-stream');
var stream2string = require('stream-to-string');
var fs = require('fs-extra-promise');
var jsDocParse = require('jsdoc-parse');
var jsdoc2md = require('jsdoc-to-markdown');

module.exports = function(input, output) {

input = input || process.stdin; // default stdin
output = output || process.stdout; // default stdout

// get input as a stream
return getInputAsStream(input).then(function(inputStream) {
return jsdoc2md.getTemplateData({ files: input, 'no-cache': true }).then((comments) => {

var parser = jsDocParse();
// build json schema from comments
var jsonSchema = buildJsonSchema(comments);

// send input into jsdoc-parser
inputStream.pipe(parser);
// if the output is a stream
if (output.write) {

// read jsdoc-parse output as json string
return stream2string(parser).then(function(comments) {

// convert json string into JSON array of comments
var jsonComments = JSON.parse(comments);

// build json schema from comments
var jsonSchema = buildJsonSchema(jsonComments);

// if the output is a stream
if (output.write) {

// send result to output stream
string2stream(JSON.stringify(jsonSchema)).pipe(output);
}
else {
// send result to output stream
string2stream(JSON.stringify(jsonSchema)).pipe(output);
}
else {

// otherwise, write output to disk
fs.writeJsonAsync(output, jsonSchema, { spaces: 4 }).then(function(err) {
if (err) {
console.error(err);
}
});
}
// otherwise, write output to disk
fs.writeJsonAsync(output, jsonSchema, { spaces: 4 }).then(function(err) {
if (err) {
console.error(err);
}
});
}

// if no output object, return promise with JSON object
return Promise.resolve(jsonSchema);
// if no output object, return promise with JSON object
return Promise.resolve(jsonSchema);

});
});
};

Expand Down
3 changes: 1 addition & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@
"dependencies": {
"commander": "^2.9.0",
"fs-extra-promise": "^0.3.1",
"jsdoc-parse": "^1.2.7",
"stream-to-string": "^1.0.1",
"jsdoc-to-markdown": "^6.0.1",
"string-to-stream": "^1.1.0"
},
"devDependencies": {
Expand Down