windscout 0.2.1 → 0.3.1

package/README.md

@@ -18,6 +18,8 @@ WindScout drives the official `windscribe-cli`: it connects to each country × p
 npm install -g windscout   # or run once with: npx windscout
 ```
 
+On startup, WindScout checks npm for a newer version. If there is one, it shows the command to update, both in the picker and after the final report.
+
 ## Usage
 
 Run `windscout` with no arguments to open the interactive picker:
@@ -72,6 +74,7 @@ windscout -t 40 -a                          # longer connect timeout, also list
 | `-t, --timeout` | seconds to wait for each connection | 20 |
 | `-a, --all` | include failed attempts in the final table | off |
 | `-n, --no-speed` | connect-only mode: skip the download test, rank by latency | saved, or off |
+| `-v, --version` | print the installed version, and the update command if a newer one is on npm | |
 
 ## Connect-only mode
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windscout",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {

package/windscout.js

@@ -151,6 +151,26 @@ async function probe(query, protocol, timeout, onStep = () => {}) {
   }
 }
 
+// ---------- update check ----------
+
+const VERSION = JSON.parse(readFileSync(new URL("./package.json", import.meta.url), "utf8")).version;
+let update = null; // newer version on npm, once known
+let updateCheck = Promise.resolve();
+// numeric x.y.z compare; parseInt drops a prerelease suffix ("0-beta" → 0)
+const newer = (a, b) => {
+  const x = a.split(".").map((n) => parseInt(n)), y = b.split(".").map((n) => parseInt(n));
+  for (let i = 0; i < 3; i++) if (x[i] !== y[i]) return x[i] > y[i];
+  return false;
+};
+// best effort: offline or registry down just means no notice
+const checkUpdate = () =>
+  fetch("https://registry.npmjs.org/windscout/latest", { signal: AbortSignal.timeout(3000) })
+    .then((r) => r.json())
+    .then(({ version }) => { if (version && newer(version, VERSION)) update = version; })
+    .catch(() => {});
+const updateNotice = () => `update available: ${VERSION} → ${update} · run: ${
+  process.env.npm_command === "exec" ? "npx windscout@latest" : "npm install -g windscout@latest"}`;
+
 // ---------- formatting ----------
 
 const color = (code, s) => (process.env.NO_COLOR || !process.stdout.isTTY ? s : `\x1b[${code}m${s}\x1b[0m`);
@@ -382,7 +402,7 @@ function pick(saved, timeout) {
     const render = () => {
       const rows = out.rows || 24;
       const list = visible();
-      const height = Math.max(3, rows - 19);
+      const height = Math.max(3, rows - 19 - (update ? 1 : 0));
       cursor = Math.max(0, Math.min(cursor, list.length - 1));
       if (cursor < top) top = cursor;
       if (cursor >= top + height) top = cursor - height + 1;
@@ -432,6 +452,7 @@ function pick(saved, timeout) {
       lines.splice(head.length + table.length + 1, 0, centerIn(buttonLine, width), "");
       if (message) lines.push(centerIn(yellow(message), width));
       lines.push("", centerIn(dim(repoLink), width));
+      if (update) lines.push(centerIn(yellow(updateNotice()), width));
       const at = draw(lines);
 
       // click map, in screen coordinates
@@ -458,7 +479,10 @@ function pick(saved, timeout) {
       };
     };
 
+    let closed = false;
+    updateCheck.then(() => update && !closed && render()); // the check usually lands after the first draw
     const finish = (value) => {
+      closed = true;
       out.off("resize", render);
       input.removeAllListeners("keypress");
       input.removeAllListeners("mouse");
@@ -730,6 +754,7 @@ Options:
   -t, --timeout SEC     seconds to wait for each connection (default: 20)
   -a, --all             also show failed attempts in the final table
   -n, --no-speed        connect-only: skip the download test, rank by latency (faster scan)
+  -v, --version         show the installed version (and whether a newer one is out)
   -h, --help            show this help
 
 Selection is stored in ${CONFIG}
@@ -743,10 +768,17 @@ async function main() {
       timeout: { type: "string", short: "t", default: "20" },
       all: { type: "boolean", short: "a", default: false },
       help: { type: "boolean", short: "h", default: false },
+      version: { type: "boolean", short: "v", default: false },
       "no-speed": { type: "boolean", short: "n", default: false },
     },
   });
   if (a.help) return console.log(HELP);
+  updateCheck = checkUpdate(); // runs while the app starts and the user picks, before the VPN starts switching
+  if (a.version) {
+    console.log(`windscout ${VERSION}`);
+    await updateCheck;
+    return update && console.error(yellow(updateNotice()));
+  }
   const timeout = Number(a.timeout);
   if (!(timeout > 0)) throw new Error("--timeout must be a positive number");
 
@@ -776,6 +808,8 @@ async function main() {
   const results = await scan(countries, protocols, timeout, tty);
   if (stop) console.log(yellow("interrupted, showing partial results"));
   report(results, protocols, a.all);
+  await updateCheck;
+  if (update) console.error("\n" + yellow(updateNotice()));
 }
 
 main().catch((e) => {