site/src/libs/config.ts

import fs from 'node:fs'
import { load as yamlLoad } from 'js-yaml'
import { z } from 'zod'
import { zPrefixedVersionSemver, zVersionMajorMinor, zVersionSemver } from './validation'

// The config schema used to validate the config file content and ensure all values required by the site are valid.
const configSchema = z.object({
  analytics: z.object({
    fathom_site: z.string()
  }),
  anchors: z.object({
    min: z.number(),
    max: z.number()
  }),
  authors: z.string(),
  baseURL: z.url(),
  blog: z.url(),
  cdn: z.object({
    css: z.url(),
    css_hash: z.string(),
    js: z.url(),
    js_hash: z.string(),
    js_bundle: z.url(),
    js_bundle_hash: z.string(),
    floating_ui_esm: z.url(),
    vanilla_calendar_pro_esm: z.url()
  }),
  current_version: zVersionSemver,
  current_ruby_version: zVersionSemver,
  description: z.string(),
  docs_version: zVersionMajorMinor,
  docsDir: z.string(),
  examples: z.url(),
  download: z.object({
    dist: z.url(),
    dist_examples: z.url(),
    source: z.url()
  }),
  github_org: z.url(),
  icons: z.url(),
  opencollective: z.url(),
  repo: z.url(),
  rfs_version: zPrefixedVersionSemver,
  subtitle: z.string(),
  swag: z.url(),
  title: z.string(),
  toc: z.object({
    min: z.number(),
    max: z.number()
  }),
  x: z.string()
})

let config: Config | undefined

// A helper to get the config loaded fom the `config.yml` file. If the config does not match the `configSchema`, an
// error is thrown to indicate that the config file is invalid and some action is required.
export function getConfig(): Config {
  if (config) {
    // Returns the config if it has already been loaded.
    return config
  }

  try {
    // Load the config from the `config.yml` file.
    const rawConfig = yamlLoad(fs.readFileSync('./config.yml', 'utf8'))

    // Parse the config using the config schema to validate its content and get back a fully typed config object.
    config = configSchema.parse(rawConfig)

    return config
  } catch (error) {
    if (error instanceof z.ZodError) {
      console.error('The `config.yml` file content is invalid:', error.issues)
    }

    throw new Error('Failed to load configuration from `config.yml`', { cause: error })
  }
}

type Config = z.infer<typeof configSchema>