chore: Change typedoc setup to use monorepo. (#261)

kinyoklion · web-flow · commit fa9e45b9e5ae · 2023-08-29T10:31:45.000-07:00
diff --git a/actions/ci/action.yml b/actions/ci/action.yml
@@ -40,4 +40,4 @@ runs:
 
     - name: Build Docs
       shell: bash
-      run: yarn workspace ${{ inputs.workspace_name }} doc
+      run: yarn build:doc -- ${{ inputs.workspace_path }}
diff --git a/package.json b/package.json
@@ -21,7 +21,7 @@
     "clean": "yarn workspaces foreach -pt run clean",
     "build": "yarn workspaces foreach -p --topological-dev run build",
     "//": "When using build:doc you need to specify the workspace. 'yarn run build:doc packages/shared/common' for example.",
-    "build:doc": "./scripts/build-doc.sh $1",
+    "build:doc": "npx typedoc --options $1/typedoc.json",
     "lint": "npx eslint . --ext .ts",
     "lint:fix": "yarn run lint -- --fix",
     "test": "echo Please run tests for individual packages.",
@@ -43,7 +43,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^5.0.0",
     "prettier": "^3.0.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   },
   "packageManager": "yarn@3.4.1"
diff --git a/packages/sdk/akamai-base/package.json b/packages/sdk/akamai-base/package.json
@@ -35,7 +35,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts",
     "build": "rollup -c rollup.config.js && ../../../scripts/replace-version.sh .",
     "clean": "rimraf dist",
     "tsw": "yarn tsc --watch",
@@ -69,7 +68,7 @@
     "rollup": "^3.23.0",
     "rollup-plugin-generate-package-json": "^3.2.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   },
   "dependencies": {
diff --git a/packages/sdk/akamai-base/typedoc.json b/packages/sdk/akamai-base/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/sdk/akamai-edgekv/package.json b/packages/sdk/akamai-edgekv/package.json
@@ -35,7 +35,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts",
     "build": "rollup -c rollup.config.js && ../../../scripts/replace-version.sh .",
     "clean": "rimraf dist",
     "tsw": "yarn tsc --watch",
@@ -69,7 +68,7 @@
     "rollup": "^3.23.0",
     "rollup-plugin-generate-package-json": "^3.2.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   },
   "dependencies": {
diff --git a/packages/sdk/akamai-edgekv/typedoc.json b/packages/sdk/akamai-edgekv/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/sdk/cloudflare/package.json b/packages/sdk/cloudflare/package.json
@@ -26,7 +26,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "build": "../../../scripts/build-package.sh",
     "clean": "rimraf dist",
     "tsw": "yarn tsc --watch",
@@ -60,7 +59,7 @@
     "prettier": "^3.0.0",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/sdk/cloudflare/typedoc.json b/packages/sdk/cloudflare/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/sdk/server-node/package.json b/packages/sdk/server-node/package.json
@@ -36,7 +36,6 @@
     "client"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "clean": "npx tsc --build --clean",
     "//": "We run the tests in-band because the FS tests work best sequential.",
     "test": "npx jest --ci --runInBand",
@@ -65,7 +64,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/sdk/server-node/typedoc.json b/packages/sdk/server-node/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/sdk/vercel/package.json b/packages/sdk/vercel/package.json
@@ -25,7 +25,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "build": "../../../scripts/build-package.sh && ../../../scripts/replace-version.sh .",
     "clean": "rimraf dist",
     "tsw": "yarn tsc --watch",
@@ -58,7 +57,7 @@
     "prettier": "^3.0.0",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/sdk/vercel/typedoc.json b/packages/sdk/vercel/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/shared/akamai-edgeworker-sdk/package.json b/packages/shared/akamai-edgeworker-sdk/package.json
@@ -21,7 +21,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "test": "npx jest --ci",
     "build": "npx tsc",
     "clean": "npx tsc --build --clean",
@@ -51,7 +50,7 @@
     "rollup": "^3.23.0",
     "rollup-plugin-generate-package-json": "^3.2.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   },
   "dependencies": {
diff --git a/packages/shared/akamai-edgeworker-sdk/typedoc.json b/packages/shared/akamai-edgeworker-sdk/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "skipErrorChecking": true
+}
diff --git a/packages/shared/common/package.json b/packages/shared/common/package.json
@@ -19,7 +19,6 @@
     "client"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "test": "npx jest --ci",
     "build": "npx tsc",
     "clean": "npx tsc --build --clean",
@@ -42,7 +41,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/shared/common/typedoc.json b/packages/shared/common/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/shared/sdk-server-edge/package.json b/packages/shared/sdk-server-edge/package.json
@@ -25,7 +25,6 @@
     "dist"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "build": "../../../scripts/build-package.sh",
     "tsw": "yarn tsc --watch",
     "clean": "rimraf dist",
@@ -59,7 +58,7 @@
     "prettier": "^3.0.0",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/shared/sdk-server-edge/typedoc.json b/packages/shared/sdk-server-edge/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/shared/sdk-server/package.json b/packages/shared/sdk-server/package.json
@@ -19,7 +19,6 @@
     "client"
   ],
   "scripts": {
-    "doc": "../../../scripts/build-doc.sh .",
     "test": "npx jest --ci",
     "build": "npx tsc",
     "clean": "npx tsc --build --clean",
@@ -48,7 +47,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/shared/sdk-server/typedoc.json b/packages/shared/sdk-server/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/store/node-server-sdk-dynamodb/package.json b/packages/store/node-server-sdk-dynamodb/package.json
@@ -24,8 +24,7 @@
     "test": "npx jest --ci --runInBand",
     "build": "npx tsc",
     "lint": "npx eslint . --ext .ts",
-    "lint:fix": "yarn run lint --fix",
-    "doc": "../../../scripts/build-doc.sh ."
+    "lint:fix": "yarn run lint --fix"
   },
   "dependencies": {
     "ioredis": "^5.3.2"
@@ -51,7 +50,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/store/node-server-sdk-dynamodb/tsconfig.ref.json b/packages/store/node-server-sdk-dynamodb/tsconfig.ref.json
@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "composite": true
+  }
+}
diff --git a/packages/store/node-server-sdk-dynamodb/typedoc.json b/packages/store/node-server-sdk-dynamodb/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/packages/store/node-server-sdk-redis/package.json b/packages/store/node-server-sdk-redis/package.json
@@ -24,8 +24,7 @@
     "test": "npx jest --ci --runInBand",
     "build": "npx tsc",
     "lint": "npx eslint . --ext .ts",
-    "lint:fix": "yarn run lint --fix",
-    "doc": "../../../scripts/build-doc.sh ."
+    "lint:fix": "yarn run lint --fix"
   },
   "dependencies": {
     "ioredis": "^5.3.2"
@@ -49,7 +48,7 @@
     "launchdarkly-js-test-helpers": "^2.2.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.0.5",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.0",
     "typescript": "5.1.6"
   }
 }
diff --git a/packages/store/node-server-sdk-redis/tsconfig.ref.json b/packages/store/node-server-sdk-redis/tsconfig.ref.json
@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "composite": true
+  }
+}
diff --git a/packages/store/node-server-sdk-redis/typedoc.json b/packages/store/node-server-sdk-redis/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}
diff --git a/scripts/build-doc.sh b/scripts/build-doc.sh
diff --git a/tsconfig.json b/tsconfig.json
@@ -30,6 +30,12 @@
     },
     {
       "path": "./packages/sdk/akamai-base/tsconfig.ref.json"
+    },
+    {
+      "path": "./packages/store/node-server-sdk-redis/tsconfig.ref.json"
+    },
+    {
+      "path": "./packages/store/node-server-sdk-dynamodb/tsconfig.ref.json"
     }
   ]
 }
diff --git a/typedoc.base.json b/typedoc.base.json
@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+  "readme": "none"
+}
