0.0.13 • Published 6 months ago

@censujiang/vite-plugin-version-mark v0.0.13

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

@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.

npm version npm downloads types License

Vite Nuxt

Awesome

Demo

demo screen shot

Install

yarn add -D @censujiang/vite-plugin-version-mark
# OR npm install -D @censujiang/vite-plugin-version-mark

Usage

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.

namedescriptiontypedefaultsupported
nameapplication namestringname in package.json0.0.1+
versionapplication versionstringversion in package.json0.0.1+
ifGitSHAuse git commit SHA as the versionbooleanfalse0.0.1+
ifShortSHAuse git commit short SHA as the versionbooleantrue0.0.1+
ifLogprint info in the Consolebooleantrue0.0.1+
ifGlobalset a variable named `__${APPNAME}_VERSION__` in the windowbooleantrue0.0.4+
ifMetaadd \ in the \booleantrue0.0.1+
ifImportMetaadd import.meta.env.__${APPNAME}_VERSION__ in the Appbooleantrue0.0.9+
commandprovide a custom command to retrieve the version For example: git describe --tagsstringgit rev-parse --short HEAD0.0.8+

View CHANGELOG

0.0.13

6 months ago

0.0.12

10 months ago

0.0.11

10 months ago

0.0.10

10 months ago

0.0.9

10 months ago