vite-plugin-info v0.4.1
vite-plugin-info
Export build information as Vite virutal module.
This plugin helps you add build timestamp / commit SHA / ... to your application. So you can easily check whether the production version meets your expectations.
Installation
npm i -D vite-plugin-info
Add plugin vite-plugin-info
to your vite.config.ts
.
// vite.config.ts
import { defineConfig } from 'vite'
import BuildInfo from 'vite-plugin-info'
export default defineConfig({
plugins: [
BuildInfo()
]
})
Usage
vite-plugin-info
creates three virtual modules, ~build/time
, ~build/info
, and ~build/meta
.
~build/time
It exports the timestamp when the vite started.
import now from '~build/time'
console.log(now)
// There will be a log like "Fri Jun 24 2022 16:30:30 GMT+0800 (中国标准时间)"
~build/info
It exports the infomation about the current git repo. This is powered by git-repo-info and ci-info.
import {
CI,
github,
sha,
abbreviatedSha,
tag,
lastTag,
commitsSinceLastTag,
committer,
committerDate,
author,
authorDate,
commitMessage
} from '~build/info';
// ...
~build/meta
It exports some meta data from the options of the plugin.
// vite.config.ts
export default defineConfig({
plugins: [
BuildInfo({
meta: { message: 'This is set from vite.config.ts' }
})
]
})
Then you can import them in your Vite app.
import { message } from '~build/meta'
console.log(message)
// This is set from vite.config.ts
Note
Meta data will be serialized to JSON format, so you should gen it in you
vite.config.ts
and pass the result object.
To get TypeScript support, you can add type declaration in your env.d.ts
(It is include in the official Vite project template).
declare module '~build/meta' {
export const message: string;
}
~build/package
It exports the information of the current package.json
.
import { name, version } from '~build/package';
License
MIT License © 2021 XLor