npm-pkginfo-cli/lib/render.js

Command line utility to view info about your current package

import { colorterm } from "./util/color";
import { debug } from "./util/debug";
import { debugTime } from "./util/debugTime";

const render = (packages, options) => {
  debug("[render] args", {packages}, {options});

  // SHOULD EXIT VS RETURN
  if (!packages) {
    console.log("No packages listed");
    debug("[render] exit no packages");
    return false;
  }

  // ADDS COLOR PROPERTIES TO STRINGS WHEN IMPORTED
  color(options.color);

  var MAX_LENGTH = process.stdout.columns || 80;
  var MAX_STARS = 0;
  var MAX_DOWNLOADS = 0;
  var MAX_NAME = 0;
  var MAX_VERSION = 0;

  var pad_stars;
  var pad_downs;
  var pad_version;
  var base_length;
  var sorted;

  // SET THE MAX VALUES FOR FORMATTING LATER WHILE WE ARE INSIDE THE LOOP
  const set_lengths = (pkg) => {
    var pkg_stars = pkg.stargazers_count;
    var pkg_down = pkg.downloads;
    var pkg_name = pkg.name;
    var pkg_ver = "0.0.0.0";
    if (pkg.metadata) {
      pkg_ver = pkg.metadata.version;
    } else {
      pkg_ver = pkg.version;
    }
    if (parseInt(pkg_stars) > MAX_STARS) { MAX_STARS = parseInt(pkg_stars); }
    if (parseInt(pkg_down) > MAX_DOWNLOADS) { MAX_DOWNLOADS = parseInt(pkg_down); }
    if (pkg_name.length > MAX_NAME) { MAX_NAME = pkg_name.length; }
    var version_len = (pkg_ver) ? pkg_ver.length : 0;
    if (version_len > MAX_VERSION) { MAX_VERSION = version_len; }
  };

  const sort_stars = (a, b) => {
    set_lengths(a);
    set_lengths(b);

    if (parseInt(a.stargazers_count) < parseInt(b.stargazers_count)) {
      return 1;
    } else {
      return -1;
    }
  };

  const sort_downloads = (a, b) => {
    set_lengths(a);
    set_lengths(b);

    if (parseInt(a.downloads) < parseInt(b.downloads)) {
      return 1;
    } else {
      return -1;
    }
  };

  const table_header = [
    "Stars",
    "Downloads",
    "Package",
    "Description"
  ].join(" ");

  const table_divider = "-".padStart(table_header.length, "-");

  const wrap_version = (ver) => {
    return ["(", ver, ")"].join("");
  };

  const format_line = (item) => {
    if (!item.name) { return false; }
    if (item.metadata) {
      item.description = item.metadata.description;
      item.version = item.metadata.version;
    }
    const name = item.name;
    const downloads = (item.downloads || 0).toString().padStart(pad_downs, " ");
    const stars = (item.stargazers_count || 0).toString().padStart(pad_stars, " ");
    const version = wrap_version(item.version || "0.0.0");
    const description = (item.description || "undefined").slice(0, MAX_LENGTH - base_length - name.length);

    return ["",
      (options.sort === "downloads") ? stars.default : stars.yellow.bold,
      (options.sort === "downloads") ? downloads.yellow.bold : downloads.default,
      name.cyan.bold,
      version.dim.italic,
      description.white
    ].join(" ");
  };

  const print_table = (results) => {
    var table = [];
    table.push(table_header.bold);
    table.push(table_divider);

    for (var item of results) {
      table.push(format_line(item));
    }
    console.log(table.join("\n"));
  };

  if (options.sort === "downloads") {
    debug("[render] sort_downloads");
    debugTime("[render]", "mark");
    sorted = packages.sort(sort_downloads);
  } else {
    debug("[render] sort_stars");
    debugTime("[render]", "mark");
    sorted = packages.sort(sort_stars);
  }

  pad_stars = MAX_STARS.toString().length;
  pad_downs = MAX_DOWNLOADS.toString().length;
  pad_version = MAX_VERSION;
  base_length = (4 * 2) + pad_stars + pad_downs + pad_version;

  debug("[render] print table");
  debugTime("[render]", "mark");
  debug(
    ["Longest", MAX_LENGTH].join(": "),
    ["pad_stars", pad_stars].join(": "),
    ["pad_downs", pad_downs].join(": "),
    ["pad_version", pad_version].join(": "),
  );
  print_table(sorted);
  debug("[render] done");
  debugTime("[render]", "end");
  return true;
};

export { render };