@crustjs/crust 0.2.1 → 0.3.1

package/README.md

@@ -5,7 +5,7 @@ CLI tooling for the Crust framework
 ## Install
 
 ```sh
-bun add -d @crustjs/crust
+npm install -D @crustjs/crust
 ```
 
 ## Documentation

package/bin/crust.js

@@ -1,50 +1,59 @@
 #!/usr/bin/env node
-// Auto-generated by crust build --package -- do not edit
+// Auto-generated by crust build -- do not edit
 import { spawn } from "node:child_process";
 import { chmodSync, existsSync } from "node:fs";
 import { dirname, resolve } from "node:path";
 import process from "node:process";
 import { fileURLToPath } from "node:url";
 
+const NAME = "crust";
 const PLATFORMS = {
 	"linux-x64": {
 		"packagePathSegment": "crust-linux-x64",
 		"packageName": "@crustjs/crust-linux-x64",
+		"targetAlias": "linux-x64",
 		"binaryFilename": "crust-bun-linux-x64"
 	},
 	"linux-arm64": {
 		"packagePathSegment": "crust-linux-arm64",
 		"packageName": "@crustjs/crust-linux-arm64",
+		"targetAlias": "linux-arm64",
 		"binaryFilename": "crust-bun-linux-arm64"
 	},
 	"linux-x64-musl": {
 		"packagePathSegment": "crust-linux-x64-musl",
 		"packageName": "@crustjs/crust-linux-x64-musl",
+		"targetAlias": "linux-x64-musl",
 		"binaryFilename": "crust-bun-linux-x64-musl"
 	},
 	"linux-arm64-musl": {
 		"packagePathSegment": "crust-linux-arm64-musl",
 		"packageName": "@crustjs/crust-linux-arm64-musl",
+		"targetAlias": "linux-arm64-musl",
 		"binaryFilename": "crust-bun-linux-arm64-musl"
 	},
 	"darwin-x64": {
 		"packagePathSegment": "crust-darwin-x64",
 		"packageName": "@crustjs/crust-darwin-x64",
+		"targetAlias": "darwin-x64",
 		"binaryFilename": "crust-bun-darwin-x64"
 	},
 	"darwin-arm64": {
 		"packagePathSegment": "crust-darwin-arm64",
 		"packageName": "@crustjs/crust-darwin-arm64",
+		"targetAlias": "darwin-arm64",
 		"binaryFilename": "crust-bun-darwin-arm64"
 	},
 	"win32-x64": {
 		"packagePathSegment": "crust-windows-x64",
 		"packageName": "@crustjs/crust-windows-x64",
+		"targetAlias": "windows-x64",
 		"binaryFilename": "crust-bun-windows-x64.exe"
 	},
 	"win32-arm64": {
 		"packagePathSegment": "crust-windows-arm64",
 		"packageName": "@crustjs/crust-windows-arm64",
+		"targetAlias": "windows-arm64",
 		"binaryFilename": "crust-bun-windows-arm64.exe"
 	}
 };
@@ -64,41 +73,27 @@ const platformKey =
 const target = PLATFORMS[platformKey];
 
 if (!target) {
-	console.error("[crust] Unsupported platform: " + platformKey);
-	console.error("[crust] Supported platforms: linux-x64, linux-arm64, linux-x64-musl, linux-arm64-musl, darwin-x64, darwin-arm64, windows-x64, windows-arm64");
+	console.error("[" + NAME + "] Unsupported platform: " + platformKey);
+	console.error("[" + NAME + "] Supported platforms: linux-x64, linux-arm64, linux-x64-musl, linux-arm64-musl, darwin-x64, darwin-arm64, windows-x64, windows-arm64");
 	process.exit(1);
 }
 
