@hublo/sentinel 1.5.0-alpha.29 → 1.5.0-alpha.30

package/dist/bin/sentinel.js

@@ -15,7 +15,7 @@ import {
   palette,
   registerAdapters,
   resolve
-} from "../chunk-74VJKZ7N.js";
+} from "../chunk-K3UHYGVE.js";
 import {
   resolveContext
 } from "../chunk-HCKUWKF4.js";

package/dist/{chunk-74VJKZ7N.js → chunk-K3UHYGVE.js}

@@ -6052,44 +6052,43 @@ function renderJson(report) {
 `;
 }
 function renderMarkdown(report) {
+  const version = report.settings.find((setting) => setting.key === "sentinel")?.value;
   const places = /* @__PURE__ */ new Map();
   for (const finding of report.findings) {
-    const family = familyOf(finding.metric);
-    if (family !== void 0) places.set(family, (places.get(family) ?? 0) + 1);
+    places.set(finding.metric, (places.get(finding.metric) ?? 0) + 1);
   }
-  const version = report.settings.find((setting) => setting.key === "sentinel")?.value;
-  const present = new Set(report.rows.map((row) => row.metric));
-  const rows = FAMILIES.filter(
-    (family) => family.metrics.some((metric) => present.has(metric)) || places.has(family.label)
-  ).map((family) => {
-    const row = report.rows.find((candidate) => candidate.metric === family.headline);
-    const marker = row?.status === void 0 ? "" : ` (${row.status})`;
-    const shown = row?.unit.split(";")[0] ?? "";
-    const unit = shown === "" ? "" : `${shown.startsWith("%") ? "" : " "}${shown}`;
-    const value = row === void 0 ? "--" : `${figure(row)}${unit}${marker}`;
-    const label = helpFor(family.headline)?.label ?? family.label;
-    return `| ${label} | ${value} | ${places.get(family.label) ?? 0} |`;
-  });
-  const notes = report.notes.length === 0 ? "" : `
-${report.notes.map((note) => `- ${note.split(". ")[0] ?? note}`).join("\n")}
-`;
+  const figureLine = (row) => {
+    const help = helpFor(row.metric);
+    const label = help?.label ?? row.metric;
+    const VERDICT = { ok: "ok", near: "near", exceed: "exceeds" };
+    const mark = row.status === void 0 ? "" : ` **${VERDICT[row.status] ?? row.status}**`;
+    const unit = row.unit === "" ? "" : `${row.unit.startsWith("%") ? "" : " "}${row.unit}`;
+    const count = places.get(row.metric) ?? 0;
+    const found = count === 0 ? "" : ` \xB7 ${count} ${count === 1 ? "place" : "places"}`;
+    const line = `**${label}** \xB7 ${figure(row)}${mark}${unit}${found}`;
+    return help?.fix === void 0 ? [line, ""] : [line, `> **What to do.** ${help.fix}`, ""];
+  };
+  const byLabel = byFamily(report.rows);
+  const families = [
+    ...byLabel.filter((family) => family.label === "Bundle"),
+    ...byLabel.filter((family) => family.label !== "Bundle")
+  ].flatMap((family) => [`##### ${family.label}`, "", ...family.rows.flatMap(figureLine)]);
+  const notes = report.notes.length === 0 ? [] : ["", ...report.notes.map((note) => `- ${note.split(". ")[0] ?? note}`)];
   return [
     `#### \`${report.module}\``,
     "",
-    // "in this family" and not "to look", because the count is the family's and the label on its
-    // left is one figure of it: 51 complexity places sit beside the worst function, not under it.
-    "| | Figure | Places in this family |",
-    "| --- | --- | --- |",
-    ...rows,
-    notes,
+    summaryText(report),
+    ...notes,
+    "",
+    ...families,
     "> Measured on this branch and **not compared with `main`**. No figure here refuses anything.",
-    "> `(ok)` or `(exceed)` is where a figure sits against a PUBLISHED reference; a figure with no",
-    "> marker has none, which is a decision and not a gap. A file breaching several rules counts",
-    "> once per rule. The code behind every place is in the `static-analysis.html` artifact.",
+    "> **ok**, **near** or **exceeds** is where a figure sits against a PUBLISHED reference; a",
+    "> figure with no verdict has none, which is a decision and not a gap. A file breaching several",
+    "> rules counts once per rule. The code behind every place, and the drawing of the import",
+    "> graph, are in the `static-analysis.html` the artifact carries.",
     // ⭐ The version that produced these numbers, because the thresholds a module cannot override
     // live in the tool: nine gauge limits, the complexity bands, the bundle budgets. Two recaps
     // from two versions are not comparable, and without this nothing on the comment would say so.
-    // Read from the settings the report already carries rather than from the package a second time.
     ...version === void 0 ? [] : [`> Measured by sentinel ${version}.`],
     ""
   ].join("\n");
@@ -6277,18 +6276,23 @@ function grouped(count) {
   if (!Number.isInteger(count)) return String(count);
   return String(count).replace(/\B(?=(\d{3})+(?!\d))/g, "\u202F");
 }
-function summaryLine(report) {
+function summaryParts(report, bold) {
   const withReference = report.rows.filter((row) => row.status !== void 0);
   const above = withReference.filter((row) => row.status === "exceed").length;
   const findings = report.findings ?? [];
   const inTests = findings.filter((finding) => finding.metric === "clonesTests").length;
   const inProduct = findings.length - inTests;
-  const parts = [
-    withReference.length === 0 ? "No figure here has a published reference" : `<b>${above} of ${withReference.length}</b> figures with a published reference are above it`,
-    `<b>${grouped(inProduct)}</b> places in product code`,
-    ...inTests === 0 ? [] : [`<b>${grouped(inTests)}</b> clones in tests`]
+  return [
+    withReference.length === 0 ? "No figure here has a published reference" : `${bold(`${above} of ${withReference.length}`)} figures with a published reference are above it`,
+    `${bold(grouped(inProduct))} places in product code`,
+    ...inTests === 0 ? [] : [`${bold(grouped(inTests))} clones in tests`]
   ];
-  return parts.join(" &middot; ");
+}
+function summaryLine(report) {
+  return summaryParts(report, (text) => `<b>${text}</b>`).join(" &middot; ");
+}
+function summaryText(report) {
+  return summaryParts(report, (text) => `**${text}**`).join(" \xB7 ");
 }
 function populationsLine(report) {
   const of = (metric) => {

package/dist/index.js

@@ -6,7 +6,7 @@ import {
   registerAdapters,
   resolve,
   setDefaultRunner
-} from "./chunk-74VJKZ7N.js";
+} from "./chunk-K3UHYGVE.js";
 import {
   BaseAdapter
 } from "./chunk-HCKUWKF4.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hublo/sentinel",
-  "version": "1.5.0-alpha.29",
+  "version": "1.5.0-alpha.30",
   "description": "One CLI that guards code health across Hublo repos: shared lint/typescript/build/test presets, static & dynamic analysis, and architecture checks.",
   "type": "module",
   "license": "MIT",