ng-checkup 0.0.0-stage → 0.1.0

package/dist/report/html.js

@@ -0,0 +1,210 @@
+import { formatCount, plural } from '../checks/context.js';
+import { formatDuration, formatLocation, gradeLabel, kindLabel, overallScore, remainingCount, SCORE_EXPLANATION, severityLabel, topPriorities } from './summary.js';
+/**
+ * Renders the report as one self-contained HTML file.
+ *
+ * Self-contained is a hard requirement, not a style choice: the report is
+ * meant to be mailed to a client, attached to a ticket or opened on a machine
+ * without network, and it describes a private codebase. So there is no
+ * external font, script, stylesheet or image, and nothing on the page phones
+ * home. It follows the system light/dark preference and prints cleanly, since
+ * "save as PDF" is how many readers will pass it on.
+ */
+export function renderHtml(report) {
+    const { project } = report;
+    const score = overallScore(report);
+    const priorities = topPriorities(report);
+    const meta = [kindLabel(project.kind), project.angularVersion ? `Angular ${project.angularVersion}` : undefined, plural(project.sourceFiles, 'TypeScript file'), plural(project.templateFiles, 'template'), plural(project.linesOfCode, 'line') + ' of code']
+        .filter(Boolean)
+        .join(' · ');
+    return `<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="generator" content="${escape(`${report.tool.name} ${report.tool.version}`)}">
+<title>Angular checkup: ${escape(project.name)}</title>
+<style>${STYLES}</style>
+</head>
+<body>
+<main>
+  <header class="masthead">
+    <div>
+      <p class="eyebrow">Angular checkup</p>
+      <h1>${escape(project.name)}</h1>
+      <p class="meta">${escape(meta)}</p>
+      <p class="meta">Generated ${escape(report.generatedAt.slice(0, 10))}</p>
+    </div>
+    ${score === undefined ? '' : scoreRing(score)}
+  </header>
+
+  <section aria-labelledby="overview">
+    <h2 id="overview" class="section-title">Overview</h2>
+    <div class="cards">
+      ${report.checks.map(overviewCard).join('\n      ')}
+    </div>
+  </section>
+
+  ${priorities.length === 0
+        ? ''
+        : `<section aria-labelledby="priorities">
+    <h2 id="priorities" class="section-title">Top priorities</h2>
+    <ol class="priorities">
+      ${priorities
+            .map(({ check, finding }) => `<li><span class="chip sev-${finding.severity}">${severityLabel(finding.severity)}</span><span><strong>${inline(finding.message)}</strong> <a href="#${check.id}" class="area">${escape(check.title)}</a></span></li>`)
+            .join('\n      ')}
+    </ol>
+  </section>`}
+
+  ${report.checks.map(checkSection).join('\n  ')}
+
+  <footer>
+    <p>${score === undefined ? '' : `Score: ${escape(SCORE_EXPLANATION)} `}File counts are static and need no build; deprecations come from the installed packages' own <code>@deprecated</code> tags.</p>
+    <p>Generated by ${escape(report.tool.name)} ${escape(report.tool.version)} in ${escape(formatDuration(report.durationMs))}.</p>
+  </footer>
+</main>
+</body>
+</html>
+`;
+}
+/** The score as a ring: the arc length is the score, the colour its band. */
+function scoreRing(score) {
+    const radius = 42;
+    const circumference = 2 * Math.PI * radius;
+    const band = score >= 80 ? 'good' : score >= 50 ? 'fair' : 'poor';
+    return `<figure class="score" aria-label="Score ${score} out of 100">
+      <svg viewBox="0 0 100 100" width="112" height="112" aria-hidden="true">
+        <circle cx="50" cy="50" r="${radius}" class="ring-track"/>
+        <circle cx="50" cy="50" r="${radius}" class="ring-value grade-${band}" stroke-dasharray="${((score / 100) * circumference).toFixed(1)} ${circumference.toFixed(1)}" transform="rotate(-90 50 50)"/>
+      </svg>
+      <figcaption><span class="score-value">${score}</span><span class="score-unit">/100</span></figcaption>
+    </figure>`;
+}
+/** One card of the overview grid, linking to its section. */
+function overviewCard(check) {
+    return `<a class="card" href="#${check.id}"><span class="pill grade-${check.grade}">${gradeLabel(check.grade)}</span><strong>${escape(check.title)}</strong><span class="card-summary">${inline(check.summary)}</span></a>`;
+}
+/** The full section of one check: summary, metric grid, findings. */
+function checkSection(check) {
+    return `<section class="check" id="${check.id}" aria-labelledby="${check.id}-title">
+    <div class="check-head">
+      <h2 id="${check.id}-title">${escape(check.title)}</h2>
+      <span class="pill grade-${check.grade}">${gradeLabel(check.grade)}</span>
+    </div>
+    <p class="check-summary">${inline(check.summary)}</p>
+    ${check.metrics.length === 0
+        ? ''
+        : `<dl class="metrics">
+      ${check.metrics.map((metric) => `<div class="metric"><dt>${escape(metric.label)}</dt><dd>${escape(String(metric.value))}</dd>${metric.hint ? `<dd class="hint">${escape(metric.hint)}</dd>` : ''}</div>`).join('\n      ')}
+    </dl>`}
+    ${check.findings.length === 0 ? '' : `<ul class="findings">\n      ${check.findings.map(findingItem).join('\n      ')}\n    </ul>`}
+  </section>`;
+}
+/** One finding with its detail and example files. */
+function findingItem(finding) {
+    const more = remainingCount(finding);
+    const files = finding.files ?? [];
+    return `<li class="finding">
+        <div class="finding-head"><span class="chip sev-${finding.severity}">${severityLabel(finding.severity)}</span><strong>${inline(finding.message)}</strong></div>
+        ${finding.detail ? `<p>${inline(finding.detail)}</p>` : ''}
+        ${files.length === 0 ? '' : `<ul class="files">${files.map((file) => `<li>${escape(formatLocation(file))}</li>`).join('')}${more > 0 ? `<li class="more">and ${formatCount(more)} more</li>` : ''}</ul>`}
+      </li>`;
+}
+/** Escapes text and turns backtick spans into `<code>`, the only markup finding text uses. */
+function inline(text) {
+    return escape(text).replace(/`([^`]+)`/g, '<code>$1</code>');
+}
+/** HTML-escapes text for element content and double-quoted attributes. */
+export function escape(text) {
+    return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
+}
+/**
+ * The stylesheet. Colours are tokens on `:root`, redefined for dark mode, so
+ * the grade and severity colours stay legible on both backgrounds.
+ */
+const STYLES = `
+:root {
+  --bg: #f7f7f5; --surface: #ffffff; --text: #1b1d21; --muted: #5d636e; --border: #e3e3df; --code-bg: #f0f0ec;
+  --good: #1f7a4d; --good-bg: #e3f3ea; --fair: #8a5a00; --fair-bg: #fbf0d9; --poor: #b42318; --poor-bg: #fde8e6; --info: #5d636e; --info-bg: #ececea;
+  --accent: #3b5bdb; --ring-track: #e7e7e3;
+  color-scheme: light;
+}
+@media (prefers-color-scheme: dark) {
+  :root {
+    --bg: #121316; --surface: #1b1d21; --text: #ececec; --muted: #9aa0aa; --border: #2c2f35; --code-bg: #25282e;
+    --good: #5cc98f; --good-bg: #173326; --fair: #e8b54d; --fair-bg: #3a2d10; --poor: #f17a6e; --poor-bg: #3d1a17; --info: #9aa0aa; --info-bg: #2a2c31;
+    --accent: #8ea6ff; --ring-track: #2c2f35;
+    color-scheme: dark;
+  }
+}
+* { box-sizing: border-box; }
+body { margin: 0; background: var(--bg); color: var(--text); font: 15px/1.55 ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif; -webkit-font-smoothing: antialiased; }
+main { max-width: 960px; margin: 0 auto; padding: 40px 16px 56px; }
+code, .files { font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace; font-size: 0.88em; }
+code { background: var(--code-bg); padding: 1px 5px; border-radius: 4px; overflow-wrap: anywhere; }
+a { color: inherit; }
+.masthead { display: flex; justify-content: space-between; align-items: center; gap: 24px; padding-bottom: 28px; border-bottom: 1px solid var(--border); }
+.eyebrow { margin: 0 0 4px; color: var(--accent); font-size: 13px; font-weight: 600; letter-spacing: 0.06em; text-transform: uppercase; }
+h1 { margin: 0 0 8px; font-size: 32px; line-height: 1.15; letter-spacing: -0.01em; overflow-wrap: anywhere; }
+.meta { margin: 0; color: var(--muted); font-size: 14px; }
+.score { margin: 0; position: relative; width: 112px; height: 112px; flex: none; }
+.score svg { display: block; }
+.ring-track { fill: none; stroke: var(--ring-track); stroke-width: 9; }
+.ring-value { fill: none; stroke-width: 9; stroke-linecap: round; }
+.ring-value.grade-good { stroke: var(--good); } .ring-value.grade-fair { stroke: var(--fair); } .ring-value.grade-poor { stroke: var(--poor); }
+.score figcaption { position: absolute; inset: 0; display: flex; align-items: center; justify-content: center; }
+.score-value { font-size: 30px; font-weight: 700; font-variant-numeric: tabular-nums; }
+.score-unit { color: var(--muted); font-size: 13px; margin-left: 1px; padding-top: 10px; }
+.section-title { font-size: 13px; font-weight: 600; letter-spacing: 0.06em; text-transform: uppercase; color: var(--muted); margin: 36px 0 12px; }
+.cards { display: grid; grid-template-columns: repeat(auto-fill, minmax(200px, 1fr)); gap: 12px; }
+.card { display: flex; flex-direction: column; gap: 6px; padding: 16px; background: var(--surface); border: 1px solid var(--border); border-radius: 10px; text-decoration: none; transition: border-color 0.15s; }
+.card:hover { border-color: var(--accent); }
+.card strong { font-size: 15px; }
+.card-summary { color: var(--muted); font-size: 13.5px; }
+.pill, .chip { display: inline-block; width: fit-content; border-radius: 999px; font-size: 12px; font-weight: 600; padding: 2px 10px; }
+.grade-good.pill { color: var(--good); background: var(--good-bg); } .grade-fair.pill { color: var(--fair); background: var(--fair-bg); }
+.grade-poor.pill { color: var(--poor); background: var(--poor-bg); } .grade-info.pill { color: var(--info); background: var(--info-bg); }
+.chip { flex: none; padding: 1px 8px; font-size: 11.5px; }
+.sev-high { color: var(--poor); background: var(--poor-bg); } .sev-medium { color: var(--fair); background: var(--fair-bg); }
+.sev-low, .sev-info { color: var(--info); background: var(--info-bg); }
+.priorities { margin: 0; padding: 0; list-style: none; display: grid; gap: 8px; counter-reset: priority; }
+.priorities li { display: flex; gap: 10px; align-items: baseline; padding: 12px 16px; background: var(--surface); border: 1px solid var(--border); border-radius: 10px; }
+.priorities .area { color: var(--muted); font-size: 13px; margin-left: 6px; white-space: nowrap; }
+.check { margin-top: 40px; padding-top: 28px; border-top: 1px solid var(--border); }
+.check-head { display: flex; align-items: center; gap: 12px; flex-wrap: wrap; }
+.check-head h2 { margin: 0; font-size: 22px; letter-spacing: -0.005em; }
+.check-summary { margin: 8px 0 16px; color: var(--muted); }
+.metrics { display: grid; grid-template-columns: repeat(auto-fill, minmax(150px, 1fr)); gap: 10px; margin: 0 0 18px; }
+.metric { padding: 12px 14px; background: var(--surface); border: 1px solid var(--border); border-radius: 10px; }
+.metric dt { color: var(--muted); font-size: 12.5px; }
+.metric dd { margin: 2px 0 0; font-size: 20px; font-weight: 650; font-variant-numeric: tabular-nums; overflow-wrap: anywhere; }
+.metric dd.hint { font-size: 12.5px; font-weight: 400; color: var(--muted); }
+.findings { list-style: none; margin: 0; padding: 0; display: grid; grid-template-columns: minmax(0, 1fr); gap: 10px; }
+.finding { min-width: 0; padding: 14px 16px; background: var(--surface); border: 1px solid var(--border); border-radius: 10px; break-inside: avoid; }
+.finding-head { display: flex; gap: 10px; align-items: baseline; }
+.finding p { margin: 6px 0 0; color: var(--muted); font-size: 14px; }
+.files { margin: 8px 0 0; padding: 8px 12px; list-style: none; background: var(--code-bg); border-radius: 6px; color: var(--muted); overflow-x: auto; }
+.files li { white-space: nowrap; line-height: 1.7; }
+.files .more { font-family: inherit; font-style: italic; }
+footer { margin-top: 48px; padding-top: 20px; border-top: 1px solid var(--border); color: var(--muted); font-size: 13px; }
+footer p { margin: 4px 0; }
+@media (max-width: 600px) {
+  main { padding-top: 24px; }
+  .masthead { flex-direction: column-reverse; align-items: flex-start; }
+  h1 { font-size: 26px; }
+  .priorities li, .finding-head { flex-direction: column; gap: 6px; }
+  .priorities .area { margin-left: 0; }
+}
+@media print {
+  /* Printing from a dark-mode browser must still give black on white. */
+  :root {
+    --bg: #fff; --surface: #fff; --text: #1b1d21; --muted: #5d636e; --border: #e3e3df; --code-bg: #f0f0ec;
+    --good: #1f7a4d; --good-bg: #e3f3ea; --fair: #8a5a00; --fair-bg: #fbf0d9; --poor: #b42318; --poor-bg: #fde8e6; --info: #5d636e; --info-bg: #ececea;
+    --accent: #3b5bdb; --ring-track: #e7e7e3; color-scheme: light;
+  }
+  main { padding: 0; max-width: none; }
+  .card:hover { border-color: var(--border); }
+  .check { break-before: auto; }
+}
+`;
+//# sourceMappingURL=html.js.map

package/dist/report/html.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.js","sourceRoot":"","sources":["../../src/report/html.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEpK;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC;SAC1P,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,KAAK,CAAC,CAAC;IAEf,OAAO;;;;;kCAKyB,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;0BAC5D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACrC,MAAM;;;;;;;YAOH,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;wBACR,MAAM,CAAC,IAAI,CAAC;kCACF,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;;MAEnE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;;;;;;QAMzC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;;;;IAKpD,UAAU,CAAC,MAAM,KAAK,CAAC;QACrB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;;;QAGA,UAAU;aACT,GAAG,CACF,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CACrB,6BAA6B,OAAO,CAAC,QAAQ,KAAK,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,uBAAuB,KAAK,CAAC,EAAE,kBAAkB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CACzN;aACA,IAAI,CAAC,UAAU,CAAC;;aAGvB;;IAEE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;;;SAGvC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,iBAAiB,CAAC,GAAG;sBACpD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;;;;;CAK5H,CAAC;AACF,CAAC;AAED,6EAA6E;AAC7E,SAAS,SAAS,CAAC,KAAa;IAC9B,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,aAAa,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,IAAI,GAAU,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IACzE,OAAO,2CAA2C,KAAK;;qCAEpB,MAAM;qCACN,MAAM,6BAA6B,IAAI,uBAAuB,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;;8CAE3H,KAAK;cACrC,CAAC;AACf,CAAC;AAED,6DAA6D;AAC7D,SAAS,YAAY,CAAC,KAAkB;IACtC,OAAO,0BAA0B,KAAK,CAAC,EAAE,6BAA6B,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,uCAAuC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;AAC9N,CAAC;AAED,qEAAqE;AACrE,SAAS,YAAY,CAAC,KAAkB;IACtC,OAAO,8BAA8B,KAAK,CAAC,EAAE,sBAAsB,KAAK,CAAC,EAAE;;gBAE7D,KAAK,CAAC,EAAE,WAAW,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;gCACtB,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;;+BAExC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;MAE9C,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QACxB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;QACF,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,2BAA2B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;UAE5N;MACE,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gCAAgC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa;aACzH,CAAC;AACd,CAAC;AAED,qDAAqD;AACrD,SAAS,WAAW,CAAC,OAAgB;IACnC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;IAClC,OAAO;0DACiD,OAAO,CAAC,QAAQ,KAAK,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;UAC7I,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;UACxD,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,wBAAwB,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO;YACpM,CAAC;AACb,CAAC;AAED,8FAA8F;AAC9F,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAC/D,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChI,CAAC;AAED;;;GAGG;AACH,MAAM,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoFd,CAAC"}

package/dist/report/markdown.d.ts

@@ -0,0 +1,8 @@
+import type { Report } from '../types.js';
+/**
+ * Renders the report as GitHub-flavoured Markdown, for a pull request, a
+ * wiki page or an issue. Finding text already uses Markdown backticks, so it
+ * goes in as written; only table cells are escaped, where a `|` would split
+ * the row.
+ */
+export declare function renderMarkdown(report: Report): string;

package/dist/report/markdown.js

@@ -0,0 +1,55 @@
+import { formatCount, plural } from '../checks/context.js';
+import { formatDuration, formatLocation, gradeLabel, kindLabel, overallScore, remainingCount, SCORE_EXPLANATION, severityLabel, topPriorities } from './summary.js';
+/**
+ * Renders the report as GitHub-flavoured Markdown, for a pull request, a
+ * wiki page or an issue. Finding text already uses Markdown backticks, so it
+ * goes in as written; only table cells are escaped, where a `|` would split
+ * the row.
+ */
+export function renderMarkdown(report) {
+    const { project } = report;
+    const lines = [];
+    const score = overallScore(report);
+    lines.push(`# Angular checkup: ${project.name}`, '');
+    lines.push(`${kindLabel(project.kind)}${project.angularVersion ? ` · Angular ${project.angularVersion}` : ''} · ${plural(project.sourceFiles, 'TypeScript file')} · ${plural(project.templateFiles, 'template')} · ${plural(project.linesOfCode, 'line')} of application code`, '');
+    if (score !== undefined)
+        lines.push(`**Score: ${score}/100.** ${SCORE_EXPLANATION}`, '');
+    lines.push('| Area | Grade | Summary |', '| --- | --- | --- |');
+    for (const check of report.checks)
+        lines.push(`| ${cell(check.title)} | ${gradeLabel(check.grade)} | ${cell(check.summary)} |`);
+    lines.push('');
+    const priorities = topPriorities(report);
+    if (priorities.length > 0) {
+        lines.push('## Top priorities', '');
+        priorities.forEach(({ check, finding }, index) => lines.push(`${index + 1}. **${severityLabel(finding.severity)}:** ${finding.message} _(${check.title})_`));
+        lines.push('');
+    }
+    for (const check of report.checks) {
+        lines.push(`## ${check.title}: ${gradeLabel(check.grade)}`, '', check.summary, '');
+        if (check.metrics.length > 0) {
+            lines.push('| Metric | Value | |', '| --- | --- | --- |');
+            for (const metric of check.metrics)
+                lines.push(`| ${cell(metric.label)} | ${cell(String(metric.value))} | ${cell(metric.hint ?? '')} |`);
+            lines.push('');
+        }
+        for (const finding of check.findings) {
+            lines.push(`- **${severityLabel(finding.severity)}:** ${finding.message}`);
+            if (finding.detail)
+                lines.push(`  ${finding.detail}`);
+            for (const file of finding.files ?? [])
+                lines.push(`  - \`${formatLocation(file)}\``);
+            const more = remainingCount(finding);
+            if (more > 0)
+                lines.push(`  - and ${formatCount(more)} more`);
+        }
+        if (check.findings.length > 0)
+            lines.push('');
+    }
+    lines.push('---', '', `Generated ${report.generatedAt.slice(0, 10)} by ${report.tool.name} ${report.tool.version} in ${formatDuration(report.durationMs)}.`, '');
+    return lines.join('\n');
+}
+/** Escapes a table cell: a `|` would end it and a newline would end the row. */
+function cell(text) {
+    return text.replace(/\|/g, '\\|').replace(/\n/g, ' ');
+}
+//# sourceMappingURL=markdown.js.map

