@scientific-method/standard-checker 1.1.0 → 2.0.0

package/dist/checks/evidence-entries.js

@@ -6,6 +6,7 @@ import { isSuperseded } from "../evidence.js";
 import { asList } from "../ids.js";
 import { checkAddress, checkOffset } from "../locations.js";
 import { locationRule } from "../standard.js";
+import { parseScalar } from "../yaml.js";
 /** Checks a finding's method, environment and locations. */
 export function checkFinding(ctx, e) {
     const { problem } = ctx;
@@ -121,6 +122,24 @@ export function checkExperiment(ctx, id, e, isSup) {
     const builds = asList(meta.builds);
     if (builds.length !== 1)
         problem(file, "an experiment lists exactly one build", "ENTRY-TYPES-7");
+    // The standard's experiment entry lists the starting states: a save patch, a save, new-game,
+    // emulated-call or null, where a save or a patch is in saves/. A missing field is reported with
+    // the other required fields. Which save hashes the fixture needs depends on the form, so an
+    // unknown one gets no save hash problem. A path in saves/ names a file under it, so it has a
+    // name after saves/ and no empty, . or .. segment.
+    const state = meta.starting_state;
+    const savePath = typeof state === "string" &&
+        state.startsWith("saves/") &&
+        state
+            .split("/")
+            .slice(1)
+            .every((s) => s !== "" && s !== "." && s !== "..");
+    const fromSave = state === null || savePath;
+    if (state !== undefined && !fromSave && state !== "new-game" && state !== "emulated-call") {
+        // A string the front matter would read as another value, such as a quoted "null", is shown quoted.
+        const shown = typeof state === "string" && state !== "" && parseScalar(state) === state ? state : JSON.stringify(state);
+        problem(file, `starting_state ${shown} is none of the forms the standard defines: a save or save patch in saves/, new-game, emulated-call or null`);
+    }
     const fixture = meta.fixture && join(specDir, "experiments", meta.fixture);
     if (!fixture || !existsSync(fixture))
         problem(file, `fixture ${meta.fixture} does not exist`);
@@ -132,13 +151,13 @@ export function checkExperiment(ctx, id, e, isSup) {
             // Only a new game and an emulated call start without a save. starting_state null still has
             // one: a save that cannot be committed, kept with the captures and found by its hash.
             const save = fx.starting_state;
-            if (!["new-game", "emulated-call"].includes(meta.starting_state) && !save?.xxh3) {
+            if (fromSave && !save?.xxh3) {
                 const where = "gives the hash of the save its runs started from in starting_state.xxh3";
-                problem(fixture, meta.starting_state === null
+                problem(fixture, state === null
                     ? `${where}; starting_state null names a save kept with the captures, and an experiment that starts without a save has starting_state new-game or emulated-call`
                     : where);
             }
-            if (typeof meta.starting_state === "string" && meta.starting_state.endsWith(".patch.json") && !save?.base_xxh3)
+            if (savePath && state.endsWith(".patch.json") && !save?.base_xxh3)
                 problem(fixture, "a patch fixture gives the base save's hash as well");
             for (const key of ["xxh3", "base_xxh3"])
                 if (save?.[key] && !/^[0-9a-f]{32}$/.test(String(save[key])))
@@ -156,10 +175,8 @@ export function checkExperiment(ctx, id, e, isSup) {
             problem(fixture, `is not valid JSON: ${err.message}`);
         }
     }
-    if (typeof meta.starting_state === "string" &&
-        meta.starting_state.startsWith("saves/") &&
-        !existsSync(join(specDir, "experiments", meta.starting_state)))
-        problem(file, `starting_state ${meta.starting_state} does not exist`);
+    if (savePath && !existsSync(join(specDir, "experiments", state)))
+        problem(file, `starting_state ${state} does not exist`);
     // A recording is committed in recordings/, kept with the captures, or one of the build's files.
     if (typeof meta.recording === "string" && meta.recording !== "") {
         const rec = meta.recording;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scientific-method/standard-checker",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Checks a restoration's spec/, parity/ and deviations/ against version 1 of the dinorefurb documentation standard.",
   "type": "module",
   "license": "MIT",