@svelte-vitals/core 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -247,6 +247,17 @@ declare function formatJsonReport(results: Result[], config: Config, meta: {
 /** Render failing findings as an agent-actionable Markdown remediation document (issue #18). */
 declare function formatAgentReport(results: Result[], config: Config): string;
 
+/** Render penalized findings as a SARIF 2.1.0 log string (issue #18, design slice 5). */
+declare function formatSarifReport(results: Result[], config: Config, meta: {
+    version: string;
+}): string;
+
+/**
+ * Render penalized findings as GitHub Actions workflow commands (issue #18, design slice 5).
+ * GitHub turns these into inline PR annotations and run-annotation entries. Returns '' when clean.
+ */
+declare function formatGithubReport(results: Result[], config: Config): string;
+
 /** Drop rules disabled via config (design §6). */
 declare function selectRules(rules: Rule[], config: Config): Rule[];
 /** Apply per-rule severity overrides to results (design §6). */
@@ -268,4 +279,4 @@ interface ScoreOptions {
 /** Compute the headline score and its breakdown (design §12). */
 declare function computeScore(results: Result[], config: Config, options?: ScoreOptions): ScoreResult;
 
-export { type Category, type Classification, type Config, type ConsoleReportOptions, type Detection, type Fix, type HeadProvider, type HeadTag, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, type Result, type Rule, type RuleContext, type RuleSetting, type Runtime, SITEMAP_SOURCE_PATHS, type Scope, type ScoreModel, type ScoreOptions, type ScoreResult, type Severity, type Summary, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, classify, computeScore, defaultConfig, defaultProject, defineConfig, effectiveSeverity, formatAgentReport, formatConsoleReport, formatJsonReport, hasFailureAtOrAbove, headTagRule, isPenalized, runRules, selectRules, seo001Title, seo002Description, seo003Canonical, seo004OgImage, seo005OgTitle, seo006Robots, seo007Sitemap, seo008JsonLd, seo009HtmlLang, summarize };
+export { type Category, type Classification, type Config, type ConsoleReportOptions, type Detection, type Fix, type HeadProvider, type HeadTag, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, type Result, type Rule, type RuleContext, type RuleSetting, type Runtime, SITEMAP_SOURCE_PATHS, type Scope, type ScoreModel, type ScoreOptions, type ScoreResult, type Severity, type Summary, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, classify, computeScore, defaultConfig, defaultProject, defineConfig, effectiveSeverity, formatAgentReport, formatConsoleReport, formatGithubReport, formatJsonReport, formatSarifReport, hasFailureAtOrAbove, headTagRule, isPenalized, runRules, selectRules, seo001Title, seo002Description, seo003Canonical, seo004OgImage, seo005OgTitle, seo006Robots, seo007Sitemap, seo008JsonLd, seo009HtmlLang, summarize };

package/dist/index.js

@@ -499,6 +499,97 @@ function formatAgentReport(results, config) {
   return lines.join("\n").replace(/\n+$/, "\n");
 }
 
+// src/reporter/shared.ts
+function severityToSarifLevel(sev) {
+  return sev === "critical" ? "error" : sev === "warning" ? "warning" : "note";
+}
+function severityToGithubLevel(sev) {
+  return sev === "critical" ? "error" : sev === "warning" ? "warning" : "notice";
+}
+function messageText(result) {
+  return result.recommendation ? `${result.message} ${result.recommendation}` : result.message;
+}
+function docsUrlFor(id) {
+  return `https://svelte-vitals.dev/rules/${id}`;
+}
+var RULE_META = new Map(
+  allRules.map((r) => [r.id, { title: r.title, severity: r.severity, docsUrl: docsUrlFor(r.id) }])
+);
+function ruleMetaById(id) {
+  return RULE_META.get(id);
+}
+
+// src/reporter/sarif.ts
+function formatSarifReport(results, config, meta) {
+  const penalized = results.filter((r) => isPenalized(r.detection, config.treatDynamicAs));
+  const rules = [];
+  const ruleIndex = /* @__PURE__ */ new Map();
+  const sarifResults = penalized.map((r) => {
+    if (!ruleIndex.has(r.id)) {
+      const m = ruleMetaById(r.id);
+      const name = m?.title ?? r.id;
+      ruleIndex.set(r.id, rules.length);
+      rules.push({
+        id: r.id,
+        name,
+        shortDescription: { text: name },
+        helpUri: r.docsUrl ?? m?.docsUrl ?? docsUrlFor(r.id),
+        defaultConfiguration: { level: severityToSarifLevel(m?.severity ?? r.severity) }
+      });
+    }
+    const result = {
+      ruleId: r.id,
+      ruleIndex: ruleIndex.get(r.id),
+      level: severityToSarifLevel(effectiveSeverity(r, config)),
+      message: { text: messageText(r) },
+      partialFingerprints: { "svelteVitals/v1": `${r.id}:${r.route ?? "project"}` }
+    };
+    if (r.location) {
+      result.locations = [{ physicalLocation: { artifactLocation: { uri: r.location } } }];
+    }
+    return result;
+  });
+  const log = {
+    $schema: "https://json.schemastore.org/sarif-2.1.0.json",
+    version: "2.1.0",
+    runs: [
+      {
+        tool: {
+          driver: {
+            name: "svelte-vitals",
+            informationUri: "https://svelte-vitals.dev",
+            version: meta.version,
+            rules
+          }
+        },
+        results: sarifResults
+      }
+    ]
+  };
+  return JSON.stringify(log, null, 2);
+}
+
+// src/reporter/github.ts
+function escapeData(s) {
+  return s.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A");
+}
+function escapeProp(s) {
+  return escapeData(s).replace(/:/g, "%3A").replace(/,/g, "%2C");
+}
+function formatGithubReport(results, config) {
+  const penalized = results.filter((r) => isPenalized(r.detection, config.treatDynamicAs));
+  const lines = penalized.map((r) => {
+    const level = severityToGithubLevel(effectiveSeverity(r, config));
+    const meta = ruleMetaById(r.id);
+    const title = meta ? `${r.id}: ${meta.title}` : r.id;
+    const props = [];
+    if (r.location) props.push(`file=${escapeProp(r.location)}`);
+    props.push(`title=${escapeProp(title)}`);
+    return `::${level} ${props.join(",")}::${escapeData(messageText(r))}`;
+  });
+  return lines.join("\n");
+}
+
 // src/config-apply.ts
 function selectRules(rules, config) {
   return rules.filter((rule) => config.rules[rule.id] !== "off");
@@ -522,7 +613,9 @@ export {
   effectiveSeverity,
   formatAgentReport,
   formatConsoleReport,
+  formatGithubReport,
   formatJsonReport,
+  formatSarifReport,
   hasFailureAtOrAbove,
   headTagRule,
   isPenalized,

package/package.json

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