package/dist/report/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../src/report/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEpK;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAEnC,KAAK,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CACR,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,sBAAsB,EACnQ,EAAE,CACH,CAAC;IACF,IAAI,KAAK,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,WAAW,iBAAiB,EAAE,EAAE,EAAE,CAAC,CAAC;IAEzF,KAAK,CAAC,IAAI,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,CAAC;IAChE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACpC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,OAAO,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,OAAO,CAAC,OAAO,MAAM,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QAC7J,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACnF,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAAC;YAC1D,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;YACzI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3E,IAAI,OAAO,CAAC,MAAM;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACtD,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,EAAE;gBAAE,KAAK,CAAC,IAAI,CAAC,SAAS,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;YACrC,IAAI,IAAI,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,WAAW,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,aAAa,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACjK,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,gFAAgF;AAChF,SAAS,IAAI,CAAC,IAAY;IACxB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACxD,CAAC"}

package/dist/report/summary.d.ts

@@ -0,0 +1,45 @@
+import type { CheckResult, Finding, Grade, Report, Severity } from '../types.js';
+/** A finding together with the check it belongs to, for the cross-check priority list. */
+export interface Priority {
+    check: CheckResult;
+    finding: Finding;
+}
+/**
+ * The overall score, 0 to 100: the average of the graded areas at 100 for
+ * good, 60 for fair and 20 for poor. Areas graded `info` are left out, so a
+ * repository is not marked down for what the tool could not measure.
+ * Undefined when nothing was graded at all.
+ *
+ * A deliberately simple formula. Every report prints it next to the score,
+ * because a number whose derivation is hidden invites arguing with it instead
+ * of with the findings.
+ */
+export declare function overallScore(report: Report): number | undefined;
+/** The sentence every format prints under the score. */
+export declare const SCORE_EXPLANATION = "Average of the graded areas: good counts 100, fair 60, poor 20. Areas marked info are not counted.";
+/**
+ * The findings to act on first, across all checks: every `high` finding,
+ * then `medium` ones if fewer than `limit` are high, in report order within a
+ * severity. Low and info findings never make the list.
+ */
+export declare function topPriorities(report: Report, limit?: number): Priority[];
+/** Display label of a grade. */
+export declare function gradeLabel(grade: Grade): string;
+/** Display label of a severity. */
+export declare function severityLabel(severity: Severity): string;
+/** `path:line`, or just `path` when the location has no line. */
+export declare function formatLocation(ref: {
+    path: string;
+    line?: number;
+}): string;
+/** "1.5 s" or "820 ms". */
+export declare function formatDuration(milliseconds: number): string;
+/** The workspace kind as a reader would name it. */
+export declare function kindLabel(kind: Report['project']['kind']): string;
+/**
+ * How many more files a finding covers than it lists. 0 when it lists them
+ * all, and 0 when it lists none: then `count` is a number of occurrences in
+ * the message, not of files, and "and 12 more" under an empty list would
+ * read as a rendering bug.
+ */
+export declare function remainingCount(finding: Finding): number;

