firefox-location2 2.0.0 → 2.0.1

package/README.md

@@ -11,13 +11,13 @@
 
 <img alt="Firefox" align="right" src="https://cdn.jsdelivr.net/gh/extension-js/media@db5deb23fbfa85530f8146718812972998e13a4d/browser_logos/svg/firefox.svg" width="10.5%" />
 
-* Finds Firefox in the following channel order: `stable` / `esr` / `developer edition` / `nightly`.
+* By default checks only `stable`. Optionally can cascade to `esr` / `developer edition` / `nightly`.
 * Supports macOS / Windows / Linux
 * Works both as an ES module or CommonJS
 
 ## Support table
 
-This table lists the default locations where Firefox is typically installed for each supported platform and channel. The package checks these paths (in order) and returns the first one found. 
+This table lists the default locations where Firefox is typically installed for each supported platform and channel. By default, only the Stable channel is checked. When fallback is enabled, the package checks these paths (in order) and returns the first one found.
 
 <table>
   <thead>
@@ -153,26 +153,34 @@ This table lists the default locations where Firefox is typically installed for
   </tbody>
 </table>
 
-Returns the first existing path found, or <code>null</code> if none are found.
+Returns the first existing path found (given selected channels), or <code>null</code> if none are found.
 
 Note: On Linux, the module first tries to resolve binaries on <code>$PATH</code> (using <code>which</code>) for the common channels listed above, then falls back to checking common filesystem locations like <code>/usr/bin/firefox</code>, <code>/usr/local/bin/firefox</code>, <code>/snap/bin/firefox</code>, and <code>/opt/firefox/firefox</code>.
 
 ## Usage
 
-**Via Node.js:**
+**Via Node.js (strict by default):**
 
 ```js
 import firefoxLocation from "firefox-location2";
 
+// Strict (Stable only)
 console.log(firefoxLocation());
-// /Applications/Firefox.app/Contents/MacOS/firefox
+// => "/Applications/Firefox.app/Contents/MacOS/firefox" or null
+
+// Enable fallback (Stable / ESR / Developer Edition / Nightly)
+console.log(firefoxLocation(true));
+// => first found among Stable/ESR/Developer/Nightly or null
 ```
 
 **Via CLI:**
 
 ```bash
 npx firefox-location2
-# /Applications/Firefox.app/Contents/MacOS/firefox
+# Strict (Stable only)
+
+npx firefox-location2 --fallback
+# Enable cascade (Stable / ESR / Developer / Nightly)
 ```
 
 ## Planned enhancements
@@ -184,12 +192,12 @@ npx firefox-location2
 
 ## Related projects
 
