feat: Switch from babel to typescript (#190)

Author: mykola-mokhnach

.eslintrc.json

@@ -1,11 +1,22 @@
 {
-  "extends": "@appium/eslint-config-appium",
+  "extends": ["@appium/eslint-config-appium-ts"],
   "overrides": [
     {
       "files": "test/**/*.js",
       "rules": {
-        "func-names": "off"
+        "func-names": "off",
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    },
+    {
+      "files": "scripts/**/*",
+      "parserOptions": {"sourceType": "script"},
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
       }
     }
-  ]
+  ],
+  "rules": {
+    "require-await": "error"
+  }
 }

.mocharc.js

@@ -1,4 +1,4 @@
 module.exports = {
-  require: ['@babel/register'],
+  require: ['ts-node/register'],
   forbidOnly: Boolean(process.env.CI)
 };

babel.config.json

@@ -54,8 +54,17 @@ const DEFAULT_OPTS = {
 
 
 class Simctl {
+  /** @type {any?} */
+  xcrun;
+
+  /** @type {number} */
+  execTimeout;
+
+  /** @type {boolean} */
+  logErrors;
+
   /**
-   * @param {SimctlOpts} opts
+   * @param {Partial<SimctlOpts>} opts
    */
   constructor (opts = {}) {
     opts = _.cloneDeep(opts);
@@ -111,8 +120,8 @@ class Simctl {
    * @param {string} subcommand - One of available simctl subcommands.
    *                           Execute `xcrun simctl` in Terminal to see the full list
    *                           of available subcommands.
-   * @param {ExecOpts?} opts
-   * @return {Promise<ExecResult|SubProcess>} Either the result of teen process's `exec` or
+   * @param {Partial<ExecOpts>} opts
+   * @return {Promise<import('teen_process').TeenProcessExecResult|import('teen_process').SubProcess>} Either the result of teen process's `exec` or
    * `SubProcess` instance depending of `opts.asynchronous` value.
    * @throws {Error} If the simctl subcommand command returns non-zero return code.
    */
@@ -154,6 +163,7 @@ class Simctl {
         );
         execArgs = ['arch', [...archArgs, xcrun, ...args], execOpts];
       }
+      // @ts-ignore We know what we are doing here
       return asynchronous ? new SubProcess(...execArgs) : await tpExec(...execArgs);
     } catch (e) {
       if (!this.logErrors || !logErrors) {

lib/simctl.js

@@ -6,7 +6,7 @@ const commands = {};
  *
  * @param {string} filePath - Full path to a media file on the local
  *                            file system.
- * @return {Promise<ExecResult>} Command execution result.
+ * @return {Promise<import('teen_process').TeenProcessExecResult>} Command execution result.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
  * @throws {Error} If the `udid` instance property is unset

lib/subcommands/addmedia.js

@@ -22,8 +22,8 @@ const commands = {};
  * until Simulator booting is completed.
  * The method is only available since Xcode8.
  *
- * @param {BootMonitorOptions} opts - Monitoring options.
- * @returns {Promise<SubProcess>} The instance of the corresponding monitoring process.
+ * @param {Partial<BootMonitorOptions>} opts - Monitoring options.
+ * @returns {Promise<import('teen_process').SubProcess>} The instance of the corresponding monitoring process.
  * @throws {Error} If the Simulator fails to finish booting within the given timeout and onFinished
  * property is not set.
  * @throws {Error} If the `udid` instance property is unset

lib/subcommands/bootstatus.js

@@ -23,7 +23,7 @@ const commands = {};
  * @param {string} name - The device name to be created.
  * @param {string} deviceTypeId - Device type, for example 'iPhone 6'.
  * @param {string} platformVersion - Platform version, for example '10.3'.
- * @param {SimCreationOpts} opts - Simulator options for creating devices.
+ * @param {Partial<SimCreationOpts>} opts - Simulator options for creating devices.
  * @return {Promise<string>} The UDID of the newly created device.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
@@ -92,7 +92,7 @@ commands.createDevice = async function createDevice (name, deviceTypeId, platfor
   }
 
   // make sure that it gets out of the "Creating" state
-  const retries = parseInt(timeout / 1000, 10);
+  const retries = parseInt(`${timeout / 1000}`, 10);
   await retryInterval(retries, 1000, async () => {
     const devices = _.values(await this.getDevices());
     for (const deviceArr of _.values(devices)) {

lib/subcommands/create.js

@@ -14,7 +14,7 @@ const commands = {};
  */
 commands.eraseDevice = async function eraseDevice (timeout = 1000) {
   // retry erase with a sleep in between because it's flakey
-  const retries = parseInt(timeout / 200, 10);
+  const retries = parseInt(`${timeout / 200}`, 10);
   await retryInterval(retries, 200,
     async () => await this.exec('erase', {
       args: [this.requireUdid('erase')]

lib/subcommands/erase.js

@@ -36,7 +36,7 @@ async function handleRawPayload (payload, onPayloadStored) {
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {CertOptions} opts
+ * @param {Partial<CertOptions>} opts
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset
@@ -62,7 +62,7 @@ commands.addRootCertificate = async function addRootCertificate (cert, opts = {}
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {CertOptions} opts
+ * @param {Partial<CertOptions>} opts
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset

lib/subcommands/keychain.js

@@ -18,6 +18,7 @@ const commands = {};
  * @throws {Error} If the `udid` instance property is unset
  */
 commands.launchApp = async function launchApp (bundleId, tries = 5) {
+  // @ts-ignore A string will always be returned
   return await retryInterval(tries, 1000, async () => {
     const {stdout} = await this.exec('launch', {
       args: [this.requireUdid('launch'), bundleId],