next-banner/src/config.ts

Generate Open Graph images for Next.js on build

import { merge } from "merge-anything";
import fs from "node:fs";
import { BannerConfig } from "./types";
import { loadFile } from "./cli/file";
import { getPath } from "./cli/file";
import { NextConfig } from "next/types";

const defaultConfig: BannerConfig = {
  domain: "localhost:3000",
  nextDir: ".next",
  excludePages: [],
  layoutDir: "next-banner-layouts",
  outputDir: "next-banner-generated",
  width: 1200,
  height: 630,
  concurrency: 10,
};

const CONFIG_FILE = ".next/next-banner.json";

async function getConfig(): Promise<BannerConfig> {
  try {
    const file = await loadFile<BannerConfig>(getPath(`./${CONFIG_FILE}`));
    return file as BannerConfig;
  } catch (e) {
    console.log("found error, using default config");
    return defaultConfig;
  }
}

type CombinedConfig = { nextBanner: Partial<BannerConfig> } & NextConfig;

/**
 * Sets layout and custom data for the banner.
 * @constructor
 * @param {CombinedConfig} config - Next.js and Banner configuration
 */

function withNextBanner(config: CombinedConfig) {
  // Write config to file to be able to use it in the cli
  const merged = merge(defaultConfig, config.nextBanner);

  return {
    ...config,
    webpack: (webpackConfig) => {
      try {
        const file = getPath(CONFIG_FILE);
        const json = JSON.stringify(merged, null, 2);

        // const folder = getPath(CONFIG_FILE.substring(0, CONFIG_FILE.lastIndexOf("/")));
        // if (!fs.existsSync(folder)) {
        //   fs.mkdirSync(folder, { recursive: true });
        // }

        fs.writeFileSync(file, json);
      } catch (err) {
        console.error(err);
      }

      return webpackConfig;
    },
    publicRuntimeConfig: {
      ...config.publicRuntimeConfig,
      nextBannerOptions: merged,
    },
  };
}

export { getConfig, withNextBanner };