-* [chrome-location2](https://github.com/hughsk/chrome-location2)
-* [edge-location](https://github.com/cezaraugusto/edge-location)
-* [firefox-location](https://github.com/hughsk/firefox-location)
 * [brave-location](https://github.com/cezaraugusto/brave-location)
-* [vivaldi-location](https://github.com/jandrey/vivaldi-location)
-* [opera-location](https://github.com/jandrey/opera-location)
+* [chrome-location2](https://github.com/cezaraugusto/chrome-location2)
+* [edge-location](https://github.com/cezaraugusto/edge-location)
+* [opera-location2](https://github.com/cezaraugusto/opera-location2)
+* [vivaldi-location2](https://github.com/cezaraugusto/vivaldi-location2)
+* [yandex-location2](https://github.com/cezaraugusto/yandex-location2)
 
 ## License
 

package/bin.js

@@ -3,4 +3,7 @@
 const locateFirefox =
   require('./dist/index.cjs').default || require('./dist/index.cjs');
 
-console.log(locateFirefox());
+const argv = process.argv.slice(2);
+const allowFallback = argv.includes('--fallback') || argv.includes('-f');
+
+console.log(locateFirefox(allowFallback));

package/dist/index.cjs

@@ -43,7 +43,10 @@ const external_os_namespaceObject = require("os");
 var external_os_default = /*#__PURE__*/ __webpack_require__.n(external_os_namespaceObject);
 const external_which_namespaceObject = require("which");
 var external_which_default = /*#__PURE__*/ __webpack_require__.n(external_which_namespaceObject);
-function locateFirefox(deps) {
+function locateFirefox(allowFallbackOrDeps, depsMaybe) {
+    const isBoolean = 'boolean' == typeof allowFallbackOrDeps;
+    const allowFallback = isBoolean ? allowFallbackOrDeps : false;
+    const deps = isBoolean ? depsMaybe : allowFallbackOrDeps;
     const f = (null == deps ? void 0 : deps.fs) ?? external_fs_default();
     const w = (null == deps ? void 0 : deps.which) ?? external_which_default();
     const o = (null == deps ? void 0 : deps.os) ?? external_os_default();
@@ -54,34 +57,42 @@ function locateFirefox(deps) {
     const win = 'win32' === platform;
     const other = !osx && !win;
     if (other) {
-        const candidates = [
-            'firefox',
+        const stable = [
+            'firefox'
+        ];
+        const fallbacks = [
             'firefox-esr',
             'firefox-developer-edition',
             'firefox-devedition',
             'firefox-nightly'
         ];
+        const candidates = allowFallback ? [
+            ...stable,
+            ...fallbacks
+        ] : stable;
         for (const cmd of candidates)try {
             const resolved = w.sync(cmd);
             if (resolved) return resolved;
         } catch (_) {}
-        const linuxPaths = [
-            '/usr/bin/firefox',
-            '/usr/local/bin/firefox',
-            '/usr/lib/firefox/firefox',
-            '/snap/bin/firefox',
-            '/opt/firefox/firefox',
-            '/usr/local/firefox/firefox',
-            p.join(o.homedir(), 'bin', 'firefox'),
-            p.join(o.homedir(), 'Downloads', 'firefox', 'firefox'),
-            p.join(o.homedir(), '.local', 'share', 'flatpak', 'exports', 'bin', 'org.mozilla.firefox'),
-            '/var/lib/flatpak/exports/bin/org.mozilla.firefox'
-        ];
-        for (const linuxPath of linuxPaths)if (f.existsSync(linuxPath)) return linuxPath;
+        if (allowFallback) {
+            const linuxPaths = [
+                '/usr/bin/firefox',
+                '/usr/local/bin/firefox',
+                '/usr/lib/firefox/firefox',
+                '/snap/bin/firefox',
+                '/opt/firefox/firefox',
+                '/usr/local/firefox/firefox',
+                p.join(o.homedir(), 'bin', 'firefox'),
+                p.join(o.homedir(), 'Downloads', 'firefox', 'firefox'),
+                p.join(o.homedir(), '.local', 'share', 'flatpak', 'exports', 'bin', 'org.mozilla.firefox'),
+                '/var/lib/flatpak/exports/bin/org.mozilla.firefox'
+            ];
+            for (const linuxPath of linuxPaths)if (f.existsSync(linuxPath)) return linuxPath;
+        }
         return null;
     }
     if (osx) {
-        const apps = [
+        const appsAll = [
             {
                 app: 'Firefox.app',
                 exec: 'firefox'
@@ -99,6 +110,9 @@ function locateFirefox(deps) {
                 exec: 'firefox'
             }
         ];
+        const apps = allowFallback ? appsAll : [
+            appsAll[0]
+        ];
         const systemBase = '/Applications';
         const userBase = p.join(o.homedir(), 'Applications');
         for (const { app, exec } of apps){
@@ -115,17 +129,20 @@ function locateFirefox(deps) {
             env.PROGRAMFILES,
             env['PROGRAMFILES(X86)']
         ].filter(Boolean);
-        const suffixes = [
+        const suffixesAll = [
             p.join('Mozilla Firefox', 'firefox.exe'),
             p.join('Mozilla Firefox ESR', 'firefox.exe'),
             p.join('Mozilla Firefox Developer Edition', 'firefox.exe'),
             p.join('Firefox Nightly', 'firefox.exe')
         ];
+        const suffixes = allowFallback ? suffixesAll : [
+            suffixesAll[0]
+        ];
         for (const prefix of prefixes)for (const suffix of suffixes){
             const exePath = p.join(prefix, suffix);
             if (f.existsSync(exePath)) return exePath;
         }
-        const defaultPaths = [
+        const defaultPathsAll = [
             'C:\\Program Files\\Mozilla Firefox\\firefox.exe',
             'C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe',
             'C:\\Program Files\\Mozilla Firefox ESR\\firefox.exe',
@@ -135,6 +152,7 @@ function locateFirefox(deps) {
             'C:\\Program Files\\Firefox Nightly\\firefox.exe',
             'C:\\Program Files (x86)\\Firefox Nightly\\firefox.exe'
         ];
+        const defaultPaths = allowFallback ? defaultPathsAll : defaultPathsAll.slice(0, 2);
         for (const defaultPath of defaultPaths)if (f.existsSync(defaultPath)) return defaultPath;
         return null;
     }

package/dist/index.d.ts

@@ -16,4 +16,4 @@ export type Deps = {
     env?: NodeJS.ProcessEnv;
     platform?: NodeJS.Platform;
 };
-export default function locateFirefox(deps?: Deps): string | null;
+export default function locateFirefox(allowFallbackOrDeps?: boolean | Deps, depsMaybe?: Deps): string | null;

package/dist/index.js

@@ -2,7 +2,10 @@ import * as __WEBPACK_EXTERNAL_MODULE_fs__ from "fs";
 import * as __WEBPACK_EXTERNAL_MODULE_path__ from "path";
 import * as __WEBPACK_EXTERNAL_MODULE_os__ from "os";
 import * as __WEBPACK_EXTERNAL_MODULE_which__ from "which";
-function locateFirefox(deps) {
+function locateFirefox(allowFallbackOrDeps, depsMaybe) {
+    const isBoolean = 'boolean' == typeof allowFallbackOrDeps;
+    const allowFallback = isBoolean ? allowFallbackOrDeps : false;
+    const deps = isBoolean ? depsMaybe : allowFallbackOrDeps;
     const f = (null == deps ? void 0 : deps.fs) ?? __WEBPACK_EXTERNAL_MODULE_fs__["default"];
     const w = (null == deps ? void 0 : deps.which) ?? __WEBPACK_EXTERNAL_MODULE_which__["default"];
     const o = (null == deps ? void 0 : deps.os) ?? __WEBPACK_EXTERNAL_MODULE_os__["default"];
@@ -13,34 +16,42 @@ function locateFirefox(deps) {
     const win = 'win32' === platform;
     const other = !osx && !win;
     if (other) {
-        const candidates = [
-            'firefox',
+        const stable = [
+            'firefox'
+        ];
+        const fallbacks = [
             'firefox-esr',
             'firefox-developer-edition',
             'firefox-devedition',
             'firefox-nightly'
         ];
+        const candidates = allowFallback ? [
+            ...stable,
+            ...fallbacks
+        ] : stable;
         for (const cmd of candidates)try {
             const resolved = w.sync(cmd);
             if (resolved) return resolved;
         } catch (_) {}
-        const linuxPaths = [
-            '/usr/bin/firefox',
-            '/usr/local/bin/firefox',
-            '/usr/lib/firefox/firefox',
-            '/snap/bin/firefox',
-            '/opt/firefox/firefox',
-            '/usr/local/firefox/firefox',
-            p.join(o.homedir(), 'bin', 'firefox'),
-            p.join(o.homedir(), 'Downloads', 'firefox', 'firefox'),
-            p.join(o.homedir(), '.local', 'share', 'flatpak', 'exports', 'bin', 'org.mozilla.firefox'),
-            '/var/lib/flatpak/exports/bin/org.mozilla.firefox'
-        ];
-        for (const linuxPath of linuxPaths)if (f.existsSync(linuxPath)) return linuxPath;
+        if (allowFallback) {
+            const linuxPaths = [
+                '/usr/bin/firefox',
+                '/usr/local/bin/firefox',
+                '/usr/lib/firefox/firefox',
+                '/snap/bin/firefox',
+                '/opt/firefox/firefox',
+                '/usr/local/firefox/firefox',
+                p.join(o.homedir(), 'bin', 'firefox'),
+                p.join(o.homedir(), 'Downloads', 'firefox', 'firefox'),
+                p.join(o.homedir(), '.local', 'share', 'flatpak', 'exports', 'bin', 'org.mozilla.firefox'),
+                '/var/lib/flatpak/exports/bin/org.mozilla.firefox'
+            ];
+            for (const linuxPath of linuxPaths)if (f.existsSync(linuxPath)) return linuxPath;
+        }
         return null;
     }
     if (osx) {
-        const apps = [
+        const appsAll = [
             {
                 app: 'Firefox.app',
                 exec: 'firefox'
@@ -58,6 +69,9 @@ function locateFirefox(deps) {
                 exec: 'firefox'
             }
         ];
+        const apps = allowFallback ? appsAll : [
+            appsAll[0]
+        ];
         const systemBase = '/Applications';
         const userBase = p.join(o.homedir(), 'Applications');
         for (const { app, exec } of apps){
@@ -74,17 +88,20 @@ function locateFirefox(deps) {
             env.PROGRAMFILES,
             env['PROGRAMFILES(X86)']
         ].filter(Boolean);
-        const suffixes = [
+        const suffixesAll = [
             p.join('Mozilla Firefox', 'firefox.exe'),
             p.join('Mozilla Firefox ESR', 'firefox.exe'),
             p.join('Mozilla Firefox Developer Edition', 'firefox.exe'),
             p.join('Firefox Nightly', 'firefox.exe')
         ];
+        const suffixes = allowFallback ? suffixesAll : [
+            suffixesAll[0]
+        ];
         for (const prefix of prefixes)for (const suffix of suffixes){
             const exePath = p.join(prefix, suffix);
             if (f.existsSync(exePath)) return exePath;
         }
-        const defaultPaths = [
+        const defaultPathsAll = [
             'C:\\Program Files\\Mozilla Firefox\\firefox.exe',
             'C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe',
             'C:\\Program Files\\Mozilla Firefox ESR\\firefox.exe',
@@ -94,6 +111,7 @@ function locateFirefox(deps) {
             'C:\\Program Files\\Firefox Nightly\\firefox.exe',
             'C:\\Program Files (x86)\\Firefox Nightly\\firefox.exe'
         ];
+        const defaultPaths = allowFallback ? defaultPathsAll : defaultPathsAll.slice(0, 2);
         for (const defaultPath of defaultPaths)if (f.existsSync(defaultPath)) return defaultPath;
         return null;
     }

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/cezaraugusto/firefox-location2.git"
   },
   "name": "firefox-location2",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Approximates the current location of the Firefox browser across platforms.",
   "homepage": "https://www.npmjs.com/package/firefox-location2",
   "type": "module",