@svelte-vitals/core 0.8.0 → 0.10.0

package/dist/index.d.ts

@@ -53,7 +53,7 @@ interface Result {
     line?: number;
 }
 type Scope = 'route' | 'project';
-type Category = 'seo' | 'performance' | 'a11y' | 'maintainability';
+type Category = 'seo' | 'performance';
 /** How dynamic (`{data.title}`) values are treated by scoring (design §4, §12). */
 type TreatDynamicAs = 'pass' | 'warn' | 'fail';
 /** Per-rule override: disable, or change severity. */
@@ -66,6 +66,8 @@ interface Config {
     rules: Record<string, RuleSetting>;
     /** Minimum severity that fails the run / CI (design §6). */
     failOn: Severity;
+    /** Per-category weights for the combined Health score (default: equal, 1 each) (#10). */
+    weights?: Partial<Record<Category, number>>;
 }
 declare const defaultConfig: Config;
 /** Merge user config over defaults. Identity helper for config files (design §6). */
@@ -320,6 +322,15 @@ interface ScoreOptions {
 declare function computeScore(results: Result[], config: Config, options?: ScoreOptions): ScoreResult;
 /** Compute an independent score per category present in `results` (issue #10). */
 declare function scoresByCategory(results: Result[], config: Config): Partial<Record<Category, ScoreResult>>;
+interface HealthResult {
+    /** Weighted overall score across present categories (0–100). */
+    health: number;
+    categories: Partial<Record<Category, ScoreResult>>;
+    /** Effective weight used per present category. */
+    weights: Partial<Record<Category, number>>;
+}
+/** Combined weighted Health score over the categories present in `results` (#10). */
+declare function computeHealth(results: Result[], config: Config): HealthResult;
 
 declare function issueOf(result: Result): {
     fix?: Fix | undefined;
@@ -338,7 +349,7 @@ type JsonIssue = ReturnType<typeof issueOf> & {
 interface JsonReport {
     version: string;
     score: number;
-    scoreModel: ScoreModel;
+    weights: Partial<Record<Category, number>>;
     categories: Record<string, {
         score: number;
         scoreModel: ScoreModel;
@@ -379,4 +390,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 { type Category, type Classification, type Config, type ConsoleReportOptions, type Detection, type Fix, type HeadProvider, type HeadTag, type ImageInfo, type JsonReport, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, 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 Summary, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, buildJsonReport, classify, computeScore, defaultConfig, defaultProject, defineConfig, docsUrlFor, effectiveSeverity, explainRule, formatAgentReport, formatConsoleReport, formatGithubReport, formatJsonReport, formatSarifReport, hasFailureAtOrAbove, headTagRule, imageRule, isPenalized, perf001ImageDimensions, perf002ImageLoading, runRules, scoresByCategory, 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 HealthResult, type ImageInfo, type JsonReport, type Presence, type Project, ROBOTS_SOURCE_PATHS, type ResolvedHead, 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 Summary, type TreatDynamicAs, type Value, allRules, applyRuleSeverities, buildJsonReport, classify, computeHealth, computeScore, defaultConfig, defaultProject, defineConfig, docsUrlFor, effectiveSeverity, explainRule, formatAgentReport, formatConsoleReport, formatGithubReport, formatJsonReport, formatSarifReport, hasFailureAtOrAbove, headTagRule, imageRule, isPenalized, perf001ImageDimensions, perf002ImageLoading, runRules, scoresByCategory, selectRules, seo001Title, seo002Description, seo003Canonical, seo004OgImage, seo005OgTitle, seo006Robots, seo007Sitemap, seo008JsonLd, seo009HtmlLang, summarize };

package/dist/index.js

@@ -490,6 +490,27 @@ function scoresByCategory(results, config) {
   for (const [cat, rs] of byCat) out[cat] = computeScore(rs, config);
   return out;
 }
+function computeHealth(results, config) {
+  const categories = scoresByCategory(results, config);
+  const weights = {};
+  let weighted = 0;
+  let total = 0;
+  for (const cat of Object.keys(categories)) {
+    const w = config.weights?.[cat] ?? 1;
+    if (!Number.isFinite(w) || w < 0) {
+      throw new RangeError(`invalid weight for '${cat}'; expected a finite number >= 0.`);
+    }
+    weights[cat] = w;
+    weighted += categories[cat].score * w;
+    total += w;
+  }
+  if (Object.keys(weights).length === 0) return { health: 100, categories, weights };
+  if (total === 0) {
+    throw new RangeError("Health weights sum to 0; at least one present category must have a positive weight.");
+  }
+  const health = Math.round(weighted / total);
+  return { health, categories, weights };
+}
 
 // src/reporter/console.ts
 var RULE = "\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500";
@@ -500,11 +521,9 @@ var SEVERITY_TITLE = {
 };
 var CATEGORY_LABEL = {
   seo: "SEO",
-  performance: "Performance",
-  a11y: "Accessibility",
-  maintainability: "Maintainability"
+  performance: "Performance"
 };
-var CATEGORY_ORDER = ["seo", "performance", "a11y", "maintainability"];
+var CATEGORY_ORDER = ["seo", "performance"];
 function scoreLine(label, { score, scoreModel }) {
   const parts = [`route avg ${scoreModel.routeAverage}`];
   if (scoreModel.sitePenalty > 0) parts.push(`site \u2212${scoreModel.sitePenalty}`);
@@ -531,9 +550,9 @@ function byRouteTree(results, config) {
 }
 function formatConsoleReport(results, config, options = {}) {
   const summary = summarize(results, config);
-  const byCat = scoresByCategory(results, config);
+  const { health, categories: byCat } = computeHealth(results, config);
   const present2 = CATEGORY_ORDER.filter((c) => byCat[c] !== void 0);
-  const header = [`Svelte Vitals  \xB7  ${options.mode ?? "static mode"}`, ""];
+  const header = [`Svelte Vitals  \xB7  ${options.mode ?? "static mode"}`, "", `Health: ${health}/100`];
   for (const c of present2) {
     header.push(scoreLine(CATEGORY_LABEL[c] ?? c, byCat[c]));
   }
@@ -580,10 +599,8 @@ function issueOf(result) {
   };
 }
 function buildJsonReport(results, config, meta) {
-  const seoResults = results.filter((r) => (r.category ?? "seo") === "seo");
-  const { score, scoreModel } = computeScore(seoResults, config);
+  const { health, categories: byCat, weights } = computeHealth(results, config);
   const summary = summarize(results, config);
-  const byCat = scoresByCategory(results, config);
   const categories = Object.fromEntries(
     Object.entries(byCat).map(([cat, sr]) => [cat, { score: sr.score, scoreModel: sr.scoreModel }])
   );
@@ -599,7 +616,7 @@ function buildJsonReport(results, config, meta) {
     issues: rs.filter((r) => isPenalized(r.detection, config.treatDynamicAs)).map((r) => ({ ...issueOf(r), severity: effectiveSeverity(r, config) }))
   }));
   const siteIssues = results.filter((r) => r.route === void 0 && isPenalized(r.detection, config.treatDynamicAs)).map((r) => ({ ...issueOf(r), severity: effectiveSeverity(r, config) }));
-  return { version: meta.version, score, scoreModel, categories, summary, routes, siteIssues };
+  return { version: meta.version, score: health, weights, categories, summary, routes, siteIssues };
 }
 function formatJsonReport(results, config, meta) {
   return JSON.stringify(buildJsonReport(results, config, meta), null, 2);
@@ -612,7 +629,8 @@ function mdTags(text) {
 }
 function formatAgentReport(results, config) {
   const failing = results.filter((r) => classify(r, config) === "fail");
-  const lines = ["# svelte-vitals \u2014 fixes", ""];
+  const { health } = computeHealth(results, config);
+  const lines = ["# svelte-vitals \u2014 fixes", "", `Health: ${health}/100`, ""];
   if (failing.length === 0) {
     lines.push("No issues to fix.", "");
     return lines.join("\n").replace(/\n+$/, "\n");
@@ -771,6 +789,7 @@ export {
   applyRuleSeverities,
   buildJsonReport,
   classify,
+  computeHealth,
   computeScore,
   defaultConfig,
   defaultProject,

package/package.json

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