chore: publish

- appium@2.0.0-beta.65
 - @appium/docutils@0.3.8
 - @appium/typedoc-plugin-appium@0.6.3

.github/workflows/build.yml

@@ -78,7 +78,3 @@ jobs:
           install-command: npm ci
       - name: ESLint
         run: npm run lint:ci
-      - name: Validate Renovate Config
-        uses: rinchsan/renovate-config-validator@1ea1e8514f6a33fdd71c40b0a5fa3512b9e7b936 # tag=v0
-        with:
-          pattern: '{.renovaterc.json,renovate/default.json}'

.github/workflows/docs.yml

@@ -1,7 +1,21 @@
 name: Build Docs
 
 on:
-  pull_request_target:
+  pull_request:
+    paths:
+      - '**/typedoc.json'
+      - '**/tsconfig*.json'
+      - '**/package*.json'
+      - '**/*mkdocs*.ya?ml'
+      - 'packages/docutils/requirements.txt'
+      - 'packages/*/README.md'
+      - 'packages/*/docs/**'
+      - 'packages/*/**/*.ts'
+      - 'packages/*/**/*.js'
+      - '.github/workflows/docs.yml' # this file
+      - '!**/test/**'
+      - '!**/sample-code/**'
+  push:
     paths:
       - '**/typedoc.json'
       - '**/tsconfig*.json'
@@ -15,10 +29,6 @@ on:
       - '.github/workflows/docs.yml' # this file
       - '!**/test/**'
       - '!**/sample-code/**'
-
-    branches: [master]
-
-concurrency: preview-${{ github.ref }}
 
 jobs:
   docs:
@@ -39,8 +49,3 @@ jobs:
           git config --local user.name "github-actions[bot]"
       - name: Build Docs
         run: npm run docs:preview
-      - name: Deploy Preview
-        uses: rossjrw/pr-preview-action@2a652922e9b9c53e7e5ea62fa38da744de09043c # v1
-        with:
-          source-dir: ./packages/appium/docs/site
-          custom-url: 'appium.github.io/appium'

.github/workflows/renovate.yml

@@ -0,0 +1,26 @@
+name: Validate Renovate Configs
+on:
+  push:
+    paths:
+      - '.github/workflows/renovate.yml' # this file
+      - '.renovaterc.json'
+      - 'renovate/default.json'
+  pull_request:
+    paths:
+      - '.github/workflows/renovate.yml' # this file
+      - '.renovaterc.json'
+      - 'renovate/default.json'
+
+permissions:
+  contents: read
+
+jobs:
+  renovate:
+    name: Check Renovate Configs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - name: Validate Renovate Config
+        uses: rinchsan/renovate-config-validator@1ea1e8514f6a33fdd71c40b0a5fa3512b9e7b936 # tag=v0
+        with:
+          pattern: '{.renovaterc.json,renovate/default.json}'

README.md

@@ -13,16 +13,16 @@ Appium is an open-source, cross-platform test automation tool for native,
 hybrid, mobile web and desktop apps. Initially created to automate iOS and Android mobile
 applications Appium has grown to a full-featured platform that provides [WebDriver](https://www.w3.org/TR/webdriver/)-based automation possibilities for the whole set of different mobile and desktop platforms.
 See the full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
 
 :bangbang: Major documentation revision in progress
 
-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.github.io/appium/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
 
 Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
 found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.github.io/appium/docs/en/latest/).
+progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).
 
 ### Requirements
 
@@ -71,8 +71,8 @@ appium driver uninstall xcuitest
 ```
 
 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers at
 the current Appium 2.0 documentation.
 
 ### Plugins
@@ -104,8 +104,8 @@ appium server --use-plugins=device-farm,images
 ```
 
 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#plugins) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-plugins) plugins at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#plugins) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-plugins) plugins at
 the current Appium 2.0 documentation.
 
 
@@ -169,11 +169,11 @@ Java/Kotlin. Appium opens up the possibility of true cross-platform native app
 automation, for mobile and beyond. Finally!
 
 If you're new to Appium or want a more comprehensive description of what this is all
