add typedoc

polywrap · Sep 18, 2023 · e6c6a37 · e6c6a37
1 parent 59f8314
commit e6c6a37
Show file tree

Hide file tree

Showing 39 changed files with 758 additions and 544 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,4 +24,5 @@ polywrap.deployment.txt
 **/__pycache__/
 **/dist/
 poetry.lock
-examples/yarn.lock
+examples/yarn.lock
+reference
diff --git a/package.json b/package.json
@@ -44,7 +44,8 @@
     "graphql": "15.5.0",
     "lerna": "4.0.0",
     "prettier": "2.2.1",
+    "rimraf": "3.0.2",
     "ts-node": "10.9.1",
-    "rimraf": "3.0.2"
+    "typedoc": "^0.25.1"
   }
-}
+}
diff --git a/packages/asyncify/tsconfig.json b/packages/asyncify/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

diff --git a/packages/asyncify/typedoc.json b/packages/asyncify/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/client/tsconfig.json b/packages/client/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

diff --git a/packages/client/typedoc.json b/packages/client/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/config-builder/tsconfig.json b/packages/config-builder/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "include": [
     "./src/**/*.ts",
     "./examples/**/*.ts"

diff --git a/packages/config-builder/typedoc.json b/packages/config-builder/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/config-bundle/tsconfig.json b/packages/config-bundle/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/config-bundle/typedoc.json b/packages/config-bundle/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/config-bundles/sys/tsconfig.json b/packages/config-bundles/sys/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/config-bundles/sys/typedoc.json b/packages/config-bundles/sys/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/config-bundles/web3/tsconfig.json b/packages/config-bundles/web3/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/config-bundles/web3/typedoc.json b/packages/config-bundles/web3/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/core-client/tsconfig.json b/packages/core-client/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

diff --git a/packages/core-client/typedoc.json b/packages/core-client/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/core/typedoc.json b/packages/core/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/manifests/wrap/tsconfig.json b/packages/manifests/wrap/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/msgpack/tsconfig.json b/packages/msgpack/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

diff --git a/packages/msgpack/typedoc.json b/packages/msgpack/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/plugin/tsconfig.json b/packages/plugin/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/plugin/typedoc.json b/packages/plugin/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/result/tsconfig.json b/packages/result/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/result/typedoc.json b/packages/result/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/test-cases/tsconfig.json b/packages/test-cases/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

diff --git a/packages/tracing/tsconfig.json b/packages/tracing/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build",
     "typeRoots": [

diff --git a/packages/tracing/typedoc.json b/packages/tracing/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/uri-resolver-extensions/tsconfig.json b/packages/uri-resolver-extensions/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/uri-resolver-extensions/typedoc.json b/packages/uri-resolver-extensions/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/uri-resolvers/tsconfig.json b/packages/uri-resolvers/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/uri-resolvers/typedoc.json b/packages/uri-resolvers/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/packages/wasm/tsconfig.json b/packages/wasm/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

diff --git a/packages/wasm/typedoc.json b/packages/wasm/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}
diff --git a/tsconfig.json → tsconfig.base.json b/tsconfig.json → tsconfig.base.json
@@ -10,6 +10,7 @@
     "experimentalDecorators": true,
     "moduleResolution": "node",
     "declaration": true,
+    "declarationMap": true,
     "preserveSymlinks": true,
     "preserveWatchOutput": true,
     "pretty": false,
@@ -22,9 +23,6 @@
     "sourceMap": true,
     "target": "es5",
     "resolveJsonModule": true,
-    "strictNullChecks": true
-  },
-  "include": [
-    "./src/**/*"
-  ],
+    "strictNullChecks": true,
+  }
 }
diff --git a/tsconfig.docs.json b/tsconfig.docs.json
@@ -0,0 +1,49 @@
+{
+  "references": [
+    {
+      "path": "./packages/asyncify"
+    },
+    {
+      "path": "./packages/client"
+    },
+    {
+      "path": "./packages/config-builder"
+    },
+    {
+      "path": "./packages/config-bundle"
+    },
+    {
+      "path": "./packages/config-bundles/sys"
+    },
+    {
+      "path": "./packages/config-bundles/web3"
+    },
+    {
+      "path": "./packages/core"
+    },
+    {
+      "path": "./packages/core-client"
+    },
+    {
+      "path": "./packages/msgpack"
+    },
+    {
+      "path": "./packages/plugin"
+    },
+    {
+      "path": "./packages/result"
+    },
+    {
+      "path": "./packages/tracing"
+    },
+    {
+      "path": "./packages/uri-resolver-extensions"
+    },
+    {
+      "path": "./packages/uri-resolvers"
+    },
+    {
+      "path": "./packages/wasm"
+    }
+  ]
+}
diff --git a/typedoc.base.json b/typedoc.base.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+}
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,12 @@
+{
+  "entryPoints": ["./packages/*", "./packages/config-bundles/*"],
+  "exclude": ["./packages/test-cases"],
+  "name": "Polywrap Javascript Client",
+  "entryPointStrategy": "packages",
+  "includeVersion": true,
+  "tsconfig": "./tsconfig.docs.json",
+  "out": "./reference"
+
+  // Potentially useful for debugging
+  // "logLevel": "Verbose"
+}