treeUtils.ts

import {Writable}       from 'stream';
import {asTree}         from 'treeify';

import {Configuration}  from './Configuration';
import * as formatUtils from './formatUtils';

export type TreeNode = {
  label?: string;
  value?: formatUtils.Tuple;
  children?: Array<TreeNode> | TreeMap;
};

export type TreeRoot = TreeNode & {
  children: Array<TreeNode>;
};

export type TreeMap = {
  [key: string]: TreeNode | false;
};

export type TreeifyNode = {
  [key: string]: TreeifyNode;
};

export function treeNodeToTreeify(printTree: TreeNode, {configuration}: {configuration: Configuration}) {
  const target = {};
  let n = 0;

  const copyTree = (printNode: Array<TreeNode> | TreeMap, targetNode: TreeifyNode) => {
    const iterator = Array.isArray(printNode)
      ? printNode.entries()
      : Object.entries(printNode);

    for (const [key, child] of iterator) {
      if (!child)
        continue;

      const {label, value, children} = child;

      const finalParts = [];
      if (typeof label !== `undefined`)
        finalParts.push(formatUtils.applyStyle(configuration, label, formatUtils.Style.BOLD));
      if (typeof value !== `undefined`)
        finalParts.push(formatUtils.pretty(configuration, value[0], value[1]));
      if (finalParts.length === 0)
        finalParts.push(formatUtils.applyStyle(configuration, `${key}`, formatUtils.Style.BOLD));

      const finalLabel = finalParts.join(`: `).trim();

      // The library we use, treeify, doesn't support having multiple nodes with
      // the same label. To work around that, we prefix each label with a unique
      // string that we strip before output.
      const uniquePrefix = `\0${n++}\0`;
      const createdNode = targetNode[`${uniquePrefix}${finalLabel}`] = {};

      if (typeof children !== `undefined`) {
        copyTree(children, createdNode);
      }
    }
  };

  if (typeof printTree.children === `undefined`)
    throw new Error(`The root node must only contain children`);

  copyTree(printTree.children, target);
  return target;
}

export function treeNodeToJson(printTree: TreeNode) {
  const copyTree = (printNode: TreeNode) => {
    if (typeof printNode.children === `undefined`) {
      if (typeof printNode.value === `undefined`)
        throw new Error(`Assertion failed: Expected a value to be set if the children are missing`);

      return formatUtils.json(printNode.value[0], printNode.value[1]);
    }

    const iterator = Array.isArray(printNode.children)
      ? printNode.children.entries()
      : Object.entries(printNode.children ?? {});

    const targetChildren: {[key: string]: any} = Array.isArray(printNode.children)
      ? []
      : {};

    for (const [key, child] of iterator)
      if (child)
        targetChildren[cleanKey(key)] = copyTree(child);

    if (typeof printNode.value === `undefined`)
      return targetChildren;

    return {
      value: formatUtils.json(printNode.value[0], printNode.value[1]),
      children: targetChildren,
    };
  };

  return copyTree(printTree);
}

export function emitList(values: Array<formatUtils.Tuple>, {configuration, stdout, json}: {configuration: Configuration, stdout: Writable, json: boolean}) {
  const children = values.map(value => ({value}));
  emitTree({children}, {configuration, stdout, json});
}

export function emitTree(tree: TreeNode, {configuration, stdout, json, separators = 0}: {configuration: Configuration, stdout: Writable, json: boolean, separators?: number}) {
  if (json) {
    const iterator = Array.isArray(tree.children)
      ? tree.children.values()
      : Object.values(tree.children ?? {});

    for (const child of iterator)
      if (child)
        stdout.write(`${JSON.stringify(treeNodeToJson(child))}\n`);

    return;
  }

  let treeOutput = asTree(treeNodeToTreeify(tree, {configuration}) as any, false, false);

  treeOutput = treeOutput.replace(/\0[0-9]+\0/g, ``);

  // A slight hack to add line returns between two top-level entries
  if (separators >= 1)
    treeOutput = treeOutput.replace(/^([├└]─)/gm, `│\n$1`).replace(/^│\n/, ``);

  // Another one for the second level fields. We run it twice because in some pathological cases the regex matches would
  if (separators >= 2)
    for (let t = 0; t < 2; ++t)
      treeOutput = treeOutput.replace(/^([│ ].{2}[├│ ].{2}[^\n]+\n)(([│ ]).{2}[├└].{2}[^\n]*\n[│ ].{2}[│ ].{2}[├└]─)/gm, `$1$3  │ \n$2`).replace(/^│\n/, ``);

  if (separators >= 3)
    throw new Error(`Only the first two levels are accepted by treeUtils.emitTree`);

  stdout.write(treeOutput);
}

function cleanKey(key: string | number) {
  return typeof key === `string` ? key.replace(/^\0[0-9]+\0/, ``) : key;
}