@svelte-vitals/core 0.20.0 → 0.21.0

package/dist/index.d.ts

@@ -717,6 +717,16 @@ declare function formatSarifReport(results: Result[], config: Config, meta: {
  */
 declare function formatGithubReport(results: Result[], config: Config): string;
 
+/**
+ * Render a compact Markdown summary — Health score, per-category table, severity counts, and
+ * a findings table — suitable for a GitHub Actions job summary or a sticky PR comment
+ * (`svelte-vitals ci install`). Delegates all aggregation to `buildJsonReport` so the numbers
+ * never drift from the JSON/console reporters.
+ */
+declare function formatMarkdownReport(results: Result[], config: Config, meta: {
+    version: string;
+}): string;
+
 type Band = 'good' | 'warn' | 'poor';
 declare const BAND_COLOR: Record<Band, string>;
 declare function scoreBand(score: number): Band;
@@ -743,4 +753,4 @@ declare function selectRules(rules: Rule[], config: Config): Rule[];
 /** Apply per-rule severity overrides to results (design §6). */
 declare function applyRuleSeverities(results: Result[], config: Config): Result[];
 
-export { BAND_COLOR, CHILD_NODE_KEYS, type Category, type Classification, type ComponentFacts, type Config, type ConsoleReportOptions, type Detection, type EachBlockFact, type EffectFact, type Fix, type HeadProvider, type HeadTag, type HeadingInfo, type HealthResult, type ImageInfo, type JsonReport, type Palette, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, type ResolvedHeadings, type ResolvedImages, type Result, type Rule, type RuleContext, type RuleInfo, type RuleSetting, type Runtime, SITEMAP_SOURCE_PATHS, type Scope, type ScoreModel, type ScoreOptions, type ScoreResult, type Severity, type SourceSpan, type Summary, type SuppressionDirective, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, arch001ComponentSize, arch002PropCount, attrText, attrTextOf, attrValue, attrValueOf, buildHtmlDocument, buildJsonReport, classify, collectComponentFacts, computeHealth, computeScore, correct001EachKey, correct002EffectDerived, correct003EffectAsOnMount, correct004UnmutatedState, correct005PropMutation, defaultConfig, defaultProject, defineConfig, docsUrlFor, effectiveSeverity, emptyComponentFacts, escapeHtml, explainRule, findAttr, formatAgentReport, formatConsoleReport, formatGithubReport, formatHtmlReport, formatJsonReport, formatSarifReport, hasFailureAtOrAbove, headTagRule, imageRule, isPenalized, lineOf, linkRule, noColorPalette, parseComponentFacts, perf001ImageDimensions, perf002ImageLoading, perf003PreloadAs, perf004FontPreloadCrossorigin, perf005LcpImage, perf006ResponsiveImage, perf007RenderBlockingScript, perf008Preconnect, perf009HeavyImport, perf010NamespaceImport, runRules, safeHref, scoreBand, scoreColor, scoresByCategory, sec001Html, sec002JavascriptUrl, selectRules, seo001Title, seo002Description, seo003Canonical, seo004OgImage, seo005OgTitle, seo006Robots, seo007Sitemap, seo008JsonLd, seo009HtmlLang, seo010Indexability, seo011TwitterCard, seo012OgDescription, seo013OgUrl, seo014Viewport, seo015SitemapInRobots, seo016JsonLdValidity, seo017DeprecatedType, seo018RelativeUrl, seo019DateFormat, seo020Placeholder, seo021RequiredProps, seo022TitleLength, seo023DescriptionLength, seo024Charset, seo025ImageAlt, seo026Hreflang, seo027Heading, seo028TitleUnique, seo029DescriptionUnique, seo030HeadingOrder, summarize, textFromNodes, valueFromNodes };
+export { BAND_COLOR, CHILD_NODE_KEYS, type Category, type Classification, type ComponentFacts, type Config, type ConsoleReportOptions, type Detection, type EachBlockFact, type EffectFact, type Fix, type HeadProvider, type HeadTag, type HeadingInfo, type HealthResult, type ImageInfo, type JsonReport, type Palette, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, type ResolvedHeadings, type ResolvedImages, type Result, type Rule, type RuleContext, type RuleInfo, type RuleSetting, type Runtime, SITEMAP_SOURCE_PATHS, type Scope, type ScoreModel, type ScoreOptions, type ScoreResult, type Severity, type SourceSpan, type Summary, type SuppressionDirective, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, arch001ComponentSize, arch002PropCount, attrText, attrTextOf, attrValue, attrValueOf, buildHtmlDocument, buildJsonReport, classify, collectComponentFacts, computeHealth, computeScore, correct001EachKey, correct002EffectDerived, correct003EffectAsOnMount, correct004UnmutatedState, correct005PropMutation, defaultConfig, defaultProject, defineConfig, docsUrlFor, effectiveSeverity, emptyComponentFacts, escapeHtml, explainRule, findAttr, formatAgentReport, formatConsoleReport, formatGithubReport, formatHtmlReport, formatJsonReport, formatMarkdownReport, formatSarifReport, hasFailureAtOrAbove, headTagRule, imageRule, isPenalized, lineOf, linkRule, noColorPalette, parseComponentFacts, perf001ImageDimensions, perf002ImageLoading, perf003PreloadAs, perf004FontPreloadCrossorigin, perf005LcpImage, perf006ResponsiveImage, perf007RenderBlockingScript, perf008Preconnect, perf009HeavyImport, perf010NamespaceImport, runRules, safeHref, scoreBand, scoreColor, scoresByCategory, sec001Html, sec002JavascriptUrl, selectRules, seo001Title, seo002Description, seo003Canonical, seo004OgImage, seo005OgTitle, seo006Robots, seo007Sitemap, seo008JsonLd, seo009HtmlLang, seo010Indexability, seo011TwitterCard, seo012OgDescription, seo013OgUrl, seo014Viewport, seo015SitemapInRobots, seo016JsonLdValidity, seo017DeprecatedType, seo018RelativeUrl, seo019DateFormat, seo020Placeholder, seo021RequiredProps, seo022TitleLength, seo023DescriptionLength, seo024Charset, seo025ImageAlt, seo026Hreflang, seo027Heading, seo028TitleUnique, seo029DescriptionUnique, seo030HeadingOrder, summarize, textFromNodes, valueFromNodes };

package/dist/index.js

@@ -2654,6 +2654,82 @@ function formatGithubReport(results, config) {
   return lines.join("\n");
 }
 
+// src/reporter/markdown.ts
+var MAX_FINDINGS = 50;
+var SEVERITY_EMOJI = { critical: "\u{1F534}", warning: "\u{1F7E1}", info: "\u{1F535}" };
+var SEVERITY_RANK2 = { critical: 0, warning: 1, info: 2 };
+function escapeCell(s) {
+  return s.replace(/\|/g, "\\|").replace(/\r\n|\r|\n/g, " ");
+}
+function locationOf(issue, route) {
+  if (issue.location) return issue.line !== void 0 ? `${issue.location}:${issue.line}` : issue.location;
+  return route ?? "-";
+}
+function flattenFindings(report) {
+  const findings = [];
+  for (const r of report.routes) {
+    for (const issue of r.issues) {
+      findings.push({
+        severity: issue.severity,
+        id: issue.id,
+        location: locationOf(issue, r.route),
+        message: issue.title
+      });
+    }
+  }
+  for (const issue of report.siteIssues) {
+    findings.push({
+      severity: issue.severity,
+      id: issue.id,
+      location: locationOf(issue, void 0),
+      message: issue.title
+    });
+  }
+  return findings.map((f, index) => ({ f, index })).sort((a, b) => SEVERITY_RANK2[a.f.severity] - SEVERITY_RANK2[b.f.severity] || a.index - b.index).map(({ f }) => f);
+}
+function categoryRows(categories) {
+  const names = Object.keys(categories).sort();
+  return names.map((cat) => `| ${cat} | ${categories[cat].score} |`);
+}
+function formatMarkdownReport(results, config, meta) {
+  const report = buildJsonReport(results, config, meta);
+  const lines = [];
+  lines.push(`<!-- svelte-vitals v${meta.version} -->`);
+  lines.push(`## svelte-vitals \u2014 Health ${report.score}/100`);
+  lines.push("");
+  const catRows = categoryRows(report.categories);
+  if (catRows.length > 0) {
+    lines.push("| Category | Score |");
+    lines.push("| --- | --- |");
+    lines.push(...catRows);
+    lines.push("");
+  }
+  const { critical, warning, info, passed } = report.summary;
+  lines.push(`**${critical} critical \xB7 ${warning} warning \xB7 ${info} info** (${passed} checks passed)`);
+  lines.push("");
+  const findings = flattenFindings(report);
+  if (findings.length === 0) {
+    lines.push("\u2705 No issues found.");
+  } else {
+    lines.push("### Findings");
+    lines.push("");
+    lines.push("| Severity | Rule | Location | Message |");
+    lines.push("| --- | --- | --- | --- |");
+    const shown = findings.slice(0, MAX_FINDINGS);
+    for (const f of shown) {
+      const rule = `[${f.id}](${docsUrlFor(f.id)})`;
+      lines.push(
+        `| ${SEVERITY_EMOJI[f.severity]} ${f.severity} | ${rule} | ${escapeCell(f.location)} | ${escapeCell(f.message)} |`
+      );
+    }
+    if (findings.length > MAX_FINDINGS) {
+      lines.push("");
+      lines.push(`\u2026and ${findings.length - MAX_FINDINGS} more (run \`npx svelte-vitals\` locally for the full report)`);
+    }
+  }
+  return lines.join("\n");
+}
+
 // src/reporter/html.ts
 var BAND_COLOR = {
   good: "#2FA968",
@@ -2888,6 +2964,7 @@ export {
   formatGithubReport,
   formatHtmlReport,
   formatJsonReport,
+  formatMarkdownReport,
   formatSarifReport,
   hasFailureAtOrAbove,
   headTagRule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@svelte-vitals/core",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Shared, runtime-agnostic core for svelte-vitals (types, rule engine, scorer, reporter).",
   "type": "module",
   "license": "MIT",