Fixed typedoc setup for monorepo

Author: s1hofmann

core/nut.js/README.md

@@ -1,3 +1,3 @@
-# nut.js (Native UI Toolkit)
+# @nut-tree/nut-js
 
 This is the core package for nut.js, the one package that keeps all the other packages together. It provides the basic functionality to interact with the screen, the keyboard, and the mouse.

core/nut.js/package.json

@@ -54,7 +54,7 @@
     "publish:next": "pnpm publish --tag next --no-git-checks",
     "publish:release": "pnpm publish --no-git-checks",
     "prepublishOnly": "pnpm run compile",
-    "typedoc": "typedoc --options ./typedoc.js --entryPointStrategy expand ./lib"
+    "typedoc": "typedoc --out docs"
   },
   "dependencies": {
     "@nut-tree/default-clipboard-provider": "workspace:*",

core/nut.js/typedoc.js

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["index.ts"]
+}

core/nut.js/typedoc.json

@@ -0,0 +1,3 @@
+# @nut-tree/provider-interfaces
+
+This package contains all defined provider interfaces which can be used for custom implementations.

core/provider-interfaces/README.md

@@ -9,7 +9,8 @@
     "compile": "pnpm run clean && tsc -p .",
     "publish:next": "pnpm publish --tag next --no-git-checks",
     "publish:release": "pnpm publish --no-git-checks",
-    "prepublishOnly": "pnpm run compile"
+    "prepublishOnly": "pnpm run compile",
+    "typedoc": "typedoc --out docs"
   },
   "keywords": [
     "nut-js",

core/provider-interfaces/package.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["index.ts"]
+}

core/provider-interfaces/typedoc.json

@@ -0,0 +1,3 @@
+# @nut-tree/shared
+
+This package contains shared code to be used by the @nut-tree/nut-js and e.g. provider implementations.

core/shared/README.md

@@ -12,7 +12,8 @@
     "compile": "pnpm run clean && tsc -p .",
     "publish:next": "pnpm publish --tag next --no-git-checks",
     "publish:release": "pnpm publish --no-git-checks",
-    "prepublishOnly": "pnpm run compile"
+    "prepublishOnly": "pnpm run compile",
+    "typedoc": "typedoc --out docs"
   },
   "dependencies": {
     "node-abort-controller": "3.1.1",

core/shared/package.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["index.ts"]
+}

core/shared/typedoc.json

@@ -9,7 +9,9 @@
     "coverage:clean": "pnpm -r run coverage:clean",
     "prepare": "husky install",
     "publish:next": "pnpm -r run publish:next",
-    "publish:release": "pnpm -r run publish:release"
+    "publish:release": "pnpm -r run publish:release",
+    "typedoc-all": "pnpm -r run typedoc",
+    "typedoc": "pnpm run typedoc-all && typedoc"
   },
   "packageManager": "pnpm@8.15.2",
   "workspaces": [
@@ -18,7 +20,6 @@
     "examples/*",
     "e2e/*"
   ],
-  "dependencies": {},
   "devDependencies": {
     "@types/jest": "29.5.12",
     "@types/node": "20.11.17",

package.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "exclude": [
+    "**/dist/**",
+    "**/node_modules/**",
+    "**/*.spec.ts",
+    "**/__mocks__/**"
+  ],
+  "excludePrivate": true,
+  "excludeExternals": true,
+  "excludeProtected": true,
+  "hideGenerator": true,
+  "entryPointStrategy": "expand",
+  "includeVersion": true,
+  "theme": "default"
+}

typedoc.base.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPointStrategy": "packages",
+  "entryPoints": [
+    "core/nut.js",
+    "core/provider-interfaces",
+    "core/shared"
+  ],
+  "includeVersion": false
+}