@sasjs/cli/build/commands/lint/lintCommand.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.LintCommand = void 0;
var initLint_1 = require("./initLint");
var processLint_1 = require("./processLint");
var command_1 = require("../../types/command");
var types_1 = require("../../types");
var utils_1 = require("../../utils");
var syntax = 'lint <subCommand> [filterStrings..]';
var usage = 'sasjs lint [ find | fix | init ]';
var description = "Provides the capability to identify, for SAS file, whether there are any ERRORs or WARNINGs present and if so, which line number they are on.";
var examples = [
    {
        command: 'sasjs lint',
        description: 'Lints all .sas files in the current project.\n' +
            'All the exceptions (along with line / column numbers) will be shown in the console.'
    },
    {
        command: 'sasjs lint find mf_a mf_b',
        description: 'Lints all .sas files starting from mf_a or mf_b in the current project.\n' +
            'All the exceptions (along with line / column numbers) will be shown in the console.'
    },
    {
        command: 'sasjs lint find /home/user/project/sasjs/services/appinit.sas',
        description: 'Lints only appinit.sas file present in services folder.\n' +
            'All the exceptions (along with line / column numbers) will be shown in the console.'
    },
    {
        command: 'sasjs lint find sasjs/macros',
        description: 'Lints all .sas files present in sasjs/macros folder.\n' +
            'All the exceptions (along with line / column numbers) will be shown in the console.'
    },
    {
        command: 'sasjs lint fix',
        description: 'Fixes lint violations in all .sas files in the current project.\n' +
            'All the exceptions (along with line / column numbers) will be fixed.'
    },
    {
        command: 'sasjs lint fix mf_a mf_b',
        description: 'Fixes lint violations in all .sas files starting from mf_a or mf_b in the current project.\n' +
            'All the exceptions (along with line / column numbers) will be fixed.'
    },
    {
        command: 'sasjs lint fix /home/user/project/sasjs/services/appinit.sas',
        description: 'Fixes lint violations in only appinit.sas in services folder.\n' +
            'All the exceptions (along with line / column numbers) will be fixed.'
    },
    {
        command: 'sasjs lint fix sasjs/macros/',
        description: 'Fixes lint violations in all .sas files in the macros folder.\n' +
            'All the exceptions (along with line / column numbers) will be fixed.'
    },
    {
        command: 'sasjs lint init',
        description: "Creates a SASjs Lint configuration file. Its name will be of the form '.sasjslint'"
    }
];
var LintCommand = /** @class */ (function (_super) {
    __extends(LintCommand, _super);
    function LintCommand(args) {
        if (args.length < 4) {
            args.splice(3, 0, 'find');
        }
        return _super.call(this, args, {
            syntax: syntax,
            usage: usage,
            description: description,
            examples: examples
        }) || this;
    }
    LintCommand.prototype.execute = function () {
        return __awaiter(this, void 0, void 0, function () {
            var _a, subCommand, filterStrings;
            return __generator(this, function (_b) {
                switch (_b.label) {
                    case 0:
                        _a = this.parsed, subCommand = _a.subCommand, filterStrings = _a.filterStrings;
                        if (!(subCommand === 'init')) return [3 /*break*/, 2];
                        return [4 /*yield*/, (0, initLint_1.initLint)()
                                .then(function (res) {
                                if (res.fileAlreadyExisted)
                                    (0, utils_1.displaySuccess)('The lint configuration file `.sasjslint` is already present.');
                                else
                                    (0, utils_1.displaySuccess)('The lint configuration file `.sasjslint` has been created. You can now run `sasjs lint`.');
                                return command_1.ReturnCode.Success;
                            })
                                .catch(function (err) {
                                (0, utils_1.displayError)(err, 'An error has occurred whilst initialising SASjs Lint.');
                                return command_1.ReturnCode.InternalError;
                            })];
                    case 1: return [2 /*return*/, _b.sent()];
                    case 2:
                        if (!(subCommand === 'fix')) return [3 /*break*/, 4];
                        return [4 /*yield*/, (0, processLint_1.lintFix)(filterStrings)
                                .then(function () { return command_1.ReturnCode.Success; })
                                .catch(function (err) {
                                (0, utils_1.displayError)(err, 'An error has occurred while running SASjs Lint Fix.');
                                return command_1.ReturnCode.LintError;
                            })];
                    case 3: return [2 /*return*/, _b.sent()];
                    case 4: return [4 /*yield*/, (0, processLint_1.processLint)(filterStrings)
                            .then(function (result) {
                            if (result.errors) {
                                (0, utils_1.displayError)('Please fix the identified lint errors.');
                                return command_1.ReturnCode.LintError;
                            }
                            if (result.warnings) {
                                process.logger.warn('Please fix the identified lint warnings.');
                                return command_1.ReturnCode.Success;
                            }
                            (0, utils_1.displaySuccess)('All matched files use @sasjs/lint code style!');
                            return command_1.ReturnCode.Success;
                        })
                            .catch(function (err) {
                            (0, utils_1.displayError)(err, 'An error has occurred when processing lint operation.');
                            return command_1.ReturnCode.InternalError;
                        })];
                    case 5: return [2 /*return*/, _b.sent()];
                }
            });
        });
    };
    return LintCommand;
}(types_1.CommandBase));
exports.LintCommand = LintCommand;