Fix all typescript errors

johnf · johnf · commit 2bbfaf1e7443 · 2024-10-05T21:46:01.000+10:00
diff --git a/src/actions.ts b/src/actions.ts
@@ -1,12 +1,12 @@
 import { getConfig } from './cli/config';
 
 import { Logger } from './logger';
-import { CliRunOptions } from './types';
+import type { CliRunOptions } from './types';
 import { adbLaunch, adbTerminate } from './utils/adb';
 import { waitFor } from './utils/wait-for';
 import { xcrunLaunch, xcrunTerminate, xcrunUi } from './utils/xcrun';
 import { createWebSocketClient } from './websocket';
-import {
+import type {
   SOCKET_TEST_REQUEST,
   SOCKET_SCROLL_TO_VALUE,
   SOCKET_CLIENT_RESPONSE,
diff --git a/src/cli/build.test.ts b/src/cli/build.test.ts
@@ -1,14 +1,14 @@
 import path from 'path';
-import execa from 'execa';
+import * as execa from 'execa';
 
 import { buildAndroid, buildHandler, buildIOS, ENTRY_FILE } from './build';
-import { CliBuildOptions, Config, ConfigEnv } from '../types';
+import type { CliBuildOptions, Config, ConfigEnv } from '../types';
 import { Logger } from '../logger';
 import * as configHelpers from './config';
 
 describe('build.ts', () => {
   const logger = new Logger();
-  const execMock = jest.spyOn(execa, 'command').mockImplementation();
+  const execMock = jest.spyOn(execa, 'execaCommand').mockImplementation();
 
   beforeEach(() => {
     execMock.mockReset();
diff --git a/src/cli/build.ts b/src/cli/build.ts
@@ -1,7 +1,7 @@
 import path from 'path';
-import execa from 'execa';
+import { execaCommand } from 'execa';
 
-import { CliBuildOptions, Config } from '../types';
+import type { CliBuildOptions, Config } from '../types';
 import { Logger } from '../logger';
 import { getConfig } from './config';
 
@@ -29,7 +29,7 @@ export const buildIOS = async (
 
   logger.info(`[OWL - CLI] Building the app with: ${buildCommand.join(' ')}.`);
 
-  await execa.command(buildCommand.join(' '), {
+  await execaCommand(buildCommand.join(' '), {
     stdio: 'inherit',
     env: {
       ENTRY_FILE,
@@ -65,7 +65,7 @@ export const buildAndroid = async (
 
   logger.info(`[OWL - CLI] Building the app with: ${buildCommand.join(' ')}.`);
 
-  await execa.command(buildCommand.join(' '), {
+  await execaCommand(buildCommand.join(' '), {
     stdio: 'inherit',
     cwd,
     env: {
diff --git a/src/cli/config.test.ts b/src/cli/config.test.ts
@@ -1,6 +1,6 @@
 import { promises as fs } from 'fs';
 
-import { Config } from '../types';
+import type { Config } from '../types';
 import { getConfig, readConfigFile, validateSchema } from './config';
 
 describe('config.ts', () => {
diff --git a/src/cli/config.ts b/src/cli/config.ts
@@ -1,7 +1,7 @@
 import { promises as fs } from 'fs';
-import Ajv, { ErrorObject, JSONSchemaType } from 'ajv';
+import Ajv, { type ErrorObject, type JSONSchemaType } from 'ajv';
 
-import { Config } from '../types';
+import type { Config } from '../types';
 
 export const validateSchema = (config: {}): Promise<Config> => {
   const configSchema: JSONSchemaType<Config> = {
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-import yargs, { Options } from 'yargs';
-import { CliBuildOptions, CliRunOptions } from '../types';
-const { hideBin } = require('yargs/helpers');
+import yargs, { type Options } from 'yargs';
+import type { CliBuildOptions, CliRunOptions } from '../types';
+import { hideBin } from 'yargs/helpers';
 const argv = yargs(hideBin(process.argv));
 
 import { buildHandler } from './build';
diff --git a/src/cli/run.test.ts b/src/cli/run.test.ts
@@ -3,11 +3,11 @@ import path from 'path';
 import * as reportHelpers from '../report';
 import * as configHelpers from './config';
 
-import { CliRunOptions, Config } from '../types';
+import type { CliRunOptions, Config } from '../types';
 import * as run from './run';
 import * as xcrun from '../utils/xcrun';
 import * as adb from '../utils/adb';
-import execa from 'execa';
+import * as execa from 'execa';
 import { Logger } from '../logger';
 
 jest.mock('../utils/xcrun');
@@ -21,9 +21,9 @@ describe('run.ts', () => {
   const mkdirMock = jest.spyOn(fs, 'mkdir');
   const execKillMock = {
     kill: jest.fn(),
-  } as unknown as execa.ExecaChildProcess<any>;
+  } as unknown as ReturnType<typeof execa.execaCommand>;
 
-  const execMock = jest.spyOn(execa, 'command').mockImplementation();
+  const execMock = jest.spyOn(execa, 'execaCommand').mockReturnValue(execKillMock);
 
   beforeEach(() => {
     mkdirMock.mockReset();
@@ -153,7 +153,7 @@ describe('run.ts', () => {
       process.cwd()
     )} --runInBand`;
 
-    const commandSyncMock = jest.spyOn(execa, 'commandSync');
+    const commandSyncMock = jest.spyOn(execa, 'execaCommandSync');
     const mockGenerateReport = jest.spyOn(reportHelpers, 'generateReport');
 
     jest.spyOn(Logger.prototype, 'print').mockImplementation();
@@ -245,7 +245,7 @@ describe('run.ts', () => {
 
       await run.runHandler({ ...args });
 
-      await expect(execMock.mock.calls[0][0]).toEqual(
+      await expect(execMock.mock.calls[0]?.[0]).toEqual(
         'node scripts/websocket-server.js'
       );
     });
diff --git a/src/cli/run.ts b/src/cli/run.ts
@@ -1,9 +1,9 @@
 import path from 'path';
-import execa from 'execa';
+import { execaCommand, execaCommandSync } from 'execa';
 import { promises as fs } from 'fs';
 
 import { cleanupScreenshots } from '../screenshot';
-import { CliRunOptions, Config } from '../types';
+import type { CliRunOptions, Config } from '../types';
 import { generateReport, cleanupReport } from '../report';
 import { getConfig } from './config';
 import { Logger } from '../logger';
@@ -102,7 +102,7 @@ export const runHandler = async (args: CliRunOptions) => {
   await cleanupScreenshots();
 
   logger.print(`[OWL - CLI] Starting websocket server.`);
-  const webSocketProcess = execa.command('node scripts/websocket-server.js', {
+  const webSocketProcess = execaCommand('node scripts/websocket-server.js', {
     stdio: 'inherit',
     cwd: path.join(__dirname, '..', '..'),
     env: {
@@ -149,7 +149,7 @@ export const runHandler = async (args: CliRunOptions) => {
   logger.info(`[OWL - CLI] Will set the jest root to ${process.cwd()}.`);
 
   try {
-    await execa.commandSync(jestCommand, {
+    await execaCommandSync(jestCommand, {
       stdio: 'inherit',
       env: {
         OWL_PLATFORM: args.platform,
diff --git a/src/client/client.ts b/src/client/client.ts
@@ -7,9 +7,9 @@ import {
   SOCKET_WAIT_TIMEOUT,
 } from './constants';
 import { initWebSocket } from './websocket';
-import { SOCKET_CLIENT_RESPONSE, SOCKET_TEST_REQUEST } from '../websocketTypes';
+import type { SOCKET_CLIENT_RESPONSE, SOCKET_TEST_REQUEST } from '../websocketTypes';
 
-import { add, get, TrackedElementData } from './trackedElements';
+import { add, get, type TrackedElementData } from './trackedElements';
 import { handleAction } from './handleAction';
 
 const logger = new Logger(true);
@@ -115,9 +115,9 @@ export const applyJsxChildrenElementTracking = (props: any): void => {
 export const patchReact = () => {
   const originalReactCreateElement: typeof React.createElement =
     React.createElement;
-  let automateTimeout: number;
+  let automateTimeout: NodeJS.Timeout;
 
-  if (parseInt(React.version.split('.')[0], 10) >= 18) {
+  if (parseInt(React.version.split('.')?.[0] || '0', 10) >= 18) {
     const jsxRuntime = require('react/jsx-runtime');
     const origJsx = jsxRuntime.jsx;
 
diff --git a/src/client/handleAction.ts b/src/client/handleAction.ts
@@ -1,10 +1,10 @@
-import { GestureResponderEvent } from 'react-native';
-import {
+import type { GestureResponderEvent } from 'react-native';
+import type {
   SOCKET_TEST_ACTION,
   SOCKET_TEST_REQUEST_VALUE,
 } from '../websocketTypes';
 import { Logger } from '../logger';
-import { TrackedElementData } from './trackedElements';
+import type { TrackedElementData } from './trackedElements';
 
 /**
  * When we call onPress/onLongPress, the function expects an `event` arg of type `GestureResponderEvent`.
@@ -22,7 +22,9 @@ const getGestureResponderEvent = (): GestureResponderEvent => ({
     timestamp: Date.now(),
     touches: [],
   },
+  // @ts-expect-error - We are mocking the event object
   currentTarget: 0,
+  // @ts-expect-error - We are mocking the event object
   target: 0,
   bubbles: false,
   cancelable: false,
diff --git a/src/client/trackedElements.ts b/src/client/trackedElements.ts
@@ -1,5 +1,5 @@
 import React from 'react';
-import {
+import type {
   PressableProps,
   TextInputProps,
   TouchableWithoutFeedbackProps,
diff --git a/src/matchers.test.ts b/src/matchers.test.ts
@@ -1,13 +1,13 @@
 import fs from 'fs';
 import pixelmatch from 'pixelmatch';
-import { mocked } from 'ts-jest/utils';
+import { mocked } from 'jest-mock';
 
 import { toMatchBaseline } from './matchers';
 
 jest.mock('pixelmatch');
 
 describe('matchers.ts', () => {
-  const mockedPixelmatch = mocked(pixelmatch, true);
+  const mockedPixelmatch = mocked(pixelmatch, { shallow: false });
 
   const imageHello1Data = `iVBORw0KGgoAAAANSUhEUgAAACUAAAALCAYAAAD4OERFAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAJaADAAQAAAABAAAACwAAAADN8bJQAAABcElEQVQ4Ec2UvytGURjHr1/lHd5JlF9leMNAiQzKbqCMBt5ikUEWMhkMDGZ/gEHZDMqCsr6JQel9yW8Dg4lBJvL5ck7dTudw3UG+9el5nvM859znnnPujaIoKoMq+Ffqo5uTFB1dMacLuuEixXxNaYRNd26lO/BHcZbnjEEecu4zy82AjnARbuEIOsBqEqdkmLGDAav1luAB7mEBtLYrNdUKd27Cxjq+d1iFTtiALZCG4QYGQLlTGAXJd3zTjB9CM7SB6schpF4Sj76kmnoCu2v9+OemcBc7Z3yZKbAN+5o6Jj+hQiM1uWMDj/U2Ze+Utlu7Jb1A5tP7Om9NnDexvtIz4/tMC4MHscQ1fm0sTuTa3XkLVD8zrretM9RjByGkIommWFJHWIjFiVzbVKh4n8QIVBvWsLMQ0jaJPKheF3wI9uBX+qmpZVarAV12fSnyVyCkdRI9cAm65K/w3Z0inU56Y/1LRBJVUNQODUmKfTUfKJc7FJ+heOgAAAAASUVORK5CYII=`;
   const imageHello1Buffer = Buffer.from(imageHello1Data, 'base64');
diff --git a/src/matchers.ts b/src/matchers.ts
@@ -3,7 +3,7 @@ import path from 'path';
 import pixelmatch from 'pixelmatch';
 import { PNG } from 'pngjs';
 
-import { Platform } from './types';
+import type { Platform } from './types';
 
 declare global {
   namespace jest {
@@ -76,7 +76,7 @@ export const toMatchBaseline = (
     }
 
     // Create and save the diff image
-    fs.writeFileSync(diffPath, PNG.sync.write(diffImage));
+    fs.writeFileSync(diffPath, PNG.sync.write(diffImage).toString());
 
     return {
       message: () =>
diff --git a/src/report.ts b/src/report.ts
@@ -3,7 +3,7 @@ import handlebars from 'handlebars';
 import { promises as fs } from 'fs';
 
 import { Logger } from './logger';
-import { JestReport, Platform, ReportStats } from './types';
+import type { JestReport, Platform, ReportStats } from './types';
 import { fileExists } from './utils/file-exists';
 
 export const cleanupReport = async () => {
diff --git a/src/screenshot.test.ts b/src/screenshot.test.ts
@@ -1,4 +1,4 @@
-import execa from 'execa';
+import * as execa from 'execa';
 import path from 'path';
 import { promises as fs } from 'fs';
 
@@ -8,7 +8,7 @@ import * as fileExistsHelpers from './utils/file-exists';
 const SCREENSHOT_FILENAME = 'screen';
 
 describe('screenshot.ts', () => {
-  const commandMock = jest.spyOn(execa, 'command');
+  const commandMock = jest.spyOn(execa, 'execaCommand');
   const mkdirMock = jest.spyOn(fs, 'mkdir').mockImplementation();
   const writeFileMock = jest.spyOn(fs, 'writeFile').mockImplementation();
 
diff --git a/src/screenshot.ts b/src/screenshot.ts
@@ -1,10 +1,10 @@
-import execa from 'execa';
+import { execaCommand } from 'execa';
 import { promises as fs } from 'fs';
 import path from 'path';
 
 import { fileExists } from './utils/file-exists';
 import { Logger } from './logger';
-import { Platform } from './types';
+import type { Platform } from './types';
 
 export const cleanupScreenshots = async () => {
   const latestDirPath = path.join(process.cwd(), '.owl', 'latest');
@@ -60,7 +60,7 @@ export const takeScreenshot = async (filename: string): Promise<string> => {
   logger.info(
     `[OWL - CLI] Will run the screenshot command: ${screenshotCommand}.`
   );
-  await execa.command(screenshotCommand, {
+  await execaCommand(screenshotCommand, {
     stdio,
     cwd,
     shell: platform === 'android',
diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,4 @@
-import { Arguments } from 'yargs';
+import type { Arguments } from 'yargs';
 
 export type Platform = 'ios' | 'android';
 
diff --git a/src/utils/adb.test.ts b/src/utils/adb.test.ts
@@ -1,4 +1,5 @@
-import execa from 'execa';
+import * as execa from 'execa';
+import { execaCommand } from 'execa';
 
 import * as adb from './adb';
 
@@ -9,8 +10,8 @@ describe('adb.ts', () => {
 
   const execKillMock = {
     kill: jest.fn(),
-  } as unknown as execa.ExecaChildProcess<any>;
-  const execMock = jest.spyOn(execa, 'command').mockReturnValue(execKillMock);
+  } as unknown as ReturnType<typeof execaCommand>;
+  const execMock = jest.spyOn(execa, 'execaCommand').mockReturnValue(execKillMock);
 
   beforeEach(() => {
     execMock.mockReset();
diff --git a/src/utils/adb.ts b/src/utils/adb.ts
@@ -1,6 +1,6 @@
 import path from 'path';
-import execa from 'execa';
-import { ConfigAndroid } from '../types';
+import { execaCommand } from 'execa';
+import type { ConfigAndroid } from '../types';
 
 export const adbInstall = async ({
   debug,
@@ -23,7 +23,7 @@ export const adbInstall = async ({
   const appPath = path.join(cwd, appFilename);
 
   const command = `adb install -r ${appPath}`;
-  await execa.command(command, { stdio });
+  await execaCommand(command, { stdio });
 };
 
 export const adbTerminate = async ({
@@ -36,7 +36,7 @@ export const adbTerminate = async ({
   const stdio = debug ? 'inherit' : 'ignore';
 
   const command = `adb shell am force-stop ${packageName}`;
-  await execa.command(command, { stdio });
+  await execaCommand(command, { stdio });
 };
 
 export const adbLaunch = async ({
@@ -49,5 +49,5 @@ export const adbLaunch = async ({
   const stdio = debug ? 'inherit' : 'ignore';
 
   const command = `adb shell monkey -p "${packageName}" -c android.intent.category.LAUNCHER 1`;
-  await execa.command(command, { stdio });
+  await execaCommand(command, { stdio });
 };
diff --git a/src/utils/xcrun.test.ts b/src/utils/xcrun.test.ts
@@ -1,4 +1,5 @@
-import execa from 'execa';
+import * as execa from 'execa';
+import { execaCommand } from 'execa';
 
 import * as xcrun from './xcrun';
 
@@ -9,9 +10,9 @@ describe('xcrun.ts', () => {
 
   const execKillMock = {
     kill: jest.fn(),
-    stdout: 'bundleId',
-  } as unknown as execa.ExecaChildProcess<any>;
-  const execMock = jest.spyOn(execa, 'command').mockReturnValue(execKillMock);
+  } as unknown as ReturnType<typeof execaCommand>;
+  const execMock = jest.spyOn(execa, 'execaCommand').mockReturnValue(execKillMock);
+
 
   beforeEach(() => {
     execMock.mockClear();
diff --git a/src/utils/xcrun.ts b/src/utils/xcrun.ts
diff --git a/tsconfig.json b/tsconfig.json
