feat: add all the types (#635)

.eslintrc.json

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

.github/workflows/unit-test.yml

@@ -2,7 +2,6 @@ name: Unit Tests
 
 on: [pull_request, push]
 
-
 jobs:
   prepare_matrix:
     runs-on: ubuntu-latest
@@ -13,9 +12,9 @@ jobs:
       id: generate-matrix
       run: echo "versions=$(curl -s https://endoflife.date/api/nodejs.json | jq -c '[[.[] | select(.lts != false)][:3] | .[].cycle | tonumber]')" >> "$GITHUB_OUTPUT"
 
-  test:
+  unit-test:
     needs:
-    - prepare_matrix
+      - prepare_matrix
     strategy:
       matrix:
         node-version: ${{ fromJSON(needs.prepare_matrix.outputs.versions) }}

.gitignore

@@ -8,3 +8,6 @@ coverage
 .nyc_output/
 test-results.xml
 .DS_Store
+docs/reference/
+site/
+.vscode/

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint:commit -- --edit ${1}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint:staged

.mocharc.js

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

.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "dev",
+      "problemMatcher": [],
+      "label": "npm: dev",
+      "detail": "npm run build -- --watch",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

.wallaby.js

@@ -0,0 +1,42 @@
+'use strict';
+
+module.exports = (wallaby) => {
+  return {
+    compilers: {
+      '**/*.js': wallaby.compilers.typeScript({
+        allowJs: true,
+        allowSyntheticDefaultImports: true,
+        resolveJsonModule: true,
+        isolatedModules: true,
+      }),
+      '**/*.ts?(x)': wallaby.compilers.typeScript(),
+    },
+    debug: true,
+    env: {
+      type: 'node',
+    },
+    files: ['index.ts', 'lib/**/*'],
+    testFramework: 'mocha',
+    tests: ['test/unit/**/*-specs.js'],
+    workers: {
+      restart: true,
+    },
+    setup(wallaby) {
+      // copied out of `./test/setup.js`
+
+      const chai = require('chai');
+      const chaiAsPromised = require('chai-as-promised');
+
+      // The `chai` global is set if a test needs something special.
+      // Most tests won't need this.
+      global.chai = chai.use(chaiAsPromised);
+
+      // `should()` is only necessary when working with some `null` or `undefined` values.
+      global.should = chai.should();
+
+      const mocha = wallaby.testFramework;
+      mocha.timeout(10000);
+    },
+    runMode: 'onsave',
+  };
+};

commitlint.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-leading-blank': [0],
+    'body-max-line-length': [0],
+    'footer-max-line-length': [0],
+    'header-max-length': [0],
+    'subject-case': [0],
+    'subject-full-stop': [0],
+  },
+};

index.js

@@ -1,6 +1,8 @@
-// transpile:main
+import {install} from 'source-map-support';
 
-import { AndroidUiautomator2Driver } from './lib/driver';
+install();
 
-export { AndroidUiautomator2Driver };
+import {AndroidUiautomator2Driver} from './lib/driver';
+
+export {AndroidUiautomator2Driver};
 export default AndroidUiautomator2Driver;