@softpractice/softpractice-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arthur Sultanbekov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# Softpractice CLI npm installer
+
+This package is a launcher for the native Softpractice CLI. During installation
+it downloads the GoReleaser archive with the same version from the GitHub
+Release, verifies it against `checksums.txt`, and installs the `softpractice`
+command.
+
+```bash
+npm install -g @softpractice/softpractice-cli
+softpractice --help
+```
+
+The installer supports macOS, Linux, and Windows on `arm64` and `x64`. It
+requires Node.js 18 or newer and access to GitHub Releases. Installation with
+`--ignore-scripts` is unsupported because npm would not download the native
+binary.
+
+## Manual release
+
+The npm version must equal the GitHub release version without its `v` prefix.
+For example, npm `0.1.0` installs artifacts from GitHub Release `v0.1.0`.
+
+1. Update the `version` in this directory's `package.json`.
+2. Commit it and create the matching Git tag, for example `v0.1.0`.
+3. Run `goreleaser release --clean` from the repository root and confirm that
+   the GitHub Release contains all platform archives and `checksums.txt`.
+4. From this directory, run `npm install`, `npm test`, and `npm pack --dry-run`.
+5. Authenticate once with `npm login`, then publish with:
+
+   ```bash
+   npm publish --access public
+   ```
+
+6. In an empty temporary directory, verify the published package:
+
+   ```bash
+   npm install -g @softpractice/softpractice-cli@0.1.0
+   softpractice --help
+   ```
+
+Do not publish the npm package before its matching GitHub Release exists.

package/bin/softpractice.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const { existsSync } = require("node:fs");
+const { spawnSync } = require("node:child_process");
+const { binaryPath } = require("../lib/platform");
+
+const executable = binaryPath();
+
+if (!existsSync(executable)) {
+  console.error(
+    "softpractice: the native binary is missing. Reinstall @softpractice/softpractice-cli without --ignore-scripts.",
+  );
+  process.exit(1);
+}
+
+const result = spawnSync(executable, process.argv.slice(2), { stdio: "inherit" });
+if (result.error) {
+  console.error(`softpractice: could not start native binary: ${result.error.message}`);
+  process.exit(1);
+}
+process.exit(result.status === null ? 1 : result.status);

package/lib/platform.js

@@ -0,0 +1,34 @@
+"use strict";
+
+const path = require("node:path");
+
+const platforms = {
+  darwin: "Darwin",
+  linux: "Linux",
+  win32: "Windows",
+};
+
+const architectures = {
+  arm64: "arm64",
+  x64: "x86_64",
+};
+
+function releaseArtifact(platform = process.platform, architecture = process.arch) {
+  const os = platforms[platform];
+  const arch = architectures[architecture];
+  if (!os || !arch) {
+    throw new Error(`unsupported platform: ${platform}/${architecture}`);
+  }
+
+  const extension = platform === "win32" ? "zip" : "tar.gz";
+  return {
+    filename: `softpractice-cli_${os}_${arch}.${extension}`,
+    executable: platform === "win32" ? "softpractice.exe" : "softpractice",
+  };
+}
+
+function binaryPath(packageRoot = path.resolve(__dirname, "..")) {
+  return path.join(packageRoot, "dist", releaseArtifact().executable);
+}
+
+module.exports = { binaryPath, releaseArtifact };

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@softpractice/softpractice-cli",
+  "version": "0.1.0",
+  "description": "Cross-platform command-line companion for a Softpractice learning workspace",
+  "license": "MIT",
+  "author": "Arthur Sultanbekov",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arthur-s/softpractice-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/arthur-s/softpractice-cli/issues"
+  },
+  "homepage": "https://github.com/arthur-s/softpractice-cli#readme",
+  "bin": {
+    "softpractice": "bin/softpractice.js"
+  },
+  "scripts": {
+    "postinstall": "node scripts/install.js",
+    "test": "node --test test/**/*.test.js",
+    "pack:dry-run": "npm pack --dry-run"
+  },
+  "files": [
+    "bin",
+    "scripts",
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "adm-zip": "^0.6.1",
+    "tar": "^7.4.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/install.js

@@ -0,0 +1,77 @@
+"use strict";
+
+const crypto = require("node:crypto");
+const fs = require("node:fs/promises");
+const os = require("node:os");
+const path = require("node:path");
+const AdmZip = require("adm-zip");
+const tar = require("tar");
+const { releaseArtifact } = require("../lib/platform");
+
+const packageRoot = path.resolve(__dirname, "..");
+const packageInfo = require(path.join(packageRoot, "package.json"));
+const repository = "https://github.com/arthur-s/softpractice-cli";
+
+async function download(url) {
+  const response = await fetch(url);
+  if (!response.ok) {
+    throw new Error(`download ${url}: HTTP ${response.status}`);
+  }
+  return Buffer.from(await response.arrayBuffer());
+}
+
+function expectedChecksum(checksums, filename) {
+  const escapedFilename = filename.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  const match = checksums.match(new RegExp(`^([a-fA-F0-9]{64})\\s+\\*?${escapedFilename}$`, "m"));
+  if (!match) {
+    throw new Error(`checksum for ${filename} is absent from checksums.txt`);
+  }
+  return match[1].toLowerCase();
+}
+
+async function extract(archive, artifact, directory) {
+  const archivePath = path.join(directory, artifact.filename);
+  await fs.writeFile(archivePath, archive);
+  if (artifact.filename.endsWith(".zip")) {
+    new AdmZip(archivePath).extractAllTo(directory, true);
+    return;
+  }
+  await tar.x({ file: archivePath, cwd: directory, strict: true });
+}
+
+async function install() {
+  const artifact = releaseArtifact();
+  const tag = `v${packageInfo.version}`;
+  const releaseURL = `${repository}/releases/download/${tag}`;
+  const [archive, checksums] = await Promise.all([
+    download(`${releaseURL}/${artifact.filename}`),
+    download(`${releaseURL}/checksums.txt`),
+  ]);
+  const actualChecksum = crypto.createHash("sha256").update(archive).digest("hex");
+  if (actualChecksum !== expectedChecksum(checksums.toString("utf8"), artifact.filename)) {
+    throw new Error(`checksum mismatch for ${artifact.filename}`);
+  }
+
+  const temporaryDirectory = await fs.mkdtemp(path.join(os.tmpdir(), "softpractice-npm-"));
+  try {
+    await extract(archive, artifact, temporaryDirectory);
+    const source = path.join(temporaryDirectory, artifact.executable);
+    const destinationDirectory = path.join(packageRoot, "dist");
+    const destination = path.join(destinationDirectory, artifact.executable);
+    await fs.access(source);
+    await fs.rm(destinationDirectory, { recursive: true, force: true });
+    await fs.mkdir(destinationDirectory, { recursive: true });
+    await fs.copyFile(source, destination);
+    if (process.platform !== "win32") {
+      await fs.chmod(destination, 0o755);
+    }
+    console.log(`Installed Softpractice CLI ${packageInfo.version} for ${process.platform}/${process.arch}.`);
+  } finally {
+    await fs.rm(temporaryDirectory, { recursive: true, force: true });
+  }
+}
+
+install().catch((error) => {
+  console.error(`softpractice install: ${error.message}`);
+  process.exitCode = 1;
+});