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

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## `1.3.0` – 2026-Apr-09
+
+- chore: switch to `tsdown` for building packages
+
+## `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.mts

@@ -0,0 +1,27 @@
+import { Plugin } from "vite";
+
+//#region src/index.d.ts
+/**
+ * Configuration options for the plugin '@open-xchange/vite-plugin-project-meta'.
+ */
+interface VitePluginProjectMetaOptions {
+  /**
+   * The display name of the project.
+   */
+  projectName: string;
+}
+declare const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
+/**
+ * Vite plugin that provides a virtual module 'virtual:metadata' exporting a
+ * metadata object with project build information (timestamp, commit ID, etc.).
+ *
+ * @param options
+ *  Plugin configuration.
+ *
+ * @returns
+ *  The Vite plugin object.
+ */
+declare function vitePluginProjectMeta(options: VitePluginProjectMetaOptions): Plugin;
+//#endregion
+export { PROJECT_NAME, VitePluginProjectMetaOptions, vitePluginProjectMeta as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;AAcA;UAAiB,4BAAA;;;;EAKf,WAAA;AAAA;AAAA,cAKW,YAAA;;;AAAuD;;;;;;;;iBAc5C,qBAAA,CAAsB,OAAA,EAAS,4BAAA,GAA+B,MAAA"}

package/dist/index.mjs

@@ -0,0 +1,61 @@
+import { join } from "node:path";
+import { readFileSync } from "node:fs";
+import { createHash } from "node:crypto";
+//#region src/index.ts
+const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
+/**
+* Vite plugin that provides a virtual module 'virtual:metadata' exporting a
+* metadata object with project build information (timestamp, commit ID, etc.).
+*
+* @param options
+*  Plugin configuration.
+*
+* @returns
+*  The Vite plugin object.
+*/
+function vitePluginProjectMeta(options) {
+	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" }));
+			metadata = {
+				id: pkg.name,
+				name: options.projectName,
+				version: pkg.version,
+				builddate: (/* @__PURE__ */ new Date()).toISOString(),
+				commitsha: process.env.CI_COMMIT_SHA
+			};
+		},
+		resolveId(source) {
+			return source === MODULE_NAME ? MODULE_ID : null;
+		},
+		load(id) {
+			if (id !== MODULE_ID) return null;
+			return {
+				code: `export default ${JSON.stringify(metadata)};`,
+				map: { mappings: "" }
+			};
+		},
+		transformIndexHtml(_html, context) {
+			if (!context.bundle) return;
+			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);
+			return [{
+				tag: "meta",
+				attrs: {
+					name: "etag-fix",
+					content: hash.repeat(count).slice(0, len)
+				},
+				injectTo: "head"
+			}];
+		}
+	};
+}
+//#endregion
+export { PROJECT_NAME, vitePluginProjectMeta as default };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["\nimport { join } from 'node:path'\nimport { readFileSync } from 'node:fs'\nimport { createHash } from 'node:crypto'\n\nimport type { Plugin } from 'vite'\n\nimport type { VirtualProjectMetadata } from 'virtual:metadata'\n\n// types ======================================================================\n\n/**\n * Configuration options for the plugin '@open-xchange/vite-plugin-project-meta'.\n */\nexport interface VitePluginProjectMetaOptions {\n\n  /**\n   * The display name of the project.\n   */\n  projectName: string\n}\n\n// constants ==================================================================\n\nexport const PROJECT_NAME = '@open-xchange/vite-plugin-project-meta'\n\n// plugin =====================================================================\n\n/**\n * Vite plugin that provides a virtual module 'virtual:metadata' exporting a\n * metadata object with project build information (timestamp, commit ID, etc.).\n *\n * @param options\n *  Plugin configuration.\n *\n * @returns\n *  The Vite plugin object.\n */\nexport default function vitePluginProjectMeta(options: VitePluginProjectMetaOptions): Plugin {\n\n  const MODULE_NAME = 'virtual:metadata'\n  const MODULE_ID = `\\0${PROJECT_NAME}/${MODULE_NAME}`\n\n  let metadata: VirtualProjectMetadata\n\n  return {\n    name: PROJECT_NAME,\n\n    configResolved(config) {\n      /** @ignore */\n      interface Package {\n        name: string\n        version: string\n      }\n      const pkg = JSON.parse(readFileSync(join(config.root, 'package.json'), { encoding: 'utf8' })) as Package\n      metadata = {\n        id: pkg.name,\n        name: options.projectName,\n        version: pkg.version,\n        builddate: new Date().toISOString(),\n        commitsha: process.env.CI_COMMIT_SHA,\n      }\n    },\n\n    resolveId(source) {\n      return (source === MODULE_NAME) ? MODULE_ID : null\n    },\n\n    load(id) {\n      if (id !== MODULE_ID) { return null }\n      const code = `export default ${JSON.stringify(metadata)};`\n      return { code, map: { mappings: '' } }\n    },\n\n    transformIndexHtml(_html, context) {\n      if (!context.bundle) { return }\n      const hash = createHash('md5').update(metadata.builddate).digest('hex')\n      const len = Number.parseInt(hash.slice(0, 4), 16) % 99 + 42\n      const count = Math.ceil(len / hash.length)\n      const content = hash.repeat(count).slice(0, len)\n      const attrs = { name: 'etag-fix', content }\n      // inject a <meta> element into the <head>\n      return [{ tag: 'meta', attrs, injectTo: 'head' }]\n    },\n  }\n}\n"],"mappings":";;;;AAwBA,MAAa,eAAe;;;;;;;;;;;AAc5B,SAAwB,sBAAsB,SAA+C;CAE3F,MAAM,cAAc;CACpB,MAAM,YAAY,KAAK,aAAa,GAAG;CAEvC,IAAI;AAEJ,QAAO;EACL,MAAM;EAEN,eAAe,QAAQ;GAMrB,MAAM,MAAM,KAAK,MAAM,aAAa,KAAK,OAAO,MAAM,eAAe,EAAE,EAAE,UAAU,QAAQ,CAAC,CAAC;AAC7F,cAAW;IACT,IAAI,IAAI;IACR,MAAM,QAAQ;IACd,SAAS,IAAI;IACb,4BAAW,IAAI,MAAM,EAAC,aAAa;IACnC,WAAW,QAAQ,IAAI;IACxB;;EAGH,UAAU,QAAQ;AAChB,UAAQ,WAAW,cAAe,YAAY;;EAGhD,KAAK,IAAI;AACP,OAAI,OAAO,UAAa,QAAO;AAE/B,UAAO;IAAE,MADI,kBAAkB,KAAK,UAAU,SAAS,CAAC;IACzC,KAAK,EAAE,UAAU,IAAI;IAAE;;EAGxC,mBAAmB,OAAO,SAAS;AACjC,OAAI,CAAC,QAAQ,OAAU;GACvB,MAAM,OAAO,WAAW,MAAM,CAAC,OAAO,SAAS,UAAU,CAAC,OAAO,MAAM;GACvE,MAAM,MAAM,OAAO,SAAS,KAAK,MAAM,GAAG,EAAE,EAAE,GAAG,GAAG,KAAK;GACzD,MAAM,QAAQ,KAAK,KAAK,MAAM,KAAK,OAAO;AAI1C,UAAO,CAAC;IAAE,KAAK;IAAQ,OAFT;KAAE,MAAM;KAAY,SADlB,KAAK,OAAO,MAAM,CAAC,MAAM,GAAG,IAAI;KACL;IAEb,UAAU;IAAQ,CAAC;;EAEpD"}

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,23 +1,20 @@
 {
   "name": "@open-xchange/vite-plugin-project-meta",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "Vite plugin providing a virtual import for project metadata",
   "repository": {
     "type": "git",
-    "url": "https://gitlab.open-xchange.com/fspd/commons/plugins",
+    "url": "git+https://gitlab.open-xchange.com/fspd/commons/plugins.git",
     "directory": "packages/vite-plugin-project-meta"
   },
   "license": "MIT",
   "engines": {
     "node": ">=20.18"
   },
-  "packageManager": "yarn@4.9.4",
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    },
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json",
     "./virtual": {
       "types": "./dist/virtual.d.ts"
     }
