feat: add typedoc support (#268)

This PR
Generates documentation based on TypeScript types and deploys the docs
using GH pages.

How to test
This was tested in a fork. The generated GH page can be seen
[here](https://beeme1mr.github.io/js-sdk/).

Signed-off-by: Michael Beemer <[email protected]>

Author: beeme1mr

.eslintrc.json

@@ -1,48 +1,56 @@
 {
-	"env":{
-		 "browser":true,
-		 "es2021":true
+	"env": {
+		"browser": true,
+		"es2021": true
 	},
-	"extends":[
-		 "eslint:recommended",
-		 "plugin:@typescript-eslint/recommended",
-		 "prettier",
-		 "plugin:jsdoc/recommended"
+	"extends": [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"prettier",
+		"plugin:jsdoc/recommended"
 	],
-	"parser":"@typescript-eslint/parser",
-	"parserOptions":{
-		 "ecmaVersion":"latest",
-		 "sourceType":"module"
+	"parser": "@typescript-eslint/parser",
+	"parserOptions": {
+		"ecmaVersion": "latest",
+		"sourceType": "module"
 	},
-	"plugins":[
-		 "@typescript-eslint",
-		 "check-file",
-		 "jsdoc"
+	"plugins": [
+		"@typescript-eslint",
+		"check-file",
+		"jsdoc"
 	],
-	"rules":{
-		 "linebreak-style":[
-				"error",
-				"unix"
-		 ],
-		 "quotes":[
-				"error",
-				"single",
-				{
-					"avoidEscape": true
-				}
-		 ],
-		 "semi":[
-				"error",
-				"always"
-		 ],
-		 "check-file/filename-naming-convention":[
+	"rules": {
+		"jsdoc/check-tag-names": [
+			"warn",
+			{
+				"definedTags": [
+					"experimental"
+				]
+			}
+		],
+		"linebreak-style": [
+			"error",
+			"unix"
+		],
+		"quotes": [
+			"error",
+			"single",
+			{
+				"avoidEscape": true
+			}
+		],
+		"semi": [
+			"error",
+			"always"
+		],
+		"check-file/filename-naming-convention": [
 			"error",
 			{
-				"**/*.{js,ts}":"KEBAB_CASE"
+				"**/*.{js,ts}": "KEBAB_CASE"
 			},
-      {
-      	"ignoreMiddleExtensions": true
-      }
+			{
+				"ignoreMiddleExtensions": true
+			}
 		]
 	}
-}
+}

.github/workflows/release-please.yml

@@ -15,28 +15,41 @@ jobs:
           command: manifest
           token: ${{secrets.GITHUB_TOKEN}}
           default-branch: main
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      release_tag_name: ${{ steps.release.outputs.tag_name }}
 
+  npm-release:
+    needs: Release-please
+    runs-on: ubuntu-latest
+    if: ${{ needs.release-please.outputs.release_created }}
+    steps:
       # The logic below handles the npm publication:
       - name: Checkout Repository
-        if: ${{ steps.release.outputs.releases_created }}
         uses: actions/checkout@v3
       - name: Setup Node
         uses: actions/setup-node@v3
-        if: ${{ steps.release.outputs.releases_created }}
         with:
           node-version: 16
-          registry-url: 'https://registry.npmjs.org'
+          registry-url: "https://registry.npmjs.org"
       - name: Build Packages
-        if: ${{ steps.release.outputs.releases_created }}
         run: |
           npm ci
           npm run build
 
-      # Release Please has already incremented versions and published tags, so we just
       # need to publish all unpublished versions to NPM here
       # Our scripts only publish versions that do not already exist.
       - name: Publish to NPM
-        if: ${{ steps.release.outputs.releases_created }}
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
         run: npm publish --access public
+
+      - name: Build Docs
+        run: npm run docs
+
+      - name: Deploy Documentation 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: typedoc

.gitignore

@@ -105,4 +105,7 @@ dist
 
 # yalc stuff
 yalc.lock
-.yalc/
+.yalc/
+
+# Ignore generated doc folder
+typedoc