package/dist/report/summary.js

@@ -0,0 +1,65 @@
+/** Points per grade for the overall score. `info` is absent: it never counts. */
+const GRADE_POINTS = { good: 100, fair: 60, poor: 20 };
+/** Severity order, most urgent first. */
+const SEVERITY_RANK = { high: 0, medium: 1, low: 2, info: 3 };
+/**
+ * The overall score, 0 to 100: the average of the graded areas at 100 for
+ * good, 60 for fair and 20 for poor. Areas graded `info` are left out, so a
+ * repository is not marked down for what the tool could not measure.
+ * Undefined when nothing was graded at all.
+ *
+ * A deliberately simple formula. Every report prints it next to the score,
+ * because a number whose derivation is hidden invites arguing with it instead
+ * of with the findings.
+ */
+export function overallScore(report) {
+    const graded = report.checks.filter((check) => check.grade !== 'info');
+    if (graded.length === 0)
+        return undefined;
+    return Math.round(graded.reduce((sum, check) => sum + GRADE_POINTS[check.grade], 0) / graded.length);
+}
+/** The sentence every format prints under the score. */
+export const SCORE_EXPLANATION = 'Average of the graded areas: good counts 100, fair 60, poor 20. Areas marked info are not counted.';
+/**
+ * The findings to act on first, across all checks: every `high` finding,
+ * then `medium` ones if fewer than `limit` are high, in report order within a
+ * severity. Low and info findings never make the list.
+ */
+export function topPriorities(report, limit = 5) {
+    return report.checks
+        .flatMap((check) => check.findings.map((finding) => ({ check, finding })))
+        .filter(({ finding }) => finding.severity === 'high' || finding.severity === 'medium')
+        .sort((left, right) => SEVERITY_RANK[left.finding.severity] - SEVERITY_RANK[right.finding.severity])
+        .slice(0, limit);
+}
+/** Display label of a grade. */
+export function gradeLabel(grade) {
+    return { good: 'Good', fair: 'Fair', poor: 'Poor', info: 'Info' }[grade];
+}
+/** Display label of a severity. */
+export function severityLabel(severity) {
+    return { high: 'High', medium: 'Medium', low: 'Low', info: 'Note' }[severity];
+}
+/** `path:line`, or just `path` when the location has no line. */
+export function formatLocation(ref) {
+    return ref.line === undefined ? ref.path : `${ref.path}:${ref.line}`;
+}
+/** "1.5 s" or "820 ms". */
+export function formatDuration(milliseconds) {
+    return milliseconds >= 1000 ? `${(milliseconds / 1000).toFixed(1)} s` : `${milliseconds} ms`;
+}
+/** The workspace kind as a reader would name it. */
+export function kindLabel(kind) {
+    return { 'angular-cli': 'Angular CLI', nx: 'Nx', unknown: 'unknown workspace' }[kind];
+}
+/**
+ * How many more files a finding covers than it lists. 0 when it lists them
+ * all, and 0 when it lists none: then `count` is a number of occurrences in
+ * the message, not of files, and "and 12 more" under an empty list would
+ * read as a rendering bug.
+ */
+export function remainingCount(finding) {
+    const listed = finding.files?.length ?? 0;
+    return listed === 0 ? 0 : Math.max(0, (finding.count ?? 0) - listed);
+}
+//# sourceMappingURL=summary.js.map