@@ -26,23 +23,17 @@
     "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.8",
+    "@open-xchange/linter-presets": "^1.22.0",
+    "@open-xchange/tsconfig": "^0.0.2"
   },
   "peerDependencies": {
-    "vite": "^6.0.0 || ^7.0.0"
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "tsc && tsc --project src && eslint .",
+    "verify": "pnpm build && pnpm lint"
   }
 }

package/dist/index.d.ts

@@ -1,22 +0,0 @@
-import type { Plugin } from "vite";
-/**
- * Configuration options for the plugin "@open-xchange/vite-plugin-project-meta".
- */
-export interface VitePluginProjectMetaOptions {
-    /**
-     * The display name of the project.
-     */
-    projectName: string;
-}
-export declare const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
-/**
- * Vite plugin that provides a virtual module "virtual:metadata" exporting a
- * metadata object with project build information (timestamp, commit ID, etc.).
- *
- * @param options
- *  Plugin configuration.
- *
- * @returns
- *  The Vite plugin object.
- */
-export default function vitePluginProjectMeta(options: VitePluginProjectMetaOptions): Plugin;

package/dist/index.js

@@ -1,56 +0,0 @@
-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";
-// plugin =====================================================================
-/**
- * Vite plugin that provides a virtual module "virtual:metadata" exporting a
- * metadata object with project build information (timestamp, commit ID, etc.).
- *
- * @param options
- *  Plugin configuration.
- *
- * @returns
- *  The Vite plugin object.
- */
-export default function vitePluginProjectMeta(options) {
-    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" }));
-            metadata = {
-                id: pkg.name,
-                name: options.projectName,
-                version: pkg.version,
-                builddate: new Date().toISOString(),
-                commitsha: process.env.CI_COMMIT_SHA,
-            };
-        },
-        resolveId(source) {
-            return (source === MODULE_NAME) ? MODULE_ID : null;
-        },
-        load(id) {
-            if (id !== MODULE_ID) {
-                return null;
-            }
-            const code = `export default ${JSON.stringify(metadata)};`;
-            return { code, map: { mappings: "" } };
-        },
-        transformIndexHtml(_html, context) {
-            if (!context.bundle) {
-                return;
-            }
-            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 };
-            // inject a <meta> element into the <head>
-            return [{ tag: "meta", attrs, injectTo: "head" }];
-        },
-    };
-}