-about, please read our [Intro to Appium](https://appium.github.io/appium/docs/en/latest/intro/).
+about, please read our [Intro to Appium](https://appium.io/docs/en/latest/intro/).
 
 ### Quickstart
 
-Check out our [Quickstart](https://appium.github.io/appium/docs/en/latest/quickstart/) guide
+Check out our [Quickstart](https://appium.io/docs/en/latest/quickstart/) guide
 to get going with Appium.
 
 There is also a sample code that contains [many examples of tests in a variety
@@ -181,7 +181,7 @@ of different languages](https://github.com/appium/appium/tree/1.x/sample-code)!
 
 ### Documentation
 
-For prettily-rendered docs, please visit [Appium Documentation](https://appium.github.io/appium).
+For prettily-rendered docs, please visit [Appium Documentation](https://appium.io).
 You can always find the full list of Appium doc pages at [Appium's GitHub
 Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well.
 
@@ -196,7 +196,7 @@ Interested in where Appium is heading in the future? Check out the [Roadmap](ROA
 
 ### Project History, Credits & Inspiration
 
-* [History](https://appium.github.io/appium/docs/en/latest/intro/history/)
+* [History](https://appium.io/docs/en/latest/intro/history/)
 
 ### User Forums
 

package.json

@@ -85,8 +85,8 @@
   },
   "devDependencies": {
     "@colors/colors": "1.5.0",
-    "@commitlint/cli": "17.5.1",
-    "@commitlint/config-conventional": "17.4.4",
+    "@commitlint/cli": "17.6.1",
+    "@commitlint/config-conventional": "17.6.1",
     "@tsconfig/node14": "1.0.3",
     "@types/chai": "4.3.4",
     "@types/chai-as-promised": "7.1.5",
@@ -94,7 +94,7 @@
     "@types/mocha": "10.0.1",
     "@types/node": "18.15.11",
     "@types/semver": "7.3.13",
-    "@types/sinon": "10.0.13",
+    "@types/sinon": "10.0.14",
     "@types/sinon-chai": "3.2.9",
     "@types/teen_process": "2.0.0",
     "@types/ws": "8.5.4",
@@ -123,10 +123,11 @@
     "lerna": "6.6.1",
     "lint-staged": "13.2.1",
     "log-symbols": "4.1.0",
-    "midnight-smoker": "2.0.1",
+    "midnight-smoker": "2.0.3",
     "mjpeg-consumer": "2.0.0",
     "mjpeg-server": "0.3.1",
     "mocha": "10.2.0",
+    "mocha-chai-jest-snapshot": "1.1.4",
     "npm-run-all": "4.1.5",
     "prettier": "2.8.7",
     "rewiremock": "3.14.5",

packages/appium/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0-beta.65](https://github.com/appium/appium/compare/appium@2.0.0-beta.64...appium@2.0.0-beta.65) (2023-04-18)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
 ## [2.0.0-beta.64](https://github.com/appium/appium/compare/appium@2.0.0-beta.63...appium@2.0.0-beta.64) (2023-04-14)
 
 

packages/appium/README.md

@@ -13,16 +13,16 @@ Appium is an open-source, cross-platform test automation tool for native,
 hybrid, mobile web and desktop apps. Initially created to automate iOS and Android mobile
 applications Appium has grown to a full-featured platform that provides [WebDriver](https://www.w3.org/TR/webdriver/)-based automation possibilities for the whole set of different mobile and desktop platforms.
 See the full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
 
 :bangbang: Major documentation revision in progress
 
-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.github.io/appium/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
 
 Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
 found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.github.io/appium/docs/en/latest/).
+progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).
 
 ### Requirements
 
@@ -71,8 +71,8 @@ appium driver uninstall xcuitest
 ```
 
 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers at
 the current Appium 2.0 documentation.
 
 ### Plugins
@@ -104,8 +104,8 @@ appium server --use-plugins=device-farm,images
 ```
 
 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#plugins) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-plugins) plugins at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#plugins) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-plugins) plugins at
 the current Appium 2.0 documentation.
 
 
@@ -169,11 +169,11 @@ Java/Kotlin. Appium opens up the possibility of true cross-platform native app
 automation, for mobile and beyond. Finally!
 
 If you're new to Appium or want a more comprehensive description of what this is all
-about, please read our [Intro to Appium](https://appium.github.io/appium/docs/en/latest/intro/).
+about, please read our [Intro to Appium](https://appium.io/docs/en/latest/intro/).
 
 ### Quickstart
 
-Check out our [Quickstart](https://appium.github.io/appium/docs/en/latest/quickstart/) guide
+Check out our [Quickstart](https://appium.io/docs/en/latest/quickstart/) guide
 to get going with Appium.
 
 There is also a sample code that contains [many examples of tests in a variety
@@ -181,7 +181,7 @@ of different languages](https://github.com/appium/appium/tree/1.x/sample-code)!
 
 ### Documentation
 
-For prettily-rendered docs, please visit [Appium Documentation](https://appium.github.io/appium).
+For prettily-rendered docs, please visit [Appium Documentation](https://appium.io).
 You can always find the full list of Appium doc pages at [Appium's GitHub
 Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well.
 
@@ -196,7 +196,7 @@ Interested in where Appium is heading in the future? Check out the [Roadmap](ROA
 
 ### Project History, Credits & Inspiration
 
-* [History](https://appium.github.io/appium/docs/en/latest/intro/history/)
+* [History](https://appium.io/docs/en/latest/intro/history/)
 
 ### User Forums
 

packages/appium/docs/en/ecosystem/index.md

@@ -64,7 +64,7 @@ the Appium client depends on) since that is what you will use as your primary in
 |[Appium Java client](https://github.com/appium/java-client)|Java|Appium Team|
 |[Appium Python client](https://github.com/appium/python-client)|Python|Appium Team|
 |[Appium Ruby Core client](https://github.com/appium/ruby_lib_core) (Recommended)<br>[Appium Ruby client](https://github.com/appium/ruby_lib)|Ruby|Appium Team|
-|[WebDriverIO](https://webdriver.io)|Node.js|Community|
+|[WebDriverIO](https://webdriver.io)<br>[Nightwatch](https://nightwatchjs.org/)|Node.js|Community|
 |[Appium .NET client](https://github.com/appium/dotnet-client)|C#|Appium Team*|
 |[RobotFramework](https://github.com/serhatbolsu/robotframework-appiumlibrary)|DSL|Community|
 

packages/appium/docs/mkdocs-en.yml

@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/en
+site_url: https://appium.io/docs/en
 edit_uri: edit/master/packages/appium/docs/en
 site_description: The Appium automation project documentation
 docs_dir: en

packages/appium/docs/mkdocs-ja.yml

@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/ja
+site_url: https://appium.io/docs/ja
 edit_uri: edit/master/packages/appium/docs/ja
 site_description: The Appium automation project documentation
 docs_dir: ja

packages/appium/docs/mkdocs-zh.yml

@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/zh
+site_url: https://appium.io/docs/zh
 edit_uri: edit/master/packages/appium/docs/zh
 site_description: The Appium automation project documentation
 docs_dir: zh

packages/appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.64",
+  "version": "2.0.0-beta.65",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -62,7 +62,7 @@
   "dependencies": {
     "@appium/base-driver": "^9.3.7",
     "@appium/base-plugin": "^2.2.7",
-    "@appium/docutils": "^0.3.7",
+    "@appium/docutils": "^0.3.8",
     "@appium/schema": "^0.2.6",
     "@appium/support": "^3.1.11",
     "@appium/types": "^0.11.0",

packages/base-plugin/README.md

@@ -1,3 +1,3 @@
 # Appium Base Plugin
 
-The base class used to create Appium plugins. This plugin should not be installed directly as it does nothing. Instead, you extend this plugin when creating your *own* Appium plugins. Check out the [Building Plugins](https://appium.github.io/appium/docs/en/latest/ecosystem/build-plugins/) to learn how to make use of this base class to develop Appium plugins.
+The base class used to create Appium plugins. This plugin should not be installed directly as it does nothing. Instead, you extend this plugin when creating your *own* Appium plugins. Check out the [Building Plugins](https://appium.io/docs/en/latest/ecosystem/build-plugins/) to learn how to make use of this base class to develop Appium plugins.

packages/docutils/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.8](https://github.com/appium/appium/compare/@appium/docutils@0.3.7...@appium/docutils@0.3.8) (2023-04-18)
+
+**Note:** Version bump only for package @appium/docutils
+
+
+
+
+
 ## [0.3.7](https://github.com/appium/appium/compare/@appium/docutils@0.3.6...@appium/docutils@0.3.7) (2023-04-14)
 
 

packages/docutils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "Documentation generation utilities for Appium and related projects",
   "keywords": [
     "automation",
@@ -51,7 +51,7 @@
   "dependencies": {
     "@appium/support": "^3.1.11",
     "@appium/tsconfig": "^0.3.0",
-    "@appium/typedoc-plugin-appium": "^0.6.2",
+    "@appium/typedoc-plugin-appium": "^0.6.3",
     "@sliphua/lilconfig-ts-loader": "3.2.2",
     "chalk": "4.1.2",
     "consola": "2.15.3",

packages/support/test/e2e/net.e2e.spec.js

@@ -16,7 +16,10 @@ describe('#net', function () {
   describe('downloadFile()', function () {
     it('should download file into the target folder', async function () {
       const dstPath = path.join(tmpRoot, 'download.tmp');
-      await downloadFile('https://appium.io/ico/apple-touch-icon-114x114-precomposed.png', dstPath);
+      await downloadFile(
+        'https://appium.io/docs/en/2.0/assets/images/appium-logo-white.png',
+        dstPath
+      );
       await fs.exists(dstPath).should.eventually.be.true;
     });
   });

packages/typedoc-plugin-appium/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.3](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.2...@appium/typedoc-plugin-appium@0.6.3) (2023-04-18)
+
+
+### Bug Fixes
+
+* **typedoc-plugin-appium:** fix parameter display for execute methods ([5a70d7c](https://github.com/appium/appium/commit/5a70d7ce78ce12ef8b9209a2a17c52b02ac0fc80))
+
+
+
 ## [0.6.2](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.1...@appium/typedoc-plugin-appium@0.6.2) (2023-04-12)
 
 

packages/typedoc-plugin-appium/lib/converter/method-map.ts

@@ -2,8 +2,8 @@ import _ from 'lodash';
 import {Context, DeclarationReflection, ReflectionKind} from 'typedoc';
 import {
   isCommandPropDeclarationReflection,
-  isExecMethodDefParamsPropDeclarationReflection,
   isHTTPMethodDeclarationReflection,
+  isMethodDefParamsPropDeclarationReflection,
   isRoutePropDeclarationReflection,
 } from '../guards';
 import {AppiumPluginLogger} from '../logger';
@@ -134,7 +134,7 @@ export function convertMethodMap({
 
       const payloadParamsProp = findChildByGuard(
         httpMethodProp,
-        isExecMethodDefParamsPropDeclarationReflection
+        isMethodDefParamsPropDeclarationReflection
       );
 
       const requiredParams = convertRequiredCommandParams(payloadParamsProp);

packages/typedoc-plugin-appium/lib/guards.ts

@@ -238,7 +238,7 @@ export function isExecMethodData(value: any): value is ExecMethodData {
 export function isMethodDefParamsPropDeclarationReflection(
   value: any
 ): value is MethodDefParamsPropDeclarationReflection {
-  return isReflectionWithReflectedType(value) && value.name === NAME_PARAMS;
+  return isReflectionWithReflectedType(value) && value.name === NAME_PAYLOAD_PARAMS;
 }
 
 /**
@@ -248,7 +248,7 @@ export function isMethodDefParamsPropDeclarationReflection(
 export function isExecMethodDefParamsPropDeclarationReflection(
   value: any
 ): value is ExecMethodDefParamsPropDeclarationReflection {
-  return isReflectionWithReflectedType(value) && value.name === NAME_PAYLOAD_PARAMS;
+  return isReflectionWithReflectedType(value) && value.name === NAME_PARAMS;
 }
 
 /**

packages/typedoc-plugin-appium/lib/theme/resources/partials/command.hbs

@@ -20,6 +20,7 @@
 {{/with}}
 
 {{else}}
+{{! the required/optional parameters bits are fallbacks }}
 {{#if hasRequiredParams}}
 
 ##### Required Parameters
@@ -53,8 +54,8 @@
 
 <!-- END:EXAMPLE -->
 {{/each}}
-{{/if}}
 <!-- END:EXAMPLES -->
+{{/if}}
 {{#if signature}}
 
 #### Response

packages/typedoc-plugin-appium/lib/theme/resources/partials/execute-method.hbs

@@ -3,35 +3,93 @@
 ### {{#ifNamedAnchors}} <a id="{{anchor}}" name="{{this.anchor}}"></a> {{/ifNamedAnchors}}Script: `{{name}}`
 
 {{#if hasComment}}
-
 {{> comment}}
-
+<!-- comment source: {{commentSource}} -->
 {{/if}}
 
 #### Route
 
 `{{httpMethod}} {{route}}`
 
-{{#if hasRequiredParams}}  
+{{#if parameters}}
 
-#### Required Parameters
+#### Parameters
+
+{{#with parameters}}
+
+{{{parameterTable}}}
+
+{{/with}}
+
+{{else}}
+{{! the required/optional parameters bits are fallbacks }}
+{{#if hasRequiredParams}}
+
+##### Required Parameters
 
 {{#each requiredParams}}
-
 - `{{this}}`
-
 {{/each}}
 
 {{/if}}
 
 {{#if hasOptionalParams}}
 
-#### Optional Parameters
+##### Optional Parameters
 
 {{#each optionalParams}}
 - `{{this}}`
 {{/each}}
 
 {{/if}}
-  
+{{/if}}
+
+{{#if hasExample}}
+#### {{pluralize 'Example' examples.length}}
+
+<!-- BEGIN:EXAMPLES -->
+{{#each examples}}
+##### {{lang}}
+<!-- BEGIN:EXAMPLE lang={{lang}} -->
+
+{{{text}}}
+
+<!-- END:EXAMPLE -->
+{{/each}}
+<!-- END:EXAMPLES -->
+{{/if}}
+{{#if signature}}
+
+#### Response
+
+{{#with signature}}
+
+{{#with type}}
+
+{{{type 'all'}}}
+
+{{/with}}
+
+{{#with comment}}
+
+{{{returns this}}}
+
+{{/with}}
+
+{{#with type}}
+
+{{#if declaration.signatures}}
+
+{{#each declaration.signatures}}
+
+{{> member.signature showSources=false }}
+
+{{/each}}
+
+{{/if}}
+
+{{/with}}
+
+{{/with}}
+{{/if}}
 {{/unless}}

packages/typedoc-plugin-appium/lib/utils.ts

@@ -5,12 +5,17 @@
 
 import _ from 'lodash';
 import {DeclarationReflection} from 'typedoc';
-import {isCallSignatureReflection} from './guards';
+import {isCallSignatureReflection, isReflectionWithReflectedType} from './guards';
 
 /**
  * Loops through signatures of the command's method declaration and returns the first that is a
  * `CallSignatureReflection` (if any).  This is what we think of when we think "function signature"
+ * This also works on DeclarationReflections that have a reflected type; in other words, some value that is the type of a function, but is not a function itself (such as a property assigned to a function).
  */
-export const findCallSignature = _.memoize((refl?: DeclarationReflection) =>
-  refl?.getAllSignatures()?.find(isCallSignatureReflection)
+export const findCallSignature = _.memoize(
+  (refl?: DeclarationReflection) =>
+    refl?.getAllSignatures()?.find(isCallSignatureReflection) ??
+    (isReflectionWithReflectedType(refl)
+      ? refl.type.declaration.getAllSignatures()?.find(isCallSignatureReflection)
+      : undefined)
 );

packages/typedoc-plugin-appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/typedoc-plugin-appium",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "TypeDoc plugin for Appium & its extensions",
   "homepage": "https://appium.io",
   "license": "Apache-2.0",
@@ -26,7 +26,7 @@
     "build": "cpy lib/theme/resources build",
     "clean": "npx rimraf build",
     "test": "run-s test:unit",
-    "test:e2e": "mocha --timeout 20s \"test/e2e/index.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-external-driver.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-method-map.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/converter.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/external.e2e.spec.ts\"",
+    "test:e2e": "mocha --timeout 20s \"test/e2e/index.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-external-driver.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-method-map.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/converter.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/external.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/theme/output.e2e.spec.ts\"",
     "test:smoke": "node ./index.js",
     "test:unit": "mocha --timeout 2s \"test/unit/**/*.spec.ts\""
   },

packages/typedoc-plugin-appium/test/e2e/helpers.ts

@@ -10,8 +10,8 @@ import {
   TSConfigReader,
   TypeDocOptions,
 } from 'typedoc';
-import {THEME_NAME} from '../../lib';
-import {BaseConverter} from '../../lib/converter';
+import {THEME_NAME, setup} from '../../lib';
+import {BaseConverter, NAME_BUILTIN_COMMAND_MODULE, NAME_TYPES_MODULE} from '../../lib/converter';
 import {AppiumPluginLogger} from '../../lib/logger';
 
 const {expect} = chai;
@@ -175,3 +175,13 @@ export interface InitConverterOptions<Args extends readonly any[] = any[]>
 type ConverterConstructor<T, C extends BaseConverter<T>, Args extends readonly any[] = any[]> =
   | Constructor<C, [Context, AppiumPluginLogger, ...Args]>
   | Constructor<C, [Context, AppiumPluginLogger]>;
+
+/**
+ * Creates a new TypeDoc application and/or resets it
+ */
+export function reset({
+  entryPoints = [NAME_TYPES_MODULE, NAME_FAKE_DRIVER_MODULE, NAME_BUILTIN_COMMAND_MODULE],
+  ...opts
+}: Partial<TypeDocOptions> = {}): Application {
+  return setup(initAppForPkgs({entryPoints, ...opts}));
+}

packages/typedoc-plugin-appium/test/e2e/index.e2e.spec.ts

@@ -1,16 +1,9 @@
 import _ from 'lodash';
-import {
-  Application,
-  Context,
-  DeclarationReflection,
-  ProjectReflection,
-  ReflectionKind,
-  TypeDocOptions,
-} from 'typedoc';
-import {convert, ConvertResult, postProcess, PostProcessResult, setup} from '../../lib';
+import {Context, DeclarationReflection, ProjectReflection, ReflectionKind} from 'typedoc';
+import {convert, ConvertResult, postProcess, PostProcessResult} from '../../lib';
 import {NAME_BUILTIN_COMMAND_MODULE, NAME_TYPES_MODULE} from '../../lib/converter';
 import {AppiumPluginReflectionKind, CommandReflection, ExtensionReflection} from '../../lib/model';
-import {initAppForPkgs, NAME_FAKE_DRIVER_MODULE} from './helpers';
+import {reset} from './helpers';
 
 const {expect} = chai;
 
@@ -34,16 +27,6 @@ describe('@appium/typedoc-plugin-appium', function () {
    */
   let extensionReflections!: ExtensionReflection[];
 
-  /**
-   * Creates a new TypeDoc application and/or resets it
-   */
-  function reset({
-    entryPoints = [NAME_TYPES_MODULE, NAME_FAKE_DRIVER_MODULE, NAME_BUILTIN_COMMAND_MODULE],
-    ...opts
-  }: Partial<TypeDocOptions> = {}): Application {
-    return setup(initAppForPkgs({entryPoints, ...opts}));
-  }
-
   describe('convert()', function () {
     describe('when "theme" is not "markdown" or "appium"', function () {
       it('should do nothing', async function () {

packages/typedoc-plugin-appium/test/e2e/theme/output.e2e.spec.ts

@@ -0,0 +1,49 @@
+import path from 'node:path';
+import {tempDir, fs} from 'appium/support';
+import {jestSnapshotPlugin} from 'mocha-chai-jest-snapshot';
+import {convert} from '../../../lib';
+import {reset} from '../helpers';
+
+chai.use(jestSnapshotPlugin());
+
+const {expect} = chai;
+
+describe('@appium/typedoc-plugin-appium', function () {
+  let tmpDir: string;
+  before(async function () {
+    const app = reset({
+      plugin: ['typedoc-plugin-markdown', 'typedoc-plugin-crossmodule-references'],
+    });
+    const promise = convert(app);
+    const project = app.convert();
+    await promise;
+    expect(project).to.exist;
+    tmpDir = await tempDir.openDir();
+    await app.generateDocs(project!, tmpDir);
+  });
+
+  after(async function () {
+    await fs.rimraf(tmpDir);
+  });
+
+  describe('theme', function () {
+    describe('command output', function () {
+      it('should generate expected markdown', async function () {
+        const baseDriverMd = await fs.readFile(
+          path.join(tmpDir, 'commands', 'base-driver.md'),
+          'utf8'
+        );
+        expect(baseDriverMd).toMatchSnapshot();
+      });
+    });
+    describe('execute method output', function () {
+      it('should generate expected markdown', async function () {
+        const fakeDriverMd = await fs.readFile(
+          path.join(tmpDir, 'commands', 'fake-driver.md'),
+          'utf8'
+        );
+        expect(fakeDriverMd).toMatchSnapshot();
+      });
+    });
+  });
+});

renovate/default.json

@@ -47,7 +47,7 @@
     },
     {
       "extends": ["packages:eslint"],
-      "matchPackageNames": ["@appium/eslint-config-appium"],
+      "matchPackagePrefixes": ["@appium/eslint-config-appium"],
       "groupName": "ESLint-related packages",
       "groupSlug": "eslint"
     },
@@ -58,7 +58,8 @@
     },
     {
       "matchPackagePrefixes": ["@appium/"],
-      "excludePackageNames": ["@appium/eslint-config-appium"],
+      "excludePackageNames": ["@appium/eslint-config-appium", "@appium/eslint-config-appium-ts"],
+      "matchPackageNames": "appium",
       "groupName": "Appium-related packages",
       "groupSlug": "appium"
     }