yaclt/src/utils/array-to-markdown-table.ts

Yet Another Change Log Tool

import prettier from "prettier";

/**
 * Humanize a string from camelCase,
 * cameCase becomes Camel Case
 */
const humanize = (input: string): string =>
  input
    .replace(/([a-z])([A-Z])/g, "$1 $2")
    .toLowerCase()
    .split(" ")
    .map((s) => s.charAt(0).toUpperCase() + s.slice(1))
    .join(" ");

export const arrayToMarkdownTable = <T extends Record<string, unknown>>(
  input: T[]
): string => {
  if (input.length === 0) {
    throw new Error("Need at least 1 item to generate a markdown table from.");
  }

  let markdown = "|";
  const headers = Object.keys(input[0] ?? {});
  headers.forEach((header: string) => {
    markdown += ` ${humanize(header)} |`;
  });
  markdown += "\n|";
  headers.forEach(() => {
    markdown += " --- |";
  });

  markdown += "\n";
  for (const line of input) {
    markdown += "|";
    for (const field of headers) {
      markdown += ` ${line[field]} |`;
    }
    markdown += "\n";
  }

  markdown = prettier.format(markdown, { parser: "markdown" });
  return markdown;
};