builder/lib/tasks/jsdoc/executeJsdocSdkTransformation.js

  1. const log = require("@ui5/logger").getLogger("builder:tasks:jsdoc:executeJsdocSdkTransformation");
  2. const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
  3. const fsInterface = require("@ui5/fs").fsInterface;
  4. const sdkTransformer = require("../../processors/jsdoc/sdkTransformer");
  6. /**
  7.  * Task to transform the api.json file as created by the
  8.  * [generateJsdoc]{@link module:@ui5/builder.tasks.generateJsdoc} task into a pre-processed api.json
  9.  * file suitable for the SDK.
  10.  *
  11.  * @public
  12.  * @alias module:@ui5/builder.tasks.executeJsdocSdkTransformation
  13.  * @param {object} parameters Parameters
  14.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  15.  * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  16.  * @param {object} parameters.options Options
  17.  * @param {string|Array} parameters.options.dotLibraryPattern Pattern to locate the .library resource to be processed
  18.  * @param {string} parameters.options.projectName Project name
  19.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  20.  */
  21. const executeJsdocSdkTransformation = async function(
  22. 	{workspace, dependencies, options: {projectName, dotLibraryPattern}} = {}
  23. ) {
  24. 	if (!projectName || !dotLibraryPattern) {
  25. 		throw new Error("[executeJsdocSdkTransformation]: One or more mandatory options not provided");
  26. 	}
  28. 	const [apiJsons, dotLibraries, depApiJsons] = await Promise.all([
  29. 		workspace.byGlob("/test-resources/**/designtime/api.json"),
  30. 		workspace.byGlob(dotLibraryPattern),
  31. 		dependencies.byGlob("/test-resources/**/designtime/api.json")
  32. 	]);
  33. 	if (!apiJsons.length) {
  34. 		log.info(`Failed to locate api.json resource for project ${projectName}. ` +
  35. 			`Skipping SDK Transformation...`);
  36. 		return;
  37. 	} else if (apiJsons.length > 1) {
  38. 		throw new Error(`[executeJsdocSdkTransformation]: Found more than one api.json resources for project ` +
  39. 			`${projectName}.`);
  40. 	}
  41. 	if (!dotLibraries.length) {
  42. 		throw new Error(`[executeJsdocSdkTransformation]: Failed to locate .library resource for project ` +
  43. 			`${projectName}.`);
  44. 	} else if (dotLibraries.length > 1) {
  45. 		throw new Error(`[executeJsdocSdkTransformation]: Found more than one .library resources for project ` +
  46. 			`${projectName}.`);
  47. 	}
  49. 	const combo = new ReaderCollectionPrioritized({
  50. 		name: `executeJsdocSdkTransformation - custom workspace + dependencies FS: ${projectName}`,
  51. 		readers: [workspace, dependencies]
  52. 	});
  54. 	const apiJsonPath = apiJsons[0].getPath();
  55. 	const dotLibraryPath = dotLibraries[0].getPath();
  56. 	const dependencyApiJsonPaths = depApiJsons.map((res) => {
  57. 		return res.getPath();
  58. 	});
  60. 	// Target path is typically "/test-resources/${options.namespace}/designtime/apiref/api.json"
  61. 	const targetApiJsonPath = apiJsonPath.replace(/\/api\.json$/i, "/apiref/api.json");
  63. 	const createdResources = await sdkTransformer({
  64. 		apiJsonPath,
  65. 		dotLibraryPath,
  66. 		dependencyApiJsonPaths,
  67. 		targetApiJsonPath,
  68. 		fs: fsInterface(combo)
  69. 	});
  71. 	await Promise.all(createdResources.map((resource) => {
  72. 		return workspace.write(resource);
  73. 	}));
  74. };
  76. module.exports = executeJsdocSdkTransformation;