@geonosis/review 1.2.0 → 1.4.0

package/dist/{chunk-PJWPFJAP.js → chunk-GCGDPXAF.js}

@@ -14,6 +14,17 @@ var REVIEW_DEFAULT = {
   runner: "peer-session"
 };
 var KNOWN = new Set(Object.keys(REVIEW_DEFAULT));
+var configShape = () => [
+  "geonosis-review reads geonosis.json",
+  "",
+  'geonosis.json \u2192 "review"      every key optional, every default a contract',
+  ...[...KNOWN].toSorted().map(
+    (key) => `  ${key.padEnd(18)}string?   default ${JSON.stringify(REVIEW_DEFAULT[key])}`
+  ),
+  "",
+  "A key outside this list is REFUSED by name, and `criteria` and `criteriaHeading` are compiled as",
+  "regular expressions when the config is read, never at the moment they are used."
+].join("\n");
 var isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var loadReviewConfig = (root) => {
   const file = resolve(root, "geonosis.json");
@@ -156,6 +167,7 @@ var applyDecision = (decision, root, proofs, slug) => {
 export {
   ReviewError,
   REVIEW_DEFAULT,
+  configShape,
   loadReviewConfig,
   criteriaOf,
   uncovered,

package/dist/index.js

@@ -10,7 +10,7 @@ import {
   readDecision,
   render,
   uncovered
-} from "./chunk-PJWPFJAP.js";
+} from "./chunk-GCGDPXAF.js";
 export {
   DECISIONS,
   REVIEW_DEFAULT,

package/dist/review-cli.js

@@ -1,12 +1,13 @@
 import {
   ReviewError,
   applyDecision,
+  configShape,
   criteriaOf,
   loadReviewConfig,
   readDecision,
   render,
   uncovered
-} from "./chunk-PJWPFJAP.js";
+} from "./chunk-GCGDPXAF.js";
 
 // src/review-cli.ts
 import { existsSync, readFileSync } from "fs";
@@ -25,7 +26,8 @@ var parse = (argv) => {
     if (arg === "--to") out.to = takes("--to");
     else if (arg === "--slug") out.slug = takes("--slug");
     else if (arg === "--criteria") out.criteria = takes("--criteria");
-    else if (arg.startsWith("-")) throw new ReviewError(`unknown option ${arg}`);
+    else if (arg.startsWith("-"))
+      throw new ReviewError(`unknown option ${arg} \u2014 run geonosis-review --help`);
     else if (out.verb === void 0) out.verb = arg;
     else if (out.file === void 0) out.file = arg;
     else throw new ReviewError(`unexpected argument ${arg}`);
@@ -77,10 +79,38 @@ var check = (argv, root) => {
   process.stdout.write(`all ${stated.length} criteria checked
 `);
 };
+var USAGE = `geonosis-review <apply|check> <decision.md> [options]
+
+Reads a release review \u2014 a decision file \u2014 and either applies it or checks that it covered the
+criteria the plan stated.
+
+  apply <decision.md> [--to ledger|stdout] [--slug <name>]
+      Render the decision, or write it into the ledger under a slug.
+
+  check <decision.md> --criteria <plan.md>
+      Refuse a review that did not check every acceptance criterion the plan states.
+
+  --help, -h    this text
+
+Exit codes: 0 applied \xB7 1 the review was read and REFUSED \xB7 2 the command could not run.
+
+The middle one is the contract: an approval that lists a blocker is an ANSWER, and an answer of
+"no" is not a broken tool.`;
 var main = () => {
   const root = process.cwd();
+  const args = process.argv.slice(2);
+  if (args.includes("--help") || args.includes("-h")) {
+    process.stdout.write(`${USAGE}
+`);
+    return 0;
+  }
+  if (args.includes("--print-config-shape")) {
+    process.stdout.write(`${configShape()}
+`);
+    return 0;
+  }
   try {
-    const argv = parse(process.argv.slice(2));
+    const argv = parse(args);
     if (argv.verb === "apply") apply(argv, root);
     else if (argv.verb === "check") check(argv, root);
     else throw new ReviewError(`geonosis-review takes "apply" or "check", not "${argv.verb ?? ""}"`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geonosis/review",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "types": "./dist/index.d.ts",
   "description": "The decision-only reviewer contract: a review's sole output is one JSON decision, validated and applied by a step that comments nowhere, approves nothing and cannot reach a forge.",
   "keywords": [