docs: enable auto command generation for plugins
Also enables type checks in `execute-driver-plugins` and exports types where we weren't before
MODIFY
packages/execute-driver-plugin/package.json
packages/execute-driver-plugin/package.json
},
"license": "Apache-2.0",
"author": "https://github.com/appium",
+ "types": "./build/lib/plugin.d.ts",
"files": [
"build",
"lib",
"peerDependencies": {
"appium": "^2.0.0-beta.35"
},
+ "engines": {
+ "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+ "npm": ">=8"
+ },
"publishConfig": {
"access": "public"
},
"mainClass": "ExecuteDriverPlugin"
},
"gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
- "engines": {
- "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
- "npm": ">=8"
+ "typedoc": {
+ "entryPoint": "./lib/plugin.js"
}
}

MODIFY
packages/execute-driver-plugin/tsconfig.json
packages/execute-driver-plugin/tsconfig.json
{
"compilerOptions": {
- "outDir": "build"
+ "outDir": "build",
+ "checkJs": true
},
"extends": "@appium/tsconfig/tsconfig.plugin.json",
"include": ["lib"]

MODIFY
packages/images-plugin/package.json
packages/images-plugin/package.json
"firefoxos",
"testing"
],
+ "homepage": "https://appium.io",
"bugs": {
"url": "https://github.com/appium/appium/issues"
},
},
"license": "Apache-2.0",
"author": "https://github.com/appium",
+ "types": "./build/lib/plugin.d.ts",
"files": [
"build",
"docs",
"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"
}
}

MODIFY
packages/relaxed-caps-plugin/package.json
packages/relaxed-caps-plugin/package.json
"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"
},
},
"license": "Apache-2.0",
"author": "https://github.com/appium",
+ "types": "./build/lib/plugin.d.ts",
"directories": {
"lib": "./lib"
},
"tags": [
"appium"
],
- "homepage": "https://appium.io",
- "keywords": [
- "automation",
- "javascript",
- "selenium",
- "webdriver",
- "ios",
- "android",
- "firefoxos",
- "testing"
- ]
+ "typedoc": {
+ "entryPoint": "./lib/plugin.js"
+ }
}

MODIFY
packages/universal-xml-plugin/package.json
packages/universal-xml-plugin/package.json
"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"
}
}

MODIFY
typedoc.json
typedoc.json
"./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",

docs: enable auto command generation for plugins

Also enables type checks in `execute-driver-plugins` and exports types where we weren't before