npm - @svelte-vitals/vite - Versions diffs - 0.1.0 - Mend

@svelte-vitals/vite 0.1.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 (5) hide show

package/LICENSE.md ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Kazuma Oe
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,31 @@
+# @svelte-vitals/vite
+[![npm](https://img.shields.io/npm/v/@svelte-vitals/vite)](https://www.npmjs.com/package/@svelte-vitals/vite)
+Vite/SvelteKit plugin for [svelte-vitals](https://github.com/oekazuma/svelte-vitals). It piggybacks on `vite build`, parses the **prerendered HTML's `<head>`**, and runs the same SEO rules as the CLI — library-agnostic, because it inspects the real output. Fails the build when findings reach `failOn`.
+## Usage
+```ts
+// vite.config.ts
+import { sveltekit } from '@sveltejs/kit/vite';
+import { svelteVitals } from '@svelte-vitals/vite';
+export default {
+  plugins: [sveltekit(), svelteVitals({ failOn: 'critical', report: 'console' })]
+};
+```
+## Options
+- `failOn` — minimum severity that fails the build (default `critical`).
+- `report` — `'console' | 'json' | false` (default `console`).
+- `outFile` — write the JSON report to a path.
+- `rules` / `metaComponents` / `treatDynamicAs` — same as the CLI/core config.
+- `prerenderDir` — override the prerendered-pages directory.
+Only **prerendered** routes are analyzed; for SSR/dynamic routes use the `svelte-vitals` CLI.
+## License
+[MIT](https://github.com/oekazuma/svelte-vitals/blob/main/LICENSE.md) © [Kazuma Oe](https://github.com/oekazuma)

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { Plugin } from 'vite';
+import { TreatDynamicAs, RuleSetting, Severity } from '@svelte-vitals/core';
+interface SvelteVitalsOptions {
+    /** Project root (defaults to the Vite config root / cwd). */
+    cwd?: string;
+    treatDynamicAs?: TreatDynamicAs;
+    metaComponents?: string[];
+    rules?: Record<string, RuleSetting>;
+    /** Minimum severity that fails the build (default: 'critical'). */
+    failOn?: Severity;
+    /** Report output (default: 'console'). */
+    report?: 'console' | 'json' | false;
+    /** Write the JSON report to this path. */
+    outFile?: string;
+    /** Override the prerendered-pages directory (default: .svelte-kit/output/prerendered/pages). */
+    prerenderDir?: string;
+}
+/** svelte-vitals Vite/SvelteKit plugin. */
+declare function svelteVitals(options?: SvelteVitalsOptions): Plugin;
+export { type SvelteVitalsOptions, svelteVitals };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,197 @@
+// src/plugin.ts
+import { existsSync } from "fs";
+import { writeFile, mkdir } from "fs/promises";
+import { join as join3, isAbsolute, dirname } from "path";
+// src/analyze.ts
+import {
+  allRules,
+  selectRules,
+  applyRuleSeverities,
+  runRules,
+  computeScore,
+  summarize,
+  hasFailureAtOrAbove,
+  formatConsoleReport,
+  formatJsonReport,
+  defineConfig
+} from "@svelte-vitals/core";
+// src/providers/rendered/collect.ts
+import { readFile } from "fs/promises";
+import { join } from "path";
+import { glob } from "tinyglobby";
+// src/providers/rendered/parse-html.ts
+import { parse } from "node-html-parser";
+function attrValue(v) {
+  return v !== void 0 && v.trim().length > 0 ? "static" : "absent";
+}
+function parseHtmlHead(html) {
+  const root = parse(html);
+  const head = root.querySelector("head") ?? root;
+  const tags = [];
+  const title = head.querySelector("title");
+  if (title) tags.push({ kind: "title", presence: "own", value: attrValue(title.text) });
+  for (const meta of head.querySelectorAll("meta")) {
+    const name = meta.getAttribute("name");
+    const property = meta.getAttribute("property");
+    if (!name && !property) continue;
+    tags.push({
+      kind: "meta",
+      ...name ? { name } : {},
+      ...property ? { property } : {},
+      presence: "own",
+      value: attrValue(meta.getAttribute("content"))
+    });
+  }
+  for (const link of head.querySelectorAll("link")) {
+    const rel = link.getAttribute("rel");
+    if (!rel) continue;
+    tags.push({ kind: "link", rel, presence: "own", value: attrValue(link.getAttribute("href")) });
+  }
+  for (const script of head.querySelectorAll("script")) {
+    if (script.getAttribute("type") === "application/ld+json") {
+      tags.push({ kind: "jsonld", presence: "own", value: attrValue(script.text) });
+    }
+  }
+  const htmlEl = root.querySelector("html");
+  const lang = htmlEl?.getAttribute("lang");
+  const htmlLang = lang === void 0 || lang === null ? { presence: "none", value: "absent" } : { presence: "own", value: attrValue(lang) };
+  return { tags, htmlLang };
+}
+// src/providers/rendered/collect.ts
+function deriveRouteFromHtmlPath(relPath) {
+  let p = relPath.replace(/\\/g, "/").replace(/\.html$/, "");
+  if (p === "index") return "/";
+  if (p.endsWith("/index")) p = p.slice(0, -"/index".length);
+  return "/" + p;
+}
+async function collectRenderedHeads(prerenderPagesDir) {
+  const files = (await glob("**/*.html", { cwd: prerenderPagesDir })).sort();
+  const parsedFiles = await Promise.all(
+    files.map(async (rel) => ({ rel, parsed: parseHtmlHead(await readFile(join(prerenderPagesDir, rel), "utf8")) }))
+  );
+  const heads = [];
+  let htmlLang = { presence: "none", value: "absent" };
+  for (const { rel, parsed } of parsedFiles) {
+    if (htmlLang.presence === "none" && parsed.htmlLang.presence === "own") htmlLang = parsed.htmlLang;
+    heads.push({
+      route: deriveRouteFromHtmlPath(rel),
+      source: "rendered",
+      tags: parsed.tags,
+      file: rel
+    });
+  }
+  return { heads, htmlLang };
+}
+// src/providers/rendered/project.ts
+import { access } from "fs/promises";
+import { join as join2 } from "path";
+import { ROBOTS_SOURCE_PATHS, SITEMAP_SOURCE_PATHS } from "@svelte-vitals/core";
+async function exists(path) {
+  try {
+    await access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function existsAny(cwd, paths) {
+  const found = await Promise.all(paths.map((p) => exists(join2(cwd, p))));
+  return found.some(Boolean);
+}
+async function collectRenderedProject(cwd, htmlLang) {
+  const [hasRobotsTxt, hasSitemap] = await Promise.all([
+    existsAny(cwd, ROBOTS_SOURCE_PATHS),
+    existsAny(cwd, SITEMAP_SOURCE_PATHS)
+  ]);
+  return { hasRobotsTxt, hasSitemap, htmlLang };
+}
+// src/version.ts
+import { readFileSync } from "fs";
+function readPackageVersion() {
+  try {
+    const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+    return pkg.version ?? "0.0.0";
+  } catch {
+    return "0.0.0";
+  }
+}
+// src/analyze.ts
+async function analyze(prerenderPagesDir, cwd, options) {
+  const config = defineConfig({
+    treatDynamicAs: options.treatDynamicAs ?? "pass",
+    metaComponents: options.metaComponents ?? [],
+    rules: options.rules ?? {},
+    failOn: options.failOn ?? "critical"
+  });
+  const { heads, htmlLang } = await collectRenderedHeads(prerenderPagesDir);
+  const project = await collectRenderedProject(cwd, htmlLang);
+  const results = applyRuleSeverities(
+    await runRules(selectRules(allRules, config), { heads, project, config }),
+    config
+  );
+  const { score } = computeScore(results, config);
+  const summary = summarize(results, config);
+  const failed = hasFailureAtOrAbove(summary, config.failOn);
+  const coverageNote = `Analyzed ${heads.length} prerendered route(s). SSR/dynamic routes are not covered \u2014 run \`npx svelte-vitals\` for those.`;
+  const consoleReport = formatConsoleReport(results, config, { mode: "rendered / plugin" }) + "\n" + coverageNote + "\n";
+  const jsonReport = formatJsonReport(results, config, { version: readPackageVersion() });
+  return {
+    score,
+    summary,
+    results,
+    consoleReport,
+    jsonReport,
+    routeCount: heads.length,
+    failed,
+    failOn: config.failOn
+  };
+}
+// src/plugin.ts
+var DEFAULT_PRERENDER_DIR = ".svelte-kit/output/prerendered/pages";
+function svelteVitals(options = {}) {
+  let root = options.cwd ?? process.cwd();
+  return {
+    name: "svelte-vitals",
+    apply: "build",
+    enforce: "post",
+    configResolved(config) {
+      if (!options.cwd) root = config.root;
+    },
+    async closeBundle() {
+      const pagesDir = options.prerenderDir ? options.prerenderDir : join3(root, DEFAULT_PRERENDER_DIR);
+      const resolved = isAbsolute(pagesDir) ? pagesDir : join3(root, pagesDir);
+      if (!existsSync(resolved)) return;
+      let result;
+      try {
+        result = await analyze(resolved, root, options);
+      } catch (err) {
+        console.warn(`svelte-vitals: skipped \u2014 analysis failed: ${err instanceof Error ? err.message : String(err)}`);
+        return;
+      }
+      if (result.routeCount === 0) return;
+      if (options.report !== false) {
+        const out = options.report === "json" ? result.jsonReport : result.consoleReport;
+        console.log(out);
+      }
+      if (options.outFile) {
+        const outPath = isAbsolute(options.outFile) ? options.outFile : join3(root, options.outFile);
+        await mkdir(dirname(outPath), { recursive: true });
+        await writeFile(outPath, result.jsonReport);
+      }
+      if (result.failed) {
+        throw new Error(`svelte-vitals: build failed \u2014 findings at or above "${result.failOn}".`);
+      }
+    }
+  };
+}
+export {
+  svelteVitals
+};

package/package.json ADDED Viewed

@@ -0,0 +1,52 @@
+{
+  "name": "@svelte-vitals/vite",
+  "version": "0.1.0",
+  "description": "Vite/SvelteKit plugin for svelte-vitals — analyzes prerendered HTML during vite build.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Kazuma Oe (https://github.com/oekazuma)",
+  "keywords": [
+    "svelte",
+    "sveltekit",
+    "seo",
+    "vite-plugin",
+    "svelte-vitals"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oekazuma/svelte-vitals.git",
+    "directory": "packages/vite"
+  },
+  "bugs": {
+    "url": "https://github.com/oekazuma/svelte-vitals/issues"
+  },
+  "homepage": "https://github.com/oekazuma/svelte-vitals#readme",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "node-html-parser": "^6.1.13",
+    "tinyglobby": "^0.2.17",
+    "@svelte-vitals/core": "0.3.0"
+  },
+  "peerDependencies": {
+    "vite": "^8.0.16"
+  },
+  "devDependencies": {
+    "@types/node": "^24.7.0",
+    "vite": "^8.0.16"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}