convict-doc/bin/convict-doc.ts

Easily generate Markdown documentation from your [Convict](https://github.com/mozilla/node-convict) schema.

#!/usr/bin/env tsx

import yargs from "yargs";
import { resolve } from "node:path";
import { existsSync } from "node:fs";
import { writeFile } from "node:fs/promises";
import { renderDoc } from "../src";
import { defaultOrder } from "../src/renderer";
import * as prettier from "prettier";

const args = yargs(process.argv.slice(2))
  .options({
    input: {
      type: "string",
      alias: "i",
      demandOption: true,
      description: "Path to the config file",
    },
    output: {
      type: "string",
      alias: "o",
      demandOption: false,
      description: "Path to the output file",
    },
    pretty: {
      type: "boolean",
      alias: "p",
      default: false,
      description: "Pretty print the output",
    },
    order: {
      type: "array",
      alias: "r",
      description: `Column order for the Markdown table. Valid values are "name", "default", "arg", "env", "format", "nullable", "sensitive", "doc",`,
      default: defaultOrder,
    },
  })
  .parseSync();

const { input: inputPath, output: outputPath, pretty, order } = args;
const absolutePath = resolve(process.cwd(), inputPath);

if (!existsSync(absolutePath)) {
  console.error(`File ${absolutePath} does not exist`);
  process.exit(1);
}

const config = (await import(absolutePath)).default;

if (!config) {
  console.error(`File ${absolutePath} does not export a default value`);
  process.exit(1);
}

const markdown = renderDoc(config, order as string[]);

const output = pretty
  ? await prettier.format(markdown, { parser: "markdown" })
  : markdown;

if (outputPath) {
  const outputAbsolutePath = resolve(process.cwd(), outputPath);
  await writeFile(outputAbsolutePath, output, "utf-8");
} else {
  console.log(output);
}