@feds01/zenith 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Fedotov
+
+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

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# zenith
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An architecture linter for TypeScript and JavaScript codebases, built for
+monorepos. Zenith enforces *contracts* about which parts of a codebase may
+import which other parts, declared in `zenith.toml`, and `zenith check` fails
+when the code breaks them.
+
+```sh
+npm install --save-dev @feds01/zenith
+npx zenith check
+```
+
+See the [user guide](https://feds01.github.io/zenith/) for the contracts, the
+configuration and the command line.
+
+## How it is installed
+
+Zenith is a native binary. This package has none itself, nor any install
+script: the binary for each platform is in a package of its own, which this
+one lists as an optional dependency, and the package manager installs only
+the one for your platform:
+
+| Package | Platform |
+|---|---|
+| `@feds01/zenith-darwin-arm64` | macOS, Apple silicon |
+| `@feds01/zenith-darwin-x64` | macOS, Intel |
+| `@feds01/zenith-linux-arm64` | Linux, ARM64 (static, any libc) |
+| `@feds01/zenith-linux-x64` | Linux, x86-64 (static, any libc) |
+| `@feds01/zenith-win32-x64` | Windows, x86-64 |
+
+So it installs offline from a package manager's cache, the lockfile's
+integrity hashes cover the binary, and bun needs no `trustedDependencies`
+entry for it. Don't leave optional dependencies out of the install, e.g. with
+`npm install --omit=optional`, or the `zenith` command has no binary to run.
+
+On another platform, build zenith from source with
+`cargo install --locked --git https://github.com/feds01/zenith zenith`, and
+set `ZENITH_BINARY` to the path of the binary.
+
+## Licence
+
+MIT

package/bin/zenith.js

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+// The `zenith` command of the npm package. It runs the binary from the
+// package for this platform, e.g. `@feds01/zenith-darwin-arm64`, which the
+// package manager installed as one of its optional dependencies. The binary
+// gets the arguments, stdin, stdout and stderr, and the command exits as the
+// binary does.
+
+"use strict";
+
+const { spawn } = require("child_process");
+const path = require("path");
+
+const { name: main, version, optionalDependencies } = require("../package.json");
+
+/** The exit code of a usage or internal error, as zenith's own. */
+const ERROR_EXIT_CODE = 2;
+
+/** The signals that are passed on to the binary, as when the launcher is stopped on its own. */
+const FORWARDED_SIGNALS = ["SIGINT", "SIGTERM", "SIGHUP"];
+
+/** Print `message` to stderr, and exit with an error. */
+function fail(message) {
+  process.stderr.write(`error: ${message}\n`);
+  process.exit(ERROR_EXIT_CODE);
+}
+
+/** The path of the binary to run. */
+function binaryPath() {
+  // 1. A binary of the user's own, e.g. one built from source for a
+  //    platform without a package.
+  const override = process.env.ZENITH_BINARY;
+  if (override) {
+    return override;
+  }
+
+  // 2. The package for this platform, which must be one that is published.
+  const target = `${process.platform}-${process.arch}`;
+  const platformPackage = `${main}-${target}`;
+  if (!Object.prototype.hasOwnProperty.call(optionalDependencies, platformPackage)) {
+    const supported = Object.keys(optionalDependencies)
+      .map((name) => name.slice(main.length + 1))
+      .join(", ");
+    fail(
+      `${main} has no binary for this platform, ${target}; it has binaries for ${supported}.\n` +
+        "Build zenith from source with " +
+        "`cargo install --locked --git https://github.com/feds01/zenith zenith`,\n" +
+        "and set ZENITH_BINARY to the path of the binary.",
+    );
+  }
+
+  // 3. Where the package manager installed it.
+  let manifest;
+  try {
+    manifest = require.resolve(`${platformPackage}/package.json`);
+  } catch {
+    fail(
+      `${platformPackage}, which has the binary for this platform, isn't installed.\n` +
+        `It is an optional dependency of ${main}, so it is left out when optional dependencies are,\n` +
+        "e.g. with `npm install --omit=optional`. Install again without leaving them out,\n" +
+        `or add ${platformPackage}@${version} to your dependencies.`,
+    );
+  }
+  return path.join(path.dirname(manifest), process.platform === "win32" ? "zenith.exe" : "zenith");
+}
+
+// 1. Run the binary with the launcher's arguments and streams.
+const binary = binaryPath();
+const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+
+// 2. Pass on the signals that would stop the launcher alone, so that the
+//    binary stops with it rather than running on.
+const forward = (signal) => child.kill(signal);
+for (const signal of FORWARDED_SIGNALS) {
+  process.on(signal, forward);
+}
+
+child.on("error", (error) => fail(`could not run ${binary}: ${error.message}`));
+
+// 3. Exit as the binary did: with its exit code, or by the signal that
+//    stopped it.
+child.on("exit", (code, signal) => {
+  for (const forwarded of FORWARDED_SIGNALS) {
+    process.removeListener(forwarded, forward);
+  }
+  if (signal) {
+    process.kill(process.pid, signal);
+  } else {
+    process.exit(code);
+  }
+});

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "@feds01/zenith",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "An architecture linter for TypeScript and JavaScript codebases",
+  "keywords": [
+    "architecture",
+    "linter",
+    "imports",
+    "monorepo",
+    "typescript",
+    "javascript"
+  ],
+  "homepage": "https://feds01.github.io/zenith/",
+  "bugs": "https://github.com/feds01/zenith/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/feds01/zenith.git"
+  },
+  "license": "MIT",
+  "author": "Alexander Fedotov <alexander.fedotov.uk@gmail.com>",
+  "bin": {
+    "zenith": "bin/zenith.js"
+  },
+  "files": [
+    "bin"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "optionalDependencies": {
+    "@feds01/zenith-darwin-arm64": "0.2.0",
+    "@feds01/zenith-darwin-x64": "0.2.0",
+    "@feds01/zenith-linux-arm64": "0.2.0",
+    "@feds01/zenith-linux-x64": "0.2.0",
+    "@feds01/zenith-win32-x64": "0.2.0"
+  }
+}