svelte-vitals 0.3.0 → 0.5.0

package/dist/bin.js

@@ -1,32 +1,15 @@
 #!/usr/bin/env node
 import {
+  buildRulesConfig,
+  findUnknownRuleIds,
   isReporterName,
+  knownRuleIds,
   readPackageVersion,
   run
-} from "./chunk-LYX2RVRM.js";
+} from "./chunk-RI6LBHFR.js";
 
 // src/bin.ts
 import mri from "mri";
-
-// src/rules-config.ts
-import { allRules } from "@svelte-vitals/core";
-var KNOWN_IDS = new Set(allRules.map((r) => r.id));
-function findUnknownRuleIds(ids) {
-  return [...new Set(ids.filter((id) => !KNOWN_IDS.has(id)))];
-}
-function knownRuleIds() {
-  return [...KNOWN_IDS].sort();
-}
-function buildRulesConfig(allow, ignore) {
-  const rules = {};
-  if (allow.length > 0) {
-    for (const r of allRules) if (!allow.includes(r.id)) rules[r.id] = "off";
-  }
-  for (const id of ignore) rules[id] = "off";
-  return rules;
-}
-
-// src/bin.ts
 var HELP = `svelte-vitals \u2014 a SvelteKit SEO checker (static mode)
 
 Usage:
@@ -37,7 +20,7 @@ Options:
   --treat-dynamic-as <mode>   pass | warn | fail (default: pass)
   --route <glob>              Only analyze routes matching this glob
   --by-route                  Show per-route score breakdown in console output
-  --reporter <fmt>            console | json | agent (auto: agent under AI-agent envs)
+  --reporter <fmt>            console | json | agent | sarif | github (auto: agent under AI-agent envs, github under GitHub Actions)
   --json                      Alias for --reporter=json
   --fail-on <severity>        Fail (exit 1) when any finding reaches this severity: critical | warning | info
   --fail-on-warning           Alias for --fail-on=warning
@@ -84,7 +67,9 @@ async function main() {
     reporter = "json";
   } else if (typeof argv.reporter === "string") {
     if (!isReporterName(argv.reporter)) {
-      console.error(`svelte-vitals: unknown reporter '${argv.reporter}'. Valid values: console, json, agent.`);
+      console.error(
+        `svelte-vitals: unknown reporter '${argv.reporter}'. Valid values: console, json, agent, sarif, github.`
+      );
       process.exit(2);
     }
     reporter = argv.reporter;

package/dist/{chunk-LYX2RVRM.js → chunk-RI6LBHFR.js}

@@ -1,10 +1,12 @@
 // src/index.ts
 import {
-  allRules,
+  allRules as allRules2,
   runRules,
   formatConsoleReport,
   formatJsonReport,
   formatAgentReport,
+  formatSarifReport,
+  formatGithubReport,
   summarize,
   hasFailureAtOrAbove,
   defineConfig,
@@ -449,7 +451,7 @@ function readPackageVersion() {
 // src/reporter-resolve.ts
 var AGENT_ENV_VARS = ["CLAUDECODE", "SVELTE_VITALS_AGENT"];
 function isReporterName(value) {
-  return value === "console" || value === "json" || value === "agent";
+  return value === "console" || value === "json" || value === "agent" || value === "sarif" || value === "github";
 }
 function isAgentEnv(env = process.env) {
   return AGENT_ENV_VARS.some((key) => {
@@ -457,16 +459,41 @@ function isAgentEnv(env = process.env) {
     return v !== void 0 && v !== "";
   });
 }
+function isGithubActionsEnv(env = process.env) {
+  return env.GITHUB_ACTIONS === "true";
+}
 function resolveReporter(explicit, env = process.env) {
   if (explicit) return explicit;
   const fromEnv = env.SVELTE_VITALS_REPORTER;
   if (isReporterName(fromEnv)) return fromEnv;
   if (isAgentEnv(env)) return "agent";
+  if (isGithubActionsEnv(env)) return "github";
   return "console";
 }
 function isAutoDetectedAgent(explicit, env = process.env) {
   return !explicit && !isReporterName(env.SVELTE_VITALS_REPORTER) && isAgentEnv(env);
 }
+function isAutoDetectedGithub(explicit, env = process.env) {
+  return !explicit && !isReporterName(env.SVELTE_VITALS_REPORTER) && !isAgentEnv(env) && isGithubActionsEnv(env);
+}
+
+// src/rules-config.ts
+import { allRules } from "@svelte-vitals/core";
+var KNOWN_IDS = new Set(allRules.map((r) => r.id));
+function findUnknownRuleIds(ids) {
+  return [...new Set(ids.filter((id) => !KNOWN_IDS.has(id)))];
+}
+function knownRuleIds() {
+  return [...KNOWN_IDS].sort();
+}
+function buildRulesConfig(allow, ignore) {
+  const rules = {};
+  if (allow.length > 0) {
+    for (const r of allRules) if (!allow.includes(r.id)) rules[r.id] = "off";
+  }
+  for (const id of ignore) rules[id] = "off";
+  return rules;
+}
 
 // src/index.ts
 function routeMatcher(glob) {
@@ -475,10 +502,8 @@ function routeMatcher(glob) {
   const re = new RegExp(`^${body}$`);
   return (route) => re.test(route.replace(/^\//, ""));
 }
-async function run(opts = {}) {
+async function analyzeProject(opts = {}) {
   const cwd = opts.cwd ?? process.cwd();
-  const log = opts.log ?? ((line) => console.log(line));
-  const errorLog = opts.errorLog ?? ((line) => console.error(line));
   const rt = createNodeRuntime();
   const config = defineConfig({
     treatDynamicAs: opts.treatDynamicAs ?? "pass",
@@ -486,21 +511,37 @@ async function run(opts = {}) {
     rules: opts.rules ?? {},
     failOn: opts.failOn ?? "critical"
   });
+  await detectProject(rt, cwd);
+  const matches = routeMatcher(opts.route);
+  const heads = (await sourceHeadProvider.collect(rt, cwd, config)).filter((h) => matches(h.route));
+  const project = await collectProjectFacts(rt, cwd);
+  const rules = selectRules(allRules2, config);
+  const results = applyRuleSeverities(await runRules(rules, { heads, project, config }), config);
+  return { results, config, version: readPackageVersion() };
+}
+async function run(opts = {}) {
+  const log = opts.log ?? ((line) => console.log(line));
+  const errorLog = opts.errorLog ?? ((line) => console.error(line));
+  let analysis;
   try {
-    await detectProject(rt, cwd);
+    analysis = await analyzeProject({
+      cwd: opts.cwd ?? process.cwd(),
+      metaComponents: opts.metaComponents,
+      treatDynamicAs: opts.treatDynamicAs,
+      route: opts.route,
+      failOn: opts.failOn,
+      rules: opts.rules
+    });
   } catch (err) {
     if (err instanceof ProjectError) {
       errorLog(err.message);
       return 2;
     }
-    throw err;
+    errorLog(`svelte-vitals: ${err instanceof Error ? err.message : String(err)}`);
+    return 2;
   }
   try {
-    const matches = routeMatcher(opts.route);
-    const heads = (await sourceHeadProvider.collect(rt, cwd, config)).filter((h) => matches(h.route));
-    const project = await collectProjectFacts(rt, cwd);
-    const rules = selectRules(allRules, config);
-    const results = applyRuleSeverities(await runRules(rules, { heads, project, config }), config);
+    const { results, config, version } = analysis;
     const env = opts.env ?? process.env;
     const reporter = resolveReporter(opts.reporter, env);
     if (reporter === "agent" && isAutoDetectedAgent(opts.reporter, env)) {
@@ -508,10 +549,20 @@ async function run(opts = {}) {
         "svelte-vitals: agent reporter auto-selected (AI-agent env detected); override with --reporter console|json."
       );
     }
+    if (reporter === "github" && isAutoDetectedGithub(opts.reporter, env)) {
+      errorLog(
+        "svelte-vitals: github reporter auto-selected (GitHub Actions detected); override with --reporter console|json|sarif."
+      );
+    }
     if (reporter === "json") {
-      log(formatJsonReport(results, config, { version: readPackageVersion() }));
+      log(formatJsonReport(results, config, { version }));
     } else if (reporter === "agent") {
       log(formatAgentReport(results, config));
+    } else if (reporter === "sarif") {
+      log(formatSarifReport(results, config, { version }));
+    } else if (reporter === "github") {
+      const output = formatGithubReport(results, config);
+      if (output) log(output);
     } else {
       log(formatConsoleReport(results, config, { byRoute: opts.byRoute ?? false }));
     }
@@ -524,8 +575,13 @@ async function run(opts = {}) {
 }
 
 export {
+  ProjectError,
   readPackageVersion,
   isReporterName,
+  findUnknownRuleIds,
+  knownRuleIds,
+  buildRulesConfig,
   routeMatcher,
+  analyzeProject,
   run
 };

package/dist/index.d.ts

@@ -1,6 +1,23 @@
-import { Severity, RuleSetting } from '@svelte-vitals/core';
+import { RuleSetting, Severity, Result, Config } from '@svelte-vitals/core';
 
-type ReporterName = 'console' | 'json' | 'agent';
+type ReporterName = 'console' | 'json' | 'agent' | 'sarif' | 'github';
+
+/** Thrown when the target directory is not a SvelteKit project (CLI maps to exit 2). */
+declare class ProjectError extends Error {
+    constructor(message: string);
+}
+
+/** Rule ids passed to --rules/--ignore that aren't part of the built-in registry. */
+declare function findUnknownRuleIds(ids: string[]): string[];
+/** All built-in rule ids, sorted — for help and error messages. */
+declare function knownRuleIds(): string[];
+/**
+ * Build the per-rule config map from an allow-list (--rules) and a deny-list
+ * (--ignore). An allow-list disables every rule not listed; deny always wins.
+ * Callers should reject unknown ids first (see findUnknownRuleIds) so a typo in
+ * --rules can't silently disable every rule.
+ */
+declare function buildRulesConfig(allow: string[], ignore: string[]): Record<string, RuleSetting>;
 
 interface RunOptions {
     cwd?: string;
@@ -18,10 +35,30 @@ interface RunOptions {
     env?: NodeJS.ProcessEnv;
 }
 declare function routeMatcher(glob: string | undefined): (route: string) => boolean;
+interface AnalyzeOptions {
+    cwd?: string;
+    metaComponents?: string[];
+    treatDynamicAs?: 'pass' | 'warn' | 'fail';
+    /** Restrict analysis to routes whose path matches this glob (matched against the route path without leading slash). */
+    route?: string;
+    failOn?: Severity;
+    rules?: Record<string, RuleSetting>;
+}
+interface AnalyzeResult {
+    results: Result[];
+    config: Config;
+    version: string;
+}
+/**
+ * Run static-mode analysis and return the structured findings + resolved config.
+ * Throws ProjectError when `cwd` is not a SvelteKit project. Shared by the CLI's
+ * run() and by @svelte-vitals/mcp (issue #24).
+ */
+declare function analyzeProject(opts?: AnalyzeOptions): Promise<AnalyzeResult>;
 /**
  * Run static-mode analysis once and return the process exit code (design §6):
  *   0 = no failing findings, 1 = critical finding present, 2 = execution error.
  */
 declare function run(opts?: RunOptions): Promise<number>;
 
-export { type RunOptions, routeMatcher, run };
+export { type AnalyzeOptions, type AnalyzeResult, ProjectError, type RunOptions, analyzeProject, buildRulesConfig, findUnknownRuleIds, knownRuleIds, routeMatcher, run };

package/dist/index.js

@@ -1,8 +1,18 @@
 import {
+  ProjectError,
+  analyzeProject,
+  buildRulesConfig,
+  findUnknownRuleIds,
+  knownRuleIds,
   routeMatcher,
   run
-} from "./chunk-LYX2RVRM.js";
+} from "./chunk-RI6LBHFR.js";
 export {
+  ProjectError,
+  analyzeProject,
+  buildRulesConfig,
+  findUnknownRuleIds,
+  knownRuleIds,
   routeMatcher,
   run
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-vitals",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A SvelteKit SEO checker — not a runtime Web Vitals reporter. Static analysis of your routes' head metadata.",
   "type": "module",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "mri": "^1.2.0",
     "svelte": "^5.56.3",
     "tinyglobby": "^0.2.17",
-    "@svelte-vitals/core": "0.4.0"
+    "@svelte-vitals/core": "0.6.0"
   },
   "devDependencies": {
     "@types/node": "^24.7.0"