@censujiang/vite-plugin-version-mark
Automatically insert the version or git_commit_sha in your Vite/Nuxt project.
This release is a separate branch maintained by @censujiang. The original author is @ZhongxuYang. This version is suitable for my own company's work environment, if you want to use this plugin, please consider @ZhongxuYang's master version first.
Demo
Install
yarn add -D @censujiang/vite-plugin-version-mark
# OR npm install -D @censujiang/vite-plugin-version-markUsage
Vite
// vite.config.ts
import {defineConfig} from 'vite'
import {vitePluginVersionMark} from '@censujiang/vite-plugin-version-mark'
export default defineConfig({
plugins: [
vitePluginVersionMark({
// name: 'test-app',
// version: '0.0.1',
// command: 'git describe --tags',
ifGitSHA: true,
ifShortSHA: true,
ifMeta: true,
ifLog: true,
ifGlobal: true,
ifImportMeta: true,
})
],
})Nuxt3+
// nuxt.config.ts
export default defineNuxtConfig({
modules: [
['@censujiang/vite-plugin-version-mark/nuxt', {
// name: 'test-app',
// version: '0.0.1',
// command: 'git describe --tags',
ifGitSHA: true,
ifShortSHA: true,
ifMeta: true,
ifLog: true,
ifGlobal: true,
ifImportMeta: true,
}]
],
})Then you can use @censujiang/vite-plugin-version-mark ! 🎉
Config
@censujiang/vite-plugin-version-mark can be print application version in the Console or add <meta> in HTML element.
| name | description | type | default | supported |
|---|---|---|---|---|
| name | application name | string |
name in package.json |
0.0.1+ |
| version | application version | string |
version in package.json |
0.0.1+ |
| ifGitSHA | use git commit SHA as the version | boolean |
false | 0.0.1+ |
| ifShortSHA | use git commit short SHA as the version | boolean |
true | 0.0.1+ |
| ifLog | print info in the Console | boolean |
true | 0.0.1+ |
| ifGlobal | set a variable named `__${APPNAME}_VERSION__` in the window | boolean |
true | 0.0.4+ |
| ifMeta | add <meta name="application-name" content="{APPNAME_VERSION}: {version}"> in the <head> | boolean |
true | 0.0.1+ |
| ifImportMeta | add import.meta.env.__${APPNAME}_VERSION__ in the App |
boolean |
true | 0.0.9+ |
| command | provide a custom command to retrieve the version For example: git describe --tags
|
string |
git rev-parse --short HEAD | 0.0.8+ |
View CHANGELOG