build(typedoc): migrate to tsdown

Author: lachlancollins

.changeset/giant-drinks-wish.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/typedoc-config': patch
+---
+
+build: migrate to tsdown

package.json

@@ -49,6 +49,7 @@
     "publint": "catalog:",
     "sherif": "catalog:",
     "tinyglobby": "catalog:",
+    "tsdown": "catalog:",
     "typescript": "catalog:",
     "typescript-eslint": "catalog:"
   }

packages/eslint-config/package.json

@@ -53,8 +53,7 @@
   },
   "devDependencies": {
     "@types/eslint": "catalog:",
-    "eslint": "catalog:",
-    "tsdown": "catalog:"
+    "eslint": "catalog:"
   },
   "peerDependencies": {
     "eslint": "^8.0.0 || ^9.0.0"

packages/eslint-config/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
+    "allowImportingTsExtensions": true,
     "isolatedDeclarations": true
   },
   "include": ["src"]

packages/typedoc-config/package.json

@@ -17,21 +17,21 @@
   "scripts": {
     "test:types": "tsc",
     "test:eslint": "eslint --concurrency=auto ./src",
-    "test:build": "publint --strict"
+    "build": "tsdown"
   },
   "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": {
-        "types": "./src/index.d.ts",
-        "default": "./src/index.js"
-      }
-    },
+    ".": "./dist/index.js",
+    "./typedoc-custom-settings": "./dist/typedoc-custom-settings.js",
     "./package.json": "./package.json"
   },
   "preferGlobal": false,
   "sideEffects": false,
   "files": [
+    "dist",
     "src"
   ],
   "engines": {

packages/typedoc-config/src/index.js packages/typedoc-config/src/index.tspackages/typedoc-config/src/index.js renamed to packages/typedoc-config/src/index.ts

@@ -2,13 +2,12 @@ import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { mkdir, rm } from 'node:fs/promises'
 import * as TypeDoc from 'typedoc'
+import type { PluginOptions } from 'typedoc-plugin-markdown'
+import type { Options } from './types.ts'
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
-/**
- * @type {Partial<import("typedoc").TypeDocOptions & import("typedoc-plugin-markdown").PluginOptions>}
- */
-const settings = {
+const settings: Partial<TypeDoc.TypeDocOptions & PluginOptions> = {
   plugin: [
     'typedoc-plugin-markdown',
     'typedoc-plugin-frontmatter',
@@ -23,11 +22,9 @@ const settings = {
   excludePrivate: true,
 }
 
-/**
- * @param {import('./index.js').Options} options
- * @returns {Promise<void>}
- */
-export const generateReferenceDocs = async (options) => {
+export const generateReferenceDocs = async (
+  options: Options,
+): Promise<void> => {
   for (const pkg of options.packages) {
     // Clean and recreate the output directories
     try {

packages/typedoc-config/src/typedoc-custom-settings.js

@@ -0,0 +1,14 @@
+import { MarkdownPageEvent } from 'typedoc-plugin-markdown'
+import type { MarkdownApplication } from 'typedoc-plugin-markdown'
+
+export function load(app: MarkdownApplication): void {
+  // Add `id` and `title` to frontmatter
+  app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => {
+    page.frontmatter = {
+      id: page.model.name,
+      title: page.model.name,
+    }
+    page.contents =
+      '<!-- DO NOT EDIT: this page is autogenerated from the type comments -->\n\n'
+  })
+}

packages/typedoc-config/src/typedoc-custom-settings.ts

@@ -12,5 +12,3 @@ export type Options = {
   /** Override branch for GitHub links */
   gitBranch?: string
 }
-
-export function generateReferenceDocs(config: Options): Promise<void>

packages/typedoc-config/src/index.d.ts packages/typedoc-config/src/types.tspackages/typedoc-config/src/index.d.ts renamed to packages/typedoc-config/src/types.ts

@@ -1,7 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "checkJs": true
+    "allowImportingTsExtensions": true,
+    "isolatedDeclarations": true
   },
-  "include": ["src", "*.config.*"]
+  "include": ["src"]
 }