Plato - plato/src/bin/plato.ts

//#!/usr/bin/env node

"use strict";
import { Command } from "commander";

import { performance, PerformanceObserver } from "node:perf_hooks";

import fs from "fs";
import path from "path";
import debug from "debug";

const log = debug("perf");

import plato from "../plato.js";

const obs = new PerformanceObserver((list, observer) => {
  log(list.getEntries()[0]);
  performance.clearMarks();
  observer.disconnect();
});
obs.observe({ entryTypes: ['measure'], buffered: true });

const pkg = JSON.parse(
  fs.readFileSync(path.resolve(__dirname, "..", "..", "package.json"), "utf8")
);

function commaSeparatedList(value: string) {
  // ensure we trim the whitespace on the string
  return value.split(",").map((option) => option.trim());
}

const program = new Command();

program.version(pkg.version);
program.helpOption("-h, --help", "read more information");
program.option("-t, --title <title>", "Title of the report");
program.option("-q, --quiet", "Reduce output to errors only");
program.option(
  "-x, --exclude <list>",
  "File exclusion globs",
  commaSeparatedList
);
program.option("-o, --outputDir <directory>", "The output directory");
program.option("-r, --recurse", "Recursively search directories");
program.option(
  "-d, --date",
  "Time to use as the report date (seconds, > 9999999999 assumed to be ms)"
);
program.option("-n, --noempty", "Skips empty lines from line count");
program.option(
  "-f, --files <list>",
  "Files to process globs",
  commaSeparatedList
);

program.option("-e, --eslint", "Specify a eslintrc file for ESLint linting");

program.parse(process.argv);

const options = program.opts();

performance.mark('plato:start');
plato
  .inspect(options.files, options.outputDir, {
    recurse: !!options.recurse,
    q: !!options.quiet,
    title: options.title,
    exclude: options.exclude,
    date: options.date,
    eslintrc: options.eslint,
  })
  .then(() => {
    console.log("done!");
    performance.mark(`plato:end`);
    performance.measure(`plato`, 'plato:start', 'plato:end');
  })
  .catch((ex) => {
    console.log(ex);
  });

plato/src/bin/plato.ts

Maintainability

Lines of code

Difficulty

Estimated Errors

Function weight

By Complexity

By SLOC