@reventlessdev/reventless-spec 3.0.0-alpha.143 → 3.0.0-alpha.145

package/src/lifecycle/CheckLifecycleModel.res.mjs

@@ -7,8 +7,10 @@ import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
 import * as Stdlib_JsExn from "@rescript/runtime/lib/es6/Stdlib_JsExn.js";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Stdlib_Result from "@rescript/runtime/lib/es6/Stdlib_Result.js";
 import * as Primitive_object from "@rescript/runtime/lib/es6/Primitive_object.js";
 import * as Primitive_string from "@rescript/runtime/lib/es6/Primitive_string.js";
+import * as CliArgs$Reventless from "../CliArgs.res.mjs";
 import * as Nodechild_process from "node:child_process";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
 import * as ComponentKind$Reventless from "../components/ComponentKind.res.mjs";
@@ -20,25 +22,36 @@ let repoRoot = process.cwd();
 
 let examplesDir = Nodepath.join(repoRoot, "examples");
 
-let update = process.argv.includes("--update");
-
-function flagValues(flag) {
-  let argv = process.argv;
-  let out = [];
-  for (let i = 0, i_finish = argv.length; i < i_finish; ++i) {
-    if (Primitive_object.equal(argv[i], flag)) {
-      let value = argv[i + 1 | 0];
-      if (value !== undefined && !value.startsWith("--")) {
-        out.push(value);
-      }
-    }
-  }
-  return out;
+let usage = `Usage: check-lifecycle [--root <dir>]... [--update] [--reuse-sidecars] [--json]
+
+  --root <dir>       an app whose plugins are checked together; repeatable.
+                     Without one, every directory under ./examples
+  --update           rewrite the goldens and the models instead of comparing
+  --reuse-sidecars   read the scenario sidecars a prior build wrote instead of
+                     building with REVENTLESS_EMIT_SIDECAR=1
+  --json             report as one JSON document on stdout; writes and
+                     compares nothing
+
+Contradictions, drift and unreadable plugins exit 1.`;
+
+function parseArgs(argv) {
+  return Stdlib_Result.map(Stdlib_Result.flatMap(CliArgs$Reventless.parse(undefined, [
+    "update",
+    "reuse-sidecars",
+    "json"
+  ], ["root"], undefined, argv), CliArgs$Reventless.noPositionals), a => ({
+    update: CliArgs$Reventless.bool(a, "update"),
+    roots: CliArgs$Reventless.strings(a, "root"),
+    reuseSidecars: CliArgs$Reventless.bool(a, "reuse-sidecars"),
+    json: CliArgs$Reventless.bool(a, "json")
+  }));
 }
 
-let reuseSidecars = process.argv.includes("--reuse-sidecars");
-
-let json = process.argv.includes("--json");
+let cli = {
+  bin: "check-lifecycle",
+  usage: usage,
+  parse: parseArgs
+};
 
 let noRow = "(none)";
 
@@ -685,40 +698,28 @@ function pluginDirsIn(exampleDir) {
   });
 }
 
