buildInfo(options?)

buildInfo({
	fileName: "meta/build-info.json",
	commit: process.env.GITHUB_SHA,
	data: ({ mode }) => ({ channel: mode }),
});

选项	默认值	说明
version	package.json 版本	固定版本
packageJson	"package.json"	版本来源，相对于 Vite root
fileName	"build-info.json"	构建资产路径
commit	常见 CI 环境变量	提交标识
data	{}	JSON 自定义字段或异步提供者
dev	true	开发服务器提供同名 JSON 端点
virtualModuleId	"virtual:fast-vite/build-info"	虚拟模块；false 关闭
now	() => new Date()	时间来源，用于可重复构建或测试

标准字段为 version、builtAt、mode 和可选 commit，始终覆盖自定义数据中的同名字段。插件不会改写 package.json 或 public 目录。

虚拟模块类型声明示例：

declare module "virtual:fast-vite/build-info" {
	export const version: string;
	const information: {
		version: string;
		builtAt: string;
		mode: string;
		commit?: string;
	};
	export default information;
}

buildInfo 构建信息

在构建产物中生成版本信息 JSON，同时提供开发地址和虚拟模块。 插件只读取版本清单，不会在构建过程中改写 package.json。

签名

export function buildInfo(options: BuildInfoPluginOptions = {}): Plugin;

示例

import { buildInfo } from "fast-vite-plugins";

const plugin = buildInfo({ fileName: "meta/build-info.json", version: "1.2.3" });

export default { plugins: [plugin] };

输入

输入值	输入值类型	必填/默认值	输入值说明
options	BuildInfoPluginOptions	否，默认 {}	版本来源、输出文件、开发端点和虚拟模块配置。

返回

返回值	返回值类型	返回值说明
plugin	Plugin	可直接加入 Vite plugins 的构建信息插件。