index.js

import { once } from 'events'
import assert from 'node:assert'
import chokidar from 'chokidar'
import { basename, relative } from 'path'
// @ts-ignore
import makeArray from 'make-array'
import ignoreExport from 'ignore'
// @ts-ignore
import cpx from 'cpx2'
import { inspect } from 'util'
import browserSync from 'browser-sync'

import { getCopyGlob } from './lib/build-static/index.js'
import { builder } from './lib/builder.js'
import { TopBunAggregateError } from './lib/helpers/top-bun-aggregate-error.js'

const ignore = ignoreExport.default

/**
 * @typedef {import('./lib/builder.js').TopBunOpts} TopBunOpts
 * @typedef {import('./lib/builder.js').Results} Results
*/

/**
 * @template T extends Object.<string, any>
 * @typedef {import('./lib/build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
 */

/**
 * @template T extends Object.<string, any>
 * @typedef {import('./lib/build-pages/resolve-vars.js').PostVarsFunction<T>} PostVarsFunction
 */

/**
 * @template T extends Object.<string, any>
 * @typedef {import('./lib/build-pages/page-builders/page-writer.js').PageFunction<T>} PageFunction
 */

/**
 * @template T extends Object.<string, any>
 * @typedef {import('./lib/build-pages/page-builders/template-builder.js').TemplateFunction<T>} TemplateFunction
 */

/**
 * @template T extends Object.<string, any>
 * @typedef {import('./lib/build-pages/page-builders/template-builder.js').TemplateAsyncIterator<T>} TemplateAsyncIterator
 */

/**
 * @typedef {import('./lib/build-pages/page-builders/template-builder.js').TemplateOutputOverride} TemplateOutputOverride
 */

export class TopBun {
  /** @type {string} */ #src = ''
  /** @type {string} */ #dest = ''
  /** @type {TopBunOpts} */ opts = {}
  /** @type {chokidar.FSWatcher?} */ #watcher = null
  /** @type {any?} */ #cpxWatcher = null
  /** @type {browserSync.BrowserSyncInstance?} */ #browserSyncServer = null

  /**
   *
   * @param {string} src - The src path of the page build
   * @param {string} dest - The dest path of the page build
   * @param {TopBunOpts} [opts] - The options for the site build
   */
  constructor (src, dest, opts = {}) {
    assert(src, 'src is a required argument')
    assert(dest, 'dest is a required argument')

    const defaultIgnore = ['.*', 'node_modules', basename(dest), 'package.json', 'pacakge-lock.json']

    opts.ignore = defaultIgnore.concat(makeArray(opts.ignore))

    this.#src = src
    this.#dest = dest

    this.opts = opts
  }

  get watching () {
    return Boolean(this.#watcher)
  }

  build () {
    return builder(this.#src, this.#dest, { static: true, ...this.opts })
  }

  /**
   * Build and watch a top-bun build
   * @param  {object} [params]
   * @param  {boolean} params.serve
   * @return {Promise<Results>}
   */
  async watch ({
    serve
  } = {
    serve: true
  }) {
    if (this.watching) throw new Error('Already watching.')

    /** @type Results */
    let report

    try {
      report = await builder(this.#src, this.#dest, { ...this.opts, static: false })
      console.log('Initial JS, CSS and Page Build Complete')
    } catch (err) {
      errorLogger(err)
      if (!(err instanceof TopBunAggregateError)) throw new Error('Non-aggregate error thrown', { cause: err })
      report = err.results
    }

    this.#cpxWatcher = cpx.watch(getCopyGlob(this.#src), this.#dest, { ignore: this.opts.ignore })
    if (serve) {
      const bs = browserSync.create()
      this.#browserSyncServer = bs
      bs.watch(basename(this.#dest), { ignoreInitial: true }).on('change', bs.reload)
      bs.init({
        server: this.#dest
      })
    }

    this.#cpxWatcher.on('watch-ready', () => {
      console.log('Copy watcher ready')

      this.#cpxWatcher.on('copy', (/** @type{{ srcPath: string, dstPath: string }} */e) => {
        console.log(`Copy ${e.srcPath} to ${e.dstPath}`)
      })

      this.#cpxWatcher.on('remove', (/** @type{{ path: string }} */e) => {
        console.log(`Remove ${e.path}`)
      })
    })

    this.#cpxWatcher.on('watch-error', (/** @type{Error} */err) => {
      console.log(`Copy error: ${err.message}`)
    })

    const ig = ignore().add(this.opts.ignore ?? [])

    const anymatch = (/** @type {string} */name) => ig.ignores(relname(this.#src, name))

    const watcher = chokidar.watch(`${this.#src}/**/*.+(js|css|html|md)`, {
      ignored: anymatch,
      persistent: true
    })

    this._watcher = watcher

    await once(watcher, 'ready')

    watcher.on('add', path => {
      console.log(`File ${path} has been added`)
      builder(this.#src, this.#dest, { ...this.opts, static: false })
        .then(buildLogger)
        .catch(errorLogger)
    })
    watcher.on('change', path => {
      assert(this.#src)
      assert(this.#dest)
      console.log(`File ${path} has been changed`)
      builder(this.#src, this.#dest, { ...this.opts, static: false })
        .then(buildLogger)
        .catch(errorLogger)
    })
    watcher.on('unlink', path => {
      console.log(`File ${path} has been removed`)
      builder(this.#src, this.#dest, { ...this.opts, static: false })
        .then(buildLogger)
        .catch(errorLogger)
    })
    watcher.on('error', errorLogger)

    return report
  }

  async stopWatching () {
    if ((!this.watching || !this.#cpxWatcher)) throw new Error('Not watching')
    if (this.#watcher) await this.#watcher.close()
    this.#cpxWatcher.close()
    this.#watcher = null
    this.#cpxWatcher = null
    this.#browserSyncServer?.exit() // This will kill the process
    this.#browserSyncServer = null
  }
}

/**
 * relanem is the bsaename if (root === name), otherwise relative(root, name)
 * @param  {string} root The root path string
 * @param  {string} name The name string
 * @return {string}      the relname
 */
function relname (root, name) {
  return root === name ? basename(name) : relative(root, name)
}

/**
 * An error logger
 * @param  {Error | AggregateError | any } err The error to log
 */
function errorLogger (err) {
  if (!(err instanceof Error || err instanceof AggregateError)) throw new Error('Non-error thrown', { cause: err })
  if ('results' in err) delete err.results
  console.error(inspect(err, { depth: 999, colors: true }))

  console.log('\nBuild Failed!\n\n')
  console.error(err)
}

/**
 * An build logger
 * @param  {Results} results
 */
function buildLogger (results) {
  if (results?.warnings?.length > 0) {
    console.log(
      '\nThere were build warnings:\n'
    )
  }
  for (const warning of results?.warnings) {
    if ('message' in warning) {
      console.log(`  ${warning.message}`)
    } else {
      console.warn(warning)
    }
  }

  console.log(`Pages: ${results.siteData.pages.length} Layouts: ${Object.keys(results.siteData.layouts).length} Templates: ${results.siteData.templates.length}`)
  console.log('\nBuild Success!\n\n')
}