-const candidateOne = resolve(
-	dir,
-	"..",
-	"..",
-	target.packagePathSegment,
-	"bin",
-	target.binaryFilename,
-);
-const candidateTwo = resolve(
-	dir,
-	"..",
-	"node_modules",
-	target.packageName,
-	"bin",
-	target.binaryFilename,
-);
-
-const binPath = existsSync(candidateOne)
-	? candidateOne
-	: existsSync(candidateTwo)
-		? candidateTwo
-		: null;
+const candidates = [
+	// Hoisted install: the platform package beside this one in node_modules.
+	resolve(dir, "..", "..", target.packagePathSegment, "bin", target.binaryFilename),
+	// Nested install: the platform package under this package's node_modules.
+	resolve(dir, "..", "node_modules", target.packageName, "bin", target.binaryFilename),
+	// In place: the .crust/ tree crust build staged, before any install.
+	resolve(dir, "..", "..", target.targetAlias, "bin", target.binaryFilename),
+];
+const binPath = candidates.find((candidate) => existsSync(candidate));
 
 if (!binPath) {
-	console.error("[crust] Missing platform package for " + platformKey);
-	console.error("[crust] Tried:");
-	console.error("  " + candidateOne);
-	console.error("  " + candidateTwo);
+	console.error("[" + NAME + "] Missing platform package for " + platformKey);
+	console.error("[" + NAME + "] Tried:");
+	for (const candidate of candidates) console.error("  " + candidate);
 	console.error(
-		"[crust] Reinstall dependencies on this platform and ensure optional dependencies are enabled.",
+		"[" + NAME + "] Reinstall dependencies on this platform and ensure optional dependencies are enabled.",
 	);
 	process.exit(1);
 }
@@ -116,7 +111,7 @@ const child = spawn(binPath, process.argv.slice(2), {
 });
 
 child.on("error", (error) => {
-	console.error("[crust] Failed to launch binary: " + error.message);
+	console.error("[" + NAME + "] Failed to launch binary: " + error.message);
 	process.exit(1);
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@crustjs/crust",
-	"version": "0.2.1",
+	"version": "0.3.1",
 	"description": "CLI tooling for the Crust framework",
 	"license": "MIT",
 	"author": "chenxin-yan",
@@ -29,19 +29,20 @@
 	},
 	"type": "module",
 	"files": [
-		"bin"
+		"bin",
+		"schema"
 	],
 	"bin": {
 		"crust": "bin/crust.js"
 	},
 	"optionalDependencies": {
-		"@crustjs/crust-linux-x64": "0.2.1",
-		"@crustjs/crust-linux-arm64": "0.2.1",
-		"@crustjs/crust-linux-x64-musl": "0.2.1",
-		"@crustjs/crust-linux-arm64-musl": "0.2.1",
-		"@crustjs/crust-darwin-x64": "0.2.1",
-		"@crustjs/crust-darwin-arm64": "0.2.1",
-		"@crustjs/crust-windows-x64": "0.2.1",
-		"@crustjs/crust-windows-arm64": "0.2.1"
+		"@crustjs/crust-linux-x64": "0.3.1",
+		"@crustjs/crust-linux-arm64": "0.3.1",
+		"@crustjs/crust-linux-x64-musl": "0.3.1",
+		"@crustjs/crust-linux-arm64-musl": "0.3.1",
+		"@crustjs/crust-darwin-x64": "0.3.1",
+		"@crustjs/crust-darwin-arm64": "0.3.1",
+		"@crustjs/crust-windows-x64": "0.3.1",
+		"@crustjs/crust-windows-arm64": "0.3.1"
 	}
 }

package/schema/package.json

@@ -0,0 +1,43 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"title": "package.json with a Crust build configuration",
+	"description": "package.json schema for CLIs built with Crust. Point \"$schema\" at ./node_modules/@crustjs/crust/schema/package.json to get completion for the \"crust\" block alongside the standard package.json fields.",
+	"type": "object",
+	"allOf": [
+		{
+			"$ref": "https://json.schemastore.org/package.json"
+		}
+	],
+	"properties": {
+		"crust": {
+			"description": "Build configuration read by `crust build`. Every key is optional; unknown keys fail the build. Command names and their source entries come from the standard `bin` field.",
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"runtime": {
+					"description": "Runtime the CLI is built for. Without it: deno.json/deno.jsonc selects deno; @types/node without @types/bun selects node; otherwise bun.",
+					"type": "string",
+					"enum": [
+						"bun",
+						"deno",
+						"node"
+					]
+				},
+				"bunPlugins": {
+					"description": "Bun bundler plugin modules applied to Bun and Node builds, in order: bare names resolve from node_modules, paths from the project root; each must default-export the plugin. Rejected for Deno.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"include": {
+					"description": "Directories relative to the project root that `crust build` copies into .crust/root/ and into each platform package's bin/.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			}
+		}
+	}
+}