106 lines
3.1 KiB
JavaScript
106 lines
3.1 KiB
JavaScript
/**
|
|
* @fileoverview Generates JSON output based on exportable symbols (those with
|
|
* an api tag) and boolean defines (with a define tag and a default value).
|
|
*/
|
|
var assert = require('assert');
|
|
var fs = require('fs');
|
|
var path = require('path');
|
|
|
|
|
|
/**
|
|
* Publish hook for the JSDoc template. Writes to JSON stdout.
|
|
* @param {function} data The root of the Taffy DB containing doclet records.
|
|
* @param {Object} opts Options.
|
|
*/
|
|
exports.publish = function(data, opts) {
|
|
var cwd = process.cwd();
|
|
|
|
// get all doclets with the "api" property or define (excluding enums,
|
|
// typedefs and events)
|
|
var docs = data(
|
|
[{define: {isObject: true}}, {api: {isString: true}}],
|
|
{isEnum: {'!is': true}},
|
|
{kind: {'!is': 'typedef'}},
|
|
{kind: {'!is': 'event'}}).get();
|
|
|
|
// get symbols data, filter out those that are members of private classes
|
|
var symbols = [];
|
|
var defines = [];
|
|
docs.filter(function(doc) {
|
|
var include = true;
|
|
var constructor = doc.memberof;
|
|
if (constructor && constructor.substr(-1) === '_') {
|
|
assert.strictEqual(doc.inherited, true,
|
|
'Unexpected export on private class: ' + doc.longname);
|
|
include = false;
|
|
}
|
|
return include;
|
|
}).forEach(function(doc) {
|
|
if (doc.define) {
|
|
defines.push({
|
|
name: doc.longname,
|
|
description: doc.description,
|
|
path: path.join(doc.meta.path, doc.meta.filename),
|
|
default: doc.define.default
|
|
});
|
|
} else {
|
|
var types;
|
|
var symbol = {
|
|
name: doc.longname,
|
|
kind: doc.kind,
|
|
description: doc.classdesc || doc.description,
|
|
path: path.join(doc.meta.path, doc.meta.filename)
|
|
};
|
|
if (doc.type) {
|
|
types = [];
|
|
doc.type.names.forEach(function(name) {
|
|
types.push(name.replace(/^function$/, 'Function'));
|
|
});
|
|
symbol.types = types;
|
|
}
|
|
if (doc.params) {
|
|
var params = [];
|
|
doc.params.forEach(function(param) {
|
|
var paramInfo = {
|
|
name: param.name
|
|
};
|
|
params.push(paramInfo);
|
|
var types = [];
|
|
param.type.names.forEach(function(name) {
|
|
types.push(name.replace(/^function$/, 'Function'));
|
|
});
|
|
paramInfo.types = types;
|
|
if (typeof param.variable == 'boolean') {
|
|
paramInfo.variable = param.variable;
|
|
}
|
|
if (typeof param.optional == 'boolean') {
|
|
paramInfo.optional = param.optional;
|
|
}
|
|
});
|
|
symbol.params = params;
|
|
}
|
|
if (doc.returns) {
|
|
var returns = [];
|
|
doc.returns[0].type.names.forEach(function(name) {
|
|
returns.push(name.replace(/^function$/, 'Function'));
|
|
});
|
|
symbol.returns = returns;
|
|
}
|
|
if (doc.tags) {
|
|
doc.tags.every(function(tag) {
|
|
if (tag.title == 'template') {
|
|
symbol.template = tag.value;
|
|
return false;
|
|
}
|
|
return true;
|
|
});
|
|
}
|
|
symbols.push(symbol);
|
|
}
|
|
});
|
|
|
|
process.stdout.write(
|
|
JSON.stringify({symbols: symbols, defines: defines}, null, 2));
|
|
|
|
};
|