feat(findpath): detect ChromeDriver path (#115)

* refactor: `findpath` functionc
* fix: incorrect import
* fix: import
* fix: export `findpath` via package
* fix: typo
* feat: add ChromeDriver to `findpath`
* docs: chromedriver findpath example
* test: ChromeDriver DNE in normal build
* fix: chromedriver assert
* docs: remove `win | osx` from `hostOs` type def
* docs: chromedriver var naming
* refactor: code review changes

README.md

@@ -103,6 +103,16 @@ var nwpath = findpath();
 // nwpath will equal the path to the binary depending on your environment
 ```
 
+## finding the path to the chromedriver binary
+
+If you would like to programmatically retrieve the path to the chromedriver use:
+
+``` js
+var findpath = require('nw').findpath;
+var chromedriver_path = findpath('chromedriver');
+// chromedriver_path will equal the path to the binary depending on your environment
+```
+
 Then you can use that path to run NW.js programmatically. For example, to run in the current script's directory:
 
 ```js

lib/findpath.mjs

@@ -0,0 +1,58 @@
+import { dirname } from 'node:path';
+import { env, platform } from 'node:process';
+import { join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * Get the platform dependant path of the NW.js or ChromeDriver binary.
+ * 
+ * @param {'nwjs' | 'chromedriver'} executable Path to NW.js or Chromedriver executable.
+ * @return {string}
+ */
+export default function findpath(executable = 'nwjs') {
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const nwDir = resolve(__dirname, '..', 'nwjs');
+  /**
+   * File path to executable.
+   * 
+   * @type {string}
+   */
+  let binPath = '';
+
+  /**
+    * Host operating system
+    * 
+    * @type {NodeJS.Platform}
+    */
+  let hostOs = env.npm_config_nwjs_platform || env.NWJS_PLATFORM || platform;
+
+  /**
+   * Get the platform dependant path of the NW.js binary.
+   */
+  function findNwjs() {
+    if (hostOs === 'darwin') {
+      binPath = join(nwDir, 'nwjs.app', 'Contents', 'MacOS', 'nwjs');
+    } else if (hostOs === 'win32') {
+      binPath = join(nwDir, 'nw.exe');
+    } else {
+      binPath = join(nwDir, 'nw');
+    }
+  }
+
+  /**
+   * Get the platform dependant path of the ChromeDriver binary.
+   */
+  function findChromeDriver() {
+    binPath = resolve(nwDir, `chromedriver${platform === "win32" ? ".exe" : ""}`);
+  }
+
+  if (executable === 'nwjs') {
+    findNwjs();
+  } else if (executable === 'chromedriver') {
+    findChromeDriver();
+  } else {
+    console.error(`[ ERROR ] Expected nwjs or chromedriver, got ${executable}.`);
+  }
+
+  return binPath;
+}

package.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "git://github.com/nwjs/npm-installer.git"
   },
-  "main": "index.js",
+  "main": "lib/findpath.mjs",
   "bin": {
     "nw": "bin/nw"
   },
@@ -16,9 +16,7 @@
   },
   "files": [
     "lib",
-    "bin",
-    "scripts",
-    "index.js"
+    "bin"
   ],
   "author": {
     "name": "Kyle Robinson Young",

test/index.mjs

@@ -2,8 +2,12 @@ import { strictEqual } from 'node:assert';
 import { existsSync } from 'node:fs';
 import test from 'node:test';
 
-import findpath from '../lib/findpath.js';
+import findpath from '../lib/findpath.mjs';
 
-test('has downloaded and extracted', function() {
+test('nwjs has downloaded and been extracted', function() {
   strictEqual(existsSync(findpath()), true);
 });
+
+test('chromedriver does not exist in normal build', function() {
+  strictEqual(existsSync(findpath('chromedriver')), false);
+});