@sasjs/cli 4.6.0 → 4.8.0

package/build/commands/job/spec/jobCommand.spec.js

@@ -192,8 +192,7 @@ describe('JobCommand', function () {
                         _b.sent();
                         (_a = expect(viyaExecuteModule.executeJobViya)).toHaveBeenCalledWith.apply(_a, __spreadArray([], __read(executeCalledWith({
                             jobPath: jobPath,
-                            waitForJob: true,
-                            verbose: true
+                            waitForJob: true
                         })), false));
                         return [2 /*return*/];
                 }
@@ -321,6 +320,78 @@ describe('JobCommand', function () {
                 }
             });
         }); });
+        it('should set verbose to true if verbose flag present', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var sasjs;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sasjs = new node_1.default();
+                        jest
+                            .spyOn(configUtils, 'getSASjsAndAuthConfig')
+                            .mockImplementation(function (target) {
+                            sasjs = configUtils.getSASjs(target);
+                            jest.spyOn(sasjs, 'setVerboseMode');
+                            return Promise.resolve({
+                                sasjs: sasjs,
+                                authConfig: authConfig
+                            });
+                        });
+                        return [4 /*yield*/, executeCommandWrapper([jobPath, '--verbose'])];
+                    case 1:
+                        _a.sent();
+                        expect(sasjs.setVerboseMode).toHaveBeenCalledWith(true);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should set verbose to bleached if verbose flag present and is equal to bleached', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var sasjs;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sasjs = new node_1.default();
+                        jest
+                            .spyOn(configUtils, 'getSASjsAndAuthConfig')
+                            .mockImplementation(function (target) {
+                            sasjs = configUtils.getSASjs(target);
+                            jest.spyOn(sasjs, 'setVerboseMode');
+                            return Promise.resolve({
+                                sasjs: sasjs,
+                                authConfig: authConfig
+                            });
+                        });
+                        return [4 /*yield*/, executeCommandWrapper([jobPath, '-v', 'bleached'])];
+                    case 1:
+                        _a.sent();
+                        expect(sasjs.setVerboseMode).toHaveBeenCalledWith('bleached');
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should set verbose to false if verbose flag is not present', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var sasjs;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sasjs = new node_1.default();
+                        jest
+                            .spyOn(configUtils, 'getSASjsAndAuthConfig')
+                            .mockImplementation(function (target) {
+                            sasjs = configUtils.getSASjs(target);
+                            jest.spyOn(sasjs, 'setVerboseMode');
+                            return Promise.resolve({
+                                sasjs: sasjs,
+                                authConfig: authConfig
+                            });
+                        });
+                        return [4 /*yield*/, executeCommandWrapper([jobPath])];
+                    case 1:
+                        _a.sent();
+                        expect(sasjs.setVerboseMode).toHaveBeenCalledWith(false);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
     });
     describe('for server type sas9', function () {
         beforeEach(function () {
@@ -540,7 +611,7 @@ var setupMocksForSAS9 = function () {
     jest.spyOn(process.logger, 'error');
 };
 var executeCalledWith = function (_a) {
-    var jobPath = _a.jobPath, _b = _a.waitForJob, waitForJob = _b === void 0 ? false : _b, _c = _a.output, output = _c === void 0 ? false : _c, _d = _a.logFile, logFile = _d === void 0 ? undefined : _d, _e = _a.statusFile, statusFile = _e === void 0 ? undefined : _e, _f = _a.ignoreWarnings, ignoreWarnings = _f === void 0 ? false : _f, _g = _a.source, source = _g === void 0 ? undefined : _g, _h = _a.streamLog, streamLog = _h === void 0 ? false : _h, _j = _a.verbose, verbose = _j === void 0 ? false : _j;
+    var jobPath = _a.jobPath, _b = _a.waitForJob, waitForJob = _b === void 0 ? false : _b, _c = _a.output, output = _c === void 0 ? false : _c, _d = _a.logFile, logFile = _d === void 0 ? undefined : _d, _e = _a.statusFile, statusFile = _e === void 0 ? undefined : _e, _f = _a.ignoreWarnings, ignoreWarnings = _f === void 0 ? false : _f, _g = _a.source, source = _g === void 0 ? undefined : _g, _h = _a.streamLog, streamLog = _h === void 0 ? false : _h;
     return [
         expect.anything(),
         authConfig,
@@ -552,8 +623,7 @@ var executeCalledWith = function (_a) {
         statusFile,
         ignoreWarnings,
         source,
-        streamLog,
-        verbose
+        streamLog
     ];
 };
 var executeCommandWrapper = function (additionalParams) { return __awaiter(void 0, void 0, void 0, function () {

package/build/commands/snippets/snippets.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates VS Code snippets from the Doxygen headers in the SAS Macros.
+ * @param macroFolders an array of file paths of SAS Macros.
+ * @param outDirectory a folder path where generated snippets should be put into. If ends with '<file name>.json' then provided file name will be used, otherwise default file name ('sasjs-macro-snippets.json') will be used.
+ * @returns a promise that resolves into a file path with generated VS Code snippets.
+ */
+export declare function generateSnippets(macroFolders: string[], outDirectory?: string): Promise<string>;

package/build/commands/snippets/snippets.js

@@ -0,0 +1,192 @@
+"use strict";
+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.generateSnippets = void 0;
+var utils_1 = require("@sasjs/utils");
+var path_1 = __importDefault(require("path"));
+var sasRegExp = /\.sas$/; // to check if file has .sas extension
+var briefRegExp = /^\s\s@brief\s/; // to get lines that has @brief keyword
+var paramRegExp = /^\s\s@param\s/; // to get lines that has @param keyword
+/**
+ * Generates VS Code snippets from the Doxygen headers in the SAS Macros.
+ * @param macroFolders an array of file paths of SAS Macros.
+ * @param outDirectory a folder path where generated snippets should be put into. If ends with '<file name>.json' then provided file name will be used, otherwise default file name ('sasjs-macro-snippets.json') will be used.
+ * @returns a promise that resolves into a file path with generated VS Code snippets.
+ */
+function generateSnippets(macroFolders, outDirectory) {
+    return __awaiter(this, void 0, void 0, function () {
+        var snippets, defaultOutputFileName, buildDestinationResultsFolder, snippetsFilePath;
+        var _this = this;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    snippets = {};
+                    // return an error if no macro folders has been provided
+                    if (!macroFolders.length) {
+                        return [2 /*return*/, Promise.reject("\"macroFolders\" array was not found in sasjs/sasjsconfig.json.")];
+                    }
+                    // generate snippets from all .sas file in macro folders
+                    return [4 /*yield*/, (0, utils_1.asyncForEach)(macroFolders, function (folder) { return __awaiter(_this, void 0, void 0, function () {
+                            var sasFiles;
+                            var _this = this;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, (0, utils_1.listSasFilesInFolder)(folder, true)];
+                                    case 1:
+                                        sasFiles = (_a.sent())
+                                            .map(function (file) { return path_1.default.join(folder, file); })
+                                            .filter(function (file) { return !(0, utils_1.isTestFile)(file); });
+                                        return [4 /*yield*/, (0, utils_1.asyncForEach)(sasFiles, function (file) { return __awaiter(_this, void 0, void 0, function () {
+                                                var macro, _a, _b;
+                                                return __generator(this, function (_c) {
+                                                    switch (_c.label) {
+                                                        case 0:
+                                                            macro = file.split(path_1.default.sep).pop().replace(sasRegExp, '');
+                                                            // put generated snippet into snippets object
+                                                            _a = snippets;
+                                                            _b = macro;
+                                                            return [4 /*yield*/, createSnippetFromMacro(file)];
+                                                        case 1:
+                                                            // put generated snippet into snippets object
+                                                            _a[_b] = _c.sent();
+                                                            return [2 /*return*/];
+                                                    }
+                                                });
+                                            }); })];
+                                    case 2:
+                                        _a.sent();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); })
+                        // return an error if no snippets has been generated
+                    ];
+                case 1:
+                    // generate snippets from all .sas file in macro folders
+                    _a.sent();
+                    // return an error if no snippets has been generated
+                    if (!Object.keys(snippets).length) {
+                        return [2 /*return*/, Promise.reject('No VS Code snippets has been found.')];
+                    }
+                    defaultOutputFileName = 'sasjs-macro-snippets.json';
+                    buildDestinationResultsFolder = process.sasjsConstants.buildDestinationResultsFolder;
+                    snippetsFilePath = path_1.default.join(outDirectory ? process.projectDir : buildDestinationResultsFolder, outDirectory
+                        ? /\.json$/.test(outDirectory)
+                            ? outDirectory
+                            : path_1.default.join(outDirectory, defaultOutputFileName)
+                        : defaultOutputFileName);
+                    // create file with generated VS Code snippets
+                    return [4 /*yield*/, (0, utils_1.createFile)(snippetsFilePath, JSON.stringify(snippets, null, 2))
+                        // return file path with generated VS Code snippets
+                    ];
+                case 2:
+                    // create file with generated VS Code snippets
+                    _a.sent();
+                    // return file path with generated VS Code snippets
+                    return [2 /*return*/, Promise.resolve(snippetsFilePath)];
+            }
+        });
+    });
+}
+exports.generateSnippets = generateSnippets;
+/**
+ * Creates a VS Code snippet from SAS macro.
+ * @param file file path of SAS macro.
+ * @returns promise that resolves with VS Code snippet.
+ */
+var createSnippetFromMacro = function (file) { return __awaiter(void 0, void 0, void 0, function () {
+    var fileContent, lineEnding, lines, brief, params, macro, description;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, utils_1.readFile)(file)];
+            case 1:
+                fileContent = _a.sent();
+                lineEnding = (0, utils_1.getLineEnding)(fileContent) // LF or CRLF
+                ;
+                lines = fileContent.split(lineEnding);
+                brief = lines.filter(function (line) { return briefRegExp.test(line); });
+                params = lines.filter(function (line) { return paramRegExp.test(line); });
+                macro = file.split(path_1.default.sep).pop().replace(sasRegExp, '') // macro name
+                ;
+                // if brief present, remove @brief keyword
+                if (brief.length)
+                    brief = [brief[0].replace(briefRegExp, '')];
+                // if params present, add a line break before list of params and a prefix to each param
+                if (params.length) {
+                    brief.push('\r');
+                    params = params.map(function (param) { return param.replace(paramRegExp, '-'); });
+                }
+                description = __spreadArray(__spreadArray(__spreadArray([], __read(brief), false), [
+                    params.length ? "Params:" : ''
+                ], false), __read(params), false).filter(function (line) { return line; });
+                return [2 /*return*/, {
+                        prefix: "%".concat(macro),
+                        body: "%".concat(macro, "($1)"),
+                        description: description
+                    }];
+        }
+    });
+}); };

