feat: add install-chromedriver command

.eslintrc.json

@@ -6,6 +6,13 @@
       "rules": {
         "func-names": "off"
       }
+    },
+    {
+      "files": "scripts/**/*",
+      "parserOptions": {"sourceType": "module"},
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
+      }
     }
   ]
 }

README.md

@@ -77,6 +77,24 @@ this driver supports the following:
 > **Note**
 > `msedgedriver` support is limited. `appium:autodownloadEnabled` does not work for the driver, thus `appium:executable` is necessary to automate MSEdge browser properly.
 
+## Scripts
+
+### install-chromedriver
+
+This script is used to install the given or latest stable version of chromedriver (113+) from
+[Chrome for testing](https://github.com/GoogleChromeLabs/chrome-for-testing)
+with `appium driver run chromium install-chromedriver`.
+
+Below environment arguments are available:
+- `CHROMEDRIVER_EXECUTABLE_DIR`
+  - Let the command to download chromedrivers in the given directory. Once you set `appium:executableDir` to the same directory, a new session will refer to the same directory. Defaults to `node_modules/appium-chromedriver/chromedriver` in `appium-chromium-driver` package.
+  - `CHROMEDRIVER_EXECUTABLE_DIR=/tmp/chromedrivers  appium driver run chromium install-chromedriver`
+- `CHROMEDRIVER_VERSION`
+  - Let the command download a specific version.
+  - i.e. `CHROMEDRIVER_VERSION=131.0.6778.3 appium driver run chromium install-chromedriver`
+- `CHROMELABS_URL`
+  - Let the command get the list of available chromedrivers from instead of the default `https://googlechromelabs.github.io`.
+
 ## Contributing
 
 Contributions to this project are welcome! Feel free to submit a PR on GitHub.

package.json

@@ -33,7 +33,8 @@
     "README.md",
     "CHANGELOG.md",
     "LICENSE",
-    "npm-shrinkwrap.json"
+    "npm-shrinkwrap.json",
+    "scripts"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -56,7 +57,7 @@
     "singleQuote": true
   },
   "dependencies": {
-    "appium-chromedriver": "6.0.8",
+    "appium-chromedriver": "^6.1.0",
     "bluebird": "3.7.2",
     "lodash": "4.17.21"
   },
@@ -80,7 +81,10 @@
       "macOS",
       "Linux"
     ],
-    "mainClass": "ChromiumDriver"
+    "mainClass": "ChromiumDriver",
+    "scripts": {
+      "install-chromedriver": "./scripts/install-chromedriver.mjs"
+    }
   },
   "typedoc": {
     "entryPoint": "./build/lib/index.js"

scripts/install-chromedriver.mjs

@@ -0,0 +1,21 @@
+import { ChromedriverStorageClient } from 'appium-chromedriver';
+
+function getChromedriverVersion() {
+    return process.env.CHROMEDRIVER_VERSION;
+}
+
+function getExecutableDir() {
+  return process.env.CHROMEDRIVER_EXECUTABLE_DIR;
+}
+
+async function install () {
+  const client = new ChromedriverStorageClient({
+    chromedriverDir: getExecutableDir(),
+  });
+  const chromeDriverVersion = getChromedriverVersion() || await client.getLatestKnownGoodVersion();
+  await client.syncDrivers({
+    versions: [chromeDriverVersion],
+  });
+}
+
+(async () => await install())();