Fix use of "@template"

voxpelli · voxpelli · commit 97696e22e81f · 2025-04-02T21:50:15.000+02:00
diff --git a/README.md b/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
  */
 
diff --git a/examples/css-modules/src/layouts/root.layout.js b/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
  */
 
diff --git a/examples/preact/src/layouts/root.layout.js b/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
  */
 
diff --git a/examples/tailwind/src/layouts/root.layout.js b/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
  */
 
diff --git a/index.js b/index.js
@@ -20,27 +20,27 @@ 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
  */
 
diff --git a/lib/build-pages/page-builders/html/index.js b/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')
diff --git a/lib/build-pages/page-builders/js/index.js b/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')
diff --git a/lib/build-pages/page-builders/md/index.js b/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')
diff --git a/lib/build-pages/page-builders/page-writer.js b/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.
diff --git a/lib/build-pages/page-builders/template-builder.js b/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.
diff --git a/lib/build-pages/page-data.js b/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')
diff --git a/lib/build-pages/resolve-layout.js b/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
  */
 
diff --git a/lib/build-pages/resolve-vars.js b/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
  */
 
diff --git a/lib/defaults/default.root.layout.js b/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
  */
 
diff --git a/test-cases/general-features/src/blog/page.js b/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 */
diff --git a/test-cases/general-features/src/feeds.template.js b/test-cases/general-features/src/feeds.template.js
@@ -3,22 +3,18 @@ import pMap from 'p-map'
 import jsonfeedToAtom from 'jsonfeed-to-atom'
 
 /**
- * @template T
- * @typedef {import('../../../index.js').TemplateAsyncIterator<T>} TemplateAsyncIterator
+ * @type {import('../../../index.js').TemplateAsyncIterator<{
+ *  title: string,
+ *  layout: string,
+ *  siteName: string,
+ *  homePageUrl: string,
+ *  authorName: string,
+ *  authorUrl: string,
+ *  authorImgUrl: string,
+ *  publishDate: string,
+ *  siteDescription: string
+ * }>}
  */
-
-/** @type {TemplateAsyncIterator<{
-  *  title: string,
-  *  layout: string,
-  *  siteName: string,
-  *  homePageUrl: string,
-  *  authorName: string,
-  *  authorUrl: string,
-  *  authorImgUrl: string,
-  *  publishDate: string,
-  *  siteDescription: string
-  * }>}
-*/
 export default async function * feedsTemplate ({
   vars: {
     siteName,
diff --git a/test-cases/general-features/src/layouts/blog.layout.js b/test-cases/general-features/src/layouts/blog.layout.js
@@ -3,7 +3,7 @@ import defaultRootLayout from './root.layout.js'
 import { html } from 'uhtml-isomorphic'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../../../../index.js').LayoutFunction<T>} LayoutFunction
  */
 
diff --git a/test-cases/general-features/src/layouts/root.layout.js b/test-cases/general-features/src/layouts/root.layout.js
@@ -2,7 +2,7 @@
 import { html, render } from 'uhtml-isomorphic'
 
 /**
- * @template T extends object
+ * @template {Record<string, any>} T
  * @typedef {import('../../../../index.js').LayoutFunction<T>} LayoutFunction
  */
 
diff --git a/test-cases/general-features/src/page.vars.js b/test-cases/general-features/src/page.vars.js
@@ -2,7 +2,7 @@
 import { html, render } from 'uhtml-isomorphic'
 
 /**
- * @template T extends Object.<string, any>
+ * @template {Record<string, any>} T
  * @typedef {import('../../../index.js').PostVarsFunction<T>} PostVarsFunction
  */
 
diff --git a/test-cases/general-features/src/templates/async-iterator.template.js b/test-cases/general-features/src/templates/async-iterator.template.js
@@ -1,12 +1,9 @@
 /**
- * @template T
- * @typedef {import('../../../../index.js').TemplateAsyncIterator<T>} TemplateAsyncIterator
- */
-
-/** @type {TemplateAsyncIterator<{
+ * @type {import('../../../../index.js').TemplateAsyncIterator<{
  * foo: string,
  * testVar: string
- * }>} */
+ * }>}
+ */
 export default async function * ({
   vars: {
     foo,
diff --git a/test-cases/general-features/src/templates/object-array.template.js b/test-cases/general-features/src/templates/object-array.template.js
@@ -1,10 +1,5 @@
 /**
- * @template T
- * @typedef {import('../../../../index.js').TemplateFunction<T>} TemplateFunction
- */
-
-/**
- * @type {TemplateFunction<{
+ * @type {import('../../../../index.js').TemplateFunction<{
  * foo: string,
  * testVar: string
  * }>}
diff --git a/test-cases/general-features/src/templates/simple.txt.template.js b/test-cases/general-features/src/templates/simple.txt.template.js
@@ -1,10 +1,5 @@
 /**
- * @template T
- * @typedef {import('../../../../index.js').TemplateFunction<T>} TemplateFunction
- */
-
-/**
- * @type {TemplateFunction<{
+ * @type {import('../../../../index.js').TemplateFunction<{
  * foo: string,
  * testVar: string
  * }>}
diff --git a/test-cases/general-features/src/templates/single-object.template.js b/test-cases/general-features/src/templates/single-object.template.js
