svelte-vitals 0.4.0 → 0.5.1

package/README.md

@@ -5,6 +5,8 @@
 
 > **A SvelteKit SEO checker — not a runtime Web Vitals reporter.**
 > Diagnose your project's SEO health by statically analyzing your source code, before it ships. No browser, no build server, no headless Chrome.
+>
+> **ESM-only** (Node 18+). Ships ES modules only; `require()` is unsupported by design.
 
 ```bash
 npx svelte-vitals

package/dist/bin.js

@@ -1,32 +1,15 @@
 #!/usr/bin/env node
 import {
+  buildRulesConfig,
+  findUnknownRuleIds,
   isReporterName,
+  knownRuleIds,
   readPackageVersion,
   run
-} from "./chunk-XOPYXOAE.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:

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

@@ -1,6 +1,6 @@
 // src/index.ts
 import {
-  allRules,
+  allRules as allRules2,
   runRules,
   formatConsoleReport,
   formatJsonReport,
@@ -477,6 +477,24 @@ 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) {
   if (!glob) return () => true;
@@ -484,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",
@@ -495,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)) {
@@ -523,11 +555,11 @@ async function run(opts = {}) {
       );
     }
     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: readPackageVersion() }));
+      log(formatSarifReport(results, config, { version }));
     } else if (reporter === "github") {
       const output = formatGithubReport(results, config);
       if (output) log(output);
@@ -543,8 +575,13 @@ async function run(opts = {}) {
 }
 
 export {
+  ProjectError,
   readPackageVersion,
   isReporterName,
+  findUnknownRuleIds,
+  knownRuleIds,
+  buildRulesConfig,
   routeMatcher,
+  analyzeProject,
   run
 };

package/dist/index.d.ts

@@ -1,7 +1,24 @@
-import { Severity, RuleSetting } from '@svelte-vitals/core';
+import { RuleSetting, Severity, Result, Config } from '@svelte-vitals/core';
 
 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;
     log?: (line: string) => void;
@@ -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-XOPYXOAE.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.4.0",
+  "version": "0.5.1",
   "description": "A SvelteKit SEO checker — not a runtime Web Vitals reporter. Static analysis of your routes' head metadata.",
   "type": "module",
   "license": "MIT",
@@ -22,6 +22,10 @@
     "url": "https://github.com/oekazuma/svelte-vitals/issues"
   },
   "homepage": "https://github.com/oekazuma/svelte-vitals#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
   "bin": {
     "svelte-vitals": "./dist/bin.js"
   },
@@ -38,7 +42,7 @@
     "mri": "^1.2.0",
     "svelte": "^5.56.3",
     "tinyglobby": "^0.2.17",
-    "@svelte-vitals/core": "0.5.0"
+    "@svelte-vitals/core": "0.7.0"
   },
   "devDependencies": {
     "@types/node": "^24.7.0"