feat(typedoc): release @tanstack/typedoc-config (#220)

lachlancollins · web-flow · commit 5ca7b1fa4520 · 2025-03-03T23:05:33.000+11:00
* feat: release @tanstack/typedoc-config

* Fic snap
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -7,5 +7,5 @@
   "updateInternalDependencies": "patch",
   "fixed": [],
   "linked": [],
-  "ignore": []
+  "ignore": ["@tanstack/integration-*"]
 }
diff --git a/.changeset/long-apples-fix.md b/.changeset/long-apples-fix.md
@@ -0,0 +1,5 @@
+---
+'@tanstack/typedoc-config': minor
+---
+
+feat: release @tanstack/typedoc-config
diff --git a/integrations/react/package.json b/integrations/react/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "react-integration",
+  "name": "@tanstack/integration-react",
   "version": "1.0.0",
   "private": true,
   "type": "module",
diff --git a/integrations/vanilla/package.json b/integrations/vanilla/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "vanilla-integration",
+  "name": "@tanstack/integration-vanilla",
   "version": "1.0.0",
   "private": true,
   "type": "module",
diff --git a/integrations/vue/package.json b/integrations/vue/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "vue-integration",
+  "name": "@tanstack/integration-vue",
   "version": "1.0.0",
   "private": true,
   "type": "module",
diff --git a/integrations/vue/snap/integration-vue.css b/integrations/vue/snap/integration-vue.css
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -62,6 +62,7 @@
     "@commitlint/parse": "catalog:",
     "@eslint/js": "catalog:",
     "@stylistic/eslint-plugin-js": "catalog:",
+    "@tanstack/typedoc-config": "workspace:",
     "commander": "catalog:",
     "esbuild-register": "catalog:",
     "eslint-plugin-import-x": "catalog:",
@@ -74,9 +75,6 @@
     "rollup-plugin-preserve-directives": "catalog:",
     "semver": "catalog:",
     "simple-git": "catalog:",
-    "typedoc": "catalog:",
-    "typedoc-plugin-frontmatter": "catalog:",
-    "typedoc-plugin-markdown": "catalog:",
     "typescript-eslint": "catalog:",
     "v8flags": "catalog:",
     "vite-plugin-dts": "catalog:",
