@six5536/smllm 0.0.0 → 0.4.1

package/README.md

@@ -1,3 +1,59 @@
-# @six5536/smllm
+# smllm
 
-This version only reserves the name. smllm publishes its real versions from https://github.com/six5536/smllm.
+smllm runs state machines for large language model (LLM) coding agents. This README helps you
+install smllm from npm and run its first commands. It covers installation, usage, where to find
+the full documentation, and the licence.
+
+You describe a workflow in YAML, as a subset of XState v5, and smllm drives the agent through it.
+smllm gives the agent each state's instructions. When the agent tries to stop, smllm offers the
+events that the agent can fire through one Model Context Protocol (MCP) tool. smllm works with
+Claude Code, Codex, Gemini CLI, Cursor, and other agent harnesses.
+
+- [Install](#install)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Licence](#licence)
+
+## Install
+
+Install the package globally:
+
+```sh
+npm install -g @six5536/smllm
+```
+
+This package is a thin launcher. It declares a prebuilt binary for each supported platform as an
+`optionalDependency`, and npm installs only the one that matches your machine. A small JavaScript
+shim then runs the binary.
+
+The package supports Linux and macOS on `x64` and `arm64`, and Windows on `x64`. On any other
+platform, or to build from source, install smllm with the Rust toolchain instead:
+
+```sh
+cargo install smllm
+```
+
+## Usage
+
+These commands create a config, scaffold a state machine, check it, and connect smllm to an
+agent:
+
+```sh
+smllm init                          # .smllm/config.toml
+smllm new dev --write               # scaffold a state machine
+smllm validate                      # findings as file:line: level: message
+smllm harness install claude        # hooks + MCP tool for Claude Code (or codex, gemini, cursor, …, all)
+```
+
+smllm exits with `0` on success, `1` when it finds errors (config errors, a rejected event, or a
+failed hook), and `2` on a usage or internal error.
+
+## Documentation
+
+The [smllm repository on GitHub](https://github.com/six5536/smllm#readme) has the full usage
+guide and the notes on development.
+
+## Licence
+
+smllm is licensed under the MIT licence. The
+[LICENSE](https://github.com/six5536/smllm/blob/main/LICENSE) file has the full text.

package/bin/smllm.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+"use strict";
+
+// Thin launcher: resolve the prebuilt binary for this platform and run it,
+// forwarding arguments, stdio, and the exit code.
+
+const { spawnSync } = require("node:child_process");
+const { resolveBinary, exitCode } = require("../lib/binary");
+
+let binary;
+try {
+  binary = resolveBinary(process.platform, process.arch);
+} catch (err) {
+  process.stderr.write(`${err.message}\n`);
+  process.exit(1);
+}
+
+const result = spawnSync(binary, process.argv.slice(2), { stdio: "inherit" });
+
+if (result.error) {
+  process.stderr.write(`failed to run smllm: ${result.error.message}\n`);
+  process.exit(1);
+}
+
+process.exit(exitCode(result));

package/lib/binary.js

@@ -0,0 +1,80 @@
+"use strict";
+
+// Maps the host platform to the prebuilt binary package and resolves the binary
+// path. Logic is dependency-injected (platform, arch, requireResolve) so it is
+// unit-testable without the platform packages actually being installed.
+
+const PACKAGES = {
+  "linux x64": "@six5536/smllm-linux-x64",
+  "linux arm64": "@six5536/smllm-linux-arm64",
+  "darwin x64": "@six5536/smllm-darwin-x64",
+  "darwin arm64": "@six5536/smllm-darwin-arm64",
+  "win32 x64": "@six5536/smllm-win32-x64",
+};
+
+const SUPPORTED = Object.keys(PACKAGES)
+  .map((k) => k.replace(" ", "-"))
+  .join(", ");
+
+/** Return the platform package name for a platform/arch, or null if unsupported. */
+function selectPackage(platform, arch) {
+  return PACKAGES[`${platform} ${arch}`] || null;
+}
+
+/** The binary file name inside a platform package. */
+function binaryName(platform) {
+  return platform === "win32" ? "smllm.exe" : "smllm";
+}
+
+/**
+ * Resolve the absolute path to the prebuilt binary for the given platform/arch.
+ * Throws if the platform has no binary, or if it has one but the package was
+ * never installed — each error names the fix. `requireResolve` defaults to the
+ * real `require.resolve`.
+ */
+function resolveBinary(platform, arch, requireResolve = require.resolve) {
+  const pkg = selectPackage(platform, arch);
+  if (!pkg) {
+    throw new Error(
+      `No prebuilt smllm binary for ${platform}-${arch}.\n` +
+        `Supported platforms: ${SUPPORTED}.\n` +
+        `Install from source instead: cargo install smllm`,
+    );
+  }
+  try {
+    return requireResolve(`${pkg}/bin/${binaryName(platform)}`);
+  } catch {
+    throw new Error(
+      `The smllm platform package "${pkg}" is not installed.\n` +
+        `Optional dependencies were most likely skipped during install.\n` +
+        `Reinstall smllm, or build from source: cargo install smllm`,
+    );
+  }
+}
+
+/**
+ * Map a `spawnSync` result to the exit code this process should use.
+ *
+ * A child killed by a signal reports `status === null` and `signal === "SIGINT"`
+ * etc. Shells encode that as `128 + signum`, so a Ctrl-C'd run exits 130 rather
+ * than a misleading 1. `signals` is injected for testability and defaults to
+ * Node's own table.
+ */
+function exitCode(result, signals = require("node:os").constants.signals) {
+  if (result.signal) {
+    const signum = signals[result.signal];
+    if (signum) {
+      return 128 + signum;
+    }
+  }
+  return result.status === null ? 1 : result.status;
+}
+
+module.exports = {
+  selectPackage,
+  binaryName,
+  resolveBinary,
+  exitCode,
+  PACKAGES,
+  SUPPORTED,
+};

package/package.json

@@ -1,10 +1,46 @@
 {
   "name": "@six5536/smllm",
-  "version": "0.0.0",
-  "description": "Reserves the name for smllm's first release, so that its trusted publisher can be set up. Install a later version.",
+  "version": "0.4.1",
+  "description": "State machines for LLM agents: declarative workflows that drive a coding agent through its hooks and one MCP tool.",
   "homepage": "https://github.com/six5536/smllm#readme",
-  "repository": { "type": "git", "url": "git+https://github.com/six5536/smllm.git" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/six5536/smllm.git",
+    "directory": "packages/smllm"
+  },
+  "bugs": {
+    "url": "https://github.com/six5536/smllm/issues"
+  },
+  "author": "six5536 <10079653+six5536@users.noreply.github.com>",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "provenance": true
+  },
+  "keywords": [
+    "cli",
+    "command-line",
+    "rust"
+  ],
+  "bin": {
+    "smllm": "bin/smllm.js"
+  },
+  "files": [
+    "bin/",
+    "lib/"
+  ],
   "license": "MIT",
-  "files": ["README.md"],
-  "publishConfig": { "registry": "https://registry.npmjs.org", "access": "public" }
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@six5536/smllm-linux-x64": "0.4.1",
+    "@six5536/smllm-linux-arm64": "0.4.1",
+    "@six5536/smllm-darwin-x64": "0.4.1",
+    "@six5536/smllm-darwin-arm64": "0.4.1",
+    "@six5536/smllm-win32-x64": "0.4.1"
+  },
+  "scripts": {
+    "test": "node --test test/*.test.js"
+  }
 }