# purple-version-vite

**Repository Path**: npm_1/purple-version-vite

## Basic Information

- **Project Name**: purple-version-vite
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-11-09
- **Last Updated**: 2024-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vite 插件：生成版本信息文件

## 简介

该 Vite 插件用于在 Vite 构建阶段生成包含 Git 仓库信息的版本信息文件。通过读取 Git 仓库信息，生成包含仓库地址、作者、时间和分支等信息的 version.json 文件，方便查看构建版本的详细信息。

输出如下信息：

```json
{
  "repository": "https://gitee.com/**/home.git",
  "author": "purple",
  "email": "purple@163.com",
  "time": "2023/11/9 19:36:05",
  "branch": "master",
  "commit": "ase12sDs"
}
```

## 使用

### 安装

```shell
$ pnpm i purple-version-vite --save-dev
$ npm i purple-version-vite --save-dev
$ yarn add purple-version-vite --dev
```

### 配置

在 Vite 项目的 vite.config.js 文件中引入并注册该插件：

```js
import { defineConfig } from 'vite';
import versionFilePlugin from 'purple-version-vite';

export default defineConfig({
  plugins: [
    versionFilePlugin()
    // 其他插件...
  ]
});
```

## 验证

项目执行 `pnpm build` 之后，在输出目录下生成一个 `version.json` 文件，内容是简介中的信息。

## 注意事项

请确保在 Vite 项目的构建阶段使用该插件，以便生成正确的版本信息文件。

如果 Git 相关命令无法执行，请确保环境中安装了 Git 并配置了正确的环境变量。

欢迎使用该插件，并欢迎提出改进建议或报告问题！