feat(): experimental support for typedoc generation

.gitignore

@@ -61,3 +61,4 @@ packages/*/LICENSE
 local_appium_home
 jsdoc-out
 *.tgz
+typedoc-docs

babel.config.json

@@ -12,7 +12,7 @@
   ],
   "plugins": ["source-map-support", "@babel/plugin-transform-runtime"],
   "comments": false,
-  "sourceMaps": "both",
+  "sourceMaps": true,
   "env": {
     "coverage": {
       "plugins": [

package.json

@@ -57,6 +57,7 @@
     "test:ci:e2e": "lerna run test:e2e",
     "test:e2e": "lerna run --parallel --max-buffer=128 test:e2e",
     "test:unit": "lerna run test",
+    "typedoc": "typedoc",
     "uninstall-fake-driver": "npm start -- driver uninstall fake",
     "upload": "gulp github-upload",
     "preversion": "run-s clean:artifacts build sync-pkgs && git add -A packages/appium/README.md packages/*/package.json",
@@ -151,6 +152,8 @@
     "sinon-chai": "3.7.0",
     "sync-monorepo-packages": "0.3.5",
     "through2": "4.0.2",
+    "typedoc": "0.23.10",
+    "typedoc-plugin-resolve-crossmodule-references": "0.3.0",
     "typescript": "4.7.4",
     "validate.js": "0.13.1",
     "webdriverio": "7.21.0",

packages/appium/package.json

@@ -42,7 +42,7 @@
     "types"
   ],
   "scripts": {
-    "build": "babel lib --root-mode=upward --out-dir=build/lib",
+    "build": "babel lib --source-maps --root-mode=upward --out-dir=build/lib",
     "build:docs": "node docs/scripts/build-docs.js",
     "build:docs:assets": "node docs/scripts/copy-assets.js",
     "dev": "npm run build -- --watch",
@@ -108,5 +108,8 @@
     "access": "public",
     "tag": "next"
   },
+  "typedoc": {
+    "entryPoint": "./build/lib/main.js"
+  },
   "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72"
 }

packages/base-driver/package.json

@@ -23,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "types": "./build/lib/index.d.ts",
   "directories": {
     "lib": "lib"
   },
@@ -34,7 +35,7 @@
     "build"
   ],
   "scripts": {
-    "build": "babel lib --root-mode=upward --out-dir=build/lib",
+    "build": "babel lib --source-maps --root-mode=upward --out-dir=build/lib",
     "dev": "npm run build -- --watch",
     "fix": "npm run lint -- --fix",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
@@ -77,6 +78,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "types": "./build/lib/index.d.ts",
-  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72"
+  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
+  "typedoc": {
+    "entryPoint": "./build/lib/index.js"
+  }
 }

packages/base-plugin/package.json

@@ -2,6 +2,7 @@
   "name": "@appium/base-plugin",
   "version": "1.10.2",
   "description": "The base plugin used to create Appium 2.0 plugins",
+  "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
@@ -12,6 +13,7 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "types": "./build/lib/plugin.d.ts",
   "directories": {
     "lib": "./lib"
   },
@@ -21,7 +23,7 @@
     "index.js"
   ],
   "scripts": {
-    "build": "babel lib --root-mode=upward --out-dir=build/lib",
+    "build": "babel lib --source-maps --root-mode=upward --out-dir=build/lib",
     "dev": "npm run build -- --watch",
     "fix": "npm run lint -- --fix",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
@@ -37,10 +39,11 @@
     "node": ">=14",
     "npm": ">=8"
   },
-  "types": "./build/lib/plugin.d.ts",
   "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
   "tags": [
     "appium"
   ],
-  "homepage": "https://appium.io"
+  "typedoc": {
+    "entryPoint": "./build/lib/plugin.js"
+  }
 }

packages/doctor/package.json

@@ -37,8 +37,8 @@
     "build"
   ],
   "scripts": {
-    "build:lib": "babel lib --root-mode=upward --out-dir=build/lib",
-    "build:bin": "babel bin --root-mode=upward --out-dir=build/bin",
+    "build:lib": "babel lib --source-maps --root-mode=upward --out-dir=build/lib",
+    "build:bin": "babel bin --source-maps --root-mode=upward --out-dir=build/bin",
     "build": "run-s build:*",
     "dev": "run-p \"build:lib -- --watch\" \"build:bin -- --watch\"",
     "fix": "npm run lint -- --fix",