Merge pull request #83 from polywrap/pileks/feat/typedoc

Add reference documentation via Github Pages

.github/workflows/cd-docs.yaml

@@ -0,0 +1,48 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      main
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Read .nvmrc
+        run: echo ::set-output name=NVMRC::$(cat .nvmrc)
+        id: nvm
+
+      - name: Setup Node.js
+        uses: actions/setup-node@master
+        with:
+          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: (yarn install --nonInteractive --frozen-lockfile --prefer-offline || yarn install --nonInteractive --frozen-lockfile --prefer-offline)
+
+      - name: Build
+        run: yarn build
+
+      - name: Generate reference
+        run: yarn build:reference
+
+      - name: Deploy documentation to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages-reference
+          folder: reference

.gitignore

@@ -24,4 +24,5 @@ polywrap.deployment.txt
 **/__pycache__/
 **/dist/
 poetry.lock
-examples/yarn.lock
+examples/yarn.lock
+reference

package.json

@@ -21,6 +21,7 @@
     "build:bundles": "lerna run build --scope @polywrap/*-config-bundle-js",
     "build:client": "lerna run build --scope @polywrap/core-client-js --scope @polywrap/client-js --scope @polywrap/client-config-builder-js",
     "build:docs": "lerna run build:docs",
+    "build:reference": "npx typedoc",
     "lint": "lerna run lint",
     "lint:fix": "lerna run lint -- --fix",
     "lint:ci": "yarn lint",
@@ -44,7 +45,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"
   }
-}
+}

packages/asyncify/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

packages/asyncify/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/client/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

packages/client/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/config-builder/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "include": [
     "./src/**/*.ts",
     "./examples/**/*.ts"

packages/config-builder/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/config-bundle/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/config-bundle/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/config-bundles/sys/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/config-bundles/sys/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/config-bundles/web3/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/config-bundles/web3/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/core-client/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

packages/core-client/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/core/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/core/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/manifests/wrap/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/msgpack/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

packages/msgpack/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/plugin/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/plugin/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/result/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/result/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/test-cases/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "lib": [
       "es2020",

packages/tracing/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build",
     "typeRoots": [

packages/tracing/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/uri-resolver-extensions/package.json

@@ -36,6 +36,7 @@
     "@polywrap/plugin-js": "0.12.2",
     "@polywrap/test-cases": "0.12.2",
     "@types/jest": "29.5.0",
+    "@types/copyfiles": "2.4.1",
     "base64-to-uint8array": "1.0.0",
     "copyfiles": "2.4.1",
     "doc-snippets": "~1.0.0",

packages/uri-resolver-extensions/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/uri-resolver-extensions/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/uri-resolvers/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/uri-resolvers/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

packages/wasm/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "outDir": "build"
   },

packages/wasm/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.json"
+}

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,
+  }
 }

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"
+    }
+  ]
+}

typedoc.base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+}

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"
+}