From 268605a5e3dbd40909b233c9f9a3426b34d310db Mon Sep 17 00:00:00 2001 From: Bertie690 <136088738+Bertie690@users.noreply.github.com> Date: Wed, 16 Jul 2025 02:28:02 -0400 Subject: [PATCH] [Dev] Move typedoc settings to `typedoc.json` and add `tsdoc.json` https://github.com/pagefaultgames/pokerogue/pull/6102 * Move typedoc settings out of tsconfig * Create typedoc.json * Apply Biome * Add `tsdoc.json` for `@todo` and `@linkcode` --------- Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com> --- tsconfig.json | 6 ------ tsdoc.json | 14 ++++++++++++++ typedoc.json | 7 +++++++ 3 files changed, 21 insertions(+), 6 deletions(-) create mode 100644 tsdoc.json create mode 100644 typedoc.json diff --git a/tsconfig.json b/tsconfig.json index f41b3e5895a..39b99cf9ca9 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -47,11 +47,5 @@ "outDir": "./build", "noEmit": true }, - "typedocOptions": { - "entryPoints": ["./src"], - "entryPointStrategy": "expand", - "exclude": "**/*+.test.ts", - "out": "typedoc" - }, "exclude": ["node_modules", "dist", "vite.config.ts", "vitest.config.ts", "vitest.workspace.ts"] } diff --git a/tsdoc.json b/tsdoc.json new file mode 100644 index 00000000000..b4cbc9a62a5 --- /dev/null +++ b/tsdoc.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": false, + "tagDefinitions": [ + { + "tagName": "@todo", + "syntaxKind": "block" + }, + { + "tagName": "@linkcode", + "syntaxKind": "inline" + } + ] +} diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000000..c34e6190c1a --- /dev/null +++ b/typedoc.json @@ -0,0 +1,7 @@ +{ + "entryPoints": ["./src"], + "entryPointStrategy": "expand", + "exclude": ["**/*+.test.ts"], + "out": "typedoc", + "highlightLanguages": ["javascript", "json", "jsonc", "json5", "tsx", "typescript", "markdown"] +}