内容
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/wordmark-dark.svg">
<img src="./assets/wordmark-light.svg" alt="svelte-vitals" height="56">
</picture>
</p>
<p align="center">
<a href="https://github.com/oekazuma/svelte-vitals/actions/workflows/ci.yml"><img src="https://github.com/oekazuma/svelte-vitals/actions/workflows/ci.yml/badge.svg?branch=main" alt="持续集成"></a>
<a href="https://www.npmjs.com/package/svelte-vitals"><img src="https://img.shields.io/npm/v/svelte-vitals" alt="npm 版本"></a>
<a href="https://www.npmjs.com/package/svelte-vitals"><img src="https://img.shields.io/npm/dt/svelte-vitals.svg" alt="下载量"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/svelte-vitals" alt="MIT 许可证"></a>
</p>
<p align="center">SvelteKit 的静态代码健康检查工具 — SEO、性能、正确性、安全性和架构,从源代码分析。无需浏览器或无头 Chrome。</p>
```bash
npx svelte-vitals@latest
```
<p align="center">
<img src="./docs/public/demo.gif" alt="svelte-vitals 在 SvelteKit 项目上运行,显示健康分数动画" width="700">
</p>
📖 **[文档](https://oekazuma.github.io/svelte-vitals/)**
> [!WARNING]
> **0.1 版本 — 尚未推荐用于生产环境。** 开发正在快速推进,功能可能随时更改,包括破坏性更新。在 1.0 版本发布前,请谨慎使用。
## 类别
五个类别 — **SEO**、**性能**、**正确性**、**安全性**、**架构** — 每个类别独立评分,并汇总为一个加权 **健康** 分数。 → [健康报告](https://oekazuma.github.io/svelte-vitals/guides/health-report/)
## 功能
- **多种报告方式** — `console`、`json`、`agent`(一种 Markdown 补救文档,可由 AI 代理直接操作)、`sarif`、`github`、`md`(一种纯 Markdown 报告)和 `html`(一种自包含、可分享的报告)。`agent` 报告方式在 AI 代理环境中自动选择(例如 Claude Code);`github` 在 GitHub Actions 中自动选择。 → [报告方式](https://oekazuma.github.io/svelte-vitals/guides/reporters/)
- **GitHub 集成** — 零配置的 PR 内联注释,以及 SARIF 上传,用于 Security 标签中的持久代码扫描警报;`svelte-vitals ci install` 搭建了一个完整的 GitHub Actions 工作流,围绕 `@svelte-vitals/action`,带有作业摘要和固定 PR 评论。 → [报告方式](https://oekazuma.github.io/svelte-vitals/guides/reporters/)、[CI 集成](https://oekazuma.github.io/svelte-vitals/guides/ci/)
- **实时仪表盘** — 在 `/__svelte-vitals/` 处的 searchable、filterable 仪表盘,在 `vite dev` 期间启用,默认开启:从启动时进行整个项目的覆盖,细化为实时渲染值,并带有每个发现的复制到剪贴板 AI 代理提示。 → [实时仪表盘](https://oekazuma.github.io/svelte-vitals/guides/dev-dashboard/)
- **插件模式** (`@svelte-vitals/vite`) — 预渲染 `<head>` 的构建时分析;与库无关且精确。 → [插件模式](https://oekazuma.github.io/svelte-vitals/guides/plugin-mode/)
- **MCP 服务器** (`@svelte-vitals/mcp`) — `analyze` 和 `explain_rule` 工具,用于代理的工具循环。 → [MCP 服务器](https://oekazuma.github.io/svelte-vitals/guides/mcp/)
- **代理技能** — `/svelte-vitals` 和 `/improve-svelte` 斜杠命令技能,用于 Claude Code、Cursor 和 Codex:规则知识提前,加上项目范围的、证据排名的改进路线图。 → [代理技能](https://oekazuma.github.io/svelte-vitals/guides/agent-skills/)
## 软件包
您将直接使用的三个软件包 — CLI、Vite 插件、MCP 服务器 — 所有这些都建立在共享的 `@svelte-vitals/core` 规则引擎上。 → [选择软件包](https://oekazuma.github.io/svelte-vitals/guides/choosing-a-package/)
## 入门
→ [入门](https://oekazuma.github.io/svelte-vitals/guides/getting-started/) 进行安装、首次运行和 CI gating 的退出代码。
## 贡献
参见 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解开发设置、命令和发布流程。
## 许可证
[MIT](./LICENSE.md) © [Kazuma Oe](https://github.com/oekazuma)