@sasjs/cli
Version:
Command line interface for SASjs
265 lines (264 loc) • 16.4 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.generateDocs = void 0;
var path_1 = __importDefault(require("path"));
var shelljs_1 = __importDefault(require("shelljs"));
var chalk_1 = __importDefault(require("chalk"));
var ora_1 = __importDefault(require("ora"));
var utils_1 = require("@sasjs/utils");
var getFoldersForDocs_1 = require("./internal/getFoldersForDocs");
var createDotFiles_1 = require("./internal/createDotFiles");
var getDocConfig_1 = require("./internal/getDocConfig");
/**
* Generates documentation(Doxygen)
* By default the docs will be at 'sasjsbuild/docs' folder
* If a target is supplied, generates docs only for the SAS programs / macros / jobs / services in that target (and the root).
* If no target is supplied, generates for all sas programs/ macros / jobs / services.
* @param {Target} target- the name of the target to be specific for docs.
* @param {string} outDirectory- the name of the output folder, picks from sasjsconfig.docConfig if present.
*/
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, layoutFilePath, LAYOUT_FILE, doxyParams, doxyConfigPath, spinner, pathExists, _e, stderr, code, foldersListForDot;
var _this = this;
return __generator(this, function (_f) {
switch (_f.label) {
case 0:
_c = (0, getDocConfig_1.getDocConfig)(target, config, outDirectory), serverUrl = _c.serverUrl, newOutDirectory = _c.newOutDirectory, enableLineage = _c.enableLineage, doxyContentFromConfig = _c.doxyContent;
_d = (0, getFoldersForDocs_1.getFoldersForDocs)(target, config), macroCoreFolders = _d.macroCore, macroFolders = _d.macro, programFolders = _d.program, serviceFolders = _d.service, jobFolders = _d.job;
combinedFolders = __spreadArray([], __read(new Set(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(macroCoreFolders), false), __read(macroFolders), false), __read(programFolders), false), __read(serviceFolders), false), __read(jobFolders), false))), false).map(function (fpath) { return "\"".concat(fpath, "\""); })
.join(' ');
if (combinedFolders.length === 0) {
throw new Error("Unable to locate folders for generating docs.\n" +
"Please add one of these:\n" +
" - 'macroFolders'\n" +
" - 'programFolders'\n" +
" - 'serviceConfig.serviceFolders'\n" +
" - 'jobConfig.jobFolders'\n");
}
PROJECT_NAME = "Please update the 'name' property in the package.json file";
PROJECT_BRIEF = "Please update the 'description' property in the package.json file";
_f.label = 1;
case 1:
_f.trys.push([1, 3, , 4]);
return [4 /*yield*/, (0, utils_1.readFile)(path_1.default.join(process.projectDir, 'package.json'))];
case 2:
packageJsonContent = _f.sent();
packageJson = JSON.parse(packageJsonContent);
PROJECT_NAME = packageJson.name || PROJECT_NAME;
PROJECT_BRIEF =
packageJson.description.replace(/`/g, '\\`') || PROJECT_BRIEF;
return [3 /*break*/, 4];
case 3:
e_1 = _f.sent();
(_a = process.logger) === null || _a === void 0 ? void 0 : _a.info("Unable to parse content of 'package.json'");
return [3 /*break*/, 4];
case 4:
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),
HTML_EXTRA_FILES: "\"".concat(path_1.default.join(doxyContent.path, doxyContent.favIcon), "\""),
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: 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 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 7:
pathExists = _f.sent();
if (!pathExists) return [3 /*break*/, 9];
return [4 /*yield*/, (0, utils_1.deleteFolder)(newOutDirectory)];
case 8:
_f.sent();
_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*/, 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 13:
_f.sent();
_f.label = 14;
case 14: return [2 /*return*/, { outDirectory: newOutDirectory }];
}
});
});
}
exports.generateDocs = generateDocs;
function setVariableCmd(params) {
var command = '';
if ((0, utils_1.isWindows)()) {
for (var param in params)
command += "set ".concat(param, "=").concat(params[param], " && ");
}
else {
for (var param in params)
command += "".concat(param, "='").concat(params[param], "' ");
}
return command;
}
var getDoxyConfigPath = function (doxyContentPath) { return __awaiter(void 0, void 0, void 0, function () {
var doxyFilePath;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
doxyFilePath = path_1.default.join(doxyContentPath, 'Doxyfile');
return [4 /*yield*/, (0, utils_1.fileExists)(doxyFilePath)];
case 1:
if (_a.sent())
return [2 /*return*/, doxyFilePath];
doxyFilePath = path_1.default.join(doxyContentPath, 'DoxyFile');
return [4 /*yield*/, (0, utils_1.fileExists)(doxyFilePath)];
case 2:
if (_a.sent())
return [2 /*return*/, doxyFilePath];
doxyFilePath = path_1.default.join(doxyContentPath, 'doxyfile');
return [4 /*yield*/, (0, utils_1.fileExists)(doxyFilePath)];
case 3:
if (_a.sent())
return [2 /*return*/, doxyFilePath];
doxyFilePath = path_1.default.join(doxyContentPath, 'doxyFile');
return [4 /*yield*/, (0, utils_1.fileExists)(doxyFilePath)];
case 4:
if (_a.sent())
return [2 /*return*/, doxyFilePath];
throw 'Doxygen Configuration File is not found!\n Supported names are "Doxyfile", "DoxyFile", "doxyfile" and "doxyFile"';
}
});
}); };