{"_id":"@atomfe/vite-plugin-release-info","_rev":"2-17ab84bd8ac65bf7f9628d0f69a0eed3","name":"@atomfe/vite-plugin-release-info","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@atomfe/vite-plugin-release-info","version":"0.0.1","keywords":["vite","plugin","meta","inject","version","release","html","metadata"],"author":{"name":"HHFE Team"},"license":"MIT","_id":"@atomfe/vite-plugin-release-info@0.0.1","maintainers":[{"name":"lorainwings","email":"lorainwings@gmail.com"}],"homepage":"https://github.com/lorainwings/vite-plugin-release-info#readme","bugs":{"url":"https://github.com/lorainwings/vite-plugin-release-info/issues"},"dist":{"shasum":"995a3d043c62c947738da70858689a002063af48","tarball":"https://registry.npmjs.org/@atomfe/vite-plugin-release-info/-/vite-plugin-release-info-0.0.1.tgz","fileCount":9,"integrity":"sha512-dGMBsygpXmHO+mETh3pZySemqaVh4lgrMw2tALdV6gjJP97m9BZ6ULgXfZpfaTskokNxjMYxlQZghBekjuZUCg==","signatures":[{"sig":"MEQCIHQIevSWAZm06UiD+dcC5SCfhaZOC/OJZQSrcdeeJTD1AiBX5V0Kd2tV7ebGQbd/1wDWkeb6ENLFLG8ZXufx4AgTKg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":152688},"main":"dist/index.cjs","type":"module","_from":"file:atomfe-vite-plugin-release-info-0.0.1.tgz","types":"dist/index.d.ts","module":"dist/index.js","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"dev":"tsup --watch","lint":"eslint src --ext .ts,.js,.mjs --fix","test":"vitest run","build":"tsup","clean":"rimraf dist","format":"prettier --write \"src/**/*.{ts,js,json,md}\"","example":"cd example && pnpm run dev","release":"bumpp package.json --commit --push --tag","changelog":"conventional-changelog -p conventionalcommits -i CHANGELOG.md -s","lint:check":"eslint src --ext .ts,.js,.mjs","type-check":"tsc --noEmit","bumpp:major":"bumpp package.json --commit --push --tag major && pnpm run changelog","bumpp:minor":"bumpp package.json --commit --push --tag minor && pnpm run changelog","bumpp:patch":"bumpp package.json --commit --push --tag patch && pnpm run changelog","lint:format":"eslint src --ext .ts,.js,.mjs --fix && prettier --write \"src/**/*.{ts,js,json,md}\"","format:check":"prettier --check \"src/**/*.{ts,js,json,md}\"","example:build":"cd example && pnpm run build","test:coverage":"vitest run --coverage","changelog:preview":"conventional-changelog -p conventionalcommits"},"_npmUser":{"name":"lorainwings","email":"lorainwings@gmail.com"},"_resolved":"/tmp/a2889ea7cc10145d0dba57b8cb339895/atomfe-vite-plugin-release-info-0.0.1.tgz","_integrity":"sha512-dGMBsygpXmHO+mETh3pZySemqaVh4lgrMw2tALdV6gjJP97m9BZ6ULgXfZpfaTskokNxjMYxlQZghBekjuZUCg==","repository":{"url":"git+https://github.com/lorainwings/vite-plugin-release-info.git","type":"git"},"_npmVersion":"10.8.2","description":"A Vite plugin for injecting release metadata and version information into index.html","directories":{},"_nodeVersion":"20.19.4","dependencies":{"simple-git":"^3.20.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","vite":"^5.0.0","bumpp":"^10.0.0","husky":"^9.1.7","eslint":"^9.0.0","rimraf":"^5.0.0","vitest":"^1.0.0","globals":"^16.3.0","prettier":"^3.0.0","@eslint/js":"^9.33.0","typescript":"^5.3.0","@types/node":"^20.10.0","@commitlint/cli":"^19.8.1","typescript-eslint":"^8.39.1","@vitest/coverage-v8":"^1.0.0","eslint-config-prettier":"^9.0.0","eslint-plugin-prettier":"^5.0.0","@typescript-eslint/parser":"^8.0.0","conventional-changelog-cli":"^5.0.0","@commitlint/config-conventional":"^19.8.1","@typescript-eslint/eslint-plugin":"^8.0.0","conventional-changelog-conventionalcommits":"^9.1.0"},"peerDependencies":{"vite":"^4.0.0 || ^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/vite-plugin-release-info_0.0.1_1755493099343_0.09662993225695637","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@atomfe/vite-plugin-release-info","version":"0.0.2","description":"A Vite plugin for injecting release metadata and version information into index.html","type":"module","main":"dist/index.cjs","module":"dist/index.js","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"publishConfig":{"access":"public"},"scripts":{"dev":"tsup --watch","build":"tsup","prepublishOnly":"pnpm run build","test":"vitest run","test:coverage":"vitest run --coverage","lint":"eslint src --ext .ts,.js,.mjs --fix","lint:check":"eslint src --ext .ts,.js,.mjs","lint:format":"eslint src --ext .ts,.js,.mjs --fix && prettier --write \"src/**/*.{ts,js,json,md}\"","type-check":"tsc --noEmit","clean":"rimraf dist","format":"prettier --write \"src/**/*.{ts,js,json,md}\"","format:check":"prettier --check \"src/**/*.{ts,js,json,md}\"","release":"bumpp package.json --commit --push --tag","bumpp:patch":"bumpp package.json --commit --push --tag patch && pnpm run changelog","bumpp:minor":"bumpp package.json --commit --push --tag minor && pnpm run changelog","bumpp:major":"bumpp package.json --commit --push --tag major && pnpm run changelog","changelog":"conventional-changelog -p conventionalcommits -i CHANGELOG.md -s","changelog:preview":"conventional-changelog -p conventionalcommits","prepare":"husky","example":"cd example && pnpm run dev","example:build":"cd example && pnpm run build"},"keywords":["vite","plugin","meta","inject","version","release","html","metadata"],"author":{"name":"HHFE Team"},"license":"MIT","packageManager":"pnpm@10.14.0","engines":{"node":">=18.0.0"},"devDependencies":{"@commitlint/cli":"^19.8.1","@commitlint/config-conventional":"^19.8.1","@eslint/js":"^9.33.0","@types/node":"^20.10.0","@typescript-eslint/eslint-plugin":"^8.0.0","@typescript-eslint/parser":"^8.0.0","@vitest/coverage-v8":"^1.0.0","bumpp":"^10.0.0","conventional-changelog-cli":"^5.0.0","conventional-changelog-conventionalcommits":"^9.1.0","eslint":"^9.0.0","eslint-config-prettier":"^9.0.0","eslint-plugin-prettier":"^5.0.0","globals":"^16.3.0","husky":"^9.1.7","prettier":"^3.0.0","rimraf":"^5.0.0","tsup":"^8.0.0","typescript":"^5.3.0","typescript-eslint":"^8.39.1","vite":"^5.0.0","vitest":"^1.0.0"},"peerDependencies":{"vite":"^4.0.0 || ^5.0.0"},"dependencies":{"simple-git":"^3.20.0"},"repository":{"type":"git","url":"git+https://github.com/lorainwings/vite-plugin-release-info.git"},"bugs":{"url":"https://github.com/lorainwings/vite-plugin-release-info/issues"},"homepage":"https://github.com/lorainwings/vite-plugin-release-info#readme","_id":"@atomfe/vite-plugin-release-info@0.0.2","gitHead":"22d2a82a7239c307baf211b2cee6d1c1b51af650","_nodeVersion":"21.6.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-5sVOhhrcl3GDHwg4bJs7jUDWL0dPFMGNx3APRRcyIUWyR7Qi+YwyRh/aHdwjzdIY5g6dIc53ptTDPKs5qYKx1Q==","shasum":"847f3d01802d1f5d3a38038034d11ded2388099a","tarball":"https://registry.npmjs.org/@atomfe/vite-plugin-release-info/-/vite-plugin-release-info-0.0.2.tgz","fileCount":9,"unpackedSize":159571,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIC1az8hcvObMjDryycZRNz4MSjtdPJQRyDSNLrVZfH42AiEAmAP8acNOvRuQGPvHSepU47qmA8MYBvjOn7S/QrAVz+o="}]},"_npmUser":{"name":"lorainwings","email":"lorainwings@gmail.com"},"directories":{},"maintainers":[{"name":"lorainwings","email":"lorainwings@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vite-plugin-release-info_0.0.2_1755502514994_0.07441533177228066"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-18T04:58:19.250Z","modified":"2025-08-18T07:35:15.424Z","0.0.1":"2025-08-18T04:58:19.588Z","0.0.2":"2025-08-18T07:35:15.204Z"},"bugs":{"url":"https://github.com/lorainwings/vite-plugin-release-info/issues"},"author":{"name":"HHFE Team"},"license":"MIT","homepage":"https://github.com/lorainwings/vite-plugin-release-info#readme","keywords":["vite","plugin","meta","inject","version","release","html","metadata"],"repository":{"type":"git","url":"git+https://github.com/lorainwings/vite-plugin-release-info.git"},"description":"A Vite plugin for injecting release metadata and version information into index.html","maintainers":[{"name":"lorainwings","email":"lorainwings@gmail.com"}],"readme":"

\n \"Vite\n

\n\n

@hhfe/vite-plugin-release-info

\n\n

\n \"Npm\"\n \"Downloads\"\n \"License\"\n \"test-and-build\"\n \"Vite\"\n \"TypeScript\"\n \"Node.js\"\n \"Pnpm\"\n \"Vitest\"\n \"Tsup\"\n \"ESLint\"\n \"Prettier\"\n

\n\n

\n 🚀 一个强大的 Vite 插件，用于在构建过程中向 index.html 注入构建元数据和版本信息 🚀\n

\n\n

\n 让您的应用构建信息更加透明和可追踪\n

\n\n---\n\n## ✨ 特性\n\n- 🚀 **自动注入构建信息**：构建时间、版本号、Git 信息等\n- 🔧 **高度可配置**：支持自定义字段和注入位置\n- 📦 **多种输出格式**：JSON、HTML 注释、Meta 标签、Console.log\n- 🌍 **环境信息收集**：Node.js 版本、环境变量等\n- 🐳 **CI/CD 友好**：支持 Jenkins、GitHub Actions 等\n- 📝 **TypeScript 支持**：完整的类型定义\n- 🧪 **测试覆盖**：完整的单元测试\n- 🎯 **Console.log 注入**：支持多种格式的控制台输出\n- 🏷️ **智能发布检测**：自动识别分支、标签或提交发布类型\n\n## 📦 安装\n\n```bash\npnpm add @hhfe/vite-plugin-release-info\n```\n\n## 🚀 快速开始\n\n### 基础用法\n\n```typescript\n// vite.config.ts\nimport { defineConfig } from 'vite'\nimport releaseInfo from '@hhfe/vite-plugin-release-info'\n\nexport default defineConfig({\n plugins: [\n releaseInfo()\n ]\n})\n```\n\n**注意**：插件默认只在生产构建时注入元数据。如需在开发模式下也注入，请设置 `injectInDev: true`。\n\n### 高级配置\n\n```typescript\n// vite.config.ts\nimport { defineConfig } from 'vite'\nimport releaseInfo from '@hhfe/vite-plugin-release-info'\n\nexport default defineConfig({\n plugins: [\n releaseInfo({\n // 基础配置\n includeBuildTime: true,\n includeVersion: true,\n includeGitInfo: true,\n includeNodeVersion: true,\n includeEnvInfo: true,\n\n // 自定义字段\n customFields: {\n buildId: () => `build-${Date.now()}`,\n environment: () => process.env.NODE_ENV || 'development',\n deployTime: () => new Date().toLocaleString(),\n randomValue: () => Math.random().toString(36).substring(7),\n },\n\n // 注入配置\n injectPosition: 'head',\n generateJson: false,\n generateComments: true,\n generateMetaTags: true,\n variableName: '__BUILD_META__',\n\n // Console.log 注入配置\n generateConsoleLog: true,\n consoleLogFormat: 'simple', // 'simple' | 'detailed' | 'structured'\n consoleLogEmojis: true,\n\n // 环境变量前缀\n envPrefixes: ['NODE_ENV', 'VITE_', 'JENKINS_', 'CI_'],\n })\n ]\n})\n```\n\n## 📖 API 文档\n\n### ReleaseInfoOptions\n\n| 选项 | 类型 | 默认值 | 描述 |\n|------|------|--------|------|\n| `customFields` | `Record string \\| number \\| boolean \\| Promise)>` | `{}` | 自定义元数据字段 |\n| `includeBuildTime` | `boolean` | `true` | 是否包含构建时间 |\n| `includeVersion` | `boolean` | `true` | 是否包含构建版本号 |\n| `includeGitInfo` | `boolean` | `true` | 是否包含 Git 信息 |\n| `includeNodeVersion` | `boolean` | `true` | 是否包含 Node.js 版本 |\n| `includeEnvInfo` | `boolean` | `false` | 是否包含环境变量信息 |\n| `envPrefixes` | `string[]` | `['NODE_ENV', 'VITE_', 'JENKINS_', 'CI_']` | 要包含的环境变量前缀 |\n| `injectPosition` | `'head' \\| 'body' \\| 'custom'` | `'head'` | 注入位置 |\n| `customSelector` | `string` | - | 自定义注入选择器（当 injectPosition 为 'custom' 时使用） |\n| `generateJson` | `boolean` | `false` | 是否生成 JSON 格式的元数据 |\n| `generateComments` | `boolean` | `true` | 是否生成注释格式的元数据 |\n| `generateMetaTags` | `boolean` | `true` | 是否生成 meta 标签 |\n| `generateConsoleLog` | `boolean` | `false` | 是否生成 console.log 输出 |\n| `consoleLogFormat` | `'structured' \\| 'simple' \\| 'detailed'` | `'simple'` | console.log 输出格式 |\n| `consoleLogEmojis` | `boolean` | `true` | 是否在 console.log 中使用表情符号 |\n| `variableName` | `string` | `'__BUILD_META__'` | 元数据变量名（用于在 HTML 中访问） |\n| `injectInDev` | `boolean` | `false` | 是否在开发模式下也注入（仅用于调试） |\n\n### 注入的元数据结构\n\n```typescript\ninterface BuildMetadata {\n buildTime: string // 本地化格式的构建时间\n buildTimestamp: number // 构建时间戳（毫秒）\n version?: string // 版本号（来自 package.json）\n git?: { // Git 信息\n branch?: string // 当前分支\n commit?: string // 提交哈希\n commitHash?: string // 提交哈希（别名）\n commitMessage?: string // 提交信息\n author?: string // 作者\n email?: string // 作者邮箱\n remote?: string // 远程仓库地址\n latestTag?: string // 最新标签\n short?: string // 短提交哈希（前7位）\n commitTime?: string // 提交时间\n releaseType?: 'branch' | 'tag' | 'commit' // 发布类型\n release?: string // 发布标识（分支名、标签名或提交哈希）\n }\n nodeVersion: string // Node.js 版本\n ci?: { // CI 信息\n jenkinsNodeName?: string // Jenkins 节点名\n jenkinsExecutorNumber?: string // Jenkins 执行器编号\n jenkinsBuildNumber?: string // Jenkins 构建号\n jenkinsJobName?: string // Jenkins 任务名\n githubRunId?: string // GitHub Actions 运行 ID\n githubRunNumber?: string // GitHub Actions 运行编号\n provider?: string // CI 提供商名称\n containerId?: string // CI 容器标识\n }\n env?: Record // 环境变量\n custom?: Record // 自定义字段\n}\n```\n\n## 🎯 使用示例\n\n### 1. 基础用法\n\n```html\n\n\n\n \n\n\n \n\n\n```\n\n### 2. 自定义字段\n\n```typescript\nreleaseInfo({\n customFields: {\n // 静态值\n projectName: 'My Awesome Project',\n\n // 动态值\n buildId: () => `build-${Date.now()}`,\n\n // 异步值\n apiVersion: async () => {\n const response = await fetch('/api/version')\n return response.text()\n }\n }\n})\n```\n\n### 3. 环境变量收集\n\n```typescript\nreleaseInfo({\n includeEnvInfo: true,\n envPrefixes: ['NODE_ENV', 'VITE_', 'JENKINS_', 'CI_']\n})\n```\n\n### 4. 自定义注入位置\n\n```typescript\nreleaseInfo({\n injectPosition: 'custom',\n customSelector: '#build-info'\n})\n```\n\n### 5. Console.log 注入\n\n```typescript\nreleaseInfo({\n // 启用 console.log 注入\n generateConsoleLog: true,\n\n // 选择输出格式\n consoleLogFormat: 'simple', // 'simple' | 'detailed' | 'structured'\n\n // 是否使用表情符号\n consoleLogEmojis: true,\n\n // 其他配置...\n})\n```\n\n**Console.log 特性**：\n\n- 使用彩色样式输出，标签有深色背景，值有绿色背景\n- 支持三种输出格式：simple（单行）、detailed（分组）、structured（结构化分组）\n- 可选择是否使用表情符号\n- 自动检测并显示可用的元数据信息\n\n#### Console.log 输出格式\n\n**Simple 格式**：简洁的单行输出（默认）\n\n```javascript\n🚀 构建信息\n[release] 版本号 1.0.0\n[release] 构建时间 2025-01-27 10:30:00\n[release] Git 分支 main\n[release] Git 提交ID abc1234\n[release] Git 标签 v1.0.0\n[release] Node 版本 v18.17.0\n```\n\n**Detailed 格式**：详细的分组输出（使用 console.group）\n\n```javascript\n🚀 构建信息\n[release] 版本号 1.0.0\n[release] 构建时间 2025-01-27 10:30:00\n\n⚙️ Git 信息\n [release] 分支 main\n [release] 提交ID abc1234\n [release] 标签 v1.0.0\n\n[release] Node 版本: v18.17.0\n\n🌐 环境变量\n [release] NODE_ENV: production\n [release] VITE_APP_TITLE: My App\n```\n\n**Structured 格式**：结构化的分组输出（使用 console.group）\n\n```javascript\n🚀 构建信息\n[release] 版本号 1.0.0\n[release] 构建时间 2025-01-27 10:30:00\n\n⚙️ Git 信息\n [release] 分支 main\n [release] 提交ID abc1234\n [release] 标签 v1.0.0\n\n[release] Node 版本 v18.17.0\n\n🌐 环境变量\n [release] NODE_ENV production\n [release] VITE_APP_TITLE My App\n```\n\n**注意**：所有输出都使用彩色样式，`[release]` 标签有深色背景，值有绿色背景。\n\n### 🏷️ 智能发布检测\n\n插件现在支持智能检测发布类型，自动识别当前是基于分支、标签还是提交的发布：\n\n```typescript\n// 在注入的元数据中，Git 信息现在包含：\ngit: {\n // ... 其他 Git 信息\n releaseType: 'branch' | 'tag' | 'commit', // 发布类型\n release: string, // 发布标识\n}\n```\n\n**发布类型说明**：\n\n- **`branch`**：当前在分支上（如 `main`、`develop`）\n- **`tag`**：当前在标签上（如 `v1.0.0`、`release-2024`）\n- **`commit`**：当前在分离的提交上（如 `abc1234`）\n\n**使用场景**：\n\n- 分支发布：适合开发分支或功能分支\n- 标签发布：适合版本发布和稳定版本\n- 提交发布：适合 CI/CD 中的特定提交构建\n\n## 🧪 测试\n\n```bash\n# 运行测试\npnpm test\n\n# 运行测试并生成覆盖率报告\npnpm run test:coverage\n\n# 类型检查\npnpm run type-check\n\n# 代码检查\npnpm run lint\n\n# 代码格式化\npnpm run format\n```\n\n## 📝 开发\n\n```bash\n# 克隆仓库\ngit clone https://github.com/lorainwings/vite-plugin-release-info.git\ncd vite-plugin-release-info\n\n# 安装依赖\npnpm install\n\n# 开发模式（监听文件变化）\npnpm dev\n\n# 构建项目\npnpm build\n\n# 运行示例项目\npnpm example\n\n# 构建示例项目\npnpm example:build\n\n# 清理构建文件\npnpm clean\n```\n\n## 🚀 发布\n\n项目使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范自动生成 changelog。\n\n```bash\n# 提交代码时使用规范格式\ngit commit -m \"feat: add new feature\"\ngit commit -m \"fix: resolve bug\"\ngit commit -m \"docs: update documentation\"\n\n# 发布新版本\npnpm bumpp:patch # 补丁版本 (0.0.3 → 0.0.4)\npnpm bumpp:minor # 次要版本 (0.0.3 → 0.1.0)\npnpm bumpp:major # 主要版本 (0.0.3 → 1.0.0)\n```\n\n## 🤝 贡献\n\n欢迎贡献！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。\n\n## 📄 许可证\n\nMIT License - 查看 [LICENSE](LICENSE) 文件了解详情。\n\n## 🙏 致谢\n\n感谢所有为这个项目做出贡献的开发者！\n\n## 📞 支持\n\n如果你遇到问题或有建议，请：\n\n1. 查看 [Issues](https://github.com/lorainwings/vite-plugin-release-info/issues)\n2. 创建新的 Issue\n3. 联系维护者\n\n---\n\n⭐ 如果这个项目对你有帮助，请给它一个星标！\n","readmeFilename":"README.md"}