git-sshripped 0.1.4

package/README.md

@@ -0,0 +1,95 @@
+# git-sshripped
+
+Git-transparent encryption using SSH keys. No GPG, no Rust toolchain required.
+
+This is the npm distribution of [git-sshripped](https://github.com/BSteffaniak/git-sshripped), a tool that keeps selected files encrypted at rest in Git repositories while letting developers work with plaintext when the repo is unlocked.
+
+## Install
+
+```bash
+npm install git-sshripped
+```
+
+This installs a prebuilt native binary for your platform. No Rust or Cargo needed.
+
+## Usage
+
+### CLI
+
+Once installed, `git-sshripped` is available as a command:
+
+```bash
+# Initialize in a repo
+git-sshripped init --pattern "secrets/**"
+
+# Unlock (decrypt files for local development)
+git-sshripped unlock
+
+# Lock (scrub plaintext from working tree)
+git-sshripped lock
+
+# Check status
+git-sshripped status
+```
+
+### Auto-unlock in postinstall
+
+Add this to your project's `package.json` so that encrypted files are automatically decrypted after `npm install`:
+
+```json
+{
+  "scripts": {
+    "postinstall": "git-sshripped unlock --soft"
+  }
+}
+```
+
+The `--soft` flag ensures that `npm install` won't fail if the user doesn't have access to the encrypted files (e.g., they don't have the right SSH key, or they're a CI bot without credentials). A warning is printed instead.
+
+For strict mode (fail if unlock fails):
+
+```json
+{
+  "scripts": {
+    "postinstall": "git-sshripped unlock"
+  }
+}
+```
+
+### Programmatic API
+
+```js
+const { binaryPath, run } = require("git-sshripped");
+
+// Get the path to the binary
+console.log(binaryPath);
+
+// Spawn git-sshripped with arguments
+const child = run(["status", "--json"]);
+child.on("exit", (code) => {
+  console.log("exit code:", code);
+});
+```
+
+## Binary resolution
+
+The binary is resolved in this order:
+
+1. `GIT_SSHRIPPED_BINARY_PATH` environment variable
+2. Platform-specific npm package (installed automatically via `optionalDependencies`)
+3. System-installed `git-sshripped` found in `PATH`
+
+## Supported platforms
+
+| Platform | Architecture | npm package |
+|----------|-------------|-------------|
+| macOS | ARM64 (Apple Silicon) | `@git-sshripped/darwin-arm64` |
+| macOS | x64 (Intel) | `@git-sshripped/darwin-x64` |
+| Linux | x64 (glibc) | `@git-sshripped/linux-x64` |
+| Linux | ARM64 (glibc) | `@git-sshripped/linux-arm64` |
+| Linux | x64 (musl/Alpine) | `@git-sshripped/linux-x64-musl` |
+| Windows | x64 | `@git-sshripped/win32-x64` |
+
+## License
+
+MPL-2.0

package/bin/git-sshripped

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+"use strict";
+
+const { platform, arch, env, argv } = process;
+const { execSync, spawnSync } = require("child_process");
+const path = require("path");
+
+function isMusl() {
+  // On non-linux, musl detection is irrelevant
+  if (platform !== "linux") return false;
+  try {
+    const stderr = execSync("ldd --version 2>&1", {
+      stdio: ["pipe", "pipe", "pipe"],
+    }).toString();
+    if (stderr.indexOf("musl") > -1) return true;
+  } catch (err) {
+    // ldd --version exits non-zero on musl systems and prints to stderr
+    if (err.stderr && err.stderr.toString().indexOf("musl") > -1) return true;
+  }
+  return false;
+}
+
+const PLATFORMS = {
+  win32: {
+    x64: "@git-sshripped/win32-x64/git-sshripped.exe",
+  },
+  darwin: {
+    x64: "@git-sshripped/darwin-x64/git-sshripped",
+    arm64: "@git-sshripped/darwin-arm64/git-sshripped",
+  },
+  linux: {
+    x64: "@git-sshripped/linux-x64/git-sshripped",
+    arm64: "@git-sshripped/linux-arm64/git-sshripped",
+  },
+  "linux-musl": {
+    x64: "@git-sshripped/linux-x64-musl/git-sshripped",
+  },
+};
+
+function getBinaryPath() {
+  // 1. Environment variable override
+  if (env.GIT_SSHRIPPED_BINARY_PATH) {
+    return env.GIT_SSHRIPPED_BINARY_PATH;
+  }
+
+  // 2. Resolve from platform-specific package
+  const platformKey =
+    platform === "linux" && isMusl() ? "linux-musl" : platform;
+  const subpath = PLATFORMS?.[platformKey]?.[arch];
+
+  if (subpath) {
+    try {
+      return require.resolve(subpath);
+    } catch {
+      // Platform package not installed, fall through
+    }
+  }
+
+  // 3. Fallback: look for git-sshripped in PATH
+  try {
+    const which = platform === "win32" ? "where" : "which";
+    const resolved = execSync(`${which} git-sshripped`, {
+      stdio: ["pipe", "pipe", "pipe"],
+    })
+      .toString()
+      .trim()
+      .split("\n")[0];
+    if (resolved) return resolved;
+  } catch {
+    // Not found in PATH
+  }
+
+  // 4. Give up with a helpful error
+  console.error(
+    `Error: No prebuilt git-sshripped binary available for ${platform}/${arch}.
+
+To fix this, either:
+  - Install git-sshripped via cargo: cargo install git_sshripped_cli
+  - Set GIT_SSHRIPPED_BINARY_PATH to point to a git-sshripped binary
+  - File an issue: https://github.com/BSteffaniak/git-sshripped/issues`
+  );
+  process.exit(1);
+}
+
+const binPath = getBinaryPath();
+const result = spawnSync(binPath, argv.slice(2), {
+  shell: false,
+  stdio: "inherit",
+});
+
+if (result.error) {
+  throw result.error;
+}
+
+process.exitCode = result.status;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "git-sshripped",
+  "version": "0.1.4",
+  "description": "Git-transparent encryption using SSH keys. No GPG, no Rust toolchain required.",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BSteffaniak/git-sshripped.git"
+  },
+  "bin": {
+    "git-sshripped": "bin/git-sshripped"
+  },
+  "main": "src/index.js",
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@git-sshripped/darwin-arm64": "0.1.4",
+    "@git-sshripped/darwin-x64": "0.1.4",
+    "@git-sshripped/linux-arm64": "0.1.4",
+    "@git-sshripped/linux-x64": "0.1.4",
+    "@git-sshripped/linux-x64-musl": "0.1.4",
+    "@git-sshripped/win32-x64": "0.1.4"
+  },
+  "files": [
+    "bin/",
+    "src/"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

package/src/index.js

@@ -0,0 +1,101 @@
+"use strict";
+
+const { platform, arch } = process;
+const { execSync, spawn } = require("child_process");
+const { env } = process;
+
+function isMusl() {
+  if (platform !== "linux") return false;
+  try {
+    const stderr = execSync("ldd --version 2>&1", {
+      stdio: ["pipe", "pipe", "pipe"],
+    }).toString();
+    if (stderr.indexOf("musl") > -1) return true;
+  } catch (err) {
+    if (err.stderr && err.stderr.toString().indexOf("musl") > -1) return true;
+  }
+  return false;
+}
+
+const PLATFORMS = {
+  win32: {
+    x64: "@git-sshripped/win32-x64/git-sshripped.exe",
+  },
+  darwin: {
+    x64: "@git-sshripped/darwin-x64/git-sshripped",
+    arm64: "@git-sshripped/darwin-arm64/git-sshripped",
+  },
+  linux: {
+    x64: "@git-sshripped/linux-x64/git-sshripped",
+    arm64: "@git-sshripped/linux-arm64/git-sshripped",
+  },
+  "linux-musl": {
+    x64: "@git-sshripped/linux-x64-musl/git-sshripped",
+  },
+};
+
+/**
+ * Resolves the path to the git-sshripped binary.
+ *
+ * Resolution order:
+ * 1. GIT_SSHRIPPED_BINARY_PATH environment variable
+ * 2. Platform-specific npm package
+ * 3. System-installed binary in PATH
+ *
+ * @returns {string} Absolute path to the binary
+ * @throws {Error} If no binary can be found
+ */
+function getBinaryPath() {
+  if (env.GIT_SSHRIPPED_BINARY_PATH) {
+    return env.GIT_SSHRIPPED_BINARY_PATH;
+  }
+
+  const platformKey =
+    platform === "linux" && isMusl() ? "linux-musl" : platform;
+  const subpath = PLATFORMS?.[platformKey]?.[arch];
+
+  if (subpath) {
+    try {
+      return require.resolve(subpath);
+    } catch {
+      // Platform package not installed
+    }
+  }
+
+  try {
+    const which = platform === "win32" ? "where" : "which";
+    const resolved = execSync(`${which} git-sshripped`, {
+      stdio: ["pipe", "pipe", "pipe"],
+    })
+      .toString()
+      .trim()
+      .split("\n")[0];
+    if (resolved) return resolved;
+  } catch {
+    // Not found in PATH
+  }
+
+  throw new Error(
+    `No prebuilt git-sshripped binary available for ${platform}/${arch}. ` +
+      `Install via cargo (cargo install git_sshripped_cli) or set GIT_SSHRIPPED_BINARY_PATH.`
+  );
+}
+
+/**
+ * The resolved path to the git-sshripped binary.
+ * @type {string}
+ */
+const binaryPath = getBinaryPath();
+
+/**
+ * Spawn git-sshripped with the given arguments.
+ *
+ * @param {string[]} args - Command-line arguments to pass
+ * @param {import("child_process").SpawnOptions} [options] - Options passed to child_process.spawn
+ * @returns {import("child_process").ChildProcess}
+ */
+function run(args, options) {
+  return spawn(binaryPath, args, { stdio: "inherit", ...options });
+}
+
+module.exports = { binaryPath, run };