@drkmttr/adhere 0.6.1 → 0.7.0

package/src/workflows/audit.ts

@@ -1,4 +1,4 @@
-import type { Rule, RuleId } from "#config.ts";
+import { type Examples, examplesOf, type Rule, type RuleId } from "#config.ts";
 import type { ScannedFile, WalkUnavailable } from "#models/Audit.ts";
 import { AdhereConfig } from "#services/AdhereConfig.ts";
 import { AuditCache, type Judgment, sha256 } from "#services/AuditCache.ts";
@@ -18,8 +18,7 @@ import { type Crypto, Effect, Record } from "effect";
 export interface Finding {
   readonly rule: RuleId;
   readonly description: string;
-  readonly reference?: string;
-  readonly avoid?: string;
+  readonly examples: Examples;
   readonly file: string;
   readonly line: number;
   readonly snippet: string;
@@ -233,8 +232,7 @@ export const executeAudit = (
                 {
                   rule: id,
                   description: k.rule.description,
-                  reference: k.rule.reference,
-                  avoid: k.rule.avoid,
+                  examples: examplesOf(k.rule),
                   file: file.path,
                   line: judgment.line,
                   snippet: judgment.snippet ?? "",

package/src/workflows/format.ts

@@ -97,16 +97,20 @@ const excerpt = (finding: Finding, root: string | undefined): ReadonlyArray<Line
   ];
 };
 
-/** The reference as the hint. A rule without one shows its code to avoid instead, labeled so. */
+/**
+ * The code to write as the hint. A rule with only code not to write shows
+ * that instead, labeled with its word: `never`, or `should not`.
+ */
 const hint = (finding: Finding): ReadonlyArray<Line> => {
+  const { good, bad } = finding.examples;
   const [label, code] =
-    finding.reference === undefined ? ["avoid", finding.avoid ?? ""] : ["hint", finding.reference];
+    good === undefined ? [bad?.word ?? "hint", bad?.code ?? ""] : ["hint", good.code];
   return hanging(span(`  ${label}: `, "label"), codeLines(code));
 };
 
 /**
  * One diagnostic, in the frame `vp lint` prints on a terminal: a red header,
- * the offending line, a pink underline, and the reference code as the hint.
+ * the offending line, a pink underline, and the code to write as the hint.
  */
 const frame = (finding: Finding, root: string | undefined): ReadonlyArray<Line> => [
   header(finding),