Improving typedoc config

realm · Feb 26, 2024 · a53958f · a53958f
1 parent e2fd4b5
commit a53958f
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/realm/package.json b/packages/realm/package.json
@@ -350,15 +350,15 @@
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.19.8",
     "@types/path-browserify": "^1.0.0",
-    "command-line-args": "^5.2.1",
     "chai": "4.3.6",
     "cmake-js": "6.3.2",
+    "command-line-args": "^5.2.1",
     "cross-env": "^7.0.3",
     "mocha": "^10.1.0",
     "path-browserify": "^1.0.1",
     "prebuild": "^12.1.0",
     "react-native": "0.73.2",
-    "typedoc-plugin-missing-exports": "^2.2.0"
+    "typedoc-plugin-rename-defaults": "^0.7.0"
   },
   "engines": {
     "node": ">=18"

diff --git a/packages/realm/tsconfig.docs.json b/packages/realm/tsconfig.docs.json
@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "strict": true,
+    "lib": [
+      "es2020"
+    ],
+    "types": [
+      "bson",
+      "@realm/fetch"
+    ]
+  },
+  "include": [
+    "dist/public-types"
+  ],
+  "exclude": [
+    "./binding/generated/native.d.ts"
+  ]
+}
diff --git a/packages/realm/typedoc.json b/packages/realm/typedoc.json
@@ -1,12 +1,12 @@
 {
-  "entryPoints": ["src/index.ts"],
-  "tsconfig": "./tsconfig.json",
+  "entryPoints": ["dist/public-types/index.d.ts"],
+  "tsconfig": "./tsconfig.docs.json",
   "excludeInternal": true,
   "excludePrivate": true,
   "customCss": "../../typedoc/style.css",
   "media": "../../media",
   "name": "Realm JavaScript",
   "includeVersion": true,
   "sourceLinkTemplate": "https://github.com/realm/realm-js/blob/{gitRevision}/{path}#L{line}",
-  "plugin": ["typedoc-plugin-missing-exports"]
+  "plugin": ["typedoc-plugin-rename-defaults"]
 }