@svelte-vitals/vite 0.54.6 → 0.55.0

package/README.md

@@ -34,6 +34,8 @@ export default {
 - `cwd`: project root (defaults to the Vite config root).
 - `ui`: serve the live dev dashboard (default `true`); pass `false` to keep only the build-time gate.
 
+A `svelte-vitals.config.*` and a `svelte-vitals-suppressions.json` in the project root are read automatically (explicit options win over the config file). Only source-scan suppression entries apply; route-level entries are skipped on every plugin surface (rendered route findings anchor to the built HTML) and the plugin says how many.
+
 At build time the HTML check covers prerendered routes only; the source scan applies project-wide. Routes that are not prerendered (server-rendered, or dynamic routes without prerendered entries) have no build output, so nothing checks their rendered HTML here. A prerendered route with `ssr = false` has build output, but only the empty app shell, so the HTML check skips it too (a `+layout` with `ssr = false` skips its subtree) and prints one warning listing the skipped routes. The `svelte-vitals` CLI covers them by source analysis, and browsing them during `vite dev` gets the live dashboard a rendered reading.
 
 See [Live dashboard](https://oekazuma.github.io/svelte-vitals/guides/dev-dashboard/) and [Plugin mode](https://oekazuma.github.io/svelte-vitals/guides/plugin-mode/) for the full picture.

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-import { RuleSetting } from "@svelte-vitals/core";
+import { Config, RuleSetting } from "@svelte-vitals/core";
 import { Handle } from "@sveltejs/kit";
 //#region src/hooks/handle.d.ts
 /** Options for the dev-time SvelteKit handle. A focused subset of the plugin options. */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Category, RuleOverride, RuleSetting, Severity, TreatDynamicAs } from "@svelte-vitals/core";
+import { Category, Config, RuleOverride, RuleSetting, Severity, TreatDynamicAs } from "@svelte-vitals/core";
 import { Plugin } from "vite";
 //#region src/plugin.d.ts
 interface SvelteVitalsOptions {
@@ -13,6 +13,8 @@ interface SvelteVitalsOptions {
   failOn?: Severity;
   /** Per-category weights for the combined Health score shown in the JSON/console report (flag > config file > default 1 each). */
   weights?: Partial<Record<Category, number>>;
+  /** SEO-wide switches (option > config file). `indexable: false` turns off the search-result rules. */
+  seo?: Config['seo'];
   /** Report output (default: 'console'). */
   report?: 'console' | 'json' | false;
   /** Write the JSON report to this path. */

package/dist/index.js

@@ -3,8 +3,8 @@ import { existsSync, readFileSync } from "node:fs";
 import { access, mkdir, readFile, writeFile } from "node:fs/promises";
 import { basename, dirname, isAbsolute, join, relative, sep } from "node:path";
 import { CATEGORIES, defineConfig } from "@svelte-vitals/core";
-import { ROBOTS_SOURCE_PATHS, SITEMAP_SOURCE_PATHS, SVELTE_CONFIG_FILES, VITE_CONFIG_FILES, addFactsDirectives, allRules, buildJsonReport, collectComponentFacts, collectKitModuleFacts, collectSourceFiles, collectSuppressions, computeScore, defaultConfig, findMinifyDisabled, formatConsoleReport, formatFailedRuleWarning, formatJsonReport, hasFailureAtOrAbove, renderAppShell, resolveKitAliases, resolveKitPathsBase, resolveRuleOptions, runAnalysis, safeHref, selectRules, shouldSkipRangeCheck, skippedFileWarnings, summarize, terminalSafe, unknownDirectiveIds, validateRuleSetting, withFailedRulesOff } from "@svelte-vitals/core/internal";
-import { CONFIG_FILENAMES, analyzeProject, createNodeRuntime, findUnknownRuleIds, knownRuleIds, loadConfigFile, registryTag, ruleOptionsSpec } from "svelte-vitals";
+import { ROBOTS_SOURCE_PATHS, SITEMAP_SOURCE_PATHS, SVELTE_CONFIG_FILES, VITE_CONFIG_FILES, addFactsDirectives, allRules, buildJsonReport, collectComponentFacts, collectKitModuleFacts, collectSourceFiles, collectSuppressions, computeScore, defaultConfig, findMinifyDisabled, formatConsoleReport, formatFailedRuleWarning, formatJsonReport, hasFailureAtOrAbove, isPlainObject, renderAppShell, resolveKitAliases, resolveKitPathsBase, resolveRuleOptions, runAnalysis, safeHref, selectRules, shouldSkipRangeCheck, skippedFileWarnings, summarize, terminalSafe, unknownDirectiveIds, validateRuleSetting, withFailedRulesOff, withIndexableOff } from "@svelte-vitals/core/internal";
+import { CONFIG_FILENAMES, SUPPRESSIONS_FILE, analyzeProject, applySuppressions, createNodeRuntime, findUnknownRuleIds, knownRuleIds, loadConfigFile, loadSuppressions, registryTag, ruleOptionsSpec } from "svelte-vitals";
 //#region src/providers/rendered/collect.ts
 /** Map a prerendered HTML path (relative to pages/, POSIX) to its route. */
 function deriveRouteFromHtmlPath(relPath) {
@@ -157,6 +157,29 @@ function collectSourceFiles$1(root) {
 	return collectSourceFiles(nodeRuntime, root);
 }
 //#endregion
+//#region src/suppressions.ts
+/**
+* Apply `svelte-vitals-suppressions.json` the way every plugin surface must: source-scan entries
+* only. A route-level entry (route starting with `/`) is written by the CLI against
+* `src/routes/…/+page.svelte`, while the build gate's rendered findings anchor to the built HTML
+* and the dashboard's live layer to the route itself — the gate could never match it, and the
+* dashboard's static layer would drop it only until the route was browsed and the live result
+* re-surfaced it. Skipping them everywhere keeps Health identical across surfaces; the caller
+* gets one line per fact to print. Stale entries are not counted: pruning stays with the CLI.
+*/
+function applySourceSuppressions(results, entries, config) {
+	const notices = [];
+	const source = entries.filter((e) => !e.route?.startsWith("/"));
+	const routeLevel = entries.length - source.length;
+	const applied = applySuppressions(results, source, config);
+	if (applied.suppressed > 0) notices.push(`${applied.suppressed} finding(s) suppressed by ${SUPPRESSIONS_FILE}.`);
+	if (routeLevel > 0) notices.push(`${routeLevel} route-level ${routeLevel === 1 ? "entry does" : "entries do"} not apply to the plugin (${SUPPRESSIONS_FILE}) — rendered route findings anchor to the built HTML; use \`overrides\` for those.`);
+	return {
+		results: applied.results,
+		notices
+	};
+}
+//#endregion
 //#region src/version.ts
 /** Read this package's version from its own package.json so the report never drifts. */
 function readPackageVersion() {
@@ -197,13 +220,15 @@ function readCoreVersion() {
 function mergeConfig(options, fileConfig) {
 	const weights = options.weights ?? fileConfig?.weights;
 	const overrides = options.overrides ?? fileConfig?.overrides;
+	const seo = options.seo ?? fileConfig?.seo;
 	return defineConfig({
 		treatDynamicAs: options.treatDynamicAs ?? fileConfig?.treatDynamicAs ?? "pass",
 		metaComponents: options.metaComponents ?? fileConfig?.metaComponents ?? [],
-		rules: options.rules ?? fileConfig?.rules ?? {},
+		rules: withIndexableOff(options.rules ?? fileConfig?.rules, seo) ?? {},
 		failOn: options.failOn ?? fileConfig?.failOn ?? "critical",
 		...weights !== void 0 ? { weights } : {},
-		...overrides !== void 0 ? { overrides } : {}
+		...overrides !== void 0 ? { overrides } : {},
+		...seo !== void 0 ? { seo } : {}
 	});
 }
 /**
@@ -261,11 +286,13 @@ function ssrDisabledRouteMatcher(kitModules) {
 /**
 * Collect prerendered heads + project facts + component facts, run the core pipeline, and
 * format reports. Config precedence: see `resolveConfig`. Pass `resolved` when the caller
-* already resolved config itself (build mode resolves it outside `analyze`'s try/catch so a
-* config-file validation error fails the build instead of being caught as an analysis error).
+* already resolved config and loaded `svelte-vitals-suppressions.json` itself (build mode does
+* both outside `analyze`'s try/catch so a validation error fails the build instead of being
+* caught as an analysis error); `suppressions: undefined` means the file does not exist.
 */
 async function analyze(prerenderPagesDir, cwd, options, extraProjectFacts, resolved) {
 	const { config, warnings } = resolved ?? await resolveConfig(cwd, options);
+	const suppressions = resolved ? resolved.suppressions : loadSuppressions(cwd);
 	const [rendered, components, sourceFiles] = await Promise.all([
 		collectRenderedHeads(prerenderPagesDir),
 		collectComponentFacts$1(cwd),
@@ -296,7 +323,7 @@ async function analyze(prerenderPagesDir, cwd, options, extraProjectFacts, resol
 		kitModules,
 		viteMinifyDisabled: project.viteMinifyDisabled
 	});
-	const { results, examined, failedRules, scoringConfig } = await runAnalysis(selected, {
+	const analysis = await runAnalysis(selected, {
 		heads,
 		headings,
 		images,
@@ -307,6 +334,13 @@ async function analyze(prerenderPagesDir, cwd, options, extraProjectFacts, resol
 		kitModules,
 		sourceFiles
 	}, directives);
+	const { examined, failedRules, scoringConfig } = analysis;
+	let results = analysis.results;
+	if (suppressions !== void 0) {
+		const applied = applySourceSuppressions(results, suppressions, config);
+		results = applied.results;
+		warnings.push(...applied.notices);
+	}
 	warnings.push(...skippedFileWarnings([...components, ...kitModules]));
 	warnings.push(...unknownDirectiveIds(directives, allRules));
 	for (const f of failedRules) warnings.push(formatFailedRuleWarning(f));
@@ -315,12 +349,14 @@ async function analyze(prerenderPagesDir, cwd, options, extraProjectFacts, resol
 	const failed = hasFailureAtOrAbove(summary, scoringConfig.failOn);
 	const coverageNote = `Analyzed ${heads.length} prerendered route(s)${shells.length > 0 ? ` (skipped ${shells.length} with ssr = false)` : ""}. SSR/dynamic routes are not covered — run \`npx svelte-vitals\` for those.
 Scanned ${components.length} component(s) under src/ for Correctness/Security/Architecture/Accessibility/Bundle findings.`;
+	const consoleReport = formatConsoleReport(results, scoringConfig, { mode: "rendered / plugin" }) + "\n" + coverageNote + "\n";
+	const jsonReport = formatJsonReport(results, scoringConfig, { version: readPackageVersion() }, selected.map((r) => r.id), examined);
 	return {
 		score,
 		summary,
 		results,
-		consoleReport: formatConsoleReport(results, scoringConfig, { mode: "rendered / plugin" }) + "\n" + coverageNote + "\n",
-		jsonReport: formatJsonReport(results, scoringConfig, { version: readPackageVersion() }, selected.map((r) => r.id), examined),
+		consoleReport,
+		jsonReport,
 		routeCount: rendered.heads.length,
 		failed,
 		failOn: scoringConfig.failOn,
@@ -635,6 +671,26 @@ function createStore() {
 //#endregion
 //#region src/ui/analysis.ts
 /**
+* Apply `svelte-vitals-suppressions.json` to the whole-project layer, same entries as the build
+* gate (see `applySourceSuppressions`). A malformed file is a warning here, not an error: dev
+* must keep serving. Returns the results unchanged when the file is absent or `config` is
+* unknown (an injected `analyze` that returns no config).
+*/
+function suppress(root, results, config, warnings) {
+	if (!config) return results;
+	let entries;
+	try {
+		entries = loadSuppressions(root);
+	} catch (err) {
+		warnings.push(`${err instanceof Error ? err.message : String(err)} — ${SUPPRESSIONS_FILE} ignored.`);
+		return results;
+	}
+	if (entries === void 0) return results;
+	const applied = applySourceSuppressions(results, entries, config);
+	warnings.push(...applied.notices);
+	return applied.results;
+}
+/**
 * Owns the dev-dashboard's whole-project analysis lifecycle: an async run at startup,
 * a debounced re-run on source changes, and coalescing so a change that arrives mid-run
 * produces exactly one follow-up run rather than one per change (design doc §1).
@@ -659,14 +715,16 @@ function createAnalysisRunner(opts) {
 				metaComponents: opts.metaComponents,
 				rules: opts.rules,
 				failOn: opts.failOn,
+				seo: opts.seo,
 				parseCache
 			});
-			const { results, failedRuleIds } = result;
+			const { failedRuleIds } = result;
+			const warnings = [...result.warnings ?? []];
+			const results = suppress(opts.root, result.results, result.config, warnings);
 			if (!stopped) {
 				if (failedRuleIds !== void 0) opts.onResults(results, failedRuleIds);
 				else opts.onResults(results);
 			}
-			const warnings = result.warnings ?? [];
 			const key = warnings.join("\n");
 			if (!stopped && warnings.length > 0 && key !== lastWarningsKey) opts.onWarnings?.(warnings);
 			lastWarningsKey = key;
@@ -716,6 +774,7 @@ const CONFIG_BASENAMES = /* @__PURE__ */ new Set([
 	"svelte.config.js",
 	"svelte.config.ts",
 	...CONFIG_FILENAMES,
+	SUPPRESSIONS_FILE,
 	"vite.config.js",
 	"vite.config.mjs",
 	"vite.config.ts",
@@ -819,10 +878,23 @@ function validateOverridesOption(overrides, rules) {
 	});
 	if (errors.length > 0) throw new Error(`svelte-vitals: invalid \`overrides\` option — ${errors.join(" ")}`);
 }
+/**
+* Validate the plugin's `seo` option the same way the config-file loader validates the
+* `seo` key. A `vite.config.js` gets no type checking, and `{ indexable: 'no' }` would
+* otherwise be silently inert — the failure mode `validateRulesOption` exists for.
+*/
+function validateSeoOption(seo) {
+	if (seo === void 0) return;
+	if (!isPlainObject(seo)) throw new Error("svelte-vitals: invalid `seo` option — must be an object, e.g. { indexable: false }.");
+	const unknown = Object.keys(seo).filter((k) => k !== "indexable");
+	if (unknown.length > 0) throw new Error(`svelte-vitals: invalid \`seo\` option — unknown key(s): ${unknown.join(", ")}. Known keys: indexable.`);
+	if (seo.indexable !== void 0 && typeof seo.indexable !== "boolean") throw new Error("svelte-vitals: invalid `seo` option — seo.indexable must be a boolean.");
+}
 /** svelte-vitals Vite/SvelteKit plugin. */
 function svelteVitals(options = {}) {
 	validateRulesOption(options.rules);
 	validateOverridesOption(options.overrides, options.rules);
+	validateSeoOption(options.seo);
 	let root = options.cwd ?? process.cwd();
 	let minify;
 	let configFile;
@@ -841,7 +913,10 @@ function svelteVitals(options = {}) {
 			const pagesDir = options.prerenderDir ? options.prerenderDir : join(root, DEFAULT_PRERENDER_DIR);
 			const resolved = isAbsolute(pagesDir) ? pagesDir : join(root, pagesDir);
 			if (!existsSync(resolved)) return;
-			const resolvedConfig = await resolveConfig(root, options);
+			const resolvedConfig = {
+				...await resolveConfig(root, options),
+				suppressions: loadSuppressions(root)
+			};
 			let result;
 			try {
 				const viteMinifyDisabled = await resolveMinifyDisabled(minify, configFile, root);
@@ -867,7 +942,7 @@ function svelteVitals(options = {}) {
 	if (options.ui === false) return buildPlugin;
 	return [buildPlugin, {
 		name: "svelte-vitals:ui",
-		apply: "serve",
+		apply: (_config, env) => env.command === "serve" && !process.env.VITEST,
 		async configureServer(server) {
 			process.env.SVELTE_VITALS_UI = "1";
 			const uiRoot = options.cwd ?? server.config.root;
@@ -897,6 +972,7 @@ function svelteVitals(options = {}) {
 				metaComponents: options.metaComponents,
 				rules: options.rules,
 				failOn: options.failOn,
+				seo: options.seo,
 				onResults: (results, failedRuleIds) => {
 					store.setStatic(results);
 					staticFailedRuleIds = failedRuleIds ?? [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@svelte-vitals/vite",
-  "version": "0.54.6",
+  "version": "0.55.0",
   "description": "Vite/SvelteKit plugin for svelte-vitals — analyzes prerendered HTML during vite build, plus a live dev dashboard.",
   "type": "module",
   "license": "MIT",
@@ -43,9 +43,9 @@
     "node-html-parser": "^9.0.4"
   },
   "peerDependencies": {
-    "@svelte-vitals/core": "^0.54.6",
+    "@svelte-vitals/core": "^0.55.0",
     "@sveltejs/kit": "^2.70.3",
-    "svelte-vitals": "^0.54.6",
+    "svelte-vitals": "^0.55.0",
     "vite": "^8.3.0"
   },
   "peerDependenciesMeta": {
@@ -54,12 +54,12 @@
     }
   },
   "devDependencies": {
-    "@svelte-vitals/core": "0.54.6",
+    "@svelte-vitals/core": "0.55.0",
     "@sveltejs/kit": "^2.70.3",
-    "@types/node": "^24.13.4",
-    "happy-dom": "^20.14.3",
+    "@types/node": "^24.13.5",
+    "happy-dom": "^20.14.5",
     "svelte": "^5.57.0",
-    "svelte-vitals": "0.54.6",
+    "svelte-vitals": "0.55.0",
     "vite": "^8.3.0"
   },
   "scripts": {