diff --git a/packages/config/src/typedoc/index.d.ts b/packages/config/src/typedoc/index.d.ts
@@ -1,18 +1,5 @@
-import type { UserConfig } from 'vite'
-
-export type Package = {
-  name: string
-  entryPoints: Array<string>
-  tsconfig: string
-  outputDir: string
-  exclude?: Array<string>
-}
-
-export type Options = {
-  /** Config for packages that need reference docs */
-  packages: Array<Package>
-  /** Override branch for GitHub links */
-  gitBranch?: string
-}
-
-export function generateReferenceDocs(config: Options): Promise<void>
+export type {
+  Package,
+  Options,
+  generateReferenceDocs,
+} from '@tanstack/typedoc-config'
diff --git a/packages/config/src/typedoc/index.js b/packages/config/src/typedoc/index.js
@@ -1,58 +1 @@
-import { resolve } from 'node:path'
-import { fileURLToPath } from 'node:url'
-import { mkdir, rm } from 'node:fs/promises'
-import * as TypeDoc from 'typedoc'
-
-const __dirname = fileURLToPath(new URL('.', import.meta.url))
-
-/**
- * @type {Partial<import("typedoc").TypeDocOptions & import("typedoc-plugin-markdown").PluginOptions>}
- */
-const settings = {
-  plugin: [
-    'typedoc-plugin-markdown',
-    'typedoc-plugin-frontmatter',
-    resolve(__dirname, './typedoc-custom-settings.js'),
-  ],
-  hideGenerator: true,
-  readme: 'none',
-  entryFileName: 'index',
-  hideBreadcrumbs: true,
-  hidePageHeader: true,
-  useCodeBlocks: true,
-  excludePrivate: true,
-}
-
-/**
- * @param {import('./index.js').Options} options
- * @returns {Promise<void>}
- */
-export const generateReferenceDocs = async (options) => {
-  for (const pkg of options.packages) {
-    // Clean and recreate the output directories
-    try {
-      await rm(pkg.outputDir, { recursive: true })
-    } catch (error) {
-      // @ts-expect-error
-      if (error.code !== 'ENOENT') {
-        throw error
-      }
-    }
-    await mkdir(pkg.outputDir, { recursive: true })
-
-    const app = await TypeDoc.Application.bootstrapWithPlugins({
-      ...settings,
-      gitRevision: options.gitBranch ?? 'main',
-      entryPoints: pkg.entryPoints,
-      tsconfig: pkg.tsconfig,
-      exclude: pkg.exclude,
-      out: pkg.outputDir,
-    })
-
-    const project = await app.convert()
-
-    if (project) {
-      await app.generateOutputs(project)
-    }
-  }
-}
+export { generateReferenceDocs } from '@tanstack/typedoc-config'
diff --git a/packages/typedoc-config/eslint.config.js b/packages/typedoc-config/eslint.config.js
@@ -0,0 +1,5 @@
+// @ts-check
+
+import { tanstackConfig } from '../config/src/eslint/index.js'
+
+export default [...tanstackConfig]
diff --git a/packages/typedoc-config/package.json b/packages/typedoc-config/package.json
@@ -0,0 +1,49 @@
+{
+  "name": "@tanstack/typedoc-config",
+  "version": "0.0.0",
+  "description": "Configuration and tools for publishing and maintaining TanStack projects.",
+  "author": "tannerlinsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/config.git",
+    "directory": "packages/typedoc-config"
+  },
+  "homepage": "https://tanstack.com/config",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "scripts": {
+    "test:types": "tsc",
+    "test:eslint": "eslint ./src",
+    "test:build": "publint --strict"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./src/index.d.ts",
+        "default": "./src/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "preferGlobal": false,
+  "sideEffects": false,
+  "files": [
+    "src"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "typedoc": "catalog:",
+    "typedoc-plugin-frontmatter": "catalog:",
+    "typedoc-plugin-markdown": "catalog:"
+  },
+  "devDependencies": {
+    "@types/eslint": "catalog:",
+    "eslint": "catalog:"
+  }
+}
diff --git a/packages/typedoc-config/src/index.d.ts b/packages/typedoc-config/src/index.d.ts
@@ -0,0 +1,18 @@
+import type { UserConfig } from 'vite'
+
+export type Package = {
+  name: string
+  entryPoints: Array<string>
+  tsconfig: string
+  outputDir: string
+  exclude?: Array<string>
+}
+
+export type Options = {
+  /** Config for packages that need reference docs */
+  packages: Array<Package>
+  /** Override branch for GitHub links */
+  gitBranch?: string
+}
+
+export function generateReferenceDocs(config: Options): Promise<void>
diff --git a/packages/typedoc-config/src/index.js b/packages/typedoc-config/src/index.js
@@ -0,0 +1,58 @@
+import { resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { mkdir, rm } from 'node:fs/promises'
+import * as TypeDoc from 'typedoc'
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url))
+
+/**
+ * @type {Partial<import("typedoc").TypeDocOptions & import("typedoc-plugin-markdown").PluginOptions>}
+ */
+const settings = {
+  plugin: [
+    'typedoc-plugin-markdown',
+    'typedoc-plugin-frontmatter',
+    resolve(__dirname, './typedoc-custom-settings.js'),
+  ],
+  hideGenerator: true,
+  readme: 'none',
+  entryFileName: 'index',
+  hideBreadcrumbs: true,
+  hidePageHeader: true,
+  useCodeBlocks: true,
+  excludePrivate: true,
+}
+
+/**
+ * @param {import('./index.js').Options} options
+ * @returns {Promise<void>}
+ */
+export const generateReferenceDocs = async (options) => {
+  for (const pkg of options.packages) {
+    // Clean and recreate the output directories
+    try {
+      await rm(pkg.outputDir, { recursive: true })
+    } catch (error) {
+      // @ts-expect-error
+      if (error.code !== 'ENOENT') {
+        throw error
+      }
+    }
+    await mkdir(pkg.outputDir, { recursive: true })
+
+    const app = await TypeDoc.Application.bootstrapWithPlugins({
+      ...settings,
+      gitRevision: options.gitBranch ?? 'main',
+      entryPoints: pkg.entryPoints,
+      tsconfig: pkg.tsconfig,
+      exclude: pkg.exclude,
+      out: pkg.outputDir,
+    })
+
+    const project = await app.convert()
+
+    if (project) {
+      await app.generateOutputs(project)
+    }
+  }
+}
diff --git a/packages/typedoc-config/src/typedoc-custom-settings.js b/packages/typedoc-config/src/typedoc-custom-settings.js
diff --git a/packages/typedoc-config/tsconfig.json b/packages/typedoc-config/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["bin", "src", "eslint.config.js"]
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,5 @@`
`7`	`7`	`"updateInternalDependencies": "patch",`
`8`	`8`	`"fixed": [],`
`9`	`9`	`"linked": [],`
`10`		`- "ignore": []`
	`10`	`+ "ignore": ["@tanstack/integration-*"]`
`11`	`11`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@tanstack/typedoc-config': minor
 +---
++
 +feat: release @tanstack/typedoc-config
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "react-integration",`
	`2`	`+ "name": "@tanstack/integration-react",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "vanilla-integration",`
	`2`	`+ "name": "@tanstack/integration-vanilla",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "vue-integration",`
	`2`	`+ "name": "@tanstack/integration-vue",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"type": "module",`