npm - svelte-vitals - Versions diffs - 0.2.1 → 0.4.0 - Mend

svelte-vitals 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +6 -0
package/dist/bin.js +15 -3
package/dist/{chunk-O2LBOXFF.js → chunk-XOPYXOAE.js} +53 -1
package/dist/index.d.ts +5 -1
package/dist/index.js +1 -1
package/package.json +2 -2

package/README.md CHANGED Viewed

@@ -50,6 +50,12 @@ Passed (3)
 Useful as a CI gate.
+### Agent-native output
+`svelte-vitals --reporter agent` emits a Markdown remediation document an AI coding agent can act on directly: each failing finding lists its location, a concrete fix (with a code snippet), and an acceptance check.
+It is selected **automatically** when run inside a known AI-agent harness (e.g. Claude Code sets `CLAUDECODE`). Force it anywhere with `SVELTE_VITALS_REPORTER=agent`, or override with `--reporter console|json`. When auto-selected (not requested explicitly), a one-line hint is printed to stderr explaining how to override, so a human running it in an agent terminal isn't surprised by the Markdown output.
 ## How it works
 svelte-vitals resolves the effective `<head>` of every route by walking the layout chain (`+layout.svelte` → … → `+page.svelte`) and parsing `<svelte:head>` with `svelte/compiler`.

package/dist/bin.js CHANGED Viewed

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 import {
+  isReporterName,
   readPackageVersion,
   run
-} from "./chunk-O2LBOXFF.js";
+} from "./chunk-XOPYXOAE.js";
 // src/bin.ts
 import mri from "mri";
@@ -36,7 +37,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 <mode>           console | json (default: console)
+  --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
@@ -78,7 +79,18 @@ async function main() {
     console.error(`Known rule ids: ${knownRuleIds().join(", ")}`);
     process.exit(2);
   }
-  const reporter = argv.json || argv.reporter === "json" ? "json" : "console";
+  let reporter;
+  if (argv.json) {
+    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, sarif, github.`
+      );
+      process.exit(2);
+    }
+    reporter = argv.reporter;
+  }
   const failOnRaw = argv["fail-on"];
   const failOn = argv["fail-on-warning"] ? "warning" : failOnRaw === "warning" || failOnRaw === "info" || failOnRaw === "critical" ? failOnRaw : void 0;
   const code = await run({

package/dist/{chunk-O2LBOXFF.js → chunk-XOPYXOAE.js} RENAMED Viewed

@@ -4,6 +4,9 @@ import {
   runRules,
   formatConsoleReport,
   formatJsonReport,
+  formatAgentReport,
+  formatSarifReport,
+  formatGithubReport,
   summarize,
   hasFailureAtOrAbove,
   defineConfig,
@@ -445,6 +448,35 @@ function readPackageVersion() {
   }
 }
+// src/reporter-resolve.ts
+var AGENT_ENV_VARS = ["CLAUDECODE", "SVELTE_VITALS_AGENT"];
+function isReporterName(value) {
+  return value === "console" || value === "json" || value === "agent" || value === "sarif" || value === "github";
+}
+function isAgentEnv(env = process.env) {
+  return AGENT_ENV_VARS.some((key) => {
+    const v = env[key];
+    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/index.ts
 function routeMatcher(glob) {
   if (!glob) return () => true;
@@ -478,8 +510,27 @@ async function run(opts = {}) {
     const project = await collectProjectFacts(rt, cwd);
     const rules = selectRules(allRules, config);
     const results = applyRuleSeverities(await runRules(rules, { heads, project, config }), config);
-    if (opts.reporter === "json") {
+    const env = opts.env ?? process.env;
+    const reporter = resolveReporter(opts.reporter, env);
+    if (reporter === "agent" && isAutoDetectedAgent(opts.reporter, env)) {
+      errorLog(
+        "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() }));
+    } else if (reporter === "agent") {
+      log(formatAgentReport(results, config));
+    } else if (reporter === "sarif") {
+      log(formatSarifReport(results, config, { version: readPackageVersion() }));
+    } else if (reporter === "github") {
+      const output = formatGithubReport(results, config);
+      if (output) log(output);
     } else {
       log(formatConsoleReport(results, config, { byRoute: opts.byRoute ?? false }));
     }
@@ -493,6 +544,7 @@ async function run(opts = {}) {
 export {
   readPackageVersion,
+  isReporterName,
   routeMatcher,
   run
 };

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,7 @@
 import { Severity, RuleSetting } from '@svelte-vitals/core';
+type ReporterName = 'console' | 'json' | 'agent' | 'sarif' | 'github';
 interface RunOptions {
     cwd?: string;
     log?: (line: string) => void;
@@ -8,10 +10,12 @@ interface RunOptions {
     treatDynamicAs?: 'pass' | 'warn' | 'fail';
     /** Restrict analysis to routes whose path matches this glob (matched against the route path without leading slash). */
     route?: string;
-    reporter?: 'console' | 'json';
+    reporter?: ReporterName;
     byRoute?: boolean;
     failOn?: Severity;
     rules?: Record<string, RuleSetting>;
+    /** Override process.env for reporter auto-detection (mainly useful in tests). */
+    env?: NodeJS.ProcessEnv;
 }
 declare function routeMatcher(glob: string | undefined): (route: string) => boolean;
 /**

package/dist/index.js CHANGED Viewed

@@ -1,7 +1,7 @@
 import {
   routeMatcher,
   run
-} from "./chunk-O2LBOXFF.js";
+} from "./chunk-XOPYXOAE.js";
 export {
   routeMatcher,
   run

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "svelte-vitals",
-  "version": "0.2.1",
+  "version": "0.4.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.3.0"
+    "@svelte-vitals/core": "0.5.0"
   },
   "devDependencies": {
     "@types/node": "^24.7.0"