feat: support EDGE_BINARY_PATH env variable

Author: christian-bromann

.github/workflows/ci.yml

@@ -16,15 +16,25 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
+
       - name: 💚 Use Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 20
+
       - name: 🚧 Install Dependencies
         run: npm ci
+
       - name: 📦 Build
         run: npm run build
+
+      - name: 🔧 Install Edge
+        id: edge
+        uses: browser-actions/setup-edge@v1
+
       - name: 🧪 Run Tests
         uses: GabrielBB/xvfb-action@v1
+        env:
+          EDGE_BINARY_PATH: ${{ steps.edge.outputs.edge-path }}
         with:
           run: npm test

README.md

@@ -86,7 +86,7 @@ __Returns:__ `string` - path to Edgedriver binary
 
 ### `findEdgePath`
 
-The `findEdgePath` is a helper method to find the Microsoft Egde binary on given system.
+The `findEdgePath` is a helper method to find the Microsoft Egde binary on given system. If there is a `EDGE_BINARY_PATH` environment set, it will return that value.
 
 __Returns:__ `string` - path to Microsoft Edge binary
 

src/finder.ts

@@ -164,6 +164,14 @@ function findEdgeExecutables(folder: string) {
 }
 
 export default () => {
+  /**
+   * Check for the EDGE_BINARY_PATH env variable
+   */
+  const binaryPathEnv = process.env.EDGE_BINARY_PATH
+  if (typeof binaryPathEnv === 'string' && binaryPathEnv) {
+    return process.env.EDGE_BINARY_PATH
+  }
+
   if (os.platform() === 'win32') {
     return win32()[0]
   }