chore: Integrate oxc and release configs (#1030)

Author: mykola-mokhnach

.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+root = true
+
+[*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,json,jsonc}]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120

.github/workflows/unit-test.yml

@@ -37,6 +37,6 @@ jobs:
     - run: npm run lint
       name: Run linter
     - run: npm run format:check
-      name: Run Prettier check
+      name: Run format check
     - run: npm run test
       name: Run unit tests

.releaserc

@@ -1,4 +1,5 @@
 import type {StringRecord} from '@appium/types';
+
 import type {AndroidUiautomator2Driver} from '../driver.js';
 import type {ActionResult} from './types.js';
 
@@ -39,10 +40,7 @@ export async function mobileScheduleAction(
  * @param name - Name of the scheduled action.
  * @returns The action execution history containing repeats and step results.
  */
-export async function mobileGetActionHistory(
-  this: AndroidUiautomator2Driver,
-  name: string,
-): Promise<ActionResult> {
+export async function mobileGetActionHistory(this: AndroidUiautomator2Driver, name: string): Promise<ActionResult> {
   return (await this.uiautomator2.jwproxy.command('/appium/action_history', 'POST', {
     name,
   })) as ActionResult;
@@ -53,21 +51,15 @@ export async function mobileGetActionHistory(
  * @param name - Name of the scheduled action to unschedule.
  * @returns The result of unscheduling the action.
  */
-export async function mobileUnscheduleAction(
-  this: AndroidUiautomator2Driver,
-  name: string,
-): Promise<any> {
+export async function mobileUnscheduleAction(this: AndroidUiautomator2Driver, name: string): Promise<any> {
   return await this.uiautomator2.jwproxy.command('/appium/unschedule_action', 'POST', {name});
 }
 
 /**
  * Performs a sequence of actions.
  * @param actions - Array of action objects to perform. Pointer actions are automatically converted to touch type.
  */
-export async function performActions(
-  this: AndroidUiautomator2Driver,
-  actions: StringRecord[],
-): Promise<void> {
+export async function performActions(this: AndroidUiautomator2Driver, actions: StringRecord[]): Promise<void> {
   // This is mandatory, since Selenium API uses MOUSE as the default pointer type
   const preprocessedActions = actions.map((action) =>
     Object.assign(

eslint.config.mjs

@@ -12,10 +12,7 @@ export async function getAlertText(this: AndroidUiautomator2Driver): Promise<str
  * Accepts the currently displayed alert.
  * @param buttonLabel - Optional label of the button to click. If not provided, the button will be detected automatically.
  */
-export async function mobileAcceptAlert(
-  this: AndroidUiautomator2Driver,
-  buttonLabel?: string,
-): Promise<void> {
+export async function mobileAcceptAlert(this: AndroidUiautomator2Driver, buttonLabel?: string): Promise<void> {
   await this.uiautomator2.jwproxy.command('/alert/accept', 'POST', {buttonLabel});
 }
 
@@ -30,10 +27,7 @@ export async function postAcceptAlert(this: AndroidUiautomator2Driver): Promise<
  * Dismisses the currently displayed alert.
  * @param buttonLabel - Optional label of the button to click. If not provided, the button will be detected automatically.
  */
-export async function mobileDismissAlert(
-  this: AndroidUiautomator2Driver,
-  buttonLabel?: string,
-): Promise<void> {
+export async function mobileDismissAlert(this: AndroidUiautomator2Driver, buttonLabel?: string): Promise<void> {
   await this.uiautomator2.jwproxy.command('/alert/dismiss', 'POST', {buttonLabel});
 }
 

lib/commands/actions.ts

@@ -1,6 +1,7 @@
 import {errors} from 'appium/driver.js';
-import {APK_EXTENSION} from '../extensions.js';
+
 import type {AndroidUiautomator2Driver} from '../driver.js';
+import {APK_EXTENSION} from '../extensions.js';
 import type {InstallOptions} from './types.js';
 
 /**
@@ -17,8 +18,6 @@ export async function mobileInstallMultipleApks(
   if (!Array.isArray(apks) || apks.length === 0) {
     throw new errors.InvalidArgumentError('No apks are given to install');
   }
-  const configuredApks = await Promise.all(
-    apks.map((app) => this.helpers.configureApp(app, [APK_EXTENSION])),
-  );
+  const configuredApks = await Promise.all(apks.map((app) => this.helpers.configureApp(app, [APK_EXTENSION])));
   await this.adb.installMultipleApks(configuredApks, options);
 }

lib/commands/alert.ts

@@ -1,6 +1,7 @@
 import {utils} from 'appium-android-driver';
 import {fs} from 'appium/support.js';
 import {SETTINGS_HELPER_ID} from 'io.appium.settings';
+
 import type {AndroidUiautomator2Driver} from '../driver.js';
 import {APKS_EXTENSION, APK_EXTENSION} from '../extensions.js';
 import {SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID} from '../uiautomator2-server/index.js';
@@ -17,10 +18,7 @@ export async function prepareSessionApp(this: AndroidUiautomator2Driver): Promis
     // assume is on the device and just launch via the appPackage
     this.log.info(`Starting '${this.opts.appPackage}' directly on the device`);
   } else {
-    this.log.info(
-      `Neither 'app' nor 'appPackage' was set. Starting UiAutomator2 ` +
-        'without the target application',
-    );
+    this.log.info(`Neither 'app' nor 'appPackage' was set. Starting UiAutomator2 ` + 'without the target application');
   }
 }
 
@@ -49,9 +47,7 @@ export async function initAUT(this: AndroidUiautomator2Driver): Promise<void> {
     try {
       otherApps = utils.parseArray(this.opts.otherApps);
     } catch (e) {
-      throw this.log.errorWithException(
-        `Could not parse "otherApps" capability: ${(e as Error).message}`,
-      );
+      throw this.log.errorWithException(`Could not parse "otherApps" capability: ${(e as Error).message}`);
     }
     otherApps = await Promise.all(
       otherApps.map((app) => this.helpers.configureApp(app, [APK_EXTENSION, APKS_EXTENSION])),
@@ -80,9 +76,7 @@ export async function initAUT(this: AndroidUiautomator2Driver): Promise<void> {
     }
   } else {
     if (this.opts.fullReset) {
-      throw this.log.errorWithException(
-        'Full reset requires an app capability, use fastReset if app is not provided',
-      );
+      throw this.log.errorWithException('Full reset requires an app capability, use fastReset if app is not provided');
     }
     this.log.debug('No app capability. Assuming it is already on the device');
     if (this.opts.fastReset && this.opts.appPackage) {

lib/commands/app-management.ts

@@ -6,11 +6,7 @@ import type {BatteryInfo} from './types.js';
  * @returns Battery information including level (0.0-1.0) and state (charging, discharging, etc.).
  */
 export async function mobileGetBatteryInfo(this: AndroidUiautomator2Driver): Promise<BatteryInfo> {
-  const result = (await this.uiautomator2.jwproxy.command(
-    '/appium/device/battery_info',
-    'GET',
-    {},
-  )) as {
+  const result = (await this.uiautomator2.jwproxy.command('/appium/device/battery_info', 'GET', {})) as {
     status: BatteryInfo['state'];
     level: number;
   };

lib/commands/aut.ts

@@ -1,8 +1,9 @@
-import {PROTOCOLS} from 'appium/driver.js';
-import type {DoSetElementValueOpts} from 'appium-android-driver';
 import type {Element as AppiumElement, Position, Rect, Size} from '@appium/types';
-import type {AndroidUiautomator2Driver} from '../driver.js';
+import type {DoSetElementValueOpts} from 'appium-android-driver';
 import type {Chromedriver} from 'appium-chromedriver';
+import {PROTOCOLS} from 'appium/driver.js';
+
+import type {AndroidUiautomator2Driver} from '../driver.js';
 
 /**
  * Gets the currently active element.
@@ -23,24 +24,15 @@ export async function getAttribute(
   attribute: string,
   elementId: string,
 ): Promise<string> {
-  return String(
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/attribute/${attribute}`,
-      'GET',
-      {},
-    ),
-  );
+  return String(await this.uiautomator2.jwproxy.command(`/element/${elementId}/attribute/${attribute}`, 'GET', {}));
 }
 
 /**
  * Returns whether the element is displayed.
  * @param elementId - ID of the element.
  * @returns True if the element is displayed, false otherwise.
  */
-export async function elementDisplayed(
-  this: AndroidUiautomator2Driver,
-  elementId: string,
-): Promise<boolean> {
+export async function elementDisplayed(this: AndroidUiautomator2Driver, elementId: string): Promise<boolean> {
   return toBool(await this.getAttribute('displayed', elementId));
 }
 
@@ -49,10 +41,7 @@ export async function elementDisplayed(
  * @param elementId - ID of the element.
  * @returns True if the element is enabled, false otherwise.
  */
-export async function elementEnabled(
-  this: AndroidUiautomator2Driver,
-  elementId: string,
-): Promise<boolean> {
+export async function elementEnabled(this: AndroidUiautomator2Driver, elementId: string): Promise<boolean> {
   return toBool(await this.getAttribute('enabled', elementId));
 }
 
@@ -61,10 +50,7 @@ export async function elementEnabled(
  * @param elementId - ID of the element.
  * @returns True if the element is selected, false otherwise.
  */
-export async function elementSelected(
-  this: AndroidUiautomator2Driver,
-  elementId: string,
-): Promise<boolean> {
+export async function elementSelected(this: AndroidUiautomator2Driver, elementId: string): Promise<boolean> {
   return toBool(await this.getAttribute('selected', elementId));
 }
 
@@ -74,27 +60,16 @@ export async function elementSelected(
  * @returns The element tag name.
  */
 export async function getName(this: AndroidUiautomator2Driver, elementId: string): Promise<string> {
-  return (await this.uiautomator2.jwproxy.command(
-    `/element/${elementId}/name`,
-    'GET',
-    {},
-  )) as string;
+  return (await this.uiautomator2.jwproxy.command(`/element/${elementId}/name`, 'GET', {})) as string;
 }
 
 /**
  * Gets the element location.
  * @param elementId - ID of the element.
  * @returns The element position coordinates (x, y).
  */
-export async function getLocation(
-  this: AndroidUiautomator2Driver,
-  elementId: string,
-): Promise<Position> {
-  return (await this.uiautomator2.jwproxy.command(
-    `/element/${elementId}/location`,
-    'GET',
-    {},
-  )) as Position;
+export async function getLocation(this: AndroidUiautomator2Driver, elementId: string): Promise<Position> {
+  return (await this.uiautomator2.jwproxy.command(`/element/${elementId}/location`, 'GET', {})) as Position;
 }
 
 /**
@@ -110,10 +85,7 @@ export async function getSize(this: AndroidUiautomator2Driver, elementId: string
  * Sets the value of an element using the upstream driver API.
  * @param params - Options containing the element ID and value to set.
  */
-export async function doSetElementValue(
-  this: AndroidUiautomator2Driver,
-  params: DoSetElementValueOpts,
-): Promise<void> {
+export async function doSetElementValue(this: AndroidUiautomator2Driver, params: DoSetElementValueOpts): Promise<void> {
   await this.uiautomator2.jwproxy.command(`/element/${params.elementId}/value`, 'POST', params);
 }
 
@@ -156,13 +128,8 @@ export async function click(this: AndroidUiautomator2Driver, element: string): P
  * @param element - ID of the element.
  * @returns Base64-encoded PNG screenshot of the element.
  */
-export async function getElementScreenshot(
-  this: AndroidUiautomator2Driver,
-  element: string,
-): Promise<string> {
-  return String(
-    await this.uiautomator2.jwproxy.command(`/element/${element}/screenshot`, 'GET', {}),
-  );
+export async function getElementScreenshot(this: AndroidUiautomator2Driver, element: string): Promise<string> {
+  return String(await this.uiautomator2.jwproxy.command(`/element/${element}/screenshot`, 'GET', {}));
 }
 
 /**
@@ -178,10 +145,7 @@ export async function clear(this: AndroidUiautomator2Driver, elementId: string):
  * @param elementId - ID of the element.
  * @returns The element rectangle (x, y, width, height).
  */
-export async function getElementRect(
-  this: AndroidUiautomator2Driver,
-  elementId: string,
-): Promise<Rect> {
+export async function getElementRect(this: AndroidUiautomator2Driver, elementId: string): Promise<Rect> {
   if (!this.isWebContext()) {
     return (await this.uiautomator2.jwproxy.command(`/element/${elementId}/rect`, 'GET')) as Rect;
   }