Refactor jsdoc processor internal files into lib dir

SAP · Mar 7, 2019 · 5c683c0 · 5c683c0
1 parent 66893b7
commit 5c683c0
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 28 deletions.
diff --git a/lib/processors/jsdoc/jsdoc-config-template.json b/lib/processors/jsdoc/jsdoc-config-template.json
diff --git a/lib/processors/jsdoc/jsdocGenerator.js b/lib/processors/jsdoc/jsdocGenerator.js
@@ -20,7 +20,7 @@ const {resourceFactory} = require("@ui5/fs");
  * @param {Array} [parameters.options.variants=["apijson"]] JSDoc variants to be built
  * @param {boolean} [parameters.options.sdkBuild=true] Whether additional SDK specific
  *														api.json resources shall be generated
- * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with
+ * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with newly created resources
  */
 const jsdocGenerator = async function({sourcePath, targetPath, tmpPath, options} = {}) {
 	if (!sourcePath || !targetPath || !tmpPath || !options.projectName || !options.version) {
@@ -82,11 +82,11 @@ async function generateJsdocConfig({targetPath, tmpPath, namespace, projectName,
 	const jsdocPath = path.normalize(__dirname);
 
 	const config = `{
-		"plugins": ["${jsdocPath}/ui5/plugin.js"],
+		"plugins": ["${jsdocPath}/lib/ui5/plugin.js"],
 		"opts": {
 			"recurse": true,
 			"lenient": true,
-			"template": "${jsdocPath}/ui5/template",
+			"template": "${jsdocPath}/lib/ui5/template",
 			"ui5": {
 				"saveSymbols": true
 			},

diff --git a/lib/processors/jsdoc/create-api-index.js → lib/processors/jsdoc/lib/create-api-index.js b/lib/processors/jsdoc/create-api-index.js → lib/processors/jsdoc/lib/create-api-index.js
diff --git a/...essors/jsdoc/transform-apijson-for-sdk.js → ...rs/jsdoc/lib/transform-apijson-for-sdk.js b/...essors/jsdoc/transform-apijson-for-sdk.js → ...rs/jsdoc/lib/transform-apijson-for-sdk.js
diff --git a/lib/processors/jsdoc/ui5/plugin.js → lib/processors/jsdoc/lib/ui5/plugin.js b/lib/processors/jsdoc/ui5/plugin.js → lib/processors/jsdoc/lib/ui5/plugin.js
diff --git a/lib/processors/jsdoc/ui5/template/publish.js → ...cessors/jsdoc/lib/ui5/template/publish.js b/lib/processors/jsdoc/ui5/template/publish.js → ...cessors/jsdoc/lib/ui5/template/publish.js
diff --git a/test/lib/processors/jsdoc/jsdocGenerator.js b/test/lib/processors/jsdoc/jsdocGenerator.js
@@ -19,11 +19,11 @@ test("generateJsdocConfig", async (t) => {
 		"jsdoc");
 
 	t.deepEqual(res, `{
-		"plugins": ["${jsdocGeneratorPath}/ui5/plugin.js"],
+		"plugins": ["${jsdocGeneratorPath}/lib/ui5/plugin.js"],
 		"opts": {
 			"recurse": true,
 			"lenient": true,
-			"template": "${jsdocGeneratorPath}/ui5/template",
+			"template": "${jsdocGeneratorPath}/lib/ui5/template",
 			"ui5": {
 				"saveSymbols": true
 			},