From 90decc8a0fdbb78f24350cefb15602ab3f4f066d Mon Sep 17 00:00:00 2001 From: James Garbutt <43081j@users.noreply.github.com> Date: Mon, 7 Oct 2024 16:38:27 +0700 Subject: [PATCH] fix: use typedoc config to avoid accidental inheritance (#1287) Each of our `tsconfig.json` inherits the root `tsconfig.json`. This root config currently contains the typedoc configuration too, including `endPointStrategy: "packages"`. This leads to each package in the repo having its own root-level typedoc config, which is causing typedoc to fail right now. By moving the config to a `typedoc.json` at the root, we can continue inheriting `tsconfig.json` without accidentally inheriting the typedoc config. --- tsconfig.json | 11 +---------- typedoc.json | 9 +++++++++ 2 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 typedoc.json diff --git a/tsconfig.json b/tsconfig.json index fa6e8a11..a33dfeae 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -15,14 +15,5 @@ "composite": true, "skipLibCheck": true }, - "references": [{ "path": "packages/parse5/tsconfig.json" }], - "typedocOptions": { - "entryPoints": ["packages/*"], - "out": "docs/build", - "name": "parse5", - "readme": "README.md", - "emit": "docs", - "excludeInternal": true, - "entryPointStrategy": "packages" - } + "references": [{ "path": "packages/parse5/tsconfig.json" }] } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..1fd5476d --- /dev/null +++ b/typedoc.json @@ -0,0 +1,9 @@ +{ + "entryPoints": ["packages/*"], + "out": "docs/build", + "name": "parse5", + "readme": "README.md", + "emit": "docs", + "excludeInternal": true, + "entryPointStrategy": "packages" +}