@cplieger/deadset-ts 8.0.0-dev.1 → 8.0.0-dev.10

package/dist/src/scope.js

@@ -1,150 +1,73 @@
-import { ConfigError } from "./config.js";
+import { SCOPE_SCHEMA } from "./contract/config.generated.js";
+import { dotted, locatedFault, placeIn, readStrict, StrictJSONError } from "./json-document.js";
 import { dirnamePath, isAbsolutePath, joinPath, resolvePath } from "./paths.js";
-import { checkDocument } from "./schema.js";
-/** The roles a scope document declares for a module. */
-const ROLE_TARGET = "target";
-const ROLE_CONSUMER = "consumer";
+import { MARKERS } from "./load/discover.js";
+import { failureExit } from "./failure.js";
+import { message } from "./product.js";
+import { firstRefusal } from "./schema.js";
+import { UsageError } from "./usage.js";
 /**
  * A scope document above this length is refused rather than decoded. It names one
  * target and its consumers, so a larger file is not one.
  */
 const MAX_DOCUMENT_LENGTH = 1 << 20;
 /**
- * A scope document that cannot be read as one. It ends the run with the failure
- * code: the run could not learn what to analyze, so it produced no answer.
+ * The bytes read of a scope document. A UTF-16 unit decodes from at most three bytes,
+ * so a document past the bound is past it within these.
  */