-if (process.argv.includes("--root") && flagValues("--root").length === 0) {
-  console.error("--root needs a directory after it");
-  process.exit(1);
-}
-
-let given = flagValues("--root");
-
-let roots;
-
-if (given.length !== 0) {
-  roots = given.map(given => {
-    let dir = Nodepath.resolve(given);
-    return {
-      label: Nodepath.basename(dir),
-      dir: dir
-    };
-  });
-} else {
-  let exit = 0;
+function rootsOf(given) {
+  if (given.length !== 0) {
+    return given.map(given => {
+      let dir = Nodepath.resolve(given);
+      return {
+        label: Nodepath.basename(dir),
+        dir: dir
+      };
+    });
+  }
   let entries;
   try {
     entries = Nodefs.readdirSync(examplesDir, {
       withFileTypes: true
     });
-    exit = 1;
   } catch (exn) {
-    roots = [];
-  }
-  if (exit === 1) {
-    roots = entries.filter(e => e.isDirectory()).map(e => e.name).toSorted(Primitive_string.compare).map(name => ({
-      label: name,
-      dir: Nodepath.join(examplesDir, name)
-    }));
+    return [];
   }
+  return entries.filter(e => e.isDirectory()).map(e => e.name).toSorted(Primitive_string.compare).map(name => ({
+    label: name,
+    dir: Nodepath.join(examplesDir, name)
+  }));
 }
 
 function kindOfPath(path) {
@@ -1115,7 +1116,7 @@ function modelPath(pluginDir) {
   return Nodepath.join(pluginDir, "src", "LifecycleModel.res");
 }
 
-function writeOrCompare(path, actual, label, drifted) {
+function writeOrCompare(update, path, actual, label, drifted) {
   let existed = Nodefs.existsSync(path);
   if (update || !existed) {
     Nodefs.writeFileSync(path, actual, "utf8");
@@ -1132,113 +1133,117 @@ function writeOrCompare(path, actual, label, drifted) {
   }
 }
 
-async function main() {
-  let findings = [];
-  let opaque = [];
-  let outcomes = [];
-  let failures = [];
-  let drifted = [];
-  let allDerived = [];
-  let allPluginDirs = roots.flatMap(root => pluginDirsIn(root.dir));
-  if (allPluginDirs.length === 0) {
-    console.error(`no plugins found under ` + roots.map(r => r.dir).join(", ") + ` — a plugin is a directory with both src/Plugin.res and tests/`);
-    process.exit(1);
-  }
-  let msg = reuseSidecars ? checkSidecars(allPluginDirs) : emitSidecars(allPluginDirs);
-  if (msg.TAG !== "Ok") {
-    console.error(msg._0);
-    process.exit(1);
-  }
-  if (!hasCorpus(allPluginDirs)) {
-    console.error(`no scenario sidecar exists under ` + roots.map(r => r.dir).join(", ") + ` after the build. Build that tree with REVENTLESS_EMIT_SIDECAR=1 and pass --reuse-sidecars.`);
-    process.exit(1);
-  }
-  for (let i = 0, i_finish = roots.length; i < i_finish; ++i) {
-    let root = roots[i];
-    if (root !== undefined) {
-      let example = root.label;
-      let exampleDir = root.dir;
-      let derived = [];
-      let dirs = pluginDirsIn(exampleDir);
-      for (let j = 0, j_finish = dirs.length; j < j_finish; ++j) {
-        let pluginDir = dirs[j];
-        if (pluginDir !== undefined) {
-          let plugin = Nodepath.basename(pluginDir);
-          let qualified = example + `/` + plugin;
-          let commands = await runPlugin(qualified, pluginDir, findings, opaque, outcomes);
-          if (commands.TAG === "Ok") {
-            let commands$1 = commands._0;
-            commands$1.forEach(c => {
-              derived.push(c);
-              allDerived.push([
-                qualified,
-                c
-              ]);
-            });
-            if (!json) {
-              writeOrCompare(modelPath(pluginDir), modelSource(plugin, commands$1), example + `/` + plugin + `/src/LifecycleModel.res`, drifted);
+function main() {
+  return CliArgs$Reventless.run(cli, undefined, undefined, async param => {
+    let json = param.json;
+    let update = param.update;
+    let roots = rootsOf(param.roots);
+    let findings = [];
+    let opaque = [];
+    let outcomes = [];
+    let failures = [];
+    let drifted = [];
+    let allDerived = [];
+    let allPluginDirs = roots.flatMap(root => pluginDirsIn(root.dir));
+    if (allPluginDirs.length === 0) {
+      console.error(`no plugins found under ` + roots.map(r => r.dir).join(", ") + ` — a plugin is a directory with both src/Plugin.res and tests/`);
+      process.exit(1);
+    }
+    let msg = param.reuseSidecars ? checkSidecars(allPluginDirs) : emitSidecars(allPluginDirs);
+    if (msg.TAG !== "Ok") {
+      console.error(msg._0);
+      process.exit(1);
+    }
+    if (!hasCorpus(allPluginDirs)) {
+      console.error(`no scenario sidecar exists under ` + roots.map(r => r.dir).join(", ") + ` after the build. Build that tree with REVENTLESS_EMIT_SIDECAR=1 and pass --reuse-sidecars.`);
+      process.exit(1);
+    }
+    for (let i = 0, i_finish = roots.length; i < i_finish; ++i) {
+      let root = roots[i];
+      if (root !== undefined) {
+        let example = root.label;
+        let exampleDir = root.dir;
+        let derived = [];
+        let dirs = pluginDirsIn(exampleDir);
+        for (let j = 0, j_finish = dirs.length; j < j_finish; ++j) {
+          let pluginDir = dirs[j];
+          if (pluginDir !== undefined) {
+            let plugin = Nodepath.basename(pluginDir);
+            let qualified = example + `/` + plugin;
+            let commands = await runPlugin(qualified, pluginDir, findings, opaque, outcomes);
+            if (commands.TAG === "Ok") {
+              let commands$1 = commands._0;
+              commands$1.forEach(c => {
+                derived.push(c);
+                allDerived.push([
+                  qualified,
+                  c
+                ]);
+              });
+              if (!json) {
+                writeOrCompare(update, modelPath(pluginDir), modelSource(plugin, commands$1), example + `/` + plugin + `/src/LifecycleModel.res`, drifted);
+              }
+            } else {
+              failures.push(example + `/` + plugin + `: ` + commands._0);
             }
-          } else {
-            failures.push(example + `/` + plugin + `: ` + commands._0);
           }
         }
+        if (dirs.length !== 0 && !json) {
+          let dir = Nodepath.join(exampleDir, "schema");
+          if (!Nodefs.existsSync(dir)) {
+            Nodefs.mkdirSync(dir, {
+              recursive: true
+            });
+          }
+          writeOrCompare(update, goldenPath(root), goldenJson(derived), example + `/schema/lifecycle-model.json`, drifted);
+          console.log(`ok ` + example + ` — ` + derived.length.toString() + ` commands derived from scenarios`);
+        }
       }
-      if (dirs.length !== 0 && !json) {
-        let dir = Nodepath.join(exampleDir, "schema");
-        if (!Nodefs.existsSync(dir)) {
-          Nodefs.mkdirSync(dir, {
-            recursive: true
+    }
+    let of_ = severity => findings.filter(f => f.severity === severity);
+    let contradicted = of_("contradicted");
+    if (json) {
+      console.log(reportJson(findings, opaque, allDerived, outcomes, failures));
+    } else {
+      [
+        "contradicted",
+        "unverified",
+        "undeclared",
+        "level",
+        "ambiguous"
+      ].forEach(severity => {
+        let group = of_(severity);
+        if (group.length !== 0) {
+          console.log(`\n` + severity + ` (` + group.length.toString() + `)`);
+          group.forEach(f => {
+            console.log(`  ` + f.message);
           });
+          return;
         }
-        writeOrCompare(goldenPath(root), goldenJson(derived), example + `/schema/lifecycle-model.json`, drifted);
-        console.log(`ok ` + example + ` — ` + derived.length.toString() + ` commands derived from scenarios`);
-      }
+      });
     }
-  }
-  let of_ = severity => findings.filter(f => f.severity === severity);
-  let contradicted = of_("contradicted");
-  if (json) {
-    console.log(reportJson(findings, opaque, allDerived, outcomes, failures));
-  } else {
-    [
-      "contradicted",
-      "unverified",
-      "undeclared",
-      "level",
-      "ambiguous"
-    ].forEach(severity => {
-      let group = of_(severity);
-      if (group.length !== 0) {
-        console.log(`\n` + severity + ` (` + group.length.toString() + `)`);
-        group.forEach(f => {
-          console.log(`  ` + f.message);
-        });
-        return;
-      }
-    });
-  }
-  if (failures.length !== 0 && !json) {
-    console.error(`\ncould not read:`);
-    failures.forEach(f => {
-      console.error(`  ` + f);
-    });
-  }
-  if (drifted.length !== 0) {
-    console.error(`\n` + drifted.length.toString() + ` lifecycle artifact(s) changed. If the change is intended, re-run with --update and commit them alongside the change that moved them.`);
-  }
-  if (contradicted.length !== 0 || drifted.length !== 0 || failures.length !== 0) {
-    process.exit(1);
-    return;
-  }
+    if (failures.length !== 0 && !json) {
+      console.error(`\ncould not read:`);
+      failures.forEach(f => {
+        console.error(`  ` + f);
+      });
+    }
+    if (drifted.length !== 0) {
+      console.error(`\n` + drifted.length.toString() + ` lifecycle artifact(s) changed. If the change is intended, re-run with --update and commit them alongside the change that moved them.`);
+    }
+    if (contradicted.length !== 0 || drifted.length !== 0 || failures.length !== 0) {
+      process.exit(1);
+      return;
+    }
+  });
 }
 
 export {
   repoRoot,
   examplesDir,
-  update,
-  flagValues,
-  reuseSidecars,
-  json,
+  usage,
+  parseArgs,
+  cli,
   noRow,
   asObj,
   getStr,
@@ -1278,7 +1283,7 @@ export {
   allUnverified,
   compare,
   pluginDirsIn,
-  roots,
+  rootsOf,
   kindOfPath,
   isViewPath,
   isWritablePath,

package/src/types/PrepareAccounts.res

@@ -30,29 +30,14 @@ type args = {
   help: bool,
 }
 
-let parseArgs = (argv: array<string>): result<args, string> => {
-  let acc = ref(Ok({file: None, help: false}))
-  let i = ref(0)
-  let count = argv->Array.length
-  while i.contents < count {
-    let flag = argv->Array.getUnsafe(i.contents)
-    let value = argv->Array.get(i.contents + 1)
-    switch (acc.contents, flag, value) {
-    | (Error(_), _, _) => i := count
-    | (Ok(a), "--file", Some(v)) =>
-      acc := Ok({...a, file: Some(v)})
-      i := i.contents + 2
-    | (Ok(a), "--help", _) | (Ok(a), "-h", _) =>
-      acc := Ok({...a, help: true})
-      i := i.contents + 1
-    | (Ok(_), "--file", None) => acc := Error(`${flag} needs a value`)
-    | (Ok(_), unknown, _) => acc := Error(`unknown argument "${unknown}"`)
-    }
-  }
-  acc.contents
-}
+let parseArgs = (argv: array<string>): result<args, string> =>
+  CliArgs.parse(~strings=["file"], argv)
+  ->Result.flatMap(CliArgs.noPositionals)
+  ->Result.map(a => {file: a->CliArgs.string("file"), help: a->CliArgs.help})
 
 let usage = `
+Usage: prepare-accounts [--file <path>]
+
 Make a platform's accounts manifest ready to use.
 
   --file <path>   The manifest. Defaults to .reventless/users.yaml relative to the
@@ -77,43 +62,39 @@ let castNote = (entries: array<AccountsManifest.entry>): string =>
   )
   ->Array.join("\n")
 
-let run = (): result<unit, string> =>
-  // argv[0] is node, argv[1] this script.
-  switch parseArgs(NodeProcess.argv->Array.slice(~start=2, ~end=NodeProcess.argv->Array.length)) {
+let run = (args: args): result<unit, string> =>
+  switch AccountsManifest.locate(~given=?args.file, ()) {
   | Error(_) as e => e
-  | Ok(args) if args.help =>
-    Console.log(usage)
-    Ok()
-  | Ok(args) =>
-    switch AccountsManifest.locate(~given=?args.file, ()) {
-    | Error(_) as e => e
-    | Ok(located) =>
-      let file = located->AccountsManifest.pathOf
-      switch located {
-      | SeededFrom(_, template) => Console.log(`manifest ${file} (new, copied from ${template})`)
-      | Declared(_) => Console.log(`manifest ${file}`)
-      }
-      switch AccountsManifest.prepare(~path=file) {
-      | Error(message) => Error(`${file}: ${message}`)
-      | Ok([]) => Error(`${file} declares no accounts`)
-      | Ok(prepared) =>
-        let generated = prepared->Array.filter(p => p.passwordGenerated)->Array.length
-        Console.log(
-          `accounts ${prepared
-            ->Array.length
-            ->Int.toString} declared, ${generated->Int.toString} password(s) generated\n\n${castNote(
-              prepared->Array.map(p => p.entry),
-            )}`,
-        )
-        Ok()
-      }
+  | Ok(located) =>
+    let file = located->AccountsManifest.pathOf
+    switch located {
+    | SeededFrom(_, template) => Console.log(`manifest ${file} (new, copied from ${template})`)
+    | Declared(_) => Console.log(`manifest ${file}`)
+    }
+    switch AccountsManifest.prepare(~path=file) {
+    | Error(message) => Error(`${file}: ${message}`)
+    | Ok([]) => Error(`${file} declares no accounts`)
+    | Ok(prepared) =>
+      let generated = prepared->Array.filter(p => p.passwordGenerated)->Array.length
+      Console.log(
+        `accounts ${prepared
+          ->Array.length
+          ->Int.toString} declared, ${generated->Int.toString} password(s) generated\n\n${castNote(
+            prepared->Array.map(p => p.entry),
+          )}`,
+      )
+      Ok()
     }
   }
 
-let main = async () =>
-  switch run() {
-  | Ok() => ()
-  | Error(message) =>
-    Console.error(`prepare-accounts: ${message}`)
-    NodeProcess.exit(1)
-  }
+let cli: CliArgs.cli<args> = {bin: "prepare-accounts", usage, parse: parseArgs}
+
+let main = () =>
+  CliArgs.run(cli, async args =>
+    switch run(args) {
+    | Ok() => ()
+    | Error(message) =>
+      Console.error(`prepare-accounts: ${message}`)
+      NodeProcess.exit(1)
+    }
+  )

package/src/types/PrepareAccounts.res.mjs

@@ -1,70 +1,19 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Stdlib_Result from "@rescript/runtime/lib/es6/Stdlib_Result.js";
+import * as CliArgs$Reventless from "../CliArgs.res.mjs";
 import * as AccountsManifest$Reventless from "./AccountsManifest.res.mjs";
 
 function parseArgs(argv) {
-  let acc = {
-    TAG: "Ok",
-    _0: {
-      file: undefined,
-      help: false
-    }
-  };
-  let i = 0;
-  let count = argv.length;
-  while (i < count) {
-    let flag = argv[i];
-    let value = argv[i + 1 | 0];
-    let match = acc;
-    if (match.TAG === "Ok") {
-      let a = match._0;
-      let exit = 0;
-      switch (flag) {
-        case "--file" :
-          if (value !== undefined) {
-            acc = {
-              TAG: "Ok",
-              _0: {
-                file: value,
-                help: a.help
-              }
-            };
-            i = i + 2 | 0;
-          } else {
-            acc = {
-              TAG: "Error",
-              _0: flag + ` needs a value`
-            };
-          }
-          break;
-        case "--help" :
-        case "-h" :
-          exit = 1;
-          break;
-        default:
-          acc = {
-            TAG: "Error",
-            _0: `unknown argument "` + flag + `"`
-          };
-      }
-      if (exit === 1) {
-        acc = {
-          TAG: "Ok",
-          _0: {
-            file: a.file,
-            help: true
-          }
-        };
-        i = i + 1 | 0;
-      }
-    } else {
-      i = count;
-    }
-  };
-  return acc;
+  return Stdlib_Result.map(Stdlib_Result.flatMap(CliArgs$Reventless.parse(["file"], undefined, undefined, undefined, argv), CliArgs$Reventless.noPositionals), a => ({
+    file: CliArgs$Reventless.string(a, "file"),
+    help: CliArgs$Reventless.help(a)
+  }));
 }
 
 let usage = `
+Usage: prepare-accounts [--file <path>]
+
 Make a platform's accounts manifest ready to use.
 
   --file <path>   The manifest. Defaults to .reventless/users.yaml relative to the
@@ -83,24 +32,12 @@ function castNote(entries) {
   )).join("\n");
 }
 
-function run() {
-  let e = parseArgs(process.argv.slice(2, process.argv.length));
+function run(args) {
+  let e = AccountsManifest$Reventless.locate(args.file, undefined);
   if (e.TAG !== "Ok") {
     return e;
   }
-  let args = e._0;
-  if (args.help) {
-    console.log(usage);
-    return {
-      TAG: "Ok",
-      _0: undefined
-    };
-  }
-  let e$1 = AccountsManifest$Reventless.locate(args.file, undefined);
-  if (e$1.TAG !== "Ok") {
-    return e$1;
-  }
-  let located = e$1._0;
+  let located = e._0;
   let file = AccountsManifest$Reventless.pathOf(located);
   if (located.TAG === "Declared") {
     console.log(`manifest ` + file);
@@ -129,13 +66,21 @@ function run() {
   };
 }
 
-async function main() {
-  let message = run();
-  if (message.TAG === "Ok") {
-    return;
-  }
-  console.error(`prepare-accounts: ` + message._0);
-  process.exit(1);
+let cli = {
+  bin: "prepare-accounts",
+  usage: usage,
+  parse: parseArgs
+};
+
+function main() {
+  return CliArgs$Reventless.run(cli, undefined, undefined, async args => {
+    let message = run(args);
+    if (message.TAG === "Ok") {
+      return;
+    }
+    console.error(`prepare-accounts: ` + message._0);
+    process.exit(1);
+  });
 }
 
 export {
@@ -143,6 +88,7 @@ export {
   usage,
   castNote,
   run,
+  cli,
   main,
 }
-/* AccountsManifest-Reventless Not a pure module */
+/* CliArgs-Reventless Not a pure module */