@ gusnips/ vite (笑声)
将 Vite + React SPA 的公用路由在构建时转换成真实的 HTML 文件: 一个真实的 <head>页:1
真实身体,每页一个文件.
bun add -d @gusnips/vite
import { pageFile } from "@gusnips/vite";
pageFile("/pricing"); // → "pricing.html"
何必麻烦呢
一艘Vite SPA飞船 index.html 并用 JavaScript 绘制其它一切 。 没有读取
链接用于运行一个活的捆绑:不是搜索爬行器,不是LLM,不是绘制的东西
当某人在聊天中粘贴您的链接时预览卡。 运出 <div id="root"></div> 是一个
页面可以列出,但从未引用.
因此,该建筑使每个公共路线都成为自己的文件. 每个应用都这样 最后写作.
刻出一页
import { bakeHead } from "@gusnips/vite";
const html = bakeHead(template, {
title: "Pricing | Example",
description: "What it costs.",
canonical: "https://example.com/pricing",
body: { route: "/pricing", html: rendered },
});
bakeHead 重写标题,描述,词条,开放图和Twitter标签,
<html lang>,则 hreflang 设置,并注入已渲染的标记 <div id="root">。 。 。 .
里面有四条带载荷的规则:
canonical: null剥去标签,以及og:url带着它. 对于404外壳,它是服务 对于不存在的每个地址。 空克不是剥取:空克是主张 关于""空时og:url是一张指向您头版的牌. 离开image关闭 还有,而外壳保留了您的模板。 图像是一半 人们怀念bakeHead无法抓住它给你。 它写着任何你命名的卡片。 三个 密码库根据贝壳的编造路径命名了贝壳的卡片,所以他们404.html广告/og/__not-found__.png,一个从未存在过的文件。 死链的每分每分 损坏, 浏览器里没有显示它 .og:locale非英文页面上不是可选的. 别管了,谱子不会 默认为"未知". 默认为en_US。带有葡萄牙语的葡萄牙语页面og:title然后告诉每个股权者 这张卡是英语.ogLocale("pt-BR")给你 它真正想要的下划线拼写.body携带路线, 不只是标记. 一个静态主机回答每个地址 不随最近的404.html,且该文件已提供未找到的页面 输入 这个 所以"根有子"是错误的问题:从外壳找到的一条路线 a full root, 水合物, 和 React 调和两个不同的页. 它通过扔出 树去和伐木:一个可以工作的一页,一个没人看见的bug. 标记是什么 浏览器条目在它作出决定之前进行比较.alternates必须是对等的. 爬行者忽略了整个设定 除非里面每个地址 倒数其他的, 这就是为什么你把完整列表 传递到每一页,而不是"the 其他两个".
发现文件
import { jsonLd } from "@gusnips/vite";
jsonLd({ "@type": "SoftwareApplication", name: "Example" });
// A <script type="application/ld+json"> tag containing the object.
将结果传递给 bakeHead 作为 headExtra。 。 。 . jsonLd 保存时从 HTML 控制文本中逃出
无效的 JSON. faqJsonLd 使用同一种序列器. 您提供 schema.org 字段,包括
SoftwareApplication 用于应用或 WebAPI 给一个公共API。 本地命令不是公共API.
import { llmsTxt, mcpDiscoveryJson, writeDist } from "@gusnips/vite";
await writeDist(
"dist",
"llms.txt",
llmsTxt({
title: "Example",
summary: "Read and update tasks.",
sections: [
{
title: "Reference",
links: [{ title: "Connect", url: "https://example.com/docs/mcp" }],
},
],
}),
);
await writeDist(
"dist",
"llms-full.txt",
llmsTxt({
title: "Example reference",
body: referenceMarkdown,
}),
);
await writeDist(
"dist",
".well-known/mcp.json",
mcpDiscoveryJson({
name: "Example",
homepage: "https://example.com",
documentation: "https://example.com/docs/mcp",
llmsTxt: "https://example.com/llms.txt",
llmsFullTxt: "https://example.com/llms-full.txt",
servers: [
{
name: "tasks",
transport: "streamable-http",
url: "https://api.example.com/mcp",
authentication: [
{
type: "oauth2",
protectedResourceMetadata:
"https://api.example.com/.well-known/oauth-protected-resource/mcp",
},
],
tools: ["list_tasks", "update_task"],
},
],
}),
);
构建 referenceMarkdown 从您现有的文件。 该目录没有添加内容或访问规则.
每个服务器只列出自己的工具,作为名称或对象 name, (中文(简体) ), title, (中文(简体) ), description, (中文(简体) ),
inputSchema 财务报告和审定财务报表 annotations应用计划和说明保持不变.
用于本地服务器 transport: "stdio", (中文(简体) ), command 和可选 args 改为 url。 。 。 .
authentication 被接受的方法清单 : oauth2 与 protectedResourceMetadata, (中文(简体) ), api-key
与 in (单位:千美元)header 或者说 environment, (中文(简体) ), name 和可选 prefix, (中文(简体) ), session 带有 description, (中文(简体) ),
或者说 none 供公众查阅。 方法还可以包括: description 财务报告和审定财务报表 documentation。 。 。 .
/.well-known/mcp.json 是发现元数据,而不是通用的MCP标准或客户端配置.
它不会取代实时服务器的 tools/list。这些文件不承诺搜索排名或
在特定客户端中提供支持.
渲染
import { renderTree } from "@gusnips/vite/render";
在它自己的子路径后面, 因为它是 唯一装入反应的东西。 一个只想要的回扣 一个站点映射装置不安装渲染器.
您的 SSR 条目导出一个名为函数的函数 renderPage 这叫它。 上传脚本
与 loadRenderer("dist-ssr/entry-server.js"),用于查找该名称,如果
没有.
用这个 prerender 从 react-dom/static永远 renderToString与 lazy() 后面的路线
(单位:千美元) <Suspense>, (中文(简体) ), renderToString 使倒计时。它将写入装入屏幕
每一个文件并经过任何只问根是否有子的门. 也是个答案 ""
没有错误和警告的基名不匹配, 所以 assertRendered 检查每个路径
非空输出。 和回放19个在树上 <title> 财务报告和审定财务报表 <meta> 到服务器前端
{\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}当你们填满一个时 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}他们就落在你体内 <div> 而不是组装
文档,所以这些被剥去, 和一个渲染错误被重新删除 所以一个破损的页面失败
建设而不是航运.
倒计时不是最坏的情况. renderToString 可以将自己的错误写入页面: 1
repo运出一个活的,索引化的参考页面,载有React的"不支持悬疑"消息,
一个堆栈追踪, 和五份绝对路径 从建造它的机器。 什么都没有
浏览器显示它,因为捆绑取代了负载上的身体,所以只有阅读器见过
是那些没有JavaScript的操作者, 这是每个爬行者 页面的构建。 刚才在
其两种语言之一也: 第一种是保释,但解决了 lazy() 答应,所以
下一个地方使真正的组件 并看起来完美. assertRendered 现在拒绝那条短信.
打电话 assertRendered(file, html, template) 在你写前的每一页。 它停止建设
当:
- 页面小于500字节
index.html。专注的一页 通过下层:{ minGrowth: 200 }。 。 。 . - 页:1
<title>是空的,或者,当你通过{ lang }, (中文(简体) ),<html lang>命名另一种语言. - (单位:千美元)
%NAME%占位符从未填入. - 反应
renderToString错误存在于页面中. - 页面是加载屏幕。 它只知道一个
role="status",所以给你的悬念 退后那个角色, 屏幕阅读器需要它。 一个平地<p>Loading…</p>通过.
结束您的前置脚本 process.exit(0)在包子下,导入这个渲染器离开
最后一个文件被写入后的进程 : react-dom/server 出口,请检查, react-dom/static.browser
没有,而且 process.getActiveResourcesInfo() 所以唯一的症状是
完成它的工作而永远不返回的脚本 。 26号节点也是这样(用反应度测量)
19.3 (中文(简体) ). 我们不打电话 exit 对于你来说(图书馆杀死它的主机的过程比绞刑更糟糕),
而在CI中,另一种选择是 构建一切,然后运行到暂停.
平面文件
那个 pageFile 在顶端写 pricing.html没有 pricing/index.html。网状路线保留
它们的文件夹 : /guides/errors → guides/errors.html。 。 。 .
你的应用软件的每个地址 都得回答200而不是重定向 打开
Cloudflare Pages 表示平面文件: 它服务 pricing/index.html 时间 /pricing/ 和答案
/pricing 308号机 平面文件答案 /pricing 拥有200个正常 /pricing/ 对它
加上308,所以你所广告的表格是一页的形式,这是整个要点.
这页说,"一个平面文件回答两个" 直到有人运行 curl -I 下段询问
用于: /precos/ 回来 308, (中文(简体) ), location: /precos规则没有改变,但
细节 :
在正常运行的主机上,浏览器在捆绑运行前被重定向,所以它永远不能.
但东道主不同 托管方向 /pricing 改为 /pricing/ 默认,并服务
pricing/index.html 时间 /pricing 自身曾经 trailingSlash 实值 false像这样的主持人,
写入目录格式并设置旗帜。 不管怎样,快跑 curl -I 在信任之前的一页
现场地图.
机器人、OG卡片
sitemapFor(origin, pages) 浏览您的页面注册; robotsTxt({ origin, sitemaps }) 生成
因为爬行者只读取出处:
子目录应用不能运送自己的.
sitemapXml 带 priority 格式化,作为字符串。排名页是一个决定:
属于谁走注册: 一个代码库读取一个字段 从自己的注册,另一个
给前门1.0和每个向导0.8平, 因为将一个向导排在另一个向后
猜猜看读者.
writeOgCards 横行登记,召唤你们所供应的造物师 fitText 显示
文本匹配数学。 当复制不合适,它 记录溢出并拒绝写入
而不是附加椭圆形:椭圆形使每个字符串"fit",所以复制出
它的一栏没有故障 和船舶.
assertOgImages("dist", origin) 读取每页的构建和检查每张共享卡
它的广告是一个文件存在。 最后运行 :
await assertOgImages("dist", "https://example.com");
三个密码库运出a 404.html 谁 og:image 上面写着一张从未做过的牌:
纸牌生成器在页面登记簿上行走,没有找到外壳。 每一份额a
死链接断开,浏览器里没有东西显示. bakeHead 无法抓住: 它
书写其手接的图像,而背有品牌卡的外壳是正确的. 建筑可以,
因为到那时卡片已经放在磁盘上或者没有 另一个主机的卡片被跳过 .
loadTemplate 拒绝 dist/index.html 这已经是一个已实现的页面. dist/index.html 实值
每个页面都烤好文件 从 和主页本身的输出, 所以第二个传过 a
写入 dist/ 读取一个完成的页作为它的空白,而一个嵌入到另一个中. vite build 虚空 dist/ 并且通常无法做到:恢复的建筑缓存和手动运行
的脚本 .
第一个框架前的主题
import { themeScript } from "@gusnips/vite/theme";
export default defineConfig({ plugins: [themeScript({ key: "app.theme" })] });
写作 assets/theme-<hash>.js 和一个 <script src> 结尾 <head>,所以页面是
画在读者主题上 在其他东西运行之前。 文件是 startTheme
从 @gusnips/react/theme,所以涂料前的脚本和应用程序使用的控制器是
相同的函数。 它是一个文件,而不是一个内含的脚本,所以 script-src 'self' 政策
让它运行。 照你说的做 createTheme看那个包裹的读取。 打开
预设,放进去 plugins。 。 。 .
themeScript 以 prePaintScript,它需要任何必须在
页面显示. @gusnips/locale是因为 localeGateScript 另一个是:
import { prePaintScript } from "@gusnips/vite";
prePaintScript({ name: "locale", source: localeGateScript({ ... }), position: "head-prepend" });
剧本是自己运行的,在你捆绑之前,所以它不能使用任何外部的东西. 这个
标记在结尾 <head> 默认. position: "head-prepend" 先放进去,所以..
它不等待您的样式表下载 。 用于可能离开页面的脚本 .
检查您的翻译
// scripts/check-i18n.ts
import { readFile } from "node:fs/promises";
import { checkI18n, formatI18nReport, type I18nBundle } from "@gusnips/vite/i18n";
const web: I18nBundle = {
name: "web",
locales: ["en", "pt-BR", "es"],
canonical: "en",
load: async (locale) => ({
translation: JSON.parse(await readFile(`src/i18n/locales/${locale}.json`, "utf8")),
}),
};
const report = await checkI18n([web]);
console.log(formatI18nReport(report));
process.exit(report.problems.some((p) => p.level === "error") ? 1 : 0);
canonical 语言被输入,所以 t("key") 它缺少已无法编译 。 另一个
语言不是,字符串里也没有任何东西。 此检查编译器无法做到的 :
| 当它失败时 | 因为读者得到 |
|---|---|
| 键用一种语言而不是另一种语言,或者是空白 | 犬科语言,在他们自己的中间 |
a 计数密钥缺少其语言需要的表单(pt _many(中文(简体) ) | 倒置语言的精确值为1 000 000,或原始键 |
{{name}} 成为 {{nome}},或 {{n, number}} 丢失 number | 空隙,或5000,他们写出5000 |
<0>…</0> 是否关闭 | 粗体或标记为文本 |
一个占位符被命名 lng, (中文(简体) ), ns 或另一个 t() 选项 | 其它语言,而不是值 |
| 无法装入语言 | 无所事事:其他规则都会被空了 |
load 返回一个语言的命名空间目录, 因此 JSON 文件、 TS 模块和运行时间
合并所有合适的。 如果投出,则检查会因出错而失败. 它永远不会跳过.
给我 code 它也读取了你的来源: 每一个静态 t("key") 存在,模板密钥的
固定开始存在( a)t(`plan.${id}.title`) 需求 plan, (中文(简体) ), <Trans> 没有孩子
移动时间 <0>),并抄送 <strong> 在其中不读取 t(),该打印
标记为文本.
await checkI18n([{ ...web, code: ["src/**/*.{ts,tsx}"] }]);
服务器发送的密钥以阅读器的任意语言显示,所以每个密钥必须包含在每一个
语言。 如果您能导入此列表, 或服务器的源头扫描该列表 messageKey:数字 :
await checkI18n([{ ...web, serverKeys: MESSAGE_KEYS }]);
// or, with no list to import:
await checkI18n([
{ ...web, serverCode: ["apps/api/src/**/*.ts"], serverKeyPrefixes: ["serverErrors."] },
]);
扫描读取文本,而不是语法,所以 t("key") 在注释中也算数,但检查失败
如果钥匙不见了。 修正论. 安全跳过注释需要全解析器:模式
切线在 // 也把它切开 https://并且会悄悄地错过一个真正的 t() 后结.
report.unused 列表中找不到代码的条形键 。 这是暗示,不是失败:关键
在运行时从变量中构建的,无法通过扫描看到.
如果你的价钱是用预产物买的 那就算了 { price: /\$\s?\d/ } 作为第二个论据和一个
输入副本的价格也失败 .
断相相相. 如果几个人同时写屏幕,每个区域保留一个文件
语言并排( name{ "en": {…}, "pt-BR": {…} })并合并. writeFragments 写入
out/<locale>.json 有排序的密钥,所以两个运行会写相同的字节,如果两个则不写
碎片有分歧。 如果一个已承诺的目录不再与其碎片相匹配, 则检查失败 :
await checkI18n([{ ...web, fragments: { dir: "src/i18n/fragments", out: "src/i18n/locales" } }]);
如果应用程序在运行时将碎片与扩展合并( Q) :{ ...auth.en, ...nav.en }),离开 out
关闭并启动 ownTopLevel: true。散点只保留两个片段中的第二个片段
顶级密钥,所以被拒绝.
检查您的对比度
// scripts/check-contrast.ts
import { checkContrast, formatContrastReport } from "@gusnips/vite/contrast";
const report = await checkContrast([
{ name: "web", entry: "src/index.css", sources: ["src/**/*.{ts,tsx}"] },
]);
console.log(formatContrastReport(report));
process.exit(report.problems.some((p) => p.level === "error") ? 1 : 0);
符号包测量占位符的颜色。 这算你的: 它汇编 您的条目与真正的 Tailwind CLI 并读取 CSS 回来。 没有尾风? 下一个 区域读取纯 CSS 自定义属性.
| 当它失败时 | 因为读者得到 |
|---|---|
--color-input 低于 3:1 时 --color-background模式 | 某个人看不到的字段边界 |
--color-foreground 位于背景的4.5:1以下, 两种模式 | 身体复制 一些人不能读 |
--color-primary 两种模式中都是相同的填入 | 3:1线夜间着陆的控制 |
符号在 .dark | 一个模式保持另一个模式的颜色 |
颜色的班级画 @theme 从不声明 | text-white 中午看书 晚上消失 |
它不能测量的下限也会失败:不是六进制颜色的值(或 var() 链到
一)是无人守的地板. 国家变式遵循同样的规则,a
hover: 所以状态会改变
没什么 一个完全没有规则的类也是一种警告:一个标志性的Tailwind确实存在
没有,或者一个动态构建的类 没有扫描可以看见.
过 allow: [/^bg-brand-/] 对班级来说,回购意味着。 下限为不允许列表: a
衡量比率不是一项判断.
在没有尾风的情况下检查您的对比度
如果您的颜色是简单的 CSS 自定义属性, 则没有 @theme 要编译。 命名文件,
暗块的选择器,以及必须保持可读性的对:
// scripts/check-contrast.ts
import { checkTokenPairs, formatContrastReport } from "@gusnips/vite/contrast";
const report = await checkTokenPairs([
{
name: "site",
css: "src/tokens.css",
dark: ':root[data-theme="dark"]',
textPairs: [["--ground", "--ink"]],
},
]);
console.log(formatContrastReport(report));
process.exit(report.problems.some((p) => p.level === "error") ? 1 : 0);
它读取颜色在 :root { … } 作为亮度主题和颜色 在您黑暗块作为
黑暗的那个 无暗主题叶的产品 dark 关闭:然后在
光块,没有符号需要一个黑暗的双胞胎。 若为 --ink 打开 --ground 显示在4.5:1以下,它打印出1:
site
✖ floor: src/tokens.css:8 dark: --ink (#3a3a3a) on --ground (#121212) is 1.65:1, under the 4.5:1 floor for text (WCAG 1.4.3)
✖ contrast: 1 error(s)
无所编译,所以不需要"尾风",不需要"其他同平". 它返回相同的报告为
checkContrast,所以前题是相同的,你可以在离开前加入两个:
report.problems.push(...other.problems)。 。 。 .
| 当它失败时 | 因为读者得到 |
|---|---|
| 光线或暗色主题下的一对 | 文字或边框 |
| 颜色在一个主题而不是另一个主题 | 一种模式保存或缺少颜色 |
| 一个对称名称一个没有块声明的符号 | 看上去像一对通过 |
| 一对持有非六进制的颜色 | 一层楼没人守 |
系统块与暗块不同,或不在 @media | 一个没有保存选择的页面,看起来不同 |
textPairs 持有至4.5:1 nonTextPairs (边框,焦点环,图标)到3:1. 变动
他们与 textFloor 财务报告和审定财务报表 nonTextFloor一对是 [background, foreground]; 比例为
所以命令只能决定信息的内容 把名字写成CSS
有,与 --。光块是 :root 除非你设定 light。 。 。 .
系统挡道. 未选择主题的页面会遵循系统, 因此许多应用程序会写入 黑暗的颜色有两次:一次为选定的主题,一次为其他人.
:root {
--ground: #ffffff;
--ink: #1a1a1a;
}
:root[data-theme="dark"] {
--ground: #121212;
--ink: #f2f2f2;
}
@media (prefers-color-scheme: dark) {
:root:not([data-theme]) {
--ground: #121212;
--ink: #f2f2f2;
}
}
过 system: ":root:not([data-theme])" 支票的第二块到第一块:
同样的符号,同样的颜色(#FFF 财务报告和审定财务报表 #ffffff 颜色相同),内部
@media (prefers-color-scheme: dark)。无论哪个暗块都可以坐在里面 @media screen { … }。 。 。 .
你自己开的支票. loadTokenThemes 手拿回两个调色板作为六进制, 和相同的文件
选择器 :
import { loadTokenThemes } from "@gusnips/vite/contrast";
const { light, dark } = await loadTokenThemes({
css: "src/tokens.css",
dark: ':root[data-theme="dark"]',
});
light.get("--ground"); // "#ffffff"
只用于您的应用程序所知道的内容:浏览器工具栏颜色是页面的地平面 例如,每个主题。 它扔,并说什么是缺失, 如果文件或块不在那里.
它不读. 它读取了文本,而不是CSS,而且后面也没有CSS解析器.
- 只有十六进制颜色( X)
#fff或者说#ffffff)是测量的。 一对一的象征rgb(), (中文(简体) ),oklch()或者说var()失败是无法衡量的。 {\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}Tokens no pair uses, like--radius,为 独自一人. - 在任意
@media,必须只持有声明。 A 类 块, 里面有另一个规则( 已注销的 CSS) , 并且没有读取, 支票上说它找不到 块. - 媒体查询被读取而非运行 。 A 类
@media print以您的黑暗选择器为单位的块数 选择器。 如果一个选择器被写出两次,则后期的符号获胜,如同它在CSS中所做的那样. - 光明和黑暗需要不同的选择者.
阴道预设
import { webPreset } from "@gusnips/vite/preset";
import { defineConfig } from "vite";
export default defineConfig(webPreset({ root: import.meta.dirname, port: 5173 }));
它添加 React 和 Tailwind 插件, 分数 @ 时间 src运行 vite preview 打开端口
减一千. root 需要: 是文件夹 index.html自己的子路径,
因为它拉进这两个插件.
传出更多插件 plugins。它们运行在预设自己的:
export default defineConfig(
webPreset({ root: import.meta.dirname, port: 5173, plugins: [themeScript(THEME)] }),
);
麻省理工学院的一部分 工具包