-export class ScopeError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "ScopeError";
-    }
-}
-const MODULE = {
-    kind: "section",
-    members: { id: { kind: "leaf" }, role: { kind: "leaf" }, path: { kind: "leaf" } },
-};
-/** The closed key list of the scope document, compared as bytes. */
-const SCOPE_ROOT = {
-    kind: "section",
-    members: {
-        target: MODULE,
-        workspace: { kind: "leaf" },
-        consumers: { kind: "list", members: MODULE.members ?? {} },
-    },
-};
-function isRecord(value) {
-    return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-/**
- * One string member, or undefined where the document omits it. A member the
- * document writes is a string holding at least one character, so `null` and `""`
- * are refused rather than read as absent.
- */
-function stringMember(parent, name, at) {
-    if (!Object.hasOwn(parent, name)) {
-        return undefined;
-    }
-    const value = parent[name];
-    if (typeof value !== "string") {
-        throw new ScopeError(`scope: ${at === "" ? name : `${at}.${name}`} is not a string`);
-    }
-    if (value === "") {
-        throw new ScopeError(`scope: ${at === "" ? name : `${at}.${name}`} names nothing`);
-    }
-    return value;
-}
-function readModule(value, at, role, documentDir) {
-    if (!isRecord(value)) {
-        throw new ScopeError(`scope: ${at} is not an object`);
-    }
-    const declared = stringMember(value, "role", at);
-    if (declared !== undefined && declared !== role) {
-        throw new ScopeError(`scope: ${at}.role is ${JSON.stringify(declared)}, want ${JSON.stringify(role)}`);
-    }
-    const path = stringMember(value, "path", at);
-    if (path === undefined) {
-        throw new ScopeError(`scope: ${at}.path names nothing`);
-    }
-    return {
-        id: stringMember(value, "id", at) ?? "",
-        path: isAbsolutePath(path) ? path : joinPath(documentDir, path),
-    };
-}
-/**
- * Walks the document's text against the closed key list, refusing a key the list
- * does not declare, compared as bytes, and a key one object writes twice, which a
- * parse cannot report because it keeps the last value.
- */
-function checkKeys(text, file) {
-    try {
-        checkDocument(text, SCOPE_ROOT, `scope: ${file}`);
-    }
-    catch (error) {
-        if (error instanceof ConfigError) {
-            // The configuration's refusal names the nearest configuration key, which a
-            // scope document does not have.
-            throw new ScopeError(error.kind === "unimplemented-key"
-                ? `scope: ${file}: ${error.key} is not a declared key`
-                : error.message);
-        }
-        throw error;
-    }
+const MAX_DOCUMENT_BYTES = 3 * (MAX_DOCUMENT_LENGTH + 1);
+function refusal(file, place, reason) {
+    return new UsageError(`scope: ${file}: ${place === "" ? "" : `${place}: `}${reason}`);
 }
 /**
- * Decodes the scope document at `file`. Decoding is strict: an undeclared key, a
- * key written twice in one object, and a value of a type the document does not
- * admit, `null` included, are errors, and a relative path inside the document
- * resolves against the document's own directory.
- *
- * The `workspace` key the format declares is checked and carries nothing here: it
- * names the file a Go consumer resolves the target through, and a TypeScript
- * project resolves one through its own compiler configuration.
+ * Decodes the scope document at `file`, held to the Contract's scope schema, a relative
+ * path resolved against the document's own directory. A document that cannot be read or is
+ * refused is a usage error, as any document the invocation names. `workspace` is read by Go consumers
+ * alone: a TypeScript project resolves the target through its own compiler configuration.
  */
 export function readScope(host, file) {
     const absolute = resolvePath(host.workingDirectory(), file);
     let text;
     try {
-        text = host.readFile(absolute);
+        text = host.readFile(absolute, MAX_DOCUMENT_BYTES);
     }
     catch (error) {
-        throw new ScopeError(`scope: ${file}: ${error instanceof Error ? error.message : String(error)}`);
+        throw new UsageError(`scope: ${file}: ${message(error)}`);
     }
     if (text.length > MAX_DOCUMENT_LENGTH) {
-        throw new ScopeError(`scope: ${file} is longer than ${String(MAX_DOCUMENT_LENGTH)} characters`);
+        throw new UsageError(`scope: ${file} is longer than ${String(MAX_DOCUMENT_LENGTH)} characters`);
     }
     let value;
     try {
-        value = JSON.parse(text);
+        value = readStrict(text).value;
     }
     catch (error) {
-        throw new ScopeError(`scope: ${file}: ${error instanceof Error ? error.message : String(error)}`);
+        if (!(error instanceof StrictJSONError)) {
+            throw error;
+        }
+        throw refusal(file, dotted(error.place), locatedFault(text, error));
     }
-    if (!isRecord(value)) {
-        throw new ScopeError(`scope: ${file} is not one JSON object`);
+    const refused = firstRefusal(SCOPE_SCHEMA, value);
+    if (refused !== undefined) {
+        throw refusal(file, dotted(placeIn(value, refused.pointer, refused.member)), refused.reason);
     }
-    checkKeys(text, file);
-    stringMember(value, "workspace", "");
+    const declared = value;
     const documentDir = dirnamePath(absolute);
-    if (!Object.hasOwn(value, "target")) {
-        throw new ScopeError(`scope: ${file} names no target`);
-    }
-    const target = readModule(value["target"], "target", ROLE_TARGET, documentDir);
-    const listed = Object.hasOwn(value, "consumers") ? value["consumers"] : [];
-    if (!Array.isArray(listed)) {
-        throw new ScopeError(`scope: ${file}: consumers is not an array`);
-    }
-    const consumers = listed.map((entry, index) => readModule(entry, `consumers[${String(index)}]`, ROLE_CONSUMER, documentDir));
-    return { target, consumers };
+    const moduleOf = (module) => ({
+        id: module.id ?? "",
+        path: isAbsolutePath(module.path) ? module.path : joinPath(documentDir, module.path),
+    });
+    return { target: moduleOf(declared.target), consumers: (declared.consumers ?? []).map(moduleOf) };
 }
-/** The single-package scope one directory is, when no scope document is given. */
+/**
+ * The single-package scope one directory is, when no scope document is given. A target that is
+ * no directory holds no program.
+ */
 export function scopeForDir(host, dir) {
     const path = resolvePath(host.workingDirectory(), dir);
     const kind = host.kindOf(path);
-    if (kind === "absent") {
-        throw new ScopeError(`scope: ${path} does not exist`);
-    }
     if (kind !== "directory") {
-        throw new ScopeError(`scope: ${path} is not a directory`);
+        throw failureExit("no-program", `the target ${path} ${kind === "absent" ? "does not exist" : "is not a directory"}, so it holds no compiler configuration, no file named ${MARKERS.join(", ")}: name the directory that holds one`);
     }
     return { target: { id: "", path }, consumers: [] };
 }