docs: enable auto command generation for plugins

Also enables type checks in `execute-driver-plugins` and exports types where we weren't before
appium · Jan 10, 2023 · 3dce433 · 3dce433
1 parent c269f02
commit 3dce433
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 24 deletions.
diff --git a/packages/execute-driver-plugin/package.json b/packages/execute-driver-plugin/package.json
@@ -23,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "types": "./build/lib/plugin.d.ts",
   "files": [
     "build",
     "lib",
@@ -46,6 +47,10 @@
   "peerDependencies": {
     "appium": "^2.0.0-beta.35"
   },
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+    "npm": ">=8"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -54,8 +59,7 @@
     "mainClass": "ExecuteDriverPlugin"
   },
   "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
-  "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-    "npm": ">=8"
+  "typedoc": {
+    "entryPoint": "./lib/plugin.js"
   }
 }
diff --git a/packages/execute-driver-plugin/tsconfig.json b/packages/execute-driver-plugin/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "outDir": "build"
+    "outDir": "build",
+    "checkJs": true
   },
   "extends": "@appium/tsconfig/tsconfig.plugin.json",
   "include": ["lib"]

diff --git a/packages/images-plugin/package.json b/packages/images-plugin/package.json
@@ -12,6 +12,7 @@
     "firefoxos",
     "testing"
   ],
+  "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
@@ -22,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "types": "./build/lib/plugin.d.ts",
   "files": [
     "build",
     "docs",
@@ -43,15 +45,16 @@
   "peerDependencies": {
     "appium": "^2.0.0-beta.35"
   },
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+    "npm": ">=8"
+  },
   "appium": {
     "pluginName": "images",
     "mainClass": "ImageElementPlugin"
   },
-  "types": "./build/lib/plugin.d.ts",
   "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
-  "homepage": "https://appium.io",
-  "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-    "npm": ">=8"
+  "typedoc": {
+    "entryPoint": "./lib/plugin.js"
   }
 }
diff --git a/packages/relaxed-caps-plugin/package.json b/packages/relaxed-caps-plugin/package.json
@@ -2,6 +2,17 @@
   "name": "@appium/relaxed-caps-plugin",
   "version": "1.0.0-beta.14",
   "description": "An Appium 2.0 plugin that loosens requirements for vendor prefixes on caps",
+  "keywords": [
+    "automation",
+    "javascript",
+    "selenium",
+    "webdriver",
+    "ios",
+    "android",
+    "firefoxos",
+    "testing"
+  ],
+  "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
@@ -12,6 +23,7 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "types": "./build/lib/plugin.d.ts",
   "directories": {
     "lib": "./lib"
   },
@@ -45,15 +57,7 @@
   "tags": [
     "appium"
   ],
-  "homepage": "https://appium.io",
-  "keywords": [
-    "automation",
-    "javascript",
-    "selenium",
-    "webdriver",
-    "ios",
-    "android",
-    "firefoxos",
-    "testing"
-  ]
+  "typedoc": {
+    "entryPoint": "./lib/plugin.js"
+  }
 }
diff --git a/packages/universal-xml-plugin/package.json b/packages/universal-xml-plugin/package.json
@@ -44,13 +44,16 @@
   "peerDependencies": {
     "appium": "^2.0.0-beta.35"
   },
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+    "npm": ">=8"
+  },
   "appium": {
     "pluginName": "universal-xml",
     "mainClass": "UniversalXMLPlugin"
   },
   "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
-  "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-    "npm": ">=8"
+  "typedoc": {
+    "entryPoint": "./lib/index.js"
   }
 }
diff --git a/typedoc.json b/typedoc.json
@@ -9,7 +9,11 @@
     "./packages/types",
     "./packages/base-plugin",
     "./packages/fake-driver",
-    "./packages/typedoc-plugin-appium"
+    "./packages/typedoc-plugin-appium",
+    "./packages/universal-xml-plugin",
+    "./packages/relaxed-caps-plugin",
+    "./packages/images-plugin",
+    "./packages/execute-driver-plugin"
   ],
   "name": "Appium",
   "out": "typedoc-docs",