@getsigit/sigit 1.5.6 → 1.5.7

package/README.md

@@ -21,6 +21,14 @@ npm install -g @getsigit/sigit
 
 npm pulls in the right binary for your platform automatically.
 
+If you installed this before 1.5.5, you have it under its old name,
+`@smbcloud/sigit`. That name still gets every release, so nothing is broken,
+but `@getsigit/sigit` is the one to move to:
+
+```sh
+npm uninstall -g @smbcloud/sigit && npm install -g @getsigit/sigit
+```
+
 Supported targets:
 
 - macOS, Apple Silicon and Intel

package/lib/index.js

@@ -2,6 +2,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
+/**
+ * The same launcher ships under two names: `@getsigit/sigit`, and
+ * `@smbcloud/sigit`, which is what the package was called before 1.5.5. Each
+ * one carries its own set of platform packages, so which scope to look the
+ * binary up in is whichever scope this copy was published under.
+ */
+function getScope() {
+    const selfName = require("../package.json").name;
+    const scope = selfName.split("/")[0];
+    return scope.startsWith("@") ? scope : "@getsigit";
+}
 /**
  * Returns the executable path which is located inside node_modules
  * The naming convention is cli-OS-ARCH
@@ -20,17 +31,34 @@ function getExePath() {
     }
     try {
         // Since the binary will be located inside node_modules, we can simply call require.resolve
-        return require.resolve(`@getsigit/sigit-${os}-${arch}/bin/sigit${extension}`);
+        return require.resolve(`${getScope()}/sigit-${os}-${arch}/bin/sigit${extension}`);
     }
     catch (e) {
         throw new Error(`Couldn't find application binary inside node_modules for ${os}-${arch}`);
     }
 }
+/**
+ * `@smbcloud/sigit` is kept publishing so that an install predating the rename
+ * keeps updating instead of sitting on 1.5.2, but `@getsigit/sigit` is the
+ * name the project actually goes by. Say so, once per run, on stderr — in ACP
+ * mode stdout is the JSON-RPC pipe to the editor.
+ */
+function warnIfDeprecatedName() {
+    if (getScope() !== "@smbcloud")
+        return;
+    if (process.env.SIGIT_SUPPRESS_SCOPE_NOTICE)
+        return;
+    process.stderr.write("@smbcloud/sigit is the old name for @getsigit/sigit. Both names get the " +
+        "same release for now; the new one is where siGit Code lives:\n" +
+        "  npm uninstall -g @smbcloud/sigit && npm install -g @getsigit/sigit\n" +
+        "Set SIGIT_SUPPRESS_SCOPE_NOTICE=1 to silence this.\n");
+}
 /**
  * Runs the application with args using nodejs spawn
  */
 function run() {
     var _a;
+    warnIfDeprecatedName();
     const args = process.argv.slice(2);
     const processResult = (0, child_process_1.spawnSync)(getExePath(), args, { stdio: "inherit" });
     process.exit((_a = processResult.status) !== null && _a !== void 0 ? _a : 0);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@getsigit/sigit",
-    "version": "1.5.6",
+    "version": "1.5.7",
     "keywords": [
         "sigit",
         "cli",
@@ -31,11 +31,11 @@
         "typescript": "^5.0.0"
     },
     "optionalDependencies": {
-        "@getsigit/sigit-darwin-arm64": "1.5.6",
-        "@getsigit/sigit-darwin-x64": "1.5.6",
-        "@getsigit/sigit-linux-arm64": "1.5.6",
-        "@getsigit/sigit-linux-x64": "1.5.6",
-        "@getsigit/sigit-windows-arm64": "1.5.6",
-        "@getsigit/sigit-windows-x64": "1.5.6"
+        "@getsigit/sigit-darwin-arm64": "1.5.7",
+        "@getsigit/sigit-darwin-x64": "1.5.7",
+        "@getsigit/sigit-linux-arm64": "1.5.7",
+        "@getsigit/sigit-linux-x64": "1.5.7",
+        "@getsigit/sigit-windows-arm64": "1.5.7",
+        "@getsigit/sigit-windows-x64": "1.5.7"
     }
 }