Merge branch 'main' of github.com:AutomateThePlanet/appium-novawindows-driver

Author: teo-nikolov

.gitignore

@@ -1,5 +1,142 @@
-node_modules
-build
+# Logs
+logs
 *.log
-.vscode
-package-lock.json*
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# NovaWindows driver build directory
+build/
+
+# Ignore package-lock.json in favour of npm-shrinkwrap.json for npm publishing
+package-lock.json*

eslint.config.mjs

@@ -0,0 +1,12 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import { config, configs } from 'typescript-eslint';
+import appiumConfig from '@appium/eslint-config-appium-ts';
+
+
+export default config(
+  ...appiumConfig,
+  eslint.configs.recommended,
+  configs.recommended,
+);

lib/commands/extension.ts

@@ -94,6 +94,7 @@ type KeyAction = {
     down?: boolean,
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function execute(this: NovaWindowsDriver, script: string, args: any[]) {
     if (script.startsWith(PLATFORM_COMMAND_PREFIX)) {
         script = script.replace(PLATFORM_COMMAND_PREFIX, '').trim();

lib/commands/index.ts

@@ -22,6 +22,7 @@ type Commands = {
 };
 
 declare module '../driver' {
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
     interface NovaWindowsDriver extends Commands {}
 }
 

lib/commands/powershell.ts

@@ -15,10 +15,12 @@ export async function startPowerShellSession(this: NovaWindowsDriver): Promise<v
     powerShell.stdout.setEncoding('utf8');
     powerShell.stdout.setEncoding('utf8');
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     powerShell.stdout.on('data', (chunk: any) => {
         this.powerShellStdOut += chunk.toString();
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     powerShell.stderr.on('data', (chunk: any) => {
         this.powerShellStdErr += chunk.toString();
     });
@@ -86,6 +88,7 @@ export async function sendPowerShellCommand(this: NovaWindowsDriver, command: st
         powerShell.stdin.write(`${command}\n`);
         powerShell.stdin.write(/* ps1 */ `Write-Output $([char]0x${magicNumber.toString(16)})\n`);
 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const onData: Parameters<typeof powerShell.stdout.on>[1] = ((chunk: any) => {
             const magicChar = String.fromCharCode(magicNumber);
             if (chunk.toString().includes(magicChar)) {

lib/enums.ts

@@ -4,7 +4,9 @@ type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] exte
 
 type IntRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>> | T
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type AllFlagsValue<N extends number, A extends any[] = []> = [N] extends [Partial<A>['length']] ? A['length'] : UnionFlags<N, [0, ...A, ...A]>;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type UnionFlags<N extends number, A extends any[] = []> = IntRange<0, AllFlagsValue<N, A>>;
 
 export type Enum<T> = T[keyof T];

lib/powershell/conditions.ts

@@ -162,6 +162,7 @@ export class FalseCondition extends Condition {
     }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function assertPSObjectType(obj: PSObject, type: new (...args: any[]) => PSObject) {
     if (!(obj instanceof type)) {
         throw new errors.InvalidArgumentError(`Property expected type ${type.name} but got ${(obj as object)?.constructor.name}.`);

lib/powershell/core.ts

@@ -20,6 +20,7 @@ export function pwsh(strings: TemplateStringsArray, ...values: string[]): string
 export function pwsh$(literals: TemplateStringsArray, ...substitutions: number[]) {
     const templateInstance = $(literals, ...substitutions);
     const defaultFormat = templateInstance.format.bind(templateInstance);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     templateInstance.format = (...args: any[]) => {
         const command = defaultFormat(...args);
         return /* ps1 */ `(Invoke-Expression -Command ([Text.Encoding]::UTF8.GetString([Convert]::FromBase64String('${btoa(command)}'))))`;

lib/util.ts

@@ -41,6 +41,7 @@ export class DeferredStringTemplate {
         });
     }
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     format(...args: any[]): string {
         const out: string[] = [];
         for (let i = 0, k = 0; i < this.literals.length; i++, k++) {

package.json

@@ -32,6 +32,10 @@
     "@appium/eslint-config-appium-ts": "^1.0.3",
     "@appium/tsconfig": "^0.3.5",
     "@appium/types": "^0.25.2",
-    "@types/node": "^22.14.0"
+    "@types/node": "^22.14.0",
+    "@eslint/js": "^9.23.0",
+    "eslint": "^9.23.0",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0"
   }
 }