@open-xchange/vite-plugin-project-meta 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.2.0` – 2026-Mar-13
+
+- added: support for Vite 8
+
 ## `1.1.1` – 2025-Sep-09
 
 - chore: bump dependencies

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -5,7 +5,7 @@ A Vite plugin providing a virtual import for project metadata with build informa
 The metadata object can simply be imported in source code as following:
 
 ```js
-import metadata from "virtual:metadata"
+import metadata from 'virtual:metadata'
 ```
 
 Additionally, while bundling the project, the plugin will insert a `<meta>` element into all HTML entry files containing a string with random length and contents. This is needed to workaround sticky browser cache when the HTML entry files are being served with weak e-tags that depend on the file size only but not on the file contents.
@@ -17,8 +17,8 @@ Add the plugin to your Vite configuration:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import metaPlugin from "@open-xchange/vite-plugin-project-meta"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import metaPlugin from '@open-xchange/vite-plugin-project-meta'
 
 export default defineConfig(() => {
 
@@ -28,14 +28,14 @@ export default defineConfig(() => {
     // ...
 
     metaPlugin({
-      id: "my-project-ui"
-      name: "My Project UI",
+      id: 'my-project-ui'
+      name: 'My Project UI',
     }),
   ],
 })
 ```
 
-Register TypeScript type definitions for the "virtual:metadata" module import:
+Register TypeScript type definitions for the 'virtual:metadata' module import:
 
 ```json
 // src/tsconfig.json
@@ -55,17 +55,17 @@ Use the virtual module in your code:
 ```ts
 // src/path/to/some/module.ts
 
-import metadata from "virtual:metadata"
+import metadata from 'virtual:metadata'
 
-console.log(metadata.id)        // from package.json ("name")
+console.log(metadata.id)        // from package.json ('name')
 console.log(metadata.name)      // from `options.projectName`
-console.log(metadata.version)   // from package.json ("version")
+console.log(metadata.version)   // from package.json ('version')
 console.log(metadata.builddate) // plugin execution timestamp
