@sasjs/cli/build/commands/docs/docsCommand.js

Command line interface for SASjs

"use strict";
var __extends = (this && this.__extends) || (function () {
    var extendStatics = function (d, b) {
        extendStatics = Object.setPrototypeOf ||
            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
        return extendStatics(d, b);
    };
    return function (d, b) {
        if (typeof b !== "function" && b !== null)
            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
        extendStatics(d, b);
        function __() { this.constructor = d; }
        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
    };
})();
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 };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DocsCommand = void 0;
var __1 = require("..");
var command_1 = require("../../types/command");
var targetCommand_1 = require("../../types/command/targetCommand");
var DocSubCommand;
(function (DocSubCommand) {
    DocSubCommand["Init"] = "init";
    DocSubCommand["Lineage"] = "lineage";
})(DocSubCommand || (DocSubCommand = {}));
var syntax = 'doc [subCommand]';
var aliases = ['docs'];
var usage = 'sasjs doc [init | lineage]';
var description = 'Generates docs for SAS Programs / Macros / Jobs / Services listed in the sasjsconfig.json file by default and supplied Target.';
var examples = [
    {
        command: 'sasjs doc',
        description: 'Generates documentation for the current project using Doxygen.'
    },
    {
        command: 'sasjs doc lineage',
        description: 'Generates lineage for the current project in dot language.'
    },
    {
        command: 'sasjs doc init',
        description: 'Initialises doxygen configuration for existing SASjs projects. Can also be used to reset the configuration and content.'
    }
];
var commandParseOptions = {
    outDirectory: {
        type: 'string',
        alias: 'o',
        description: 'Path to the directory where the doc output will be generated.'
    }
};
var DocsCommand = /** @class */ (function (_super) {
    __extends(DocsCommand, _super);
    function DocsCommand(args) {
        var subCommand = args[3];
        var parseOptions = subCommand === DocSubCommand.Init ? {} : commandParseOptions;
        return _super.call(this, args, {
            parseOptions: parseOptions,
            usage: usage,
            description: description,
            examples: examples,
            syntax: syntax,
            aliases: aliases
        }) || this;
    }
    DocsCommand.prototype.execute = function () {
        return __awaiter(this, void 0, void 0, function () {
            var _a, _b;
            return __generator(this, function (_c) {
                switch (_c.label) {
                    case 0:
                        if (!(this.parsed.subCommand === DocSubCommand.Init)) return [3 /*break*/, 2];
                        return [4 /*yield*/, this.executeInitDocs()];
                    case 1:
                        _a = _c.sent();
                        return [3 /*break*/, 7];
                    case 2:
                        if (!(this.parsed.subCommand === DocSubCommand.Lineage)) return [3 /*break*/, 4];
                        return [4 /*yield*/, this.executeGenerateDot()];
                    case 3:
                        _b = _c.sent();
                        return [3 /*break*/, 6];
                    case 4: return [4 /*yield*/, this.executeGenerateDocs()];
                    case 5:
                        _b = _c.sent();
                        _c.label = 6;
                    case 6:
                        _a = _b;
                        _c.label = 7;
                    case 7: return [2 /*return*/, _a];
                }
            });
        });
    };
    DocsCommand.prototype.executeGenerateDocs = function () {
        return __awaiter(this, void 0, void 0, function () {
            var target, config, returnCode;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0: return [4 /*yield*/, this.getTargetInfo()];
                    case 1:
                        target = (_a.sent()).target;
                        config = process.sasjsConfig;
                        return [4 /*yield*/, (0, __1.generateDocs)(target, config, this.parsed.outDirectory)
                                .then(function (res) {
                                var _a;
                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("Docs have been generated!\nThe docs are located in the ".concat(res.outDirectory, "' directory.\nClick to open: ").concat(res.outDirectory, "/index.html"));
                                return command_1.ReturnCode.Success;
                            })
                                .catch(function (err) {
                                var _a;
                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error('Error generating docs: ', err);
                                return command_1.ReturnCode.InternalError;
                            })];
                    case 2:
                        returnCode = _a.sent();
                        return [2 /*return*/, returnCode];
                }
            });
        });
    };
    DocsCommand.prototype.executeGenerateDot = function () {
        return __awaiter(this, void 0, void 0, function () {
            var target, config, returnCode;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0: return [4 /*yield*/, this.getTargetInfo()];
                    case 1:
                        target = (_a.sent()).target;
                        config = process.sasjsConfig;
                        return [4 /*yield*/, (0, __1.generateDot)(target, config, this.parsed.outDirectory)
                                .then(function (res) {
                                var _a;
                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("Dot files have been generated!\nFiles are located in the ".concat(res.outDirectory, "' directory."));
                                return command_1.ReturnCode.Success;
                            })
                                .catch(function (err) {
                                var _a;
                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error('Error generating docs: ', err);
                                return command_1.ReturnCode.InternalError;
                            })];
                    case 2:
                        returnCode = _a.sent();
                        return [2 /*return*/, returnCode];
                }
            });
        });
    };
    DocsCommand.prototype.executeInitDocs = function () {
        return __awaiter(this, void 0, void 0, function () {
            var returnCode;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0: return [4 /*yield*/, (0, __1.initDocs)()
                            .then(function () {
                            var _a;
                            (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success('The doxygen configuration files have been initialised under `/sasjs/doxy/`. You can now run `sasjs doc`.');
                            return command_1.ReturnCode.Success;
                        })
                            .catch(function (err) {
                            var _a;
                            (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error('Error initialising docs: ', err);
                            return command_1.ReturnCode.InternalError;
                        })];
                    case 1:
                        returnCode = _a.sent();
                        return [2 /*return*/, returnCode];
                }
            });
        });
    };
    return DocsCommand;
}(targetCommand_1.TargetCommand));
exports.DocsCommand = DocsCommand;