package/dist/report/summary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/report/summary.ts"],"names":[],"mappings":"AAEA,iFAAiF;AACjF,MAAM,YAAY,GAA2C,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAE/F,yCAAyC;AACzC,MAAM,aAAa,GAA6B,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAQxF;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAA4D,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;IACjI,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AACvG,CAAC;AAED,wDAAwD;AACxD,MAAM,CAAC,MAAM,iBAAiB,GAAG,oGAAoG,CAAC;AAEtI;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,KAAK,GAAG,CAAC;IACrD,OAAO,MAAM,CAAC,MAAM;SACjB,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;SACzE,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;SACrF,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACnG,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AACrB,CAAC;AAED,gCAAgC;AAChC,MAAM,UAAU,UAAU,CAAC,KAAY;IACrC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,mCAAmC;AACnC,MAAM,UAAU,aAAa,CAAC,QAAkB;IAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;AAChF,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,cAAc,CAAC,GAAoC;IACjE,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;AACvE,CAAC;AAED,2BAA2B;AAC3B,MAAM,UAAU,cAAc,CAAC,YAAoB;IACjD,OAAO,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;AAC/F,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,SAAS,CAAC,IAA+B;IACvD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,IAAI,CAAC,CAAC;AACxF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,OAAgB;IAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;IAC1C,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AACvE,CAAC"}

