Update JSDoc lib files from OpenUI5 change

SAP · Mar 19, 2019 · 769f201 · 769f201
1 parent 8272acb
commit 769f201
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 12 deletions.
diff --git a/lib/processors/jsdoc/lib/create-api-index.js b/lib/processors/jsdoc/lib/create-api-index.js
@@ -6,10 +6,11 @@
  */
 
 "use strict";
-const fs = require("fs");
 const path = require("path");
 
-function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetFileDeprecated, targetFileExperimental, targetFileSince) {
+function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetFileDeprecated, targetFileExperimental, targetFileSince, options) {
+ const fs = options && options.fs || require("fs");
+ const returnOutputFiles = options && !!options.returnOutputFiles;
 
  console.log("[INFO] creating API index files");
  console.log("[INFO] sap-ui-version.json: " + versionInfoFile);
@@ -18,6 +19,12 @@ function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetF
  console.log("[INFO] target file deprecated: " + targetFileDeprecated);
  console.log("[INFO] target file experimental: " + targetFileExperimental);
  console.log("[INFO] target file since: " + targetFileSince);
+ if (options && options.fs) {
+ console.log("[INFO] Using custom fs");
+ }
+ if (returnOutputFiles) {
+ console.log("[INFO] Returning output files instead of writing to fs.")
+ }
  console.log("[INFO]");
 
  // Deprecated, Experimental and Since collections
@@ -317,6 +324,7 @@ function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetF
 
  function createOverallIndex() {
  let version = "0.0.0";
+ const filesToReturn = {};
 
  var p = readJSONFile(versionInfoFile)
  .then(versionInfo => {
@@ -343,7 +351,11 @@ function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetF
  library: "*",
  symbols: symbols
  };
- return writeJSON(targetFile, result);
+ if (returnOutputFiles) {
+ filesToReturn[targetFile] = JSON.stringify(result);
+ } else {
+ return writeJSON(targetFile, result);
+ }
  })
  .then(() => {
  /* Lists - modify and cleanup */
@@ -394,12 +406,21 @@ function process(versionInfoFile, unpackedTestresourcesRoot, targetFile, targetF
  delete oListCollection.experimental.noVersion;
  }
  })
- .then(() => Promise.all([
- // write deprecated, experimental and since collections in the respective index files
- writeJSON(targetFileDeprecated, oListCollection.deprecated),
- writeJSON(targetFileExperimental, oListCollection.experimental),
- writeJSON(targetFileSince, oListCollection.since)
- ]))
+ .then(() => {
+ if (returnOutputFiles) {
+ filesToReturn[targetFileDeprecated] = JSON.stringify(oListCollection.deprecated);
+ filesToReturn[targetFileExperimental] = JSON.stringify(oListCollection.experimental);
+ filesToReturn[targetFileSince] = JSON.stringify(oListCollection.since);
+ return filesToReturn;
+ } else {
+ return Promise.all([
+ // write deprecated, experimental and since collections in the respective index files
+ writeJSON(targetFileDeprecated, oListCollection.deprecated),
+ writeJSON(targetFileExperimental, oListCollection.experimental),
+ writeJSON(targetFileSince, oListCollection.since)
+ ]);
+ }
+ })
  .catch(err => {
  console.error("**** failed to create API index for libraries:", err)
  throw err;

diff --git a/lib/processors/jsdoc/lib/transform-apijson-for-sdk.js b/lib/processors/jsdoc/lib/transform-apijson-for-sdk.js
@@ -38,14 +38,20 @@ const log = (function() {
  * @returns {Promise} A Promise that resolves after the transformation has been completed
  */
 function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles, options) {
- const fs = options && options.customFs || require("fs");
- const returnOutputFile = options && !!options.returnOutputFile;
+ const fs = options && options.fs || require("fs");
+ const returnOutputFiles = options && !!options.returnOutputFiles;
 
  log.info("Transform API index files for sap.ui.documentation");
  log.info(" original file: " + sInputFile);
  log.info(" output file: " + sOutputFile);
  log.info(" library file: " + sLibraryFile);
  log.info(" dependency dir: " + vDependencyAPIFiles);
+ if (options && options.fs) {
+ log.info("Using custom fs.");
+ }
+ if (returnOutputFiles) {
+ log.info("Returning output files instead of writing to fs.")
+ }
  log.info("");
 
  /**
@@ -739,7 +745,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
  * @param oChainObject chain object
  */
  function createApiRefApiJson(oChainObject) {
- if (returnOutputFile) {
+ if (returnOutputFiles) {
  // If requested, return data instead of writing to FS (required by UI5 Tooling/UI5 Builder)
  return JSON.stringify(oChainObject.parsedData);
  }