From ec72c8007e930a5fb38b2cc67d53a9911e213b46 Mon Sep 17 00:00:00 2001 From: vsavkin Date: Wed, 14 Sep 2016 09:08:30 -0700 Subject: [PATCH] fix: merge the decorator data with the symbol --- .../processors/addJadeDataDocsProcessor.js | 177 +++++++++++------- 1 file changed, 106 insertions(+), 71 deletions(-) diff --git a/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js b/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js index ca79155f87..c908355b71 100644 --- a/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js +++ b/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js @@ -19,6 +19,65 @@ var titleCase = function(text) { * */ + +function processExportDoc(exportDoc) { + // STABILITY STATUS + // Supported tags: + // @stable + // @experimental + // @deprecated + // Default is the empty string (no badge) + // Do not capitalize the strings, they are intended for use in constructing a css class from _hero.scss + // and used in _hero.jade + var stability = ''; + if (_.has(exportDoc, 'stable')) { + stability = 'stable'; + } else if (_.has(exportDoc, 'experimental')) { + stability = 'experimental'; + } else if (_.has(exportDoc, 'deprecated')) { + stability = 'deprecated'; + exportDoc.showDeprecatedNotes = true; + } + + var howToUse = ''; + if(_.has(exportDoc, 'howToUse')) { + var howToUseArray = exportDoc.tags.tags.filter(function(tag) { + return tag.tagName === 'howToUse' + }); + + // Remove line breaks, there should only be one tag + howToUse = howToUseArray[0].description.replace(/(\r\n|\n|\r)/gm," "); + } + + var whatItDoes = ''; + if(_.has(exportDoc, 'whatItDoes')) { + var whatItDoesArray = exportDoc.tags.tags.filter(function(tag) { + return tag.tagName === 'whatItDoes' + }); + + // Remove line breaks, there should only be one tag + whatItDoes = whatItDoesArray[0].description.replace(/(\r\n|\n|\r)/gm," "); + } + + // SECURITY STATUS + // Supported tags: + // @security + // Default is no security risk assessed for api + var security = false; + if (_.has(exportDoc, 'security')) { + var securityArray = exportDoc.tags.tags.filter(function(tag) { + return tag.tagName === 'security' + }); + + // Remove line breaks, there should only be one tag + security = securityArray[0].description.replace(/(\r\n|\n|\r)/gm," "); + + exportDoc.showSecurityNotes = true; + } + + return {stability: stability, howToUse: howToUse, whatItDoes: whatItDoes, security: security}; +} + module.exports = function addJadeDataDocsProcessor() { return { $runAfter: ['adding-extra-docs'], @@ -51,7 +110,7 @@ module.exports = function addJadeDataDocsProcessor() { * * Modules must be public and have content */ - + _.forEach(docs, function(doc) { if (doc.docType === 'module' && !doc.internal && doc.exports.length) { modules.push(doc); @@ -65,83 +124,60 @@ module.exports = function addJadeDataDocsProcessor() { intro: doc.description.replace('"', '\"').replace(/\s*(\r?\n|\r)\s*/g," "), docType: 'module' }]; - + + var decorators = {}; + // GET DATA FOR EACH PAGE (CLASS, VARS, FUNCTIONS) var modulePageInfo = _(doc.exports) .map(function(exportDoc) { + // if it ends with "Decorator", we store it in the map + // to later merge with the token + if (exportDoc.name.endsWith("Decorator")) { + var p = processExportDoc(exportDoc.callMember); + decorators[exportDoc.name] = { + stability : p.stability, + howToUse : p.howToUse, + whatItDoes : p.whatItDoes, + security : p.security, + description : exportDoc.callMember.description, + docType: 'decorator' + }; + return null; - // STABILITY STATUS - // Supported tags: - // @stable - // @experimental - // @deprecated - // Default is the empty string (no badge) - // Do not capitalize the strings, they are intended for use in constructing a css class from _hero.scss - // and used in _hero.jade - var stability = ''; - if (_.has(exportDoc, 'stable')) { - stability = 'stable'; - } else if (_.has(exportDoc, 'experimental')) { - stability = 'experimental'; - } else if (_.has(exportDoc, 'deprecated')) { - stability = 'deprecated'; - exportDoc.showDeprecatedNotes = true; + } else { + var p = processExportDoc(exportDoc); + + // Data inserted into jade-data.template.html + var dataDoc = { + name: exportDoc.name + '-' + exportDoc.docType, + title: exportDoc.name, + docType: exportDoc.docType, + exportDoc: exportDoc, + stability: p.stability, + howToUse: p.howToUse, + whatItDoes: p.whatItDoes, + security: p.security + }; + + if (exportDoc.symbolTypeName) dataDoc.varType = titleCase(exportDoc.symbolTypeName); + if (exportDoc.originalModule) dataDoc.originalModule = exportDoc.originalModule; + + return dataDoc; } - - var howToUse = ''; - if(_.has(exportDoc, 'howToUse')) { - var howToUseArray = exportDoc.tags.tags.filter(function(tag) { - return tag.tagName === 'howToUse' - }); - - // Remove line breaks, there should only be one tag - howToUse = howToUseArray[0].description.replace(/(\r\n|\n|\r)/gm," "); - } - - var whatItDoes = ''; - if(_.has(exportDoc, 'whatItDoes')) { - var whatItDoesArray = exportDoc.tags.tags.filter(function(tag) { - return tag.tagName === 'whatItDoes' - }); - - // Remove line breaks, there should only be one tag - whatItDoes = whatItDoesArray[0].description.replace(/(\r\n|\n|\r)/gm," "); - } - - // SECURITY STATUS - // Supported tags: - // @security - // Default is no security risk assessed for api - var security = false; - if (_.has(exportDoc, 'security')) { - var securityArray = exportDoc.tags.tags.filter(function(tag) { - return tag.tagName === 'security' - }); - - // Remove line breaks, there should only be one tag - security = securityArray[0].description.replace(/(\r\n|\n|\r)/gm," "); - - exportDoc.showSecurityNotes = true; - } - - // Data inserted into jade-data.template.html - var dataDoc = { - name: exportDoc.name + '-' + exportDoc.docType, - title: exportDoc.name, - docType: exportDoc.docType, - exportDoc: exportDoc, - stability: stability, - howToUse: howToUse, - whatItDoes: whatItDoes, - security: security - }; - - if (exportDoc.symbolTypeName) dataDoc.varType = titleCase(exportDoc.symbolTypeName); - if (exportDoc.originalModule) dataDoc.originalModule = exportDoc.originalModule; - return dataDoc; }) + .filter(function(s) { return !!s; }) // filter out all null values .sortBy('name') .value(); + + // find a matching symbol for every decorator item + // and merge the data + _.forEach(Object.keys(decorators), function(name) { + var varToken = name.split("Decorator")[0]; + var c = modulePageInfo.filter(function(n) { return n.exportDoc.name === varToken; }); + + c[0].docType = decorators[name].docType; + Object.assign(c[0].exportDoc, decorators[name]); + }); doc.childPages = modulePageInfo; @@ -162,7 +198,6 @@ module.exports = function addJadeDataDocsProcessor() { } }); - return docs.concat(extraDocs); } };