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

package/dist/src/reporters/annotations.js

@@ -1,4 +1,3 @@
-import { fails } from "../config.js";
 import { coalesced } from "../json-chunks.js";
 import { KINDS } from "../kinds.js";
 /** The escapes a workflow command's message needs, so a line break does not end the command. */
@@ -19,6 +18,12 @@ function escapeProperty(value) {
 function kindName(code) {
     return KINDS.get(code)?.name ?? code;
 }
+/** The command each finding severity is annotated with, whatever the failing severity. */
+const LEVELS = {
+    deny: "error",
+    warn: "warning",
+    allow: "notice",
+};
 function command(level, at, endLine, title, message) {
     return `::${level} file=${escapeProperty(at.path)},line=${String(at.line)},col=${String(at.column)},endLine=${String(endLine)},title=${escapeProperty(title)}::${escapeData(message)}`;
 }
@@ -26,16 +31,15 @@ function command(level, at, endLine, title, message) {
 const SKIP_TITLE = "type error skipped";
 const SKIP_MESSAGE = "the analysis did not evaluate the function or statement holding this type error: ";
 /**
- * One workflow annotation per finding, then one per stale suppression, each naming its
- * file, line, column and last line, titled by its code and kind, then one warning per
- * type-error skip naming its file and line. A finding at or above the failing severity is
- * an error and one below it a warning; a stale suppression is an error, because its kind
- * is fixed on at the failing severity.
+ * The annotations `contract/grammar/annotations.md` states: one per finding, at the
+ * command its severity names, and one error per stale suppression, each naming its file,
+ * line, column and last line and titled by its code and kind; then one warning per
+ * type-error skip naming its file and line, and one per note naming its directory.
  */
-export function annotations(report, options) {
+export function annotations(report) {
     return coalesced((function* lines() {
         for (const found of report.findings) {
-            yield `${command(fails(found.severity, options.failOn) ? "error" : "warning", found.position, found.position.end_line, `${found.code} ${found.kind}`, found.message)}\n`;
+            yield `${command(LEVELS[found.severity], found.position, found.position.end_line, `${found.code} ${found.kind}`, found.message)}\n`;
         }
         for (const stale of report.stale_suppressions) {
             yield `${command("error", stale.position, stale.position.line, `${stale.code} ${kindName(stale.code)}`, stale.message)}\n`;
@@ -43,5 +47,8 @@ export function annotations(report, options) {
         for (const skip of report.type_error_skips) {
             yield `::warning file=${escapeProperty(skip.path)},line=${String(skip.line)},title=${escapeProperty(SKIP_TITLE)}::${escapeData(SKIP_MESSAGE + skip.message)}\n`;
         }
+        for (const note of report.notes) {
+            yield `::warning file=${escapeProperty(note.path)},title=${escapeProperty(note.kind)}::${escapeData(note.message)}\n`;
+        }
     })());
 }

package/dist/src/reporters/sarif.js

@@ -5,6 +5,8 @@ import { lineHashes, symbolFingerprint } from "./fingerprint.js";
 import { RenderError } from "./reporter.js";
 import { utf8Bytes } from "./sha256.js";
 import { withheldLine } from "./text.js";
+import { bytewise } from "../text/compare.js";
+import { message } from "../product.js";
 const SCHEMA = "https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json";
 const VERSION = "2.1.0";
 /** The unit a finding's column counts. */
@@ -101,7 +103,7 @@ function lineHashCache(read) {
                 text = read(at.path);
             }
             catch (error) {
-                throw new RenderError(`read ${at.path} for its line fingerprint: ${error instanceof Error ? error.message : String(error)}`);
+                throw new RenderError(`read ${at.path} for its line fingerprint: ${message(error)}`);
             }
             hashes = lineHashes(text);
             held.set(at.path, hashes);
@@ -114,7 +116,7 @@ function lineHashCache(read) {
     };
 }
 /** Every position a finding names beyond its own, in the mapping's order, the first hundred. */
-function relatedOf(found) {
+function relatedOf(found, members) {
     const related = [];
     for (const one of found.details.implementations ?? []) {
         related.push({ label: "implementation", at: one.position, endLine: one.position.end_line });
@@ -126,7 +128,7 @@ function relatedOf(found) {
         const at = found.details.name_literal;
         related.push({ label: "name", at, endLine: at.end_line });
     }
-    for (const one of found.component.members ?? []) {
+    for (const one of members(found.component.id)) {
         if (declarationKey(one.ref, one.position.path) !==
             declarationKey(found.symbol.ref, found.position.path)) {
             related.push({ label: "member", at: one.position, endLine: one.position.end_line });
@@ -143,7 +145,9 @@ function messageWithLinks(message, related) {
     return `${message} (see ${links.join(", ")})`;
 }
 /** Every member of the finding the mapping places nowhere else, under its schema name. */
-function propertiesOf(found) {
+/** A result's member bag, its component holding the members the report lists for it once. */
+function propertiesOf(found, members) {
+    const listed = members(found.component.id);
     return {
         language: found.language,
         symbol: found.symbol,
@@ -154,7 +158,7 @@ function propertiesOf(found) {
             : { liveness_relation: found.liveness_relation }),
         test_only: found.test_only,
         generated: found.generated,
-        component: found.component,
+        component: listed.length === 0 ? found.component : { ...found.component, members: listed },
         retained_by: found.retained_by,
         configurations: found.configurations,
         consumers_loaded: found.consumers_loaded,
@@ -169,8 +173,8 @@ function ruleIndex(index, code) {
     }
     return at;
 }
-function findingResult(found, index, hashOf) {
-    const related = relatedOf(found);
+function findingResult(found, index, hashOf, members) {
+    const related = relatedOf(found, members);
     return {
         ruleId: found.code,
         ruleIndex: ruleIndex(index, found.code),
@@ -190,7 +194,7 @@ function findingResult(found, index, hashOf) {
             primaryLocationLineHash: hashOf(found.position),
             "deadsetSymbolRef/v1": symbolFingerprint(found.code, found.symbol.ref),
         },
-        properties: propertiesOf(found),
+        properties: propertiesOf(found, members),
     };
 }
 /** A stale suppression at the failing level, at its own site; it is no finding, so it carries no member bag. */
@@ -218,11 +222,13 @@ export function sarif(report, options) {
     const ruleList = rules(kinds);
     const index = new Map(kinds.map((kind, at) => [kind.code, at]));
     const hashOf = lineHashCache(options.readSource);
+    const listed = new Map((report.components ?? []).map((one) => [one.id, one.members]));
+    const members = (id) => listed.get(id) ?? [];
     const results = [
-        ...report.findings.map((found) => findingResult(found, index, hashOf)),
+        ...report.findings.map((found) => findingResult(found, index, hashOf, members)),
         ...report.stale_suppressions.map((stale) => staleResult(stale, index, hashOf)),
     ];
-    const languages = [...report.analyzer.languages].sort().join("+");
+    const languages = [...report.analyzer.languages].sort(bytewise).join("+");
     const withheld = withheldLine(report.totals);
     const log = {
         $schema: SCHEMA,

package/dist/src/reporters/template.js

@@ -9,6 +9,7 @@
 import { CHUNK_LENGTH } from "../json-chunks.js";
 import { RenderError } from "./reporter.js";
 import { utf8Bytes } from "./sha256.js";
+import { bytewise } from "../text/compare.js";
 /** A template that does not parse, which refuses the invocation before any analysis. */
 export class TemplateError extends Error {
     constructor(message) {
@@ -513,7 +514,7 @@ function formatted(value, nested) {
     }
     const object = value;
     const entries = Object.keys(object)
-        .sort()
+        .sort(bytewise)
         .map((key) => `${key}:${formatted(object[key] ?? null, true)}`);
     return `map[${entries.join(" ")}]`;
 }
@@ -538,26 +539,10 @@ function compareBasic(name, a, b) {
         return Number.NaN;
     }
     if (kind === "string") {
-        return byCodePoints(a, b);
+        return bytewise(a, b);
     }
     return a < b ? -1 : 1;
 }
-/**
- * Two strings ordered by the bytes of their UTF-8 encodings, which is the order of their
- * code points: the order of their UTF-16 code units differs above U+FFFF.
- */
-function byCodePoints(a, b) {
-    let at = 0;
-    while (at < a.length && at < b.length) {
-        const x = a.codePointAt(at) ?? 0;
-        const y = b.codePointAt(at) ?? 0;
-        if (x !== y) {
-            return x < y ? -1 : 1;
-        }
-        at += x > 0xffff ? 2 : 1;
-    }
-    return a.length - b.length;
-}
 /** The escapes `%q` writes for the control characters that have one of their own. */
 const QUOTED_ESCAPES = {
     '"': '\\"',
@@ -903,7 +888,7 @@ class Execution {
             }
             else if (isObject(value)) {
                 entries = Object.keys(value)
-                    .sort()
+                    .sort(bytewise)
                     .map((key) => [key, value[key] ?? null]);
             }
             else {