package/build/commands/snippets/snippetsCommand.d.ts

@@ -0,0 +1,13 @@
+import { ReturnCode } from '../../types/command';
+import { TargetCommand } from '../../types/command/targetCommand';
+/**
+ * 'snippets' command class.
+ */
+export declare class SnippetsCommand extends TargetCommand {
+    constructor(args: string[]);
+    /**
+     * Command execution method.
+     * @returns promise that results into return code.
+     */
+    execute(): Promise<ReturnCode>;
+}

package/build/commands/snippets/snippetsCommand.js

@@ -0,0 +1,122 @@
+"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.SnippetsCommand = void 0;
+var snippets_1 = require("./snippets");
+var command_1 = require("../../types/command");
+var targetCommand_1 = require("../../types/command/targetCommand");
+var utils_1 = require("../../utils");
+var syntax = 'snippets';
+var usage = 'sasjs snippets';
+var description = "Generates VS Code snippets from the Doxygen headers in the SAS Macros.";
+var examples = [
+    {
+        command: 'sasjs snippets',
+        description: description
+    }
+];
+var parseOptions = {
+    outDirectory: {
+        type: 'string',
+        alias: 'o',
+        description: 'Path to the directory where the VS Code snippets output will be generated.'
+    }
+};
+/**
+ * 'snippets' command class.
+ */
+var SnippetsCommand = /** @class */ (function (_super) {
+    __extends(SnippetsCommand, _super);
+    function SnippetsCommand(args) {
+        return _super.call(this, args, { syntax: syntax, usage: usage, description: description, examples: examples, parseOptions: parseOptions }) || this;
+    }
+    /**
+     * Command execution method.
+     * @returns promise that results into return code.
+     */
+    SnippetsCommand.prototype.execute = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var target, macroFolders, outDirectory;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getTargetInfo()];
+                    case 1:
+                        target = (_a.sent()).target;
+                        return [4 /*yield*/, (0, utils_1.getMacroFolders)(target)];
+                    case 2:
+                        macroFolders = _a.sent();
+                        outDirectory = this.parsed.outDirectory;
+                        return [4 /*yield*/, (0, snippets_1.generateSnippets)(macroFolders, outDirectory)
+                                .then(function (filePath) {
+                                var _a, _b;
+                                // handle command execution success
+                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("VS Code snippets generated! File location: ".concat(filePath));
+                                (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("Follow these instructions https://cli.sasjs.io/snippets/#import-snippets-to-vs-code to import generated VS Code snippets into your VS Code.");
+                                return command_1.ReturnCode.Success;
+                            })
+                                .catch(function (err) {
+                                var _a;
+                                // handle command execution failure
+                                (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error('Error generating VS Code snippets: ', err);
+                                return command_1.ReturnCode.InternalError;
+                            })];
+                    case 3: 
+                    // Generate snippets
+                    return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return SnippetsCommand;
+}(targetCommand_1.TargetCommand));
+exports.SnippetsCommand = SnippetsCommand;

package/build/commands/snippets/spec/snippets.spec.d.ts

@@ -0,0 +1 @@
+export {};