@sasjs/cli 4.0.3 → 4.0.4

package/build/commands/docs/generateDocs.js

@@ -95,7 +95,8 @@ var getDocConfig_1 = require("./internal/getDocConfig");
 function generateDocs(target, config, outDirectory) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var _c, serverUrl, newOutDirectory, enableLineage, doxyContentFromConfig, _d, macroCoreFolders, macroFolders, programFolders, serviceFolders, jobFolders, combinedFolders, PROJECT_NAME, PROJECT_BRIEF, packageJsonContent, packageJson, e_1, doxyContent, doxyParams, doxyConfigPath, spinner, pathExists, _e, stderr, code, foldersListForDot;
+        var _c, serverUrl, newOutDirectory, enableLineage, doxyContentFromConfig, _d, macroCoreFolders, macroFolders, programFolders, serviceFolders, jobFolders, combinedFolders, PROJECT_NAME, PROJECT_BRIEF, packageJsonContent, packageJson, e_1, doxyContent, layoutFilePath, LAYOUT_FILE, doxyParams, doxyConfigPath, spinner, pathExists, _e, stderr, code, foldersListForDot;
+        var _this = this;
         return __generator(this, function (_f) {
             switch (_f.label) {
                 case 0:
@@ -132,6 +133,29 @@ function generateDocs(target, config, outDirectory) {
                     doxyContent = __assign({ favIcon: 'favicon.ico', footer: 'new_footer.html', header: 'new_header.html', layout: 'DoxygenLayout.xml', logo: 'logo.png', readMe: '../../README.md', stylesheet: 'new_stylesheet.css', path: path_1.default.join(process.projectDir, 'sasjs', 'doxy') }, doxyContentFromConfig);
                     if (doxyContentFromConfig === null || doxyContentFromConfig === void 0 ? void 0 : doxyContentFromConfig.path)
                         doxyContent.path = (0, utils_1.getAbsolutePath)(doxyContentFromConfig.path, process.projectDir);
+                    layoutFilePath = path_1.default.join(doxyContent.path, doxyContent.layout);
+                    return [4 /*yield*/, (0, utils_1.readFile)(layoutFilePath).then(function (content) { return __awaiter(_this, void 0, void 0, function () {
+                            var testString, replaced, timeStamp, tmpFilePath;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        if (enableLineage)
+                                            return [2 /*return*/, layoutFilePath
+                                                // if enableLineage is false, create a tmp layout file without lineage tab
+                                            ];
+                                        testString = "<tab type=\"user\" url=\"data_lineage.svg\" title=\"Lineage\"/>";
+                                        replaced = content.replace(testString, '');
+                                        timeStamp = (0, utils_1.generateTimestamp)();
+                                        tmpFilePath = path_1.default.join(doxyContent.path, "".concat(timeStamp, "-DoxygenLayout.xml"));
+                                        return [4 /*yield*/, (0, utils_1.createFile)(tmpFilePath, replaced)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/, tmpFilePath];
+                                }
+                            });
+                        }); })];
+                case 5:
+                    LAYOUT_FILE = _f.sent();
                     doxyParams = setVariableCmd({
                         DOXY_HTML_OUTPUT: newOutDirectory,
                         DOXY_INPUT: "\"".concat(path_1.default.join(doxyContent.path, doxyContent.readMe), "\" ").concat(combinedFolders),
@@ -139,47 +163,59 @@ function generateDocs(target, config, outDirectory) {
                         HTML_EXTRA_STYLESHEET: "\"".concat(path_1.default.join(doxyContent.path, doxyContent.stylesheet), "\""),
                         HTML_FOOTER: path_1.default.join(doxyContent.path, doxyContent.footer),
                         HTML_HEADER: path_1.default.join(doxyContent.path, doxyContent.header),
-                        LAYOUT_FILE: path_1.default.join(doxyContent.path, doxyContent.layout),
+                        LAYOUT_FILE: LAYOUT_FILE,
                         PROJECT_BRIEF: PROJECT_BRIEF,
                         PROJECT_LOGO: path_1.default.join(doxyContent.path, doxyContent.logo),
                         PROJECT_NAME: PROJECT_NAME
                     });
                     return [4 /*yield*/, getDoxyConfigPath(doxyContent.path)];
-                case 5:
+                case 6:
                     doxyConfigPath = _f.sent();
                     (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("Using ".concat(doxyConfigPath, " as Doxygen Configuration."));
                     spinner = (0, ora_1.default)(chalk_1.default.greenBright('Generating docs', chalk_1.default.cyanBright(newOutDirectory)));
                     if (process.env.LOG_LEVEL !== utils_1.LogLevel.Debug)
                         spinner.start();
                     return [4 /*yield*/, (0, utils_1.fileExists)(newOutDirectory)];
-                case 6:
+                case 7:
                     pathExists = _f.sent();
-                    if (!pathExists) return [3 /*break*/, 8];
+                    if (!pathExists) return [3 /*break*/, 9];
                     return [4 /*yield*/, (0, utils_1.deleteFolder)(newOutDirectory)];
-                case 7:
+                case 8:
                     _f.sent();
-                    _f.label = 8;
-                case 8: return [4 /*yield*/, (0, utils_1.createFolder)(newOutDirectory)];
-                case 9:
+                    _f.label = 9;
+                case 9: return [4 /*yield*/, (0, utils_1.createFolder)(newOutDirectory)];
+                case 10:
                     _f.sent();
                     _e = shelljs_1.default.exec("".concat(doxyParams, " doxygen \"").concat(doxyConfigPath, "\""), {
                         silent: process.env.LOG_LEVEL !== utils_1.LogLevel.Debug
                     }), stderr = _e.stderr, code = _e.code;
                     if (process.env.LOG_LEVEL !== utils_1.LogLevel.Debug)
                         spinner.stop();
+                    if (!!enableLineage) return [3 /*break*/, 12];
+                    // when enable lineage is false, we are creating a tmp DoxygenLayout.xml file
+                    // this is same a original but just with removed tab for lineage
+                    // therefor, we are removing this tmp file once the shell command for doxygen is completed
+                    return [4 /*yield*/, (0, utils_1.deleteFile)(LAYOUT_FILE)];
+                case 11:
+                    // when enable lineage is false, we are creating a tmp DoxygenLayout.xml file
+                    // this is same a original but just with removed tab for lineage
+                    // therefor, we are removing this tmp file once the shell command for doxygen is completed
+                    _f.sent();
+                    _f.label = 12;
+                case 12:
                     if (code !== 0) {
                         if (stderr.startsWith('error: ')) {
                             throw new Error("\n".concat(stderr));
                         }
                         throw new Error("The Doxygen application is not installed or configured. This external tool is used by 'sasjs doc'.\n".concat(stderr, "\nPlease download and install from here: https://www.doxygen.nl/download.html#srcbin"));
                     }
-                    if (!enableLineage) return [3 /*break*/, 11];
+                    if (!enableLineage) return [3 /*break*/, 14];
                     foldersListForDot = __spreadArray([], __read(new Set(__spreadArray(__spreadArray([], __read(serviceFolders), false), __read(jobFolders), false))), false);
                     return [4 /*yield*/, (0, createDotFiles_1.createDotFiles)(foldersListForDot, newOutDirectory, serverUrl)];
-                case 10:
+                case 13:
                     _f.sent();
-                    _f.label = 11;
-                case 11: return [2 /*return*/, { outDirectory: newOutDirectory }];
+                    _f.label = 14;
+                case 14: return [2 /*return*/, { outDirectory: newOutDirectory }];
             }
         });
     });

package/package.json

@@ -102,5 +102,5 @@
     "typescript": "4.9.5",
     "util": "0.12.4"
   },
-  "version": "4.0.3"
+  "version": "4.0.4"
 }