@cxkit/vite-plugin-version - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

README.md

+# @cxkit/vite-plugin-version
+
+`@cxkit` 架构的构建层核心。它是一个高度轻量级的 Vite 插件，专为无感热更新和静态全量检查拦截生成构建时元数据。
+
+## 工作原理
+在执行 `vite build` 时，该插件会自动在你的产物目录 `dist/` 下生成一份静态配置文件 `version.json`，其中包含了一串唯一哈希 `buildId`。同时，它会通过 Vite 的 `define` 机制向应用程序的构建宏中注入基础预检配置常量，允许你在代码里自由读取 `__APP_VERSION__` 等信息。
+
+## 安装
+
+这是唯一一个需要在 **开发依赖 (devDependencies)** 中去安装的插件。
+
+```bash
+npm install -D @cxkit/vite-plugin-version
+```
+
+## 使用方法
+
+在 `vite.config.ts` 中：
+
+```ts
+import { defineConfig } from 'vite'
+import { versionManifest } from '@cxkit/vite-plugin-version'
+// 或借助 Node fs / 宏读取你的 package.json
+
+const versionPlugin = versionManifest(process.env.npm_package_version || '1.0.0')
+
+export default defineConfig({
+  plugins: [
+    // 生成 version.json 文件
+    versionPlugin.plugin
+  ],
+  // 将打包的时间与 ID 宏注入到源码替换
+  define: versionPlugin.define
+})
+```
+
+## 构建产出 (version.json)
+执行打包后，会生成如下结果：
+```json
+{
+  "version": "1.0.0",
+  "buildTime": "2026-03-26T12:00:00.000Z",
+  "buildId": "a7b8c9d0e12345"
+}
+```
+
+## 阅读完整文档
+详细用法请访问 [官方开发文档](https://github.com/chenx18_cn/cxkit)。

package.json

 {
   "name": "@cxkit/vite-plugin-version",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Vite plugin for generating version manifest and injecting build metadata.",
@@ -5,0 +5,0 @@ "type": "module",

New alerts

Unpublished package

Supply chain risk

Package version was not found on the registry. It may exist on a different registry and need to be configured to pull from that registry.

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Unpublished package

Supply chain risk

Package version was not found on the registry. It may exist on a different registry and need to be configured to pull from that registry.

Improved metrics

Total package byte prevSize

27446

5.92%

Number of package files

8

14.29%

Number of medium quality alerts

0

-100%

Number of lines in readme file

49

Infinity%

No dependency changes