@jinixx/vite-plugin-git-revision


> Git version info for applications using Vite
>
> Forked from https://github.com/qduld/vite-plugin-git-revision to fix a few issues.

Getting Started

Install:

``bash
npm install -D @jinixx/vite-plugin-git-revision
`

Add to your vite.config.js:

`js
import GitRevision from 'vite-plugin-git-revision';

export default {
plugins: [
GitRevision()
],
};
`

Configuration

To use custom configuration, pass your options to Pages when instantiating the plugin:

`js
// vite.config.js
import GitRevision from 'vite-plugin-git-revision';

export default {
plugins: [
GitRevision({
lightweightTags: false,
branch: false,
// default, remove prop if not needed, do not set to empty
commithashCommand: 'rev-parse HEAD',
// default versionCommand was describe --always
versionCommand: 'describe --tags --long --dirty --always',
// default, remove prop if not needed, do not set to empty
branchCommand: 'rev-parse --abbrev-ref HEAD',
// change the default git command used to read the DATE and TIME of the commit
datetimeCommand: 'log -1 --date=format:"%Y-%m-%d %H:%M" --pretty=format:'%ad'',
}),
],
};
`

$3

- Type: boolean
- Default: false

lightweight tags support.

$3

- Type: boolean
- Default: false

branch tags support.

$3

- Type: string
- Default: describe --always

change the default git command used to read the value of VERSION.

$3

- Type: string
- Default: rev-parse HEAD

change the default git command used to read the value of COMMITHASH.

$3

- Type: string
- Default: rev-parse --abbrev-ref HEAD

change the default git command used to read the value of BRANCH.

$3

- Type: string
- Default: log -1 --date=format:"%Y-%m-%d %H:%M" --pretty=format:'%ad'

change the default git command used to read the date and time of the commit.

Accessing the values

`js
// Anywhere in your application code
console.log(GITVERSION);
console.log(GITCOMMITDATETIME);
``

License

MIT