turnout-cli 0.2.2 → 0.3.0

package/README.md

@@ -1,3 +1,5 @@
+<p align="center"><img src="https://raw.githubusercontent.com/lacodda/turnout/main/assets/banner.svg" alt="turnout - a developer's switchyard" width="720"></p>
+
 # turnout-cli
 
 npm distribution of [turnout](https://github.com/lacodda/turnout) - a developer's switchyard: point local apps at any backend stand, keep servers and secrets at hand, build and deploy from any directory.
@@ -7,6 +9,6 @@ npm i -g turnout-cli
 turnout setup
 ```
 
-The package downloads the prebuilt binary for your platform (Windows x86_64, Linux x86_64, macOS arm64) from GitHub Releases on install. On other platforms use `cargo install turnout`.
+The package downloads the prebuilt binary for your platform (Windows x86_64, Linux x86_64, macOS arm64) from GitHub Releases - on install, or on first run when npm skips install scripts. On other platforms use `cargo install turnout`.
 
 Documentation: https://lacodda.github.io/turnout/

package/download.js

@@ -0,0 +1,88 @@
+// Downloads the turnout binary matching this package version from GitHub Releases.
+// Shared by install.js (postinstall, where lifecycle scripts are allowed) and
+// run.js (first-run fallback: npm v12 skips install scripts by default).
+const fs = require("fs");
+const https = require("https");
+const path = require("path");
+const { spawnSync } = require("child_process");
+
+const pkg = require("./package.json");
+const REPO = "lacodda/turnout";
+// The wrapper can be patched independently of the Rust binary: an explicit
+// turnout.binary field pins the release tag, otherwise it follows the version.
+const TAG = (pkg.turnout && pkg.turnout.binary) || `v${pkg.version}`;
+
+const TARGETS = {
+  "win32-x64": ["x86_64-pc-windows-msvc", "zip"],
+  "linux-x64": ["x86_64-unknown-linux-gnu", "tar.gz"],
+  "darwin-arm64": ["aarch64-apple-darwin", "tar.gz"],
+};
+
+const exe = process.platform === "win32" ? "turnout.exe" : "turnout";
+const exePath = path.join(__dirname, exe);
+
+function download(url, file, redirects, done) {
+  if (redirects > 5) return done(new Error("too many redirects"));
+  https
+    .get(url, { headers: { "user-agent": "turnout-cli" } }, (res) => {
+      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+        res.resume();
+        return download(res.headers.location, file, redirects + 1, done);
+      }
+      if (res.statusCode !== 200) {
+        res.resume();
+        return done(new Error(`HTTP ${res.statusCode} for ${url}`));
+      }
+      const out = fs.createWriteStream(file);
+      res.pipe(out);
+      out.on("finish", () => out.close(done));
+      out.on("error", done);
+    })
+    .on("error", done);
+}
+
+function install(done) {
+  const key = `${process.platform}-${process.arch}`;
+  const entry = TARGETS[key];
+  if (!entry) {
+    console.error(`turnout-cli: no prebuilt binary for ${key}; install with: cargo install turnout`);
+    process.exit(1);
+  }
+  const [target, ext] = entry;
+  const name = `turnout-${TAG}-${target}`;
+  const url = `https://github.com/${REPO}/releases/download/${TAG}/${name}.${ext}`;
+  const archive = path.join(__dirname, `archive.${ext}`);
+
+  console.log(`turnout-cli: downloading ${url}`);
+  download(url, archive, 0, (err) => {
+    if (err) {
+      console.error(`turnout-cli: download failed: ${err.message}`);
+      process.exit(1);
+    }
+    // Extraction must not depend on which tar happens to be first in PATH
+    // (Git Bash ships a GNU tar that cannot read zip): zip goes through
+    // PowerShell's Expand-Archive, tar.gz through tar on Unix systems.
+    const result =
+      ext === "zip"
+        ? spawnSync(
+            "powershell.exe",
+            ["-NoProfile", "-NonInteractive", "-Command", "Expand-Archive -LiteralPath 'archive.zip' -DestinationPath . -Force"],
+            { cwd: __dirname, stdio: "inherit" },
+          )
+        : spawnSync("tar", ["-xzf", `archive.${ext}`], { cwd: __dirname, stdio: "inherit" });
+    if (result.status !== 0) {
+      console.error("turnout-cli: cannot extract the archive");
+      process.exit(1);
+    }
+    fs.renameSync(path.join(__dirname, name, exe), exePath);
+    fs.rmSync(path.join(__dirname, name), { recursive: true, force: true });
+    fs.rmSync(archive, { force: true });
+    if (process.platform !== "win32") {
+      fs.chmodSync(exePath, 0o755);
+    }
+    console.log(`turnout-cli: installed turnout ${TAG}`);
+    done();
+  });
+}
+
+module.exports = { install, exePath };

package/install.js

