@hublo/sentinel 1.5.0-alpha.5 → 1.5.0-alpha.6

package/dist/bin/sentinel.js

@@ -15,7 +15,7 @@ import {
   palette,
   registerAdapters,
   resolve
-} from "../chunk-JNXDJ2QD.js";
+} from "../chunk-JJKFLYHK.js";
 import {
   resolveContext
 } from "../chunk-KLEXJFJ6.js";

package/dist/{chunk-JNXDJ2QD.js → chunk-JJKFLYHK.js}

@@ -4806,22 +4806,28 @@ function helpFor(key) {
 }
 
 // src/roles/static-analysis/report.ts
-function hasFinding(report) {
-  return report.rows.some((row) => row.over);
-}
 function renderConsole(report) {
   const lines = [];
   const width = (pick) => Math.max(...report.rows.map((row) => pick(row).length));
   const label = (row) => helpFor(row.metric)?.label ?? row.metric;
   const value = (row) => `${row.value} ${row.unit}`;
-  const limit = (row) => row.threshold === null ? "no threshold" : `max ${row.threshold}${row.moved ? " (module)" : ""}`;
   const labelWidth = width(label);
   const valueWidth = width(value);
   lines.push(`sentinel static-analysis: ${report.module}`);
   for (const row of report.rows) {
-    lines.push(
-      `  ${row.over ? "!" : " "} ${label(row).padEnd(labelWidth)}  ${value(row).padStart(valueWidth)}  ${limit(row)}`
-    );
+    lines.push(`    ${label(row).padEnd(labelWidth)}  ${value(row).padStart(valueWidth)}`);
+  }
+  if (report.settings.length > 0) {
+    const keyWidth = Math.max(...report.settings.map((setting) => setting.key.length));
+    lines.push("", "  measured with");
+    for (const setting of report.settings) {
+      lines.push(
+        `    ${setting.key.padEnd(keyWidth)}  ${setting.value}${setting.moved ? "  (module)" : ""}`
+      );
+    }
+    if (report.settings.some((setting) => setting.moved)) {
+      lines.push(`    (module) = overridden in ${report.module}'s static-analysis.config.mjs`);
+    }
   }
   if (report.byLanguage && Object.keys(report.byLanguage).length > 0) {
     lines.push("", "  per language, where a clone was found");
@@ -4856,13 +4862,19 @@ function escape(text) {
 function renderHtml(report) {
   const rows = report.rows.map((row) => {
     const help = helpFor(row.metric);
-    return `      <tr class="${row.over ? "over" : ""}">
+    return `      <tr>
         <th scope="row">${escape(help?.label ?? row.metric)}</th>
         <td class="num">${escape(String(row.value))} <span class="unit">${escape(row.unit)}</span></td>
-        <td class="num">${row.threshold === null ? '<span class="unit">none</span>' : escape(String(row.threshold))}${row.moved ? ' <span class="moved">module</span>' : ""}</td>
         <td class="caveat">${escape(help?.caveat ?? "")}</td>
       </tr>`;
   }).join("\n");
+  const settings = report.settings.map(
+    (setting) => `      <tr>
+        <th scope="row"><code>${escape(setting.key)}</code></th>
+        <td class="num">${escape(setting.value)}</td>
+        <td>${setting.moved ? '<span class="moved">overridden in this module</span>' : ""}</td>
+      </tr>`
+  ).join("\n");
   return `<!doctype html>
 <html lang="en">
 <head>
@@ -4878,14 +4890,16 @@ function renderHtml(report) {
   main { max-width: 60rem; margin: 0 auto; }
   h1 { font-size: 1.25rem; margin: 0 0 0.25rem; }
   p.sub { color: var(--dim); margin: 0 0 1.5rem; }
+  h2 { font-size: 0.95rem; margin: 2.5rem 0 0.5rem; }
   table { width: 100%; border-collapse: collapse; }
   th, td { text-align: left; padding: 0.6rem 0.75rem; border-bottom: 1px solid var(--rule);
            vertical-align: top; }
   thead th { font-size: 0.78rem; text-transform: uppercase; letter-spacing: 0.06em; color: var(--dim); }
   td.num { font-variant-numeric: tabular-nums; white-space: nowrap; }
-  .unit, .moved { color: var(--dim); font-size: 0.85em; }
+  code { font: 0.9em ui-monospace, SFMono-Regular, Menlo, monospace; }
+  .unit { color: var(--dim); font-size: 0.85em; }
+  .moved { color: var(--warn); font-size: 0.85em; }
   .caveat { color: var(--dim); font-size: 0.9em; }
-  tr.over th, tr.over td.num { color: var(--warn); font-weight: 600; }
 </style>
 </head>
 <body>
@@ -4894,12 +4908,21 @@ function renderHtml(report) {
   <p class="sub">Passes: ${escape(report.passes.join(", "))}</p>
   <table>
     <thead>
-      <tr><th scope="col">Metric</th><th scope="col">Value</th><th scope="col">Threshold</th><th scope="col">What it does not say</th></tr>
+      <tr><th scope="col">Metric</th><th scope="col">Value</th><th scope="col">What it does not say</th></tr>
     </thead>
     <tbody>
 ${rows}
     </tbody>
   </table>
+  <h2>Measured with</h2>
+  <table>
+    <thead>
+      <tr><th scope="col">Setting</th><th scope="col">Value</th><th scope="col">Origin</th></tr>
+    </thead>
+    <tbody>
+${settings}
+    </tbody>
+  </table>
 </main>
 </body>
 </html>
@@ -4984,6 +5007,14 @@ export default defineStaticAnalysis({
   // Named product journeys, as { 'the name product uses': ['src/some/path/**'] }. Paths are
   // relative to this module, because one run measures one module.
   journeys: {},
+
+  // Everything else comes from the role, and this is the door when a module must move one of its
+  // values. Anything set here is printed under "measured with" and marked \`(module)\`, so nobody
+  // compares this module's figures with its neighbour's without seeing that they differ:
+  //
+  //   overrides: {
+  //     duplication: { minTokens: 100 },
+  //   },
 })
 `;
 var JscpdAdapter = class extends BaseAdapter {
@@ -5087,7 +5118,7 @@ ${result.stderr ?? ""}`
         );
         return { ok: false, code: result.status ?? 1 };
       }
-      const report = buildReport(ctx, rawReportDir);
+      const report = buildReport(ctx, rawReportDir, config);
       if (!report) {
         process.stderr.write(`sentinel static-analysis(jscpd): jscpd wrote no report
 `);
@@ -5135,7 +5166,18 @@ ${result.stderr ?? ""}`
 function analysedNothing(stderr) {
   return typeof stderr === "string" && stderr.includes("--fail-on-empty");
 }
-function buildReport(ctx, reportDir) {
+function duplicationSettings(config) {
+  const moved = (key) => config.moved.some((path) => path === key || path.startsWith(`${key}.`));
+  const row = (key, value) => ({ key, value, moved: moved(key) });
+  return [
+    row("duplication.minTokens", String(config.duplication.minTokens)),
+    row("duplication.minLines", String(config.duplication.minLines)),
+    row("duplication.kinds", config.duplication.kinds.join(", ")),
+    row("languages", `${config.languages.length}: ${config.languages.join(", ")}`),
+    row("ignore", `${config.ignore.length} patterns`)
+  ];
+}
+function buildReport(ctx, reportDir, config) {
   const path = join19(reportDir, "jscpd-report.json");
   if (!existsSync14(path)) return void 0;
   let parsed;
@@ -5148,25 +5190,8 @@ function buildReport(ctx, reportDir) {
   if (!total) return void 0;
   const percent = Number((total.percentage ?? 0).toFixed(2));
   const rows = [
-    {
-      metric: "duplicatedLinesPercent",
-      value: percent,
-      unit: "%",
-      // No threshold, and none is coming from here: see `preset-data.ts`. The figure is reported as
-      // measured, and what makes it readable is the distribution it sits in, which one module
-      // cannot know.
-      threshold: null,
-      over: false,
-      moved: false
-    },
-    {
-      metric: "clones",
-      value: total.clones ?? 0,
-      unit: "entries",
-      threshold: null,
-      over: false,
-      moved: false
-    }
+    { metric: "duplicatedLinesPercent", value: percent, unit: "%" },
+    { metric: "clones", value: total.clones ?? 0, unit: "entries" }
   ];
   const formats = parsed.statistics?.formats ?? {};
   const byLanguage = Object.fromEntries(
@@ -5179,7 +5204,13 @@ function buildReport(ctx, reportDir) {
       }
     ])
   );
-  return { module: ctx.module, passes: ["duplication"], rows, byLanguage };
+  return {
+    module: ctx.module,
+    passes: ["duplication"],
+    rows,
+    settings: duplicationSettings(config),
+    byLanguage
+  };
 }
 function emit(report, shape, cwd) {
   if (shape === "console") {
@@ -5197,8 +5228,12 @@ function emit(report, shape, cwd) {
 function metricsOf(report) {
   return {
     passes: report.passes,
-    finding: hasFinding(report),
     ...Object.fromEntries(report.rows.map((row) => [row.metric, row.value])),
+    // Carried into `--json` and the CI comment for the same reason the console prints them: a
+    // figure whose settings are unknown cannot be compared with the next module's.
+    settings: Object.fromEntries(
+      report.settings.map((s) => [s.key, { value: s.value, moved: s.moved }])
+    ),
     byLanguage: report.byLanguage
   };
 }

package/dist/index.js

@@ -6,7 +6,7 @@ import {
   registerAdapters,
   resolve,
   setDefaultRunner
-} from "./chunk-JNXDJ2QD.js";
+} from "./chunk-JJKFLYHK.js";
 import {
   BaseAdapter
 } from "./chunk-KLEXJFJ6.js";

package/docs/typescript-traces.md

@@ -1171,6 +1171,14 @@ $ sentinel --init --dry-run
     +   // Named product journeys, as { 'the name product uses': ['src/some/path/**'] }. Paths are
     +   // relative to this module, because one run measures one module.
     +   journeys: {},
+    + 
+    +   // Everything else comes from the role, and this is the door when a module must move one of its
+    +   // values. Anything set here is printed under "measured with" and marked `(module)`, so nobody
+    +   // compares this module's figures with its neighbour's without seeing that they differ:
+    +   //
+    +   //   overrides: {
+    +   //     duplication: { minTokens: 100 },
+    +   //   },
     + })
 
   update package.json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hublo/sentinel",
-  "version": "1.5.0-alpha.5",
+  "version": "1.5.0-alpha.6",
   "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",