envGuard(options)
ts
envGuard({
schema: {
VITE_API_URL: { pattern: /^https:\/\//, description: "HTTPS API base URL" },
VITE_STAGE: { values: ["development", "production"] },
OPTIONAL_TOKEN: { required: false },
},
onInvalid: "error",
});规则支持 required、allowEmpty、pattern、values 和自定义 validate。诊断只包含变量名和失败原因,不会输出实际值。
envGuard 环境校验
在 Vite 启动和构建前校验环境变量,尽早暴露缺失配置。
签名
ts
export function envGuard(options: EnvGuardPluginOptions): Plugin;示例
ts
import { envGuard } from "fast-vite-plugins";
const plugin = envGuard({ schema: { VITE_API_URL: { required: true, pattern: /^https:\/\// } } });
export default { plugins: [plugin] };输入
| 输入值 | 输入值类型 | 必填/默认值 | 输入值说明 |
|---|---|---|---|
options | EnvGuardPluginOptions | 是 | 环境变量 schema、跳过模式和失败处理方式。 |
返回
| 返回值 | 返回值类型 | 返回值说明 |
|---|---|---|
plugin | Plugin | 可直接加入 Vite plugins 的环境变量校验插件。 |
