From 39f1959f2e7aa6f881eae68a460440c1fce045a5 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Fri, 18 Sep 2015 13:05:58 +0100 Subject: [PATCH] refact(angular.io-package): compute the correct path rather than fixing up later --- .../api-builder/angular.io-package/index.js | 17 +++++++------- .../processors/fixOutputPathProcessor.js | 23 ------------------- .../processors/readTypeScriptModules.js | 7 +++--- 3 files changed, 13 insertions(+), 34 deletions(-) delete mode 100644 public/api-builder/angular.io-package/processors/fixOutputPathProcessor.js diff --git a/public/api-builder/angular.io-package/index.js b/public/api-builder/angular.io-package/index.js index f542229b0d..aa7e33fa4e 100644 --- a/public/api-builder/angular.io-package/index.js +++ b/public/api-builder/angular.io-package/index.js @@ -10,8 +10,7 @@ module.exports = new Package('angular.io', [basePackage]) .factory(require('./services/renderMarkdown')) .processor(require('./processors/addJadeDataDocsProcessor')) -// MIGRATION: added this processor -.processor(require('./processors/fixOutputPathProcessor')) + // MIGRATION: added packageInfo to point to angular/angular repo // overrides base packageInfo and returns the one for the 'angular/angular' repo. .factory(require('./services/packageInfo')) @@ -59,26 +58,28 @@ module.exports = new Package('angular.io', [basePackage]) computePathsProcessor.pathTemplates.push({ docTypes: ['module'], - pathTemplate: '${id}/', + getPath: function computeModulePath(doc) { + return doc.id.replace(/^angular2\//, ''); + }, // MIGRATION: // outputPathTemplate: MODULES_DOCS_PATH + '/${id}/index.jade' - outputPathTemplate: '/${id}/index.jade' + outputPathTemplate: '${path}/index.jade' }); computePathsProcessor.pathTemplates.push({ docTypes: EXPORT_DOC_TYPES, - pathTemplate: '${moduleDoc.id}/${name}-${docType}.html', + pathTemplate: '${moduleDoc.path}/${name}-${docType}.html', // MIGRATION: // outputPathTemplate: MODULES_DOCS_PATH + '/${moduleDoc.id}/${name}-${docType}.jade', - outputPathTemplate:'/${moduleDoc.id}/${name}-${docType}.jade', + outputPathTemplate:'${moduleDoc.path}/${name}-${docType}.jade', }); computePathsProcessor.pathTemplates.push({ docTypes: ['jade-data'], - pathTemplate: '${originalDoc.id}/_data', + pathTemplate: '${originalDoc.path}/_data', // MIGRATION: // outputPathTemplate: MODULES_DOCS_PATH + '/${path}.json' - outputPathTemplate: '/${path}.json' + outputPathTemplate: '${path}.json' }); }) diff --git a/public/api-builder/angular.io-package/processors/fixOutputPathProcessor.js b/public/api-builder/angular.io-package/processors/fixOutputPathProcessor.js deleted file mode 100644 index 9511c360d9..0000000000 --- a/public/api-builder/angular.io-package/processors/fixOutputPathProcessor.js +++ /dev/null @@ -1,23 +0,0 @@ -var _ = require('lodash'); -var path = require('canonical-path'); - -/* -* Remove angular2 prefix from all doc output paths -*/ - -module.exports = function fixOutputPathProcessor() { - return { - $runAfter: ['paths-computed'], - $runBefore: ['writing-files'], - $process: function(docs) { - docs.forEach(function(doc) { - try { - doc.outputPath = doc.outputPath && path.relative("/angular2", doc.outputPath); - } catch(e) { - var x = e; - } - }); - return docs; - } - }; -}; diff --git a/public/api-builder/typescript-package/processors/readTypeScriptModules.js b/public/api-builder/typescript-package/processors/readTypeScriptModules.js index 51e56a4242..a7cf98f36b 100644 --- a/public/api-builder/typescript-package/processors/readTypeScriptModules.js +++ b/public/api-builder/typescript-package/processors/readTypeScriptModules.js @@ -63,6 +63,10 @@ module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo, var exportDoc = createExportDoc(exportSymbol.name, resolvedExport, moduleDoc, basePath, parseInfo.typeChecker); log.debug('>>>> EXPORT: ' + exportDoc.name + ' (' + exportDoc.docType + ') from ' + moduleDoc.id); + // Add this export doc to its module doc + moduleDoc.exports.push(exportDoc); + docs.push(exportDoc); + exportDoc.members = []; exportDoc.statics = []; @@ -123,9 +127,6 @@ module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo, }); } - // Add this export doc to its module doc - moduleDoc.exports.push(exportDoc); - docs.push(exportDoc); }); }); }