code-complexity/dist/src/io/cli.js

Measure the churn/complexity score. Higher values mean hotspots where refactorings should happen.

"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 (_) 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 };
    }
};
exports.__esModule = true;
var node_child_process_1 = require("node:child_process");
var node_fs_1 = require("node:fs");
var node_path_1 = require("node:path");
var node_os_1 = require("node:os");
var node_url_1 = require("node:url");
var commander_1 = require("commander");
var utils_1 = require("../utils");
var internal = { debug: (0, utils_1.buildDebugger)("cli") };
exports["default"] = { parse: parse, cleanup: cleanup };
function parse() {
    return __awaiter(this, void 0, void 0, function () {
        var _a, description, version, cli, options;
        return __generator(this, function (_b) {
            switch (_b.label) {
                case 0: return [4 /*yield*/, (0, utils_1.getPackageJson)()];
                case 1:
                    _a = _b.sent(), description = _a.description, version = _a.version;
                    cli = getRawCli(description, version).parse();
                    assertArgsAreProvided(cli);
                    options = buildOptions(cli.args, cli.opts());
                    internal.debug("applying options: ".concat(JSON.stringify(options)));
                    return [2 /*return*/, options];
            }
        });
    });
}
function cleanup(options) {
    if (options.target instanceof node_url_1.URL) {
        (0, node_child_process_1.execSync)("rm -rf ".concat(options.directory), { stdio: "ignore" });
    }
}
function getRawCli(description, version) {
    return commander_1.program
        .name("code-complexity")
        .usage("<target> [options]")
        .argument("<target>")
        .version(version || "")
        .description(description || "")
        .option("--filter <strings>", "list of globs (comma separated) to filter", commaSeparatedList)
        .option("-cs, --complexity-strategy [sloc|cyclomatic|halstead]", "choose the complexity strategy to analyze your codebase with", /^(sloc|cyclomatic|halstead)$/i)
        .option("-f, --format [format]", "format results using table or json", /^(table|json|csv)$/i)
        .option("-l, --limit [limit]", "limit the number of files to output", parseInt)
        .option("-i, --since [since]", "limit analysis to commits more recent in age than date")
        .option("-u, --until [until]", "limit analysis to commits older in age than date")
        .option("-s, --sort [sort]", "sort results (allowed valued: score, churn, complexity or file)", /^(score|churn|complexity|file)$/i)
        .option("-d, --directories", "display values for directories instead of files")
        .on("--help", function () {
        console.log();
        console.log("Examples:");
        console.log();
        [
            "$ code-complexity .",
            "$ code-complexity https://github.com/simonrenoult/code-complexity",
            "$ code-complexity foo --limit 3",
            "$ code-complexity ../foo --sort score",
            "$ code-complexity /foo/bar --filter 'src/**,!src/front/**'",
            "$ code-complexity . --limit 10 --sort score",
            "$ code-complexity . --limit 10 --modules",
            "$ code-complexity . --limit 10 --sort score -cs halstead",
            "$ code-complexity . --since=2021-06-01 --limit 100",
            "$ code-complexity . --since=2021-04-01 --until=2021-07-01",
        ].forEach(function (example) { return console.log(example.padStart(2)); });
    });
}
function buildOptions(args, options) {
    var target = parseTarget(args[0]);
    return {
        target: target,
        directory: parseDirectory(target),
        directories: options.directories,
        format: options.format ? String(options.format) : "table",
        filter: options.filter || [],
        limit: options.limit ? Number(options.limit) : undefined,
        since: options.since ? String(options.since) : undefined,
        until: options.until ? String(options.until) : undefined,
        sort: options.sort ? String(options.sort) : undefined,
        complexityStrategy: options.complexityStrategy
            ? String(options.complexityStrategy)
            : "sloc"
    };
    // FIXME: I'm not a fan of pulling the code here but it's good enough.
    function parseDirectory(target) {
        if (target instanceof node_url_1.URL) {
            var temporaryDirLocation = (0, node_os_1.tmpdir)() + node_path_1.sep + "code-complexity-".concat(new Date().getTime());
            (0, node_child_process_1.execSync)("git clone ".concat(target, " ").concat(temporaryDirLocation), {
                stdio: "ignore"
            });
            return temporaryDirLocation;
        }
        else {
            return target;
        }
    }
    function parseTarget(target) {
        try {
            return new node_url_1.URL(target);
        }
        catch (e) {
            try {
                (0, node_fs_1.lstatSync)(target);
                return target;
            }
            catch (e) {
                throw new Error("Argument 'target' is neither a directory nor a valid URL.");
            }
        }
    }
}
function commaSeparatedList(value) {
    return value.split(",");
}
function assertArgsAreProvided(internalCli) {
    if (!internalCli.args || !internalCli.args.length) {
        internalCli.help();
        process.exit(1);
    }
}