/** * @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) { function getTypes(data) { var types = []; data.forEach(function(name) { types.push(name.replace(/^function$/, 'Function')); }); return types; } // get all doclets with the "api" property or define (excluding events) or // with olx namespace var docs = data( [ {define: {isObject: true}}, {api: {isString: true}}, {'interface': {is: true}}, function() { return this.meta && (/[\\\/]externs$/).test(this.meta.path); } ], {kind: {'!is': 'file'}}, {kind: {'!is': 'event'}}).get(); // get symbols data, filter out those that are members of private classes var symbols = []; var defines = []; var typedefs = []; var externs = []; var interfaces = []; 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) { var isExterns = (/[\\\/]externs$/).test(doc.meta.path); if (isExterns && doc.longname.indexOf('olx.') === 0) { if (doc.kind == 'typedef') { typedefs.push({ name: doc.longname, types: ['{}'] }); } else { var typedef = typedefs[typedefs.length - 1]; var type = typedef.types[0]; typedef.types[0] = type .replace(/\}$/, ', ' + doc.longname.split('#')[1] + ': (' + getTypes(doc.type.names).join('|') + ')}') .replace('{, ', '{'); } } else 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 if (doc.kind == 'typedef' || doc.isEnum === true) { typedefs.push({ name: doc.longname, types: getTypes(doc.type.names) }); } else { var types; var symbol = { name: doc.longname, kind: doc.kind, description: doc.classdesc || doc.description, stability: doc.api, path: path.join(doc.meta.path, doc.meta.filename) }; if (doc.augments) { symbol.extends = doc.augments[0]; } if (doc.type) { symbol.types = getTypes(doc.type.names); } if (doc.params) { var params = []; doc.params.forEach(function(param) { var paramInfo = { name: param.name }; params.push(paramInfo); paramInfo.types = getTypes(param.type.names); if (typeof param.variable == 'boolean') { paramInfo.variable = param.variable; } if (typeof param.optional == 'boolean') { paramInfo.optional = param.optional; } if (typeof param.nullable == 'boolean') { paramInfo.nullable = param.nullable; } }); symbol.params = params; } if (doc.returns) { symbol.returns = { types: getTypes(doc.returns[0].type.names) }; if (typeof doc.returns[0].nullable == 'boolean') { symbol.returns.nullable = doc.returns[0].nullable; } } if (doc.tags) { doc.tags.every(function(tag) { if (tag.title == 'template') { symbol.template = tag.value; return false; } return true; }); } var target = isExterns ? externs : (doc.interface ? interfaces : symbols); target.push(symbol); } }); process.stdout.write( JSON.stringify({ symbols: symbols, defines: defines, typedefs: typedefs, externs: externs, interfaces: interfaces }, null, 2)); };