@cplieger/deadset-ts 8.0.0-dev.5 → 8.0.0-dev.7

package/src/report.ts

@@ -4,7 +4,9 @@
  * renders this document, so no two renderings disagree about which findings exist.
  */
 
-import type { Severity, Sort, TargetKind } from "./config.ts";
+import { SCHEMA_VERSION, SCHEMA_VERSIONS } from "./contract/contract.generated.ts";
+import type * as wire from "./contract/report.generated.ts";
+import type { Sort, TargetKind } from "./config.ts";
 import type { Conformance, DeclaredGap } from "./conformance.ts";
 import type { EdgeEvaluation } from "./edges.ts";
 import type {
@@ -17,134 +19,8 @@ import type { AppliedConvention } from "./conventions.ts";
 import type { PassResult } from "./findings-pass.ts";
 import type { StaleSuppression } from "./findings/self-check.ts";
 import type { TestFileRule } from "./references.ts";
-
-/** The version of the report schema this analyzer writes a report to. */
-const SCHEMA_VERSION = "9.0.0";
-
-/** Every report schema version this analyzer reads: the one the Contract it implements admits. */
-export const SCHEMA_VERSIONS_ACCEPTED: readonly string[] = [SCHEMA_VERSION];
-
-/** The name this analyzer writes every document under and mints every identifier with. */
-export const ANALYZER_NAME = "deadset-ts";
-
-/** The language this analyzer claims. */
-export const LANGUAGE = "ts";
-
-interface WirePosition {
-  readonly path: string;
-  readonly line: number;
-  readonly column: number;
-  readonly end_line: number;
-}
-
-interface WireDetails {
-  readonly narrower_visibility?: string;
-  readonly implementations?: readonly {
-    readonly ref: string;
-    readonly name: string;
-    readonly position: WirePosition;
-  }[];
-  readonly write_positions?: readonly WirePosition[];
-  /** Set under the name-literal rule, which no finding of this analyzer meets; SARIF still maps it. */
-  readonly name_literal?: WirePosition;
-  readonly dependency_class?: string;
-  readonly mechanism?: string;
-  readonly entry?: {
-    readonly code: string;
-    readonly symbol?: string;
-    readonly path?: string;
-    readonly reason?: string;
-  };
-  readonly overlap?: readonly string[];
-  readonly removes_last_use_of?: readonly string[];
-}
-
-/** One finding as the finding schema spells it. */
-export interface WireFinding {
-  readonly code: string;
-  readonly kind: string;
-  readonly language: string;
-  readonly position: WirePosition;
-  readonly symbol: {
-    readonly ref: string;
-    readonly kind: string;
-    readonly name: string;
-    readonly size_lines: number;
-  };
-  readonly reachability_class: string;
-  readonly confidence: string;
-  readonly liveness_relation?: string;
-  readonly test_only: boolean;
-  readonly generated: boolean;
-  readonly component: {
-    readonly id: string;
-    readonly root: boolean;
-    readonly symbol_count: number;
-    readonly deletable_lines: number;
-  };
-  readonly retained_by: readonly string[];
-  readonly configurations: readonly string[];
-  readonly consumers_loaded: readonly string[];
-  readonly fixability: string;
-  readonly severity: Severity;
-  readonly message: string;
-  readonly details: WireDetails;
-}
-
-/** One dead component a finding names, with its members, as the report lists it once. */
-export interface WireComponent {
-  readonly id: string;
-  readonly members: readonly {
-    readonly ref: string;
-    readonly name: string;
-    readonly position: WirePosition;
-  }[];
-}
-
-interface WireEdgeEvaluation {
-  readonly edge: string;
-  readonly side: string;
-  readonly symbol: string;
-  readonly state: string;
-  readonly finding?: WireFinding;
-}
-
-export interface WireStaleSuppression {
-  readonly code: string;
-  readonly mechanism: string;
-  readonly entry: {
-    readonly code: string;
-    readonly symbol?: string;
-    readonly path: string;
-    readonly reason: string;
-  };
-  readonly position: { readonly path: string; readonly line: number; readonly column: number };
-  readonly symbol: string;
-  readonly message: string;
-}
-
-interface WireDeclaredGap {
-  readonly fixture: string;
-  readonly symbol?: string;
-  readonly capability: string;
-  readonly reason: string;
-}
-
-export interface WireTotals {
-  readonly findings: number;
-  readonly by_severity: { readonly allow: number; readonly warn: number; readonly deny: number };
-  readonly deletable_lines: number;
-  readonly suppressions_in_effect: number;
-  readonly reasons_recorded: number;
-  readonly stale_suppressions: number;
-  readonly pending: number;
-  readonly omitted: number;
-  readonly withheld: {
-    readonly certain: number;
-    readonly probable: number;
-    readonly possible: number;
-  };
-}
+import { bytewise } from "./text/compare.ts";
+import { LANGUAGE, PRODUCT } from "./product.ts";
 
 /** One project configuration of the matrix a run analyzed. */
 export interface ReportConfiguration {
@@ -191,52 +67,6 @@ interface UnavailableConsumer {
   readonly reason: string;
 }
 
-/** The report document. */
-export interface Report {
-  readonly schema_version: string;
-  readonly contract_version: string;
-  readonly analyzer: {
-    readonly name: string;
-    readonly version: string;
-    readonly languages: readonly string[];
-    readonly schema_versions_accepted: readonly string[];
-    readonly conformance: {
-      readonly corpus_version: string;
-      readonly result: string;
-      readonly digest: string;
-    };
-  };
-  readonly target: { readonly kind: TargetKind; readonly root: string; readonly identity: string };
-  readonly configurations: readonly ReportConfiguration[];
-  readonly configurations_not_built: readonly ReportNotBuilt[];
-  readonly consumers: {
-    readonly declared: number;
-    readonly loaded: readonly {
-      readonly id: string;
-      readonly role: "consumer";
-      readonly path: string;
-    }[];
-    readonly unavailable: readonly {
-      readonly id: string;
-      readonly role: "consumer";
-      readonly reason: string;
-    }[];
-  };
-  readonly findings: readonly WireFinding[];
-  /** Present where the run lists each component in full. */
-  readonly components?: readonly WireComponent[];
-  readonly edge_evaluations: readonly WireEdgeEvaluation[];
-  readonly stale_suppressions: readonly WireStaleSuppression[];
-  readonly declared_gaps: readonly WireDeclaredGap[];
-  readonly excluded_by_cgo: readonly never[];
-  readonly test_file_rules: readonly TestFileRule[];
-  readonly type_error_skips: readonly TypeErrorSkip[];
-  readonly notes: readonly ReportNote[];
-  readonly unanswered_questions: readonly UnansweredCount[];
-  readonly conventions_applied: readonly AppliedConvention[];
-  readonly totals: WireTotals;
-}
-
 /** One hint about the run's setup, as the report schema's `notes` spells it. */
 export type ReportNote =
   | {
@@ -282,27 +112,22 @@ export interface ReportInput {
  * sorted, then the edge evaluations' findings.
  */
 function componentsOf(
-  findings: readonly (readonly [WireFinding, CompletedFinding])[],
-): readonly WireComponent[] {
-  const listed = new Map<string, WireComponent>();
-  for (const [wire, finding] of findings) {
+  findings: readonly (readonly [wire.Finding, CompletedFinding])[],
+): readonly wire.ComponentsEntry[] {
+  const listed = new Map<string, wire.ComponentsEntry>();
+  for (const [written, finding] of findings) {
     const { members } = finding.component;
-    if (members !== undefined && !listed.has(wire.component.id)) {
-      listed.set(wire.component.id, { id: wire.component.id, members: members.map(wireSymbol) });
+    if (members !== undefined && !listed.has(written.component.id)) {
+      listed.set(written.component.id, {
+        id: written.component.id,
+        members: members.map(wireSymbol),
+      });
     }
   }
   return [...listed.values()];
 }
 
-/** Two strings ordered bytewise. */
-function compare(a: string, b: string): number {
-  if (a === b) {
-    return 0;
-  }
-  return a < b ? -1 : 1;
-}
-
-function wirePosition(position: FindingPosition): WirePosition {
+function wirePosition(position: FindingPosition): wire.Position {
   return {
     path: position.path,
     line: position.line,
@@ -314,13 +139,13 @@ function wirePosition(position: FindingPosition): WirePosition {
 function wireSymbol(symbol: PositionedSymbol): {
   ref: string;
   name: string;
-  position: WirePosition;
+  position: wire.Position;
 } {
   return { ref: symbol.ref, name: symbol.name, position: wirePosition(symbol.position) };
 }
 
 /** The details one code carries, in the order the finding schema lists them. */
-function wireDetails(details: FindingDetails): WireDetails {
+function wireDetails(details: FindingDetails): wire.Details {
   const { entry } = details;
   return {
     ...(details.narrowerVisibility === undefined
@@ -352,7 +177,7 @@ function wireDetails(details: FindingDetails): WireDetails {
 }
 
 /** One finding as the finding schema spells it, member for member in its order. */
-export function wireFinding(finding: CompletedFinding): WireFinding {
+export function wireFinding(finding: CompletedFinding): wire.Finding {
   return {
     code: finding.code,
     kind: finding.kind,
@@ -387,7 +212,7 @@ export function wireFinding(finding: CompletedFinding): WireFinding {
   };
 }
 
-function wireEvaluation(evaluation: EdgeEvaluation<CompletedFinding>): WireEdgeEvaluation {
+function wireEvaluation(evaluation: EdgeEvaluation<CompletedFinding>): wire.EdgeEvaluationsEntry {
   return {
     edge: evaluation.edge,
     side: evaluation.side,
@@ -397,7 +222,7 @@ function wireEvaluation(evaluation: EdgeEvaluation<CompletedFinding>): WireEdgeE
   };
 }
 
-function wireStale(stale: StaleSuppression): WireStaleSuppression {
+function wireStale(stale: StaleSuppression): wire.StaleSuppressionsEntry {
   return {
     code: stale.code,
     mechanism: stale.mechanism,
@@ -418,29 +243,29 @@ function wireStale(stale: StaleSuppression): WireStaleSuppression {
 }
 
 /** The canonical key over two findings: path, line, column, code, then the symbol reference. */
-function canonical(a: WireFinding, b: WireFinding): number {
+function canonical(a: wire.Finding, b: wire.Finding): number {
   return (
-    compare(a.position.path, b.position.path) ||
+    bytewise(a.position.path, b.position.path) ||
     a.position.line - b.position.line ||
     a.position.column - b.position.column ||
-    compare(a.code, b.code) ||
-    compare(a.symbol.ref, b.symbol.ref)
+    bytewise(a.code, b.code) ||
+    bytewise(a.symbol.ref, b.symbol.ref)
   );
 }
 
 /** The canonical key over two stale suppressions, each component from the record's own member. */
-function canonicalStale(a: WireStaleSuppression, b: WireStaleSuppression): number {
+function canonicalStale(a: wire.StaleSuppressionsEntry, b: wire.StaleSuppressionsEntry): number {
   return (
-    compare(a.position.path, b.position.path) ||
+    bytewise(a.position.path, b.position.path) ||
     a.position.line - b.position.line ||
     a.position.column - b.position.column ||
-    compare(a.code, b.code) ||
-    compare(a.symbol, b.symbol)
+    bytewise(a.code, b.code) ||
+    bytewise(a.symbol, b.symbol)
   );
 }
 
 /** One declared gap as a report carries it, its members in the schema's order. */
-function wireGap(gap: DeclaredGap): WireDeclaredGap {
+function wireGap(gap: DeclaredGap): wire.DeclaredGapsEntry {
   return {
     fixture: gap.fixture,
     ...(gap.symbol === undefined ? {} : { symbol: gap.symbol }),
@@ -450,11 +275,11 @@ function wireGap(gap: DeclaredGap): WireDeclaredGap {
 }
 
 /** Edge evaluations by edge, then side, then their compact encodings. */
-function byEdge(a: WireEdgeEvaluation, b: WireEdgeEvaluation): number {
+function byEdge(a: wire.EdgeEvaluationsEntry, b: wire.EdgeEvaluationsEntry): number {
   return (
-    compare(a.edge, b.edge) ||
-    compare(a.side, b.side) ||
-    compare(JSON.stringify(a), JSON.stringify(b))
+    bytewise(a.edge, b.edge) ||
+    bytewise(a.side, b.side) ||
+    bytewise(JSON.stringify(a), JSON.stringify(b))
   );
 }
 
@@ -462,7 +287,7 @@ function byEdge(a: WireEdgeEvaluation, b: WireEdgeEvaluation): number {
  * The lines a reader deletes by acting on every finding: each distinct component a root
  * finding names, counted once however many of its roots the findings hold.
  */
-function deletableLines(findings: readonly WireFinding[]): number {
+function deletableLines(findings: readonly wire.Finding[]): number {
   const counted = new Map<string, number>();
   for (const finding of findings) {
     if (finding.component.root) {
@@ -477,7 +302,7 @@ function deletableLines(findings: readonly WireFinding[]): number {
 }
 
 /** The totals of one finding set, counted over the whole set. */
-function totalsOf(findings: readonly WireFinding[], result: PassResult): WireTotals {
+function totalsOf(findings: readonly wire.Finding[], result: PassResult): wire.Totals {
   const bySeverity = { allow: 0, warn: 0, deny: 0 };
   for (const finding of findings) {
     bySeverity[finding.severity] += 1;
@@ -500,7 +325,7 @@ function totalsOf(findings: readonly WireFinding[], result: PassResult): WireTot
 }
 
 /** Builds the report of one run, every array in the order the Contract fixes for it. */
-export function buildReport(input: ReportInput): Report {
+export function buildReport(input: ReportInput): wire.Report {
   const paired = input.result.findings
     .map((finding) => [wireFinding(finding), finding] as const)
     .sort(([a], [b]) => canonical(a, b));
@@ -509,19 +334,19 @@ export function buildReport(input: ReportInput): Report {
     one.finding === undefined ? [] : [[wireFinding(one.finding), one.finding] as const],
   );
   const unavailable = [...new Map(input.unavailable.map((one) => [one.id, one])).values()]
-    .sort((a, b) => compare(a.id, b.id))
+    .sort((a, b) => bytewise(a.id, b.id))
     .map((one) => ({ id: one.id, role: "consumer" as const, reason: one.reason }));
   const loaded = [...input.loaded]
-    .sort((a, b) => compare(a.id, b.id) || compare(a.path, b.path))
+    .sort((a, b) => bytewise(a.id, b.id) || bytewise(a.path, b.path))
     .map((one) => ({ id: one.id, role: "consumer" as const, path: one.path }));
   return {
     schema_version: SCHEMA_VERSION,
     contract_version: input.contractVersion,
     analyzer: {
-      name: ANALYZER_NAME,
+      name: PRODUCT,
       version: input.version,
       languages: [LANGUAGE],
-      schema_versions_accepted: SCHEMA_VERSIONS_ACCEPTED,
+      schema_versions_accepted: SCHEMA_VERSIONS,
       conformance: {
         corpus_version: input.conformance.corpusVersion,
         result: input.conformance.result,
@@ -530,10 +355,10 @@ export function buildReport(input: ReportInput): Report {
     },
     target: { kind: input.target.kind, root: input.target.root, identity: input.target.identity },
     configurations: [...input.configurations]
-      .sort((a, b) => compare(a.id, b.id))
+      .sort((a, b) => bytewise(a.id, b.id))
       .map((one) => ({ id: one.id, project: one.project })),
     configurations_not_built: [...input.notBuilt]
-      .sort((a, b) => compare(a.id, b.id))
+      .sort((a, b) => bytewise(a.id, b.id))
       .map((one) => ({ id: one.id, project: one.project, error: one.error })),
     consumers: { declared: loaded.length + unavailable.length, loaded, unavailable },
     findings,
@@ -546,10 +371,10 @@ export function buildReport(input: ReportInput): Report {
     // name, so the compact encodings alone order them.
     declared_gaps: input.declaredGaps
       .map(wireGap)
-      .sort((a, b) => compare(JSON.stringify(a), JSON.stringify(b))),
+      .sort((a, b) => bytewise(JSON.stringify(a), JSON.stringify(b))),
     excluded_by_cgo: [],
     test_file_rules: [...input.testFileRules]
-      .sort((a, b) => compare(a.rule, b.rule) || a.matched - b.matched)
+      .sort((a, b) => bytewise(a.rule, b.rule) || a.matched - b.matched)
       .map((one) => ({ rule: one.rule, matched: one.matched })),
     type_error_skips: [
       ...new Map(
@@ -559,16 +384,18 @@ export function buildReport(input: ReportInput): Report {
         }),
       ),
     ]
-      .sort(([a, x], [b, y]) => compare(x.path, y.path) || x.line - y.line || compare(a, b))
+      .sort(([a, x], [b, y]) => bytewise(x.path, y.path) || x.line - y.line || bytewise(a, b))
       .map(([, skip]) => skip),
     notes: [...new Map((input.notes ?? []).map((one) => [JSON.stringify(one), one])).entries()]
-      .sort(([a, x], [b, y]) => compare(x.kind, y.kind) || compare(x.path, y.path) || compare(a, b))
+      .sort(
+        ([a, x], [b, y]) => bytewise(x.kind, y.kind) || bytewise(x.path, y.path) || bytewise(a, b),
+      )
       .map(([, note]) => note),
     unanswered_questions: [...input.unanswered]
       .sort(
         (a, b) =>
-          compare(a.configuration, b.configuration) ||
-          compare(JSON.stringify(a), JSON.stringify(b)),
+          bytewise(a.configuration, b.configuration) ||
+          bytewise(JSON.stringify(a), JSON.stringify(b)),
       )
       .map((one) => ({
         configuration: one.configuration,
@@ -590,8 +417,8 @@ export function buildReport(input: ReportInput): Report {
  * whose component a deletion shrinks more comes first, then one whose subject is larger,
  * then the canonical key, so the order stays total; by position it is the canonical key.
  */
-export function sortFindings(report: Report, by: Sort): Report {
-  const bySize = (a: WireFinding, b: WireFinding): number =>
+export function sortFindings(report: wire.Report, by: Sort): wire.Report {
+  const bySize = (a: wire.Finding, b: wire.Finding): number =>
     b.component.deletable_lines - a.component.deletable_lines ||
     b.symbol.size_lines - a.symbol.size_lines ||
     canonical(a, b);
@@ -599,16 +426,26 @@ export function sortFindings(report: Report, by: Sort): Report {
 }
 
 /**
- * The report holding the first `most` findings of its order, the rest counted as omitted.
- * Every other total keeps describing the whole set. Zero keeps every finding.
+ * The report holding the first `most` findings of its order, the rest counted as omitted,
+ * and listing only the components those findings name. Every other total keeps describing
+ * the whole set. Zero keeps every finding.
  */
-export function capFindings(report: Report, most: number): Report {
+export function capFindings(report: wire.Report, most: number): wire.Report {
   if (most <= 0 || report.findings.length <= most) {
     return report;
   }
+  const findings = report.findings.slice(0, most);
+  const named = new Set(
+    [...findings, ...report.edge_evaluations.flatMap((one) => one.finding ?? [])].map(
+      (finding) => finding.component.id,
+    ),
+  );
   return {
     ...report,
-    findings: report.findings.slice(0, most),
+    findings,
+    ...(report.components === undefined
+      ? {}
+      : { components: report.components.filter((listed) => named.has(listed.id)) }),
     totals: { ...report.totals, omitted: report.findings.length - most },
   };
 }

package/src/reporters/annotations.ts

@@ -1,7 +1,7 @@
-import type { Severity } from "../config.ts";
+import type { Severity } from "../contract/contract.generated.ts";
 import { coalesced } from "../json-chunks.ts";
 import { KINDS } from "../kinds.ts";
-import type { Report } from "../report.ts";
+import type { Report } from "../contract/report.generated.ts";
 
 /** The escapes a workflow command's message needs, so a line break does not end the command. */
 const DATA_ESCAPES: Readonly<Record<string, string>> = { "%": "%25", "\r": "%0D", "\n": "%0A" };

package/src/reporters/json.ts

@@ -1,5 +1,5 @@
 import { jsonChunks } from "../json-chunks.ts";
-import type { Report } from "../report.ts";
+import type { Report } from "../contract/report.generated.ts";
 
 /** The indentation of the report document, which with the schema's member order fixes its bytes. */
 const INDENT = 2;

package/src/reporters/reporter.ts

@@ -1,5 +1,5 @@
-import type { Format } from "../config.ts";
-import type { Report } from "../report.ts";
+import type { Format } from "../contract/contract.generated.ts";
+import type { Report } from "../contract/report.generated.ts";
 import type { Template } from "./template.ts";
 
 /** What a rendering reads beside the report. */

package/src/reporters/reporters.ts

@@ -1,4 +1,4 @@
-import type { Format } from "../config.ts";
+import type { Format } from "../contract/contract.generated.ts";
 import { annotations } from "./annotations.ts";
 import { json } from "./json.ts";
 import { RenderError, type Rendering, type Renderings } from "./reporter.ts";

package/src/reporters/sarif.ts

@@ -1,12 +1,19 @@
-import type { Confidence, Severity } from "../config.ts";
 import { jsonChunks } from "../json-chunks.ts";
-import { KINDS, type KindRow } from "../kinds.ts";
+import type { KindRow, Confidence, Severity } from "../contract/contract.generated.ts";
+import { KINDS } from "../kinds.ts";
 import { declarationKey } from "../ref.ts";
-import type { Report, WireComponent, WireFinding, WireStaleSuppression } from "../report.ts";
+import type {
+  ComponentsEntry,
+  Finding,
+  Report,
+  StaleSuppressionsEntry,
+} from "../contract/report.generated.ts";
 import { lineHashes, symbolFingerprint } from "./fingerprint.ts";
 import { RenderError, type RenderOptions } from "./reporter.ts";
 import { utf8Bytes } from "./sha256.ts";
 import { withheldLine } from "./text.ts";
+import { bytewise } from "../text/compare.ts";
+import { message } from "../product.ts";
 
 const SCHEMA =
   "https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json";
@@ -128,9 +135,7 @@ function lineHashCache(read: (path: string) => string): (at: Located) => string
       try {
         text = read(at.path);
       } catch (error: unknown) {
-        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);
@@ -152,10 +157,10 @@ interface Related {
 }
 
 /** The members the report lists for one component, none where it lists none. */
-type MembersOf = (id: string) => WireComponent["members"];
+type MembersOf = (id: string) => ComponentsEntry["members"];
 
 /** Every position a finding names beyond its own, in the mapping's order, the first hundred. */
-function relatedOf(found: WireFinding, members: MembersOf): readonly Related[] {
+function relatedOf(found: Finding, members: MembersOf): readonly Related[] {
   const related: Related[] = [];
   for (const one of found.details.implementations ?? []) {
     related.push({ label: "implementation", at: one.position, endLine: one.position.end_line });
@@ -192,7 +197,7 @@ function messageWithLinks(message: string, related: readonly Related[]): string
 
 /** Every member of the finding the mapping places nowhere else, under its schema name. */
 /** A result's member bag, its component holding the members the report lists for it once. */
-function propertiesOf(found: WireFinding, members: MembersOf): Record<string, unknown> {
+function propertiesOf(found: Finding, members: MembersOf): Record<string, unknown> {
   const listed = members(found.component.id);
   return {
     language: found.language,
@@ -222,7 +227,7 @@ function ruleIndex(index: ReadonlyMap<string, number>, code: string): number {
 }
 
 function findingResult(
-  found: WireFinding,
+  found: Finding,
   index: ReadonlyMap<string, number>,
   hashOf: (at: Located) => string,
   members: MembersOf,
@@ -253,7 +258,7 @@ function findingResult(
 
 /** A stale suppression at the failing level, at its own site; it is no finding, so it carries no member bag. */
 function staleResult(
-  stale: WireStaleSuppression,
+  stale: StaleSuppressionsEntry,
   index: ReadonlyMap<string, number>,
   hashOf: (at: Located) => string,
 ): Record<string, unknown> {
@@ -287,7 +292,7 @@ export function sarif(report: Report, options: RenderOptions): Iterable<string>
     ...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/src/reporters/template.ts

@@ -10,6 +10,7 @@
 import { CHUNK_LENGTH } from "../json-chunks.ts";
 import { RenderError } from "./reporter.ts";
 import { utf8Bytes } from "./sha256.ts";
+import { bytewise } from "../text/compare.ts";
 
 /** A template that does not parse, which refuses the invocation before any analysis. */
 export class TemplateError extends Error {
@@ -618,7 +619,7 @@ function formatted(value: Value, nested: boolean): string {
   }
   const object: ValueObject = value;
   const entries = Object.keys(object)
-    .sort()
+    .sort(bytewise)
     .map((key) => `${key}:${formatted(object[key] ?? null, true)}`);
   return `map[${entries.join(" ")}]`;
 }
@@ -647,28 +648,11 @@ function compareBasic(name: string, a: Value, b: Value): number {
     return Number.NaN;
   }
   if (kind === "string") {
-    return byCodePoints(a as string, b as string);
+    return bytewise(a as string, b as string);
   }
   return (a as number) < (b as number) ? -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: string, b: string): number {
-  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: Readonly<Record<string, string>> = {
   '"': '\\"',
@@ -1022,7 +1006,7 @@ class Execution {
         entries = value.map((one, i) => [i, one]);
       } else if (isObject(value)) {
         entries = Object.keys(value)
-          .sort()
+          .sort(bytewise)
           .map((key) => [key, value[key] ?? null]);
       } else {
         throw new RenderError(`range cannot iterate over a ${kindOf(value)}`);

package/src/reporters/text.ts

@@ -1,5 +1,5 @@
 import { coalesced } from "../json-chunks.ts";
-import type { Report, WireTotals } from "../report.ts";
+import type { Report, Totals } from "../contract/report.generated.ts";
 
 /** The kind token and the confidence a stale suppression is rendered with, both fixed. */
 const STALE_KIND = "suppression";
@@ -11,7 +11,7 @@ function counted(n: number, one: string, many: string): string {
 }
 
 /** The report's totals in one line, in the order the report declares them. */
-function summary(totals: WireTotals): string {
+function summary(totals: Totals): string {
   const { allow, warn, deny } = totals.by_severity;
   return [
     `summary: ${counted(totals.findings, "finding", "findings")} (${String(allow)} allow, ${String(warn)} warn, ${String(deny)} deny)`,
@@ -31,7 +31,7 @@ const WITHHELD_ORDER = ["probable", "possible"] as const;
  * The line naming what the minimum confidence withheld and the setting that shows it all,
  * or undefined where it withheld nothing.
  */
-export function withheldLine(totals: WireTotals): string | undefined {
+export function withheldLine(totals: Totals): string | undefined {
   const named = WITHHELD_ORDER.filter((confidence) => totals.withheld[confidence] > 0);
   const lowest = named.at(-1);
   if (lowest === undefined) {