@drkmttr/adhere 0.9.4 → 0.10.0

package/src/workflows/format.ts

@@ -1,4 +1,5 @@
 import { type Kind, tokenize } from "#highlight.ts";
+import { shownId } from "#rules.ts";
 import type { AuditPlan, AuditResult, FileDone, Finding } from "#workflows/audit.ts";
 
 /**
@@ -8,6 +9,7 @@ import type { AuditPlan, AuditResult, FileDone, Finding } from "#workflows/audit
  */
 type Role =
   | "error"
+  | "warning"
   | "probability"
   | "description"
   | "path"
@@ -26,15 +28,16 @@ type Line = ReadonlyArray<Span>;
 /**
  * SGR parameters per role. The frame's are set colors, from the 256-color
  * palette (`38;5;N`) or truecolor (`38;2;R;G;B`), bold with a trailing `;1`,
- * and a dim line number. Of the header, only the `×` and the rule are red,
- * since a whole line of red is hard to read: the probability is an accent, and
- * the description a cool near-white, set here since a theme's own white can
- * be gray. The code's are the terminal's own colors (`3N`), so the user's
- * theme picks shades that read on its background; none is magenta, which
- * would run into the underline.
+ * and a dim line number. Of the header, only the `×` and the rule are red, or
+ * a warning's `⚠` and rule amber, since a whole line of red is hard to read:
+ * the probability is an accent, and the description a cool near-white, set
+ * here since a theme's own white can be gray. The code's are the terminal's
+ * own colors (`3N`), so the user's theme picks shades that read on its
+ * background; none is magenta, which would run into the underline.
  */
 const THEME: Readonly<Record<Role, string>> = {
   error: "38;2;164;20;71;1",
+  warning: "38;2;214;154;0;1",
   probability: "38;5;156",
   description: "38;2;230;230;255",
   path: "38;2;5;125;160;1",
@@ -89,9 +92,9 @@ const counted = (count: number, one: string, many: string): string =>
 
 const header = (finding: Finding): Line => [
   span("  "),
-  span("×", "error"),
+  span(finding.level === "warning" ? "⚠" : "×", finding.level),
   span(" "),
-  span(finding.rule, "error"),
+  span(shownId({ id: finding.rule, preset: finding.preset }), finding.level),
   span(" ("),
   span(finding.probability.toFixed(2), "probability"),
   span("): "),
@@ -151,6 +154,13 @@ const frame = (finding: Finding, root: string | undefined): ReadonlyArray<Line>
   ...hint(finding),
 ];
 
+/** The findings counted by level: `1 error`, or `2 errors and 1 warning` once there are warnings. */
+const found = (findings: ReadonlyArray<Finding>): string => {
+  const warnings = findings.filter((finding) => finding.level === "warning").length;
+  const errors = counted(findings.length - warnings, "error", "errors");
+  return warnings === 0 ? errors : `${errors} and ${counted(warnings, "warning", "warnings")}`;
+};
+
 const summary = (result: AuditResult): ReadonlyArray<Line> => {
   const counts = [
     counted(result.files, "file", "files"),
@@ -159,11 +169,9 @@ const summary = (result: AuditResult): ReadonlyArray<Line> => {
     ...(result.skipped > 0 ? [`${result.skipped} skipped`] : []),
     ...(result.waiting > 0 ? [`${result.waiting} waiting`] : []),
     ...(result.blocked.length > 0 ? [`${result.blocked.length} blocked`] : []),
+    ...(result.suppressed > 0 ? [`${result.suppressed} suppressed`] : []),
   ];
-  return [
-    [span(`Found ${counted(result.findings.length, "error", "errors")}.`)],
-    [span(`${counts.join(", ")}.`)],
-  ];
+  return [[span(`Found ${found(result.findings)}.`)], [span(`${counts.join(", ")}.`)]];
 };
 
 /**
@@ -213,7 +221,7 @@ export const render = (result: AuditResult, options: RenderOptions = {}): Readon
 /** What a run was asked to keep to, for the plan to say. */
 export interface RunLimits {
   readonly filter?: ReadonlyArray<string>;
-  readonly rpm?: number;
+  readonly rpm?: number | undefined;
 }
 
 /** About how long `requests` take at `rpm`: seconds under a minute, minutes past it. */
@@ -224,6 +232,41 @@ const durationAt = (requests: number, rpm: number): string => {
     : counted(Math.round(seconds / 60), "minute", "minutes");
 };
 
+/** A number to one decimal place, without a trailing .0: 3.2, 43. */
+const tenths = (n: number): string => Number(n.toFixed(1)).toLocaleString("en-US");
+
+/** A token count as the plan says it: 612, 41,000, 3.2 million, 43 million, 1.1 billion. */
+const tokensSaid = (tokens: number): string =>
+  tokens >= 1e9
+    ? `${tenths(tokens / 1e9)} billion`
+    : tokens >= 1e6
+      ? `${tenths(tokens / 1e6)} million`
+      : tokens >= 1e3
+        ? (Math.round(tokens / 1e3) * 1e3).toLocaleString("en-US")
+        : tokens.toLocaleString("en-US");
+
+/** An estimated cost as the plan says it: under $0.01, about $0.14, about $1,234. */
+const dollars = (amount: number): string =>
+  amount < 0.01
+    ? "under $0.01"
+    : amount < 100
+      ? `about $${amount.toFixed(2)}`
+      : `about $${Math.round(amount).toLocaleString("en-US")}`;
+
+/** What judging the plan costs at the model's price, when adhere knows it. */
+const costOf = (plan: AuditPlan): number | undefined =>
+  plan.price === undefined ? undefined : (plan.tokens / 1e6) * plan.price;
+
+/** The plan's input tokens and their cost; locating findings comes on top, since it depends on the findings. */
+const costLine = (plan: AuditPlan): string => {
+  const cost = costOf(plan);
+  const priced =
+    cost === undefined || plan.price === undefined
+      ? ""
+      : `: ${dollars(cost)} at $${plan.price} per million`;
+  return `Those carry about ${tokensSaid(plan.tokens)} input tokens${priced}, and more for locating findings.`;
+};
+
 export const describePlan = (plan: AuditPlan, limits: RunLimits = {}): ReadonlyArray<string> => {
   const cached = plan.cached > 0 ? `, ${plan.cached} cached` : "";
   const skipped =
@@ -260,12 +303,16 @@ export const describePlan = (plan: AuditPlan, limits: RunLimits = {}): ReadonlyA
   return [
     found,
     `Judging ${rest} takes ${counted(plan.requests, "request", "requests")} to Jev, plus 1 or more for each file with a finding.${pace}${waiting}`,
+    ...(plan.tokens > 0 ? [costLine(plan)] : []),
   ];
 };
 
 /** The question before a run sends anything. */
-export const sendQuestion = (plan: AuditPlan): string =>
-  `Send ${counted(plan.requests, "request", "requests")} to Jev?`;
+export const sendQuestion = (plan: AuditPlan): string => {
+  const cost = costOf(plan);
+  const priced = cost === undefined || plan.tokens === 0 ? "" : `, ${dollars(cost)}`;
+  return `Send ${counted(plan.requests, "request", "requests")} to Jev${priced}?`;
+};
 
 /** A run's progress so far: every file it finished, with the requests and findings they added up to. */
 export interface Progress {