(@wdio/cli): improve bootstrap ElectronJS project (#11523)

* Revert "(@wdio/protocols): revert command name change" This reverts commit daeb031. * (@wdio/cli): improve bootstrap ElectronJS project
webdriverio · Oct 25, 2023 · 496f30a · 496f30a
1 parent 963b578
commit 496f30a
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 7 deletions.
diff --git a/packages/wdio-cli/src/constants.ts b/packages/wdio-cli/src/constants.ts
@@ -464,6 +464,15 @@ export const QUESTIONNAIRE = [{
         if (isBrowserRunner(answers)) {
             return SUPPORTED_PACKAGES.framework.slice(0, 1)
         }
+        /**
+         * Serenity tests don't come with proper ElectronJS example files
+         */
+        if (getTestingPurpose(answers) === 'electron') {
+            return SUPPORTED_PACKAGES.framework.filter(
+                ({ value }) => !value.startsWith('@serenity-js')
+            )
+        }
+
         return SUPPORTED_PACKAGES.framework
     }
 }, {

diff --git a/packages/wdio-cli/src/templates/snippets/electronTest.js.ejs b/packages/wdio-cli/src/templates/snippets/electronTest.js.ejs
@@ -1,9 +1,7 @@
 import { browser } from '@wdio/globals'
 
 describe('Electron Testing', () => {
-    it('should print application metadata', async () => {
-        const appName = await browser.electron.app('getName')
-        const appVersion = await browser.electron.app('getVersion')
-        console.log('Testing Electron app:', appName, appVersion)
+    it('should print application title', async () => {
+        console.log('Hello', await browser.getTitle(), 'application!')
     })
 })
diff --git a/packages/wdio-cli/src/templates/wdio.conf.tpl.ejs b/packages/wdio-cli/src/templates/wdio.conf.tpl.ejs
@@ -1,10 +1,14 @@
 <%
+if (answers.isUsingTypeScript && answers.purpose === 'electron') {
+    %>/// <reference types="wdio-electron-service" />
+<% }
+
 if (answers.isUsingTypeScript && !answers.serenityAdapter) {
     %>import type { Options } from '@wdio/types'
 <% }
 
 if (answers.isUsingTypeScript && answers.serenityAdapter) {
-%>import type { WebdriverIOConfig } from '@serenity-js/webdriverio'
+    %>import type { WebdriverIOConfig } from '@serenity-js/webdriverio'
 <% }
 
 if (answers.isUsingTypeScript) {

diff --git a/packages/wdio-protocols/src/protocols/appium.ts b/packages/wdio-protocols/src/protocols/appium.ts
@@ -1564,7 +1564,7 @@ export default {
     },
     '/session/:sessionId/appium/execute_driver': {
         POST: {
-            command: 'driverScript',
+            command: 'executeDriverScript',
             description:
                 'This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***',
             ref: 'https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md',
@@ -1573,7 +1573,7 @@ export default {
                     name: 'script',
                     type: 'string',
                     description:
-                        "The script to execute. It has access to a 'driver' object which represents a webdriverio session attached to the current server.",
+                        "The script to execute. It has access to a 'driver' object which represents a WebdriverIO session attached to the current server.",
                     required: true,
                 },
                 {