postman-collection-to-html/cli.js

Postman collection to HTML converter

#!/usr/bin/env node

import fs from "fs";
import { argv } from "node:process";
import { collectionToHTML } from "./index.js";

// Parse and validate command-line arguments
if (argv.length < 3) {
  console.error(
    "Usage: node cli.js <input-file.json> [--output=output-file.html] [--lang=language] [--logo=logo.svg] [--divider=h1|h2|h3|h4|h5|h6]"
  );
  console.error("Options:");
  console.error(
    "  --output=file.html    Output HTML file (default: api-doc.html)"
  );
  console.error(
    "  --lang=language       Language for documentation (default: en)"
  );
  console.error("  --logo=logo.svg       SVG logo file to embed (optional)");
  console.error(
    "  --divider=h1-h6       Heading level to add border-bottom (optional)"
  );
  console.error("Available languages: en (English), fr (French)");
  process.exit(1);
}

// Extract arguments
const inputFile = argv[2];
let outputFile = "api-doc.html";
let language = "en";
let logoPath = null;
let divider = null;

// Parse remaining arguments
for (let i = 3; i < argv.length; i++) {
  const arg = argv[i];
  if (arg.startsWith("--lang=")) {
    language = arg.split("=")[1];
  } else if (arg.startsWith("--output=")) {
    outputFile = arg.split("=")[1];
  } else if (arg.startsWith("--logo=")) {
    logoPath = arg.split("=")[1];
  } else if (arg.startsWith("--divider=")) {
    divider = arg.split("=")[1];
  } else {
    console.error(`Unknown argument: ${arg}`);
    console.error("Use --help for usage information");
    process.exit(1);
  }
}

// Validate language
const supportedLanguages = ["en", "fr"];
if (!supportedLanguages.includes(language)) {
  console.error(`Unsupported language: ${language}`);
  console.error(`Available languages: ${supportedLanguages.join(", ")}`);
  process.exit(1);
}

// Validate divider if provided
const validDividers = ["h1", "h2", "h3", "h4", "h5", "h6"];
if (divider && !validDividers.includes(divider)) {
  console.error(`Invalid divider: ${divider}`);
  console.error(`Valid dividers: ${validDividers.join(", ")}`);
  process.exit(1);
}

try {
  let logo = null;

  if (logoPath) {
    try {
      logo = fs.readFileSync(logoPath, "utf8");
      console.log(`Found logo file: ${logoPath}, embedding it in the HTML...`);
    } catch (error) {
      console.error(
        `Error: Could not read logo file '${logoPath}': ${error.message}`
      );
      process.exit(1);
    }
  }

  collectionToHTML(inputFile, {
    outputFile,
    language,
    logo,
    divider,
  });
  console.log(
    `HTML generated successfully: ${outputFile} (language: ${language})`
  );
} catch (error) {
  console.error("Error:", error.message);
  process.exit(1);
}