-console.log(metadata.commitsha) // from env variable "CI_COMMIT_SHA"
+console.log(metadata.commitsha) // from env variable 'CI_COMMIT_SHA'
 ```
 
 ### Options
 
 | Name | Type | Default | Description |
 | - | - | - | - |
-| `projectName` | `string` | _required_ | Display name of the project, for metadata property "name". |
+| `projectName` | `string` | _required_ | Display name of the project, for metadata property 'name'. |

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import type { Plugin } from "vite";
+import type { Plugin } from 'vite';
 /**
- * Configuration options for the plugin "@open-xchange/vite-plugin-project-meta".
+ * Configuration options for the plugin '@open-xchange/vite-plugin-project-meta'.
  */
 export interface VitePluginProjectMetaOptions {
     /**
@@ -10,7 +10,7 @@ export interface VitePluginProjectMetaOptions {
 }
 export declare const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
 /**
- * Vite plugin that provides a virtual module "virtual:metadata" exporting a
+ * Vite plugin that provides a virtual module 'virtual:metadata' exporting a
  * metadata object with project build information (timestamp, commit ID, etc.).
  *
  * @param options

package/dist/index.js

@@ -1,11 +1,11 @@
-import { join } from "node:path";
-import { readFileSync } from "node:fs";
-import { createHash } from "node:crypto";
+import { join } from 'node:path';
+import { readFileSync } from 'node:fs';
+import { createHash } from 'node:crypto';
 // constants ==================================================================
-export const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
+export const PROJECT_NAME = '@open-xchange/vite-plugin-project-meta';
 // plugin =====================================================================
 /**
- * Vite plugin that provides a virtual module "virtual:metadata" exporting a
+ * Vite plugin that provides a virtual module 'virtual:metadata' exporting a
  * metadata object with project build information (timestamp, commit ID, etc.).
  *
  * @param options
@@ -15,13 +15,13 @@ export const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
  *  The Vite plugin object.
  */
 export default function vitePluginProjectMeta(options) {
-    const MODULE_NAME = "virtual:metadata";
+    const MODULE_NAME = 'virtual:metadata';
     const MODULE_ID = `\0${PROJECT_NAME}/${MODULE_NAME}`;
     let metadata;
     return {
         name: PROJECT_NAME,
         configResolved(config) {
-            const pkg = JSON.parse(readFileSync(join(config.root, "package.json"), { encoding: "utf8" }));
+            const pkg = JSON.parse(readFileSync(join(config.root, 'package.json'), { encoding: 'utf8' }));
             metadata = {
                 id: pkg.name,
                 name: options.projectName,
@@ -38,19 +38,19 @@ export default function vitePluginProjectMeta(options) {
                 return null;
             }
             const code = `export default ${JSON.stringify(metadata)};`;
-            return { code, map: { mappings: "" } };
+            return { code, map: { mappings: '' } };
         },
         transformIndexHtml(_html, context) {
             if (!context.bundle) {
                 return;
             }
-            const hash = createHash("md5").update(metadata.builddate).digest("hex");
+            const hash = createHash('md5').update(metadata.builddate).digest('hex');
             const len = Number.parseInt(hash.slice(0, 4), 16) % 99 + 42;
             const count = Math.ceil(len / hash.length);
             const content = hash.repeat(count).slice(0, len);
-            const attrs = { name: "etag-fix", content };
+            const attrs = { name: 'etag-fix', content };
             // inject a <meta> element into the <head>
-            return [{ tag: "meta", attrs, injectTo: "head" }];
+            return [{ tag: 'meta', attrs, injectTo: 'head' }];
         },
     };
 }

package/dist/virtual.d.ts

@@ -1,37 +1,38 @@
-declare module "virtual:metadata" {
+declare module 'virtual:metadata' {
+
+  /**
+   * Shape of the metadata object provided by the virtual module
+   * 'virtual:metadata'.
+   */
+  export interface VirtualProjectMetadata {
 
     /**
-     * Shape of the metadata object provided by the virtual module "virtual:metadata".
+     * Internal identifier of the project.
      */
-    export interface VirtualProjectMetadata {
-
-        /**
-         * Internal identifier of the project.
-         */
-        id: string;
+    id: string
 
-        /**
-         * The display name of the project.
-         */
-        name: string;
+    /**
+     * The display name of the project.
+     */
+    name: string
 
-        /**
-         * The version string of the package.
-         */
-        version: string;
+    /**
+     * The version string of the package.
+     */
+    version: string
 
-        /**
-         * The date when the package was built (ISO timestamp).
-         */
-        builddate: string;
+    /**
+     * The date when the package was built (ISO timestamp).
+     */
+    builddate: string
 
-        /**
-         * The identifier of the last GIT commit the package has been built on.
-         * Will be picked from the environment variable "CI_COMMIT_SHA".
-         */
-        commitsha: string | undefined;
-    }
+    /**
+     * The identifier of the last GIT commit the package has been built on.
+     * Will be picked from the environment variable 'CI_COMMIT_SHA'.
+     */
+    commitsha: string | undefined
+  }
 
-    const metadata: VirtualProjectMetadata;
-    export default metadata;
+  const metadata: VirtualProjectMetadata
+  export default metadata
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-project-meta",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Vite plugin providing a virtual import for project metadata",
   "repository": {
     "type": "git",
@@ -11,7 +11,6 @@
   "engines": {
     "node": ">=20.18"
   },
-  "packageManager": "yarn@4.9.4",
   "type": "module",
   "exports": {
     ".": {
@@ -26,23 +25,16 @@
     "dist",
     "CHANGELOG.*"
   ],
-  "scripts": {
-    "prepack": "yarn build && yarn lint",
-    "clean": "premove dist",
-    "build": "yarn clean && tsc --project src/tsconfig.json && cpx src/virtual.d.ts dist/",
-    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
-  },
   "devDependencies": {
-    "@open-xchange/linter-presets": "^1.9.0",
-    "@types/node": "^24.3.1",
-    "cpx2": "^8.0.0",
-    "eslint": "^9.35.0",
-    "jiti": "^2.5.1",
-    "premove": "^4.0.0",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.5"
+    "vite": "^8.0.0",
+    "@open-xchange/linter-presets": "^1.18.3"
   },
   "peerDependencies": {
-    "vite": "^6.0.0 || ^7.0.0"
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsc --project src/tsconfig.json && cpx src/virtual.d.ts dist/",
+    "clean": "premove dist",
+    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
   }
 }