package/dist/report/terminal.d.ts

@@ -0,0 +1,17 @@
+import type { Report } from '../types.js';
+/** Options for the terminal renderer. */
+export interface TerminalOptions {
+    /** ANSI colours. The CLI turns them off for a non-TTY, `NO_COLOR` or `--no-color`. */
+    color: boolean;
+    /** Every finding of every check instead of the summary and the top priorities. */
+    verbose: boolean;
+}
+/**
+ * Renders the report for a terminal.
+ *
+ * By default it shows one line per check and the top priorities, which fits a
+ * screen and is what someone running the tool for the first time wants;
+ * `verbose` adds every finding with its example files. The file reports
+ * (`--report x.html`) always carry everything, so the terminal never has to.
+ */
+export declare function renderTerminal(report: Report, options: TerminalOptions): string;

package/dist/report/terminal.js

@@ -0,0 +1,70 @@
+import { formatCount, plural } from '../checks/context.js';
+import { formatDuration, formatLocation, gradeLabel, kindLabel, overallScore, remainingCount, SCORE_EXPLANATION, severityLabel, topPriorities } from './summary.js';
+/** A tiny ANSI palette; every function is the identity when colour is off. */
+function palette(enabled) {
+    const wrap = (open, close) => (text) => (enabled ? `\u001b[${open}m${text}\u001b[${close}m` : text);
+    return { bold: wrap(1, 22), dim: wrap(2, 22), red: wrap(31, 39), green: wrap(32, 39), yellow: wrap(33, 39), cyan: wrap(36, 39), gray: wrap(90, 39) };
+}
+/**
+ * Renders the report for a terminal.
+ *
+ * By default it shows one line per check and the top priorities, which fits a
+ * screen and is what someone running the tool for the first time wants;
+ * `verbose` adds every finding with its example files. The file reports
+ * (`--report x.html`) always carry everything, so the terminal never has to.
+ */
+export function renderTerminal(report, options) {
+    const c = palette(options.color);
+    /** Backtick spans become cyan text without the backticks; without colour the backticks stay as the only marker. */
+    const code = (text) => (options.color ? text.replace(/`([^`]+)`/g, (_, inner) => c.cyan(inner)) : text);
+    const gradeBadge = (grade) => {
+        const label = ` ${gradeLabel(grade).toUpperCase().padEnd(4)} `;
+        return { good: c.green, fair: c.yellow, poor: c.red, info: c.gray }[grade](options.color ? c.bold(label) : `[${gradeLabel(grade).toUpperCase()}]`.padEnd(7));
+    };
+    const severityTag = (severity) => ({ high: c.red, medium: c.yellow, low: c.gray, info: c.gray })[severity](severityLabel(severity).toLowerCase().padEnd(6));
+    const lines = [];
+    const { project } = report;
+    lines.push(`${c.bold(report.tool.name)} ${c.dim(report.tool.version)}  ${c.bold(project.name)} ${c.dim(`· ${kindLabel(project.kind)}${project.angularVersion ? ` · Angular ${project.angularVersion}` : ''}`)}`);
+    lines.push(c.dim(`${plural(project.sourceFiles, 'TypeScript file')}, ${plural(project.templateFiles, 'template')}, ${plural(project.linesOfCode, 'line')} of application code, analysed in ${formatDuration(report.durationMs)}`));
+    lines.push('');
+    const titleWidth = Math.max(...report.checks.map((check) => check.title.length));
+    for (const check of report.checks) {
+        lines.push(`${gradeBadge(check.grade)} ${c.bold(check.title.padEnd(titleWidth))}  ${code(check.summary)}`);
+        if (!options.verbose)
+            continue;
+        for (const finding of check.findings) {
+            lines.push(`         ${severityTag(finding.severity)} ${code(finding.message)}`);
+            if (finding.detail)
+                lines.push(`                ${c.dim(code(finding.detail))}`);
+            for (const file of finding.files ?? [])
+                lines.push(`                ${c.gray(formatLocation(file))}`);
+            const more = remainingCount(finding);
+            if (more > 0)
+                lines.push(`                ${c.gray(`and ${formatCount(more)} more`)}`);
+        }
+    }
+    const score = overallScore(report);
+    if (score !== undefined) {
+        lines.push('');
+        const color = score >= 80 ? c.green : score >= 50 ? c.yellow : c.red;
+        lines.push(`${c.bold('Score')} ${color(c.bold(`${score}/100`))}  ${c.dim(SCORE_EXPLANATION)}`);
+    }
+    const priorities = topPriorities(report);
+    if (!options.verbose && priorities.length > 0) {
+        lines.push('');
+        lines.push(c.bold('Top priorities'));
+        priorities.forEach(({ check, finding }, index) => {
+            lines.push(`  ${index + 1}. ${severityTag(finding.severity)} ${code(finding.message)} ${c.dim(`(${check.title})`)}`);
+            const [first] = finding.files ?? [];
+            const total = finding.count ?? finding.files?.length ?? 0;
+            if (first)
+                lines.push(`              ${c.gray(`${formatLocation(first)}${total > 1 ? ` and ${formatCount(total - 1)} more` : ''}`)}`);
+        });
+    }
+    if (!options.verbose) {
+        lines.push('');
+        lines.push(c.dim('Every finding with its files: --verbose, or write a report with --report checkup.html (also .md, .json).'));
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=terminal.js.map

package/dist/report/terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminal.js","sourceRoot":"","sources":["../../src/report/terminal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAUpK,8EAA8E;AAC9E,SAAS,OAAO,CAAC,OAAgB;IAC/B,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5H,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;AACvJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,OAAwB;IACrE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,mHAAmH;IACnH,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,KAAa,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChI,MAAM,UAAU,GAAG,CAAC,KAAY,EAAU,EAAE;QAC1C,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/D,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/J,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,CAAC,QAAkB,EAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9K,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IACjN,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,KAAK,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,KAAK,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,qCAAqC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACnO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACjF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3G,IAAI,CAAC,OAAO,CAAC,OAAO;YAAE,SAAS;QAC/B,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,YAAY,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACjF,IAAI,OAAO,CAAC,MAAM;gBAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;YACjF,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,EAAE;gBAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;YACtG,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;YACrC,IAAI,IAAI,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACrC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE;YAC/C,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;YACrH,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;YAC1D,IAAI,KAAK;gBAAE,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACxI,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,0GAA0G,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/scan.d.ts

@@ -0,0 +1,119 @@
+/** One name brought in by an import or re-export. */
+export interface ImportBinding {
+    /** The name the module exports. `default` for a default import, `*` for a namespace import. */
+    imported: string;
+    /** The name it is bound to in this file. */
+    local: string;
+    typeOnly: boolean;
+}
+/** One `import`, `export … from` or dynamic `import()` in a source file. */
+export interface ImportFact {
+    specifier: string;
+    line: number;
+    /**
+     * True for `import type`, and for a named import whose every binding is
+     * `type`. Such an import is erased at compile time, so it cannot take part in
+     * a runtime cycle and the dependency graph ignores it.
+     */
+    typeOnly: boolean;
+    /** `import()` loads lazily and does not form an eager cycle either. */
+    dynamic: boolean;
+    /** Empty for a side-effect import (`import 'zone.js'`) and for `export * from`. */
+    bindings: ImportBinding[];
+}
+/** One `@Component` class. */
+export interface ComponentFact {
+    name: string;
+    line: number;
+    /**
+     * The literal value of `standalone` in the decorator, undefined when absent.
+     * What an absent flag means depends on the Angular version (standalone is the
+     * default from v19), which is why the scanner records only what is written
+     * and the components check interprets it.
+     */
+    standalone?: boolean;
+    /**
+     * The strategy named in `changeDetection`, undefined when absent. Like
+     * `standalone`, the default changed (OnPush from v22), so an absent value is
+     * interpreted by the check that knows the version.
+     */
+    changeDetection?: string;
+}
+/** Control-flow and escape-hatch counts for one template, inline or external. */
+export interface TemplateStats {
+    ngIf: number;
+    ngFor: number;
+    ngSwitch: number;
+    ifBlocks: number;
+    forBlocks: number;
+    switchBlocks: number;
+    deferBlocks: number;
+    /** `$any(...)`, the template's way of switching type checking off for one expression. */
+    anyCasts: number;
+}
+/** A template and where its first legacy structural directive sits, for report examples. */
+export interface TemplateFact {
+    path: string;
+    /** True for a `template:` string inside a component file. */
+    inline: boolean;
+    stats: TemplateStats;
+    /** 1-based line of the first `*ngIf`/`*ngFor`/`[ngSwitch]`, undefined when there is none. */
+    firstLegacyLine?: number;
+}
+/** Everything the checks need from one TypeScript file, gathered in a single AST pass. */
+export interface SourceFileFacts {
+    /** Report path: relative to the root, `/`-separated. */
+    path: string;
+    absolutePath: string;
+    isSpec: boolean;
+    /** Non-blank lines. */
+    linesOfCode: number;
+    imports: ImportFact[];
+    components: ComponentFact[];
+    ngModules: number;
+    injectables: number;
+    /** `@Input()` decorators on properties and setters. */
+    decoratorInputs: number;
+    /** `@Output()` decorators. */
+    decoratorOutputs: number;
+    /**
+     * Calls of imported functions, keyed `module#name` (`@angular/core#signal`)
+     * or `module#name.member` for calls such as `input.required()`. Values are the
+     * 1-based lines of each call. Resolving through the imports is what keeps a
+     * local helper that happens to be called `signal` out of the signal count.
+     */
+    calls: Map<string, number[]>;
+    /** `new X()` of an imported class, keyed like `calls`. */
+    constructions: Map<string, number[]>;
+    /** `X.member` on an imported binding, keyed `module#X.member`. Used for deprecated enum members. */
+    memberAccesses: Map<string, number[]>;
+    /**
+     * Calls of test-framework globals that are never imported: `spyOn` and
+     * `jasmine.*` for Jasmine. Each one is a line to rewrite when moving to Vitest
+     * or Jest, which is what the testing check reports them for.
+     */
+    jasmineCalls: number;
+    /** Lines of every `any` type annotation or `as any`. */
+    anyLines: number[];
+    /** Lines of every `x!` non-null assertion. */
+    nonNullLines: number[];
+    /** `x!: T` property declarations, which skip definite-assignment checking. */
+    definiteAssignments: number;
+    /** `@ts-ignore`, `@ts-expect-error` and `@ts-nocheck` comments. */
+    typeSuppressions: number;
+    /** `templateUrl`/`template` is resolved by the template scan; inline templates are collected here. */
+    inlineTemplates: TemplateFact[];
+}
+/**
+ * Parses one file and extracts its facts. Parsing is syntax-only (no type
+ * checker, no program), which is what lets a 3 000-file repository finish in
+ * seconds and lets the tool run without the project's dependencies installed.
+ * The cost is that identifiers are matched by their import, never by type.
+ */
+export declare function scanSourceFile(root: string, absolutePath: string): SourceFileFacts;
+/** Counts control flow in one template's text. */
+export declare function scanTemplate(text: string): TemplateStats;
+/** Character offset of the first legacy structural directive in a template, or undefined. */
+export declare function firstLegacyOffset(text: string): number | undefined;
+/** Scans an external template file. */
+export declare function scanTemplateFile(root: string, absolutePath: string): TemplateFact;