@@ -1,79 +1,4 @@
-// Downloads the turnout binary matching this package version from GitHub Releases.
-const fs = require("fs");
-const https = require("https");
-const path = require("path");
-const { spawnSync } = require("child_process");
-
-const pkg = require("./package.json");
-const REPO = "lacodda/turnout";
-// The wrapper can be patched independently of the Rust binary: an explicit
-// turnout.binary field pins the release tag, otherwise it follows the version.
-const TAG = (pkg.turnout && pkg.turnout.binary) || `v${pkg.version}`;
-
-const TARGETS = {
-  "win32-x64": ["x86_64-pc-windows-msvc", "zip"],
-  "linux-x64": ["x86_64-unknown-linux-gnu", "tar.gz"],
-  "darwin-arm64": ["aarch64-apple-darwin", "tar.gz"],
-};
-
-const key = `${process.platform}-${process.arch}`;
-const entry = TARGETS[key];
-if (!entry) {
-  console.error(`turnout-cli: no prebuilt binary for ${key}; install with: cargo install turnout`);
-  process.exit(1);
-}
-const [target, ext] = entry;
-const name = `turnout-${TAG}-${target}`;
-const url = `https://github.com/${REPO}/releases/download/${TAG}/${name}.${ext}`;
-const exe = process.platform === "win32" ? "turnout.exe" : "turnout";
-const archive = path.join(__dirname, `archive.${ext}`);
-
-function download(url, file, redirects, done) {
-  if (redirects > 5) return done(new Error("too many redirects"));
-  https
-    .get(url, { headers: { "user-agent": "turnout-cli" } }, (res) => {
-      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
-        res.resume();
-        return download(res.headers.location, file, redirects + 1, done);
-      }
-      if (res.statusCode !== 200) {
-        res.resume();
-        return done(new Error(`HTTP ${res.statusCode} for ${url}`));
-      }
-      const out = fs.createWriteStream(file);
-      res.pipe(out);
-      out.on("finish", () => out.close(done));
-      out.on("error", done);
-    })
-    .on("error", done);
-}
-
-console.log(`turnout-cli: downloading ${url}`);
-download(url, archive, 0, (err) => {
-  if (err) {
-    console.error(`turnout-cli: download failed: ${err.message}`);
-    process.exit(1);
-  }
-  // Extraction must not depend on which tar happens to be first in PATH
-  // (Git Bash ships a GNU tar that cannot read zip): zip goes through
-  // PowerShell's Expand-Archive, tar.gz through tar on Unix systems.
-  const result =
-    ext === "zip"
-      ? spawnSync(
-          "powershell.exe",
-          ["-NoProfile", "-NonInteractive", "-Command", "Expand-Archive -LiteralPath 'archive.zip' -DestinationPath . -Force"],
-          { cwd: __dirname, stdio: "inherit" },
-        )
-      : spawnSync("tar", ["-xzf", `archive.${ext}`], { cwd: __dirname, stdio: "inherit" });
-  if (result.status !== 0) {
-    console.error("turnout-cli: cannot extract the archive");
-    process.exit(1);
-  }
-  fs.renameSync(path.join(__dirname, name, exe), path.join(__dirname, exe));
-  fs.rmSync(path.join(__dirname, name), { recursive: true, force: true });
-  fs.rmSync(archive, { force: true });
-  if (process.platform !== "win32") {
-    fs.chmodSync(path.join(__dirname, exe), 0o755);
-  }
-  console.log(`turnout-cli: installed turnout ${TAG}`);
-});
+// Postinstall entry: pre-downloads the binary where lifecycle scripts are
+// allowed. On npm v12+ this script is skipped by default and run.js downloads
+// the binary on first launch instead.
+require("./download").install(() => {});

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "turnout-cli",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "turnout": {
-    "binary": "v0.2.2"
+    "binary": "v0.3.0"
   },
   "description": "A developer's switchyard: point local apps at any backend stand, keep servers and secrets at hand, build and deploy from any directory",
   "license": "MIT",
@@ -14,9 +14,10 @@
   },
   "keywords": ["cli", "proxy", "gateway", "deploy", "dev-environment", "stands"],
   "bin": {
-    "turnout": "run.js"
+    "turnout": "run.js",
+    "tn": "run.js"
   },
-  "files": ["install.js", "run.js"],
+  "files": ["download.js", "install.js", "run.js"],
   "scripts": {
     "postinstall": "node install.js"
   },

package/run.js

@@ -1,12 +1,18 @@
 #!/usr/bin/env node
-// Thin launcher: forwards everything to the downloaded turnout binary.
-const path = require("path");
+// Thin launcher: forwards everything to the turnout binary, downloading it on
+// first run when the postinstall script was skipped (npm v12 default).
+const fs = require("fs");
 const { spawnSync } = require("child_process");
+const { install, exePath } = require("./download");
 
-const exe = path.join(__dirname, process.platform === "win32" ? "turnout.exe" : "turnout");
-if (!require("fs").existsSync(exe)) {
-  console.error("turnout-cli: binary missing - reinstall the package (npm i -g turnout-cli)");
-  process.exit(1);
+function exec() {
+  const result = spawnSync(exePath, process.argv.slice(2), { stdio: "inherit" });
+  process.exit(result.status === null ? 1 : result.status);
+}
+
+if (fs.existsSync(exePath)) {
+  exec();
+} else {
+  console.error("turnout-cli: binary not present yet - downloading it now");
+  install(exec);
 }
-const result = spawnSync(exe, process.argv.slice(2), { stdio: "inherit" });
-process.exit(result.status === null ? 1 : result.status);