runtime-checker 1.0.0 → 1.1.0

package/README.md

@@ -1,26 +1,60 @@
-# runtime-checker
-Detects the minimum version needed for **Node.js**, **Bun**, **Deno** and browsers to execute your codebase.
-
-## Installation
-```sh
-deno add npm:runtime-checker
-bun add runtime-checker
-pnpm add runtime-checker
-npm install runtime-checker
-```
-
-## Usage
-`$ runtime-checker <dir>`
-
-### Arguments
- `--fast:` uses [fff](https://github.com/dmtrKovalenko/fff) instead of oxc AST parsing. Faster<sup>1</sup>, but less accurate.
- 
- <sup>1</sup> fff is only faster (and actually slower!) than oxc when your codebase is around 250,000~ or more lines of code, from testing on a Windows machine with a 9800X3D.
-
- `--fix`: Automatically fixes your `engines.node` field to a supported version if an issue is found.
-
- `--inspect <symbol, e.g.: Symbol.asyncDispose>`: Shows each detection of a specific symbol
-
- `--summary`: Only prints the summary
-
- `--runtime <all|deno|bun|node|safari|chrome|firefox>`: Only shows the results for a specific runtime
+# runtime-checker
+
+Find the minimum runtime version needed for a JavaScript or TypeScript codebase.
+
+It parses files with Oxc and checks runtime APIs, JavaScript syntax, module format, and native TypeScript usage. It can report requirements for Node.js, Deno, Bun, Safari, Chromium, and Firefox.
+
+## install
+
+```sh
+npm install runtime-checker
+pnpm add runtime-checker
+bun add runtime-checker
+deno add npm:runtime-checker
+```
+
+## usage
+
+```sh
+runtime-checker <dir>
+```
+
+For app compatibility, scan the code you ship. For bundled apps, that usually means the build output, not just `src`.
+
+## options
+
+```sh
+runtime-checker <dir> --summary
+runtime-checker <dir> --runtime node
+runtime-checker <dir> --inspect Symbol.asyncDispose
+runtime-checker <dir> --fix
+```
+
+- `--summary` prints only the result panel.
+- `--runtime <all|node|deno|bun|safari|chrome|firefox>` limits output to one target.
+- `--inspect <feature>` prints every detection for a feature.
+- `--fix` updates `package.json` `engines.node` when the detected Node.js version is not satisfied.
+
+## detects
+
+- Runtime APIs such as `fetch`, `Temporal`, `fs.cp`, `sqlite.DatabaseSync`, and `Symbol.asyncDispose`.
+- JavaScript syntax such as optional chaining, nullish coalescing, ESM, `await using`, and native TypeScript support.
+- Node.js `engines.node` mismatches.
+
+## output
+
+```txt
+Finished in 665ms using oxc (ast parsing) after scanning 307k lines of code.
+
+Runtimes
+- Node.js 24.0.0
+- Deno 2.8.0
+- Bun 1.3.0
+
+Browsers
+- Safari 26.0.0
+- Chromium 149.0.0
+- Firefox 141.0.0
+```
+
+Use `--inspect <feature>` when you want to see every file and location that caused a requirement.

package/npm/bin/runtime-checker.js

@@ -6,14 +6,18 @@ import { fileURLToPath } from "node:url";
 
 const root = join(dirname(fileURLToPath(import.meta.url)), "..", "..");
 const exe = process.platform === "win32" ? "runtime-checker.exe" : "runtime-checker";
-const native = join(root, "npm", "bin", "native", exe);
+const target = `${process.platform}-${process.arch}`;
+const native = join(root, "npm", "bin", "native", target, exe);
 
 if (!existsSync(native)) {
-  console.error("runtime-checker native binary is missing. Try reinstalling the package.");
+  console.error(`runtime-checker does not have a native binary for ${target}.`);
+  console.error("The npm package may be corrupted, or this platform is not supported yet.");
   process.exit(1);
 }
 
-const child = spawnSync(native, process.argv.slice(2), { stdio: "inherit" });
+const child = spawnSync(native, process.argv.slice(2), {
+  stdio: "inherit",
+});
 
 if (child.error) {
   console.error(child.error.message);

package/package.json

@@ -1,37 +1,30 @@
 {
   "name": "runtime-checker",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Detect minimum runtime versions required by JavaScript and TypeScript codebases.",
   "license": "BSD-3-Clause",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/usebarekey/runtime-checker.git"
+    "url": "git+https://github.com/usebarekey/runtime-checker.git"
   },
   "homepage": "https://github.com/usebarekey/runtime-checker",
   "bugs": {
     "url": "https://github.com/usebarekey/runtime-checker/issues"
   },
   "bin": {
-    "runtime-checker": "./npm/bin/runtime-checker.js"
+    "runtime-checker": "npm/bin/runtime-checker.js"
   },
   "files": [
-    "Cargo.lock",
-    "Cargo.toml",
     "LICENSE",
     "README.md",
-    "data",
-    "npm",
-    "src"
+    "npm/bin"
   ],
   "scripts": {
     "build": "cargo build --release",
     "check": "cargo clippy --all-targets -- -D warnings",
     "test": "cargo test",
-    "postinstall": "node ./npm/postinstall.js",
-    "prepack": "cargo build --release && node ./npm/prepare-bin.js",
-    "publish:npm": "npm publish --access public --provenance",
-    "publish:jsr": "npx --yes jsr publish"
+    "publish:npm": "npm publish --access public"
   },
   "publishConfig": {
     "access": "public"