@fraczak/k 6.0.3 → 6.1.0

package/codecs/int.mjs

@@ -17,6 +17,13 @@ import { stdin, stdout, argv, exit } from "node:process";
 import { Product, Variant } from "../Value.mjs";
 import { decodeWire, encodeToWire } from "./runtime/prefix-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} --parse | --print`);
+  stream("  --parse      Read a decimal integer from stdin, write binary pattern+value stream.");
+  stream("  --print      Read binary pattern+value stream from stdin, write decimal integer.");
+  stream("  -h, --help   Show this help.");
+}
+
 // Closed pattern for $ int = < bits '+', bits '-' >
 // with $ bits = < {} _, bits 0, bits 1 >
 const INT_PATTERN = [
@@ -79,10 +86,13 @@ function printIntValue(value) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    exit(0);
+  }
+
   if (args.length !== 1 || (args[0] !== "--parse" && args[0] !== "--print")) {
-    console.error("Usage: int.mjs --parse | --print");
-    console.error("  --parse  read a decimal integer from stdin, write binary pattern+value stream");
-    console.error("  --print  read binary pattern+value stream from stdin, write decimal integer");
+    usage();
     exit(1);
   }
 

package/codecs/json.mjs

@@ -4,6 +4,13 @@ import { stdin, stdout, argv, exit } from "node:process";
 import { decodeWire, encodeToWire } from "./runtime/prefix-codec.mjs";
 import { fromJsonValue, toJsonValue, patternFromJsonValue } from "./json-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} --parse | --print`);
+  stream("  --parse      Read JSON from stdin, write binary pattern+value stream.");
+  stream("  --print      Read binary pattern+value stream from stdin, write JSON.");
+  stream("  -h, --help   Show this help.");
+}
+
 function readAll(stream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -15,10 +22,13 @@ function readAll(stream) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    exit(0);
+  }
+
   if (args.length !== 1 || (args[0] !== "--parse" && args[0] !== "--print")) {
-    console.error("Usage: json.mjs --parse | --print");
-    console.error("  --parse  read JSON from stdin, write binary pattern+value stream");
-    console.error("  --print  read binary pattern+value stream from stdin, write JSON");
+    usage();
     exit(1);
   }
 

package/codecs/k-parse.mjs

@@ -49,6 +49,11 @@ async function main() {
   const prog = argv[1];
   const args = argv.slice(2);
 
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(prog);
+    return exit(0);
+  }
+
   let inputTypeArg = null;
   let inputPatternArg = null;
   let valueFile = null;

package/codecs/k-print.mjs

@@ -4,6 +4,15 @@ import fs from "node:fs";
 import { argv, stdin, stdout } from "node:process";
 import { decodeWire } from "./runtime/prefix-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} [--debug] [file]`);
+  stream("  Read a binary pattern+value stream and print the decoded textual value.");
+  stream("");
+  stream("Options:");
+  stream("  --debug      Print decoded pattern and value as JSON.");
+  stream("  -h, --help   Show this help.");
+}
+
 function readAll(stream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -15,6 +24,11 @@ function readAll(stream) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    return;
+  }
+
   let debug = false;
   let fileArg = null;
 
@@ -24,7 +38,8 @@ async function main() {
     } else if (fileArg == null) {
       fileArg = arg;
     } else {
-      throw new Error("Usage: k-print [--debug] [file]");
+      usage();
+      process.exit(1);
     }
   }
 

package/codecs/show.mjs

@@ -5,6 +5,15 @@ import { argv, stdin, stdout, stderr } from "node:process";
 import { decodeWire } from "./runtime/prefix-codec.mjs";
 import { propertyListToFilter, valueToK } from "./runtime/show-value.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} [wire-file]`);
+  stream("  Pass the wire stream through unchanged on stdout.");
+  stream("  Print the decoded value and filter to stderr.");
+  stream("");
+  stream("Options:");
+  stream("  -h, --help   Show this help.");
+}
+
 function readAll(stream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -16,10 +25,15 @@ function readAll(stream) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    return;
+  }
+
   let fileArg = null;
   for (const arg of args) {
     if (fileArg == null) fileArg = arg;
-    else { console.error("Usage: show.mjs [wire-file]"); process.exit(1); }
+    else { usage(); process.exit(1); }
   }
 
   const buffer = fileArg ? fs.readFileSync(fileArg) : await readAll(stdin);

package/codecs/unit.mjs

@@ -4,6 +4,13 @@ import { stdin, stdout, argv, exit } from "node:process";
 import { Product } from "../Value.mjs";
 import { decodeWire, encodeToWire } from "./runtime/prefix-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} --parse | --print`);
+  stream("  --parse      Ignore stdin and write the unit binary pattern+value stream.");
+  stream("  --print      Validate the unit binary pattern+value stream and write {}.");
+  stream("  -h, --help   Show this help.");
+}
+
 const UNIT_PATTERN = [
   ["closed-product", []]
 ];
@@ -23,10 +30,13 @@ function unitEncoding() {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    exit(0);
+  }
+
   if (args.length !== 1 || (args[0] !== "--parse" && args[0] !== "--print")) {
-    console.error("Usage: unit.mjs --parse | --print");
-    console.error("  --parse  ignore stdin and write the unit binary pattern+value stream");
-    console.error("  --print  validate the unit binary pattern+value stream and write {}");
+    usage();
     exit(1);
   }
 

package/codecs/utf16.mjs

@@ -3,6 +3,13 @@
 import { stdin, stdout, argv, exit } from "node:process";
 import { encodeText, decodeText } from "./string-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} --parse | --print`);
+  stream("  --parse      Read UTF-16 text from stdin (BOM-aware), write binary pattern+value stream of k string.");
+  stream("  --print      Read binary pattern+value stream of k string, write UTF-16LE text with BOM.");
+  stream("  -h, --help   Show this help.");
+}
+
 function readAll(stream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -43,10 +50,13 @@ function encodeUtf16Output(text) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    exit(0);
+  }
+
   if (args.length !== 1 || (args[0] !== "--parse" && args[0] !== "--print")) {
-    console.error("Usage: utf16.mjs --parse | --print");
-    console.error("  --parse  read UTF-16 text from stdin (BOM-aware), write binary pattern+value stream of k string");
-    console.error("  --print  read binary pattern+value stream of k string, write UTF-16LE text with BOM");
+    usage();
     exit(1);
   }
 

package/codecs/utf8.mjs

@@ -3,6 +3,13 @@
 import { stdin, stdout, argv, exit } from "node:process";
 import { encodeText, decodeText } from "./string-codec.mjs";
 
+function usage(stream = console.error) {
+  stream(`Usage: ${argv[1]} --parse | --print`);
+  stream("  --parse      Read UTF-8 text from stdin, write binary pattern+value stream of k string.");
+  stream("  --print      Read binary pattern+value stream of k string, write UTF-8 text.");
+  stream("  -h, --help   Show this help.");
+}
+
 function readAll(stream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -14,10 +21,13 @@ function readAll(stream) {
 
 async function main() {
   const args = argv.slice(2);
+  if (args.includes("-h") || args.includes("--help")) {
+    usage(console.log);
+    exit(0);
+  }
+
   if (args.length !== 1 || (args[0] !== "--parse" && args[0] !== "--print")) {
-    console.error("Usage: utf8.mjs --parse | --print");
-    console.error("  --parse  read UTF-8 text from stdin, write binary pattern+value stream of k string");
-    console.error("  --print  read binary pattern+value stream of k string, write UTF-8 text");
+    usage();
     exit(1);
   }