A couple of suggestions and fixes

README.md

@@ -397,7 +397,7 @@ The default `root.layout.js` is featured below, and is implemented with [`uhtml`
 import { html, render } from 'uhtml-isomorphic'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('top-bun').LayoutFunction<T>} LayoutFunction
  */
 
@@ -460,7 +460,7 @@ import defaultRootLayout from './root.layout.js'
 import { html } from 'uhtml-isomorphic'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('top-bun').LayoutFunction<T>} LayoutFunction
  */
 

examples/css-modules/src/layouts/root.layout.js

@@ -3,7 +3,7 @@ import { html } from 'htm/preact'
 import { render } from 'preact-render-to-string'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
  */
 

examples/preact/src/layouts/root.layout.js

@@ -3,7 +3,7 @@ import { html } from 'htm/preact'
 import { render } from 'preact-render-to-string'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
  */
 

examples/tailwind/src/layouts/root.layout.js

@@ -3,7 +3,7 @@ import { html } from 'htm/preact'
 import { render } from 'preact-render-to-string'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
  */
 

index.js

@@ -20,38 +20,51 @@ import { TopBunAggregateError } from './lib/helpers/top-bun-aggregate-error.js'
 */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('./lib/build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('./lib/build-pages/resolve-vars.js').PostVarsFunction<T>} PostVarsFunction
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('./lib/build-pages/page-builders/page-writer.js').PageFunction<T>} PageFunction
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('./lib/build-pages/page-builders/template-builder.js').TemplateFunction<T>} TemplateFunction
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @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
  */
 
+const DEFAULT_IGNORES = /** @type {const} */ ([
+  '.*',
+  'coverage',
+  'node_modules',
+  'package.json',
+  'package-lock.json',
+  'pnpm-lock.yaml',
+  'yarn.lock',
+])
+
+/**
+ * @template {TopBunOpts} [CurrentOpts=TopBunOpts]
+ */
 export class TopBun {
   /** @type {string} */ #src = ''
   /** @type {string} */ #dest = ''
-  /** @type {TopBunOpts} */ opts = {}
+  /** @type {Readonly<CurrentOpts & { ignore: string[] }>} */ opts
   /** @type {FSWatcher?} */ #watcher = null
   /** @type {any?} */ #cpxWatcher = null
   /** @type {browserSync.BrowserSyncInstance?} */ #browserSyncServer = null
@@ -60,20 +73,24 @@ export class TopBun {
    *
    * @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
+   * @param {CurrentOpts} [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))
+  constructor (src, dest, opts = /** @type {CurrentOpts} */ ({})) {
+    if (!src || typeof src !== 'string') throw new TypeError('src should be a (non-empty) string')
+    if (!dest || typeof dest !== 'string') throw new TypeError('dest should be a (non-empty) string')
+    if (!opts || typeof opts !== 'object') throw new TypeError('opts should be an object')
 
     this.#src = src
     this.#dest = dest
 
-    this.opts = opts
+    this.opts = {
+      ...opts,
+      ignore: [
+        ...DEFAULT_IGNORES,
+        basename(dest),
+        ...makeArray(opts.ignore),
+      ],
+    }
   }
 
   get watching () {

lib/build-pages/page-builders/html/index.js

@@ -2,15 +2,10 @@ import assert from 'node:assert'
 import { readFile } from 'fs/promises'
 import Handlebars from 'handlebars'
 
-/**
- * @template T
- * @typedef {import('../page-writer.js').PageBuilderType<T>} PageBuilderType
- */
-
 /**
  * Build all of the bundles using esbuild.
- * @template T
- * @type {PageBuilderType<T>}
+ * @template {Record<string, any>} T
+ * @type {import('../page-writer.js').PageBuilderType<T>}
  */
 export async function htmlBuilder ({ pageInfo }) {
   assert(pageInfo.type === 'html', 'html builder requires a "html" page type')

lib/build-pages/page-builders/js/index.js

@@ -1,14 +1,9 @@
 import assert from 'node:assert'
 
-/**
- * @template T
- * @typedef {import('../page-writer.js').PageBuilderType<T>} PageBuilderType
- */
-
 /**
  * Build all of the bundles using esbuild.
- * @template T
- * @type {PageBuilderType<T>}
+ * @template {Record<string, any>} T
+ * @type {import('../page-writer.js').PageBuilderType<T>}
  */
 export async function jsBuilder ({ pageInfo }) {
   assert(pageInfo.type === 'js', 'js page builder requries "js" page type')

lib/build-pages/page-builders/md/index.js

@@ -7,15 +7,10 @@ import { getMd, renderMd } from './get-md.js'
 
 const md = getMd()
 
-/**
- * @template T
- * @typedef {import('../page-writer.js').PageBuilderType<T>} PageBuilderType
- */
-
 /**
  * Build all of the bundles using esbuild.
- * @template T
- * @type {PageBuilderType<T>}
+ * @template {Record<string, any>} T
+ * @type {import('../page-writer.js').PageBuilderType<T>}
  */
 export async function mdBuilder ({ pageInfo }) {
   assert(pageInfo.type === 'md', 'md builder requires an "md" page type')

lib/build-pages/page-builders/page-writer.js

@@ -6,15 +6,15 @@ import { writeFile, mkdir } from 'fs/promises'
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('../page-data.js').PageData<T>} PageData
  */
 
 /**
  * pageLayout functions Can be used to type a name.layout.js file
  *
  * @async
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @callback PageFunction
  * @param {object} params - The parameters for the pageLayout.
  * @param {T} params.vars - All default, global, layout, page, and builder vars shallow merged.
@@ -26,14 +26,14 @@ import { writeFile, mkdir } from 'fs/promises'
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef PageBuilderResult
  * @property {object} vars - Any variables resolved by the builder
  * @property {PageFunction<T>} pageLayout - The function that returns the rendered page
  */
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @callback PageBuilderType
  *
  * @param {object} params
@@ -43,7 +43,7 @@ import { writeFile, mkdir } from 'fs/promises'
 
 /**
  * Handles rendering and writing a page to disk
- * @template T extends object
+ * @template {Record<string, any>} T
  * @param {object} params
  * @param {string} params.src   - The src folder.
  * @param {string} params.dest  - The dest folder.

lib/build-pages/page-builders/template-builder.js

@@ -6,7 +6,7 @@ import { writeFile, mkdir } from 'fs/promises'
  */
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../page-data.js').PageData<T>} PageData
  */
 
@@ -18,7 +18,7 @@ import { writeFile, mkdir } from 'fs/promises'
 /**
  * Callback for rendering a template.
  *
- * @template T extends Object.<string, any>,
+ * @template {Record<string, any>} T
  * @callback TemplateFunction
  * @param {object} params - The parameters for the template.
  * @param {T} params.vars - All of the site globalVars.
@@ -29,7 +29,7 @@ import { writeFile, mkdir } from 'fs/promises'
  */
 
 /**
- * @template T
+ * @template {Record<string, any>} T
  * @typedef {Parameters<TemplateFunction<T>>} TemplateFunctionParams
 */
 
@@ -51,7 +51,7 @@ import { writeFile, mkdir } from 'fs/promises'
 
 /**
  * The template builder renders templates agains the globalVars variables
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @param {object}  params
  * @param  {string} params.src        - The src path of the site build.
  * @param  {string} params.dest       - The dest path of the site build.

lib/build-pages/page-data.js

@@ -13,14 +13,9 @@ import pretty from 'pretty'
  * @typedef {import('./index.js').ResolvedLayout<T>} ResolvedLayout
  */
 
-/**
- * @template T
- * @typedef {import('./resolve-vars.js').PostVarsFunction<T>} PostVarsFunction
- */
-
 /**
  * Represents the data for a page.
- * @template T extends object
+ * @template {Record<string, any>} T
  */
 export class PageData {
   /** @type {PageInfo} */ pageInfo
@@ -84,7 +79,7 @@ export class PageData {
   }
 
   /**
-   * @type {PostVarsFunction<T>}
+   * @type {import('./resolve-vars.js').PostVarsFunction<T>}
    */
   async #renderPostVars ({ vars, styles, scripts, pages, page }) {
     if (!this.#initalized) throw new Error('Initialize PageData before accessing renderPostVars')

lib/build-pages/resolve-layout.js

@@ -3,7 +3,7 @@
  */
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('./page-data.js').PageData<T>} PageData
  */
 

lib/build-pages/resolve-vars.js

@@ -1,12 +1,3 @@
-/**
- * @typedef {import('../identify-pages.js').PageInfo} PageInfo
- */
-
-/**
- * @template T
- * @typedef {import('./page-data.js').PageData<T>} PageData
- */
-
 /**
  * Resolve variables by importing them from a specified path.
  *
@@ -44,14 +35,14 @@ export async function resolveVars ({
  * postVars functions Can be used to generate page vars but access all page data
  *
  * @async
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @callback PostVarsFunction
  * @param {object} params - The parameters for the pageLayout.
  * @param {T} params.vars - All default, global, layout, page, and builder vars shallow merged.
  * @param {string[]} [params.scripts] - Array of script URLs to include.
  * @param {string[]} [params.styles] - Array of stylesheet URLs to include.
- * @param {PageInfo} params.page - Info about the current page
- * @param {PageData<T>[]} params.pages - An array of info about every page
+ * @param {import('../identify-pages.js').PageInfo} params.page - Info about the current page
+ * @param {import('./page-data.js').PageData<T>[]} params.pages - An array of info about every page
  * @returns {Promise<T>} The rendered postVars
  */
 

lib/builder.js

@@ -40,12 +40,12 @@ import { ensureDest } from './helpers/ensure-dest.js'
 
 /**
  * @typedef TopBunOpts
- * @property {string[]?} [ignore] - Array of file/folder patterns to ignore.
- * @property {boolean?} [static=true] - Enable/disable static file processing
- * @property {boolean?} [metafile=true] - Enable/disable the writing of the esbuild metadata file.
- * @property {string[]?} [ignore=[]] - Array of ignore strings
- * @property {string[]?} [target=[]] - Array of target strings to pass to esbuild
- * @property {boolean?} [buildDrafts=false] - Build draft files with the published:false variable
+ * @property {string[]|undefined} [ignore] - Array of file/folder patterns to ignore.
+ * @property {boolean|undefined} [static=true] - Enable/disable static file processing
+ * @property {boolean|undefined} [metafile=true] - Enable/disable the writing of the esbuild metadata file.
+ * @property {string[]|undefined} [ignore=[]] - Array of ignore strings
+ * @property {string[]|undefined} [target=[]] - Array of target strings to pass to esbuild
+ * @property {boolean|undefined} [buildDrafts=false] - Build draft files with the published:false variable
  */
 
 /**

lib/defaults/default.root.layout.js

@@ -2,7 +2,7 @@
 import { html, render } from 'uhtml-isomorphic'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../build-pages/resolve-layout.js').LayoutFunction<T>} LayoutFunction
  */
 

test-cases/general-features/src/blog/page.js

@@ -3,12 +3,7 @@ import { html } from 'uhtml-isomorphic'
 import { dirname, basename } from 'node:path'
 
 /**
- * @template T
- * @typedef {import('../../../../index.js').LayoutFunction<T>} LayoutFunction
- */
-
-/**
- * @type {LayoutFunction<{}>}
+ * @type {import('../../../../index.js').LayoutFunction<{}>}
  */
 export default async function blogIndex ({
   /** vars */