Merge pull request #31 from ralphschuler/devel

docs: fix
ralphschuler · Nov 26, 2023 · e8e14dd · e8e14dd
2 parents 78ac88b + ac02028
commit e8e14dd
Show file tree

Hide file tree

Showing 32 changed files with 54 additions and 32 deletions.
diff --git a/package.json b/package.json
@@ -22,6 +22,8 @@
     "typedoc": "^0.25.3",
     "typedoc-github-wiki-theme": "^1.1.0",
     "typedoc-plugin-markdown": "^3.17.1",
+    "typedoc-plugin-mdn-links": "^3.1.5",
+    "typedoc-plugin-missing-exports": "^2.1.0",
     "typedoc-plugin-rename-defaults": "^0.7.0"
   },
   "homepage": "https://ralphschuler.github.io/ts-libs/",
@@ -41,8 +43,8 @@
     "clean": "yarn workspaces foreach -Apt run clean",
     "docs:all": "yarn docs:build; yarn docs:bundle:markdown && yarn docs:bundle:html",
     "docs:build": "yarn workspaces foreach -Apt run docs",
-    "docs:bundle:html": "typedoc --out docs/html --plugin @mxssfd/typedoc-theme --theme my-theme --plugin typedoc-plugin-markdown  --plugin typedoc-plugin-rename-defaults --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
-    "docs:bundle:markdown": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs/markdown  --plugin typedoc-plugin-rename-defaults --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
+    "docs:bundle:html": "typedoc --out docs/html --plugin @mxssfd/typedoc-theme --theme my-theme --plugin typedoc-plugin-markdown --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
+    "docs:bundle:markdown": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs/markdown --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
     "fixpack": "fixpack && yarn workspaces foreach -Apt run fixpack",
     "format": "yarn workspaces foreach -Apt run format",
     "format:fix": "yarn workspaces foreach -Apt run format:fix",

diff --git a/packages/ai-function-caller/package.json b/packages/ai-function-caller/package.json
@@ -47,7 +47,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/better-map/package.json b/packages/better-map/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/better-set/package.json b/packages/better-set/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/binary-serializer/package.json b/packages/binary-serializer/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/bit-mask/package.json b/packages/bit-mask/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/complex-compare/package.json b/packages/complex-compare/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/i811n/package.json b/packages/i811n/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/logger/package.json b/packages/logger/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/lsystem/package.json b/packages/lsystem/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/mixin-class-factory/package.json b/packages/mixin-class-factory/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/neuronal-network/package.json b/packages/neuronal-network/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/parser-combinator/package.json b/packages/parser-combinator/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/priority-queue/package.json b/packages/priority-queue/package.json
@@ -48,7 +48,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/prom-metrics-decorator/package.json b/packages/prom-metrics-decorator/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/prom-metrics-parser/package.json b/packages/prom-metrics-parser/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/random/package.json b/packages/random/package.json
@@ -47,7 +47,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/reactivity/package.json b/packages/reactivity/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/safe-array/package.json b/packages/safe-array/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/signature/package.json b/packages/signature/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/slot-mashine/package.json b/packages/slot-mashine/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/state-machine/package.json b/packages/state-machine/package.json
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/state-store/package.json b/packages/state-store/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/stats-tracker/package.json b/packages/stats-tracker/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/task-manager/package.json b/packages/task-manager/package.json
@@ -48,7 +48,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/ts-error/package.json b/packages/ts-error/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/webgl-sand-engine/package.json b/packages/webgl-sand-engine/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/webgl-shader-factory/package.json b/packages/webgl-shader-factory/package.json
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/packages/worker-pool/package.json b/packages/worker-pool/package.json
@@ -47,7 +47,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist node_modules docs",
-    "docs": "typedoc --json docs/docs.json --readme ./README.md",
+    "docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
     "fixpack": "fixpack",
     "format": "prettier src/",
     "format:fix": "prettier --write src/",

diff --git a/yarn.lock b/yarn.lock
@@ -1023,6 +1023,8 @@ __metadata:
     typedoc: "npm:^0.25.3"
     typedoc-github-wiki-theme: "npm:^1.1.0"
     typedoc-plugin-markdown: "npm:^3.17.1"
+    typedoc-plugin-mdn-links: "npm:^3.1.5"
+    typedoc-plugin-missing-exports: "npm:^2.1.0"
     typedoc-plugin-rename-defaults: "npm:^0.7.0"
   languageName: unknown
   linkType: soft
@@ -4993,6 +4995,24 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc-plugin-mdn-links@npm:^3.1.5":
+  version: 3.1.5
+  resolution: "typedoc-plugin-mdn-links@npm:3.1.5"
+  peerDependencies:
+    typedoc: ">= 0.23.14 || 0.24.x || 0.25.x"
+  checksum: 82d5546db8a8c28a3f6decf20f4327e3ad874e7a21d3897b1f12cfed81dd71dfc9a093ddef56adda7cfc7380f619c0f3d9e07b349d921e236e63c353c22afb0a
+  languageName: node
+  linkType: hard
+
+"typedoc-plugin-missing-exports@npm:^2.1.0":
+  version: 2.1.0
+  resolution: "typedoc-plugin-missing-exports@npm:2.1.0"
+  peerDependencies:
+    typedoc: 0.24.x || 0.25.x
+  checksum: 05eaa9f249b146dcdf791c63088452e70f734805d84faa691228b8474b4c806fba7691fd1a51bb039a2b1901af2c02db3bae17853cf4b102ee4fda0a195308fb
+  languageName: node
+  linkType: hard
+
 "typedoc-plugin-rename-defaults@npm:^0.7.0":
   version: 0.7.0
   resolution: "typedoc-plugin-rename-defaults@npm:0.7.0"