Registry / devops / vite-plugin-info

vite-plugin-info

library0.4.1jsnpmunverified

Exports build metadata as Vite virtual modules, including build timestamp, git commit info, CI environment, and custom metadata. Current stable version is 0.4.1. The plugin provides three virtual modules: ~build/time (build start timestamp), ~build/info (git repository info via git-repo-info and CI detection via ci-info), and ~build/meta (user-defined metadata from vite.config options). It supports Vite 2.9+, 3.x, and 4.x, and ships TypeScript declarations. Compared to alternative approaches like manual file generation, it integrates directly into Vite's build pipeline and updates automatically on each build.

devops observability

npm install vite-plugin-info

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-INFO

vite-plugin-info

devopsjavascriptv0.4.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

BuildInfo

✓ import BuildInfo from 'vite-plugin-info'

✗ import { BuildInfo } from 'vite-plugin-info'

Default export; named import will result in undefined.

now (from ~build/time)

✓ import now from '~build/time'

✗ import { now } from '~build/time'

~build/time module exports a single default value (Date string), not a named export.

sha (from ~build/info)

✓ import { sha } from '~build/info'

✗ import sha from '~build/info'

~build/info exports named members (sha, CI, github, etc.), not a default export.

message (from ~build/meta)

✓ import { message } from '~build/meta'

✗ import message from '~build/meta'

~build/meta exports named members matching the keys in the meta option object.

name (from ~build/package)

✓ import { name } from '~build/package'

✗ import name from '~build/package'

~build/package exports named members (name, version, etc.) from package.json.

Shows setup in vite.config.ts and usage of the four virtual modules: ~build/time, ~build/info, ~build/meta, ~build/package.

// vite.config.ts import { defineConfig } from 'vite' import BuildInfo from 'vite-plugin-info' export default defineConfig({ plugins: [ BuildInfo({ meta: { author: 'Alice', version: process.env.APP_VERSION ?? 'dev', } }) ] }) // In your app code: import now from '~build/time' import { sha, CI } from '~build/info' import { author, version } from '~build/meta' import { name } from '~build/package' console.log(`Build started: ${now}`) console.log(`Git commit: ${sha}`) console.log(`CI: ${CI}`) console.log(`App meta: ${author} ${version}`) console.log(`Package: ${name}`)

Debug

Known issues

gotchaModule paths must match exactly: '~build/time', not '@/build/time' or 'virtual:build/time'

fix

Use the exact string '~build/time' etc. as the import specifier.

affects: >=0.0.0

gotchaMeta options are serialized with JSON.stringify; functions or non-serializable values will break

fix

Only pass plain objects/arrays/strings/numbers/booleans as meta values.

affects: >=0.0.0

breakingv0.4.x is the last version supporting Vite 2.x; v1.x drops Vite 2.x support

fix

Upgrade to Vite ^3.0.0 || ^4.0.0 if using v1.x plugin.

affects: >=1.0.0

gotchaTypeScript users must declare module types for virtual modules in a .d.ts file

fix

Add declare module '~build/meta' { ... } etc. in your env.d.ts.

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module '~build/time' or its corresponding type declarations.

TypeScript doesn't know about the virtual module; missing type declaration.

fix

Add declare module '~build/time' { const now: string; export default now; } in a .d.ts file.

BuildInfo is not a function / TypeError: BuildInfo is not a constructor

Used named import instead of default import.

fix

Change import { BuildInfo } from 'vite-plugin-info' to import BuildInfo from 'vite-plugin-info'.

Error: The plugin 'vite-plugin-info' doesn't seem to be a valid Vite plugin.

Plugin is improperly applied (e.g., array inside array, or not instantiated).

fix

Ensure plugins array contains the instantiated plugin: BuildInfo(), not BuildInfo.

Upgrade

Version history

0.4.1latest on npm

Audit

Dependencies

viteoptionalRequired peer dependency for plugin functionality

Agent activity

32 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/yjl9903/vite-plugin-info ↗

packagehttps://www.npmjs.com/package/vite-plugin-info ↗