vite-plugin-version-info 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 lightrain
+
+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

@@ -0,0 +1,144 @@
+# vite-plugin-version-info
+
+A Vite plugin that injects version metadata into your app at build time. Useful for displaying neat version strings and commit timestamps in your UI or console.
+
+[**npm**](https://www.npmjs.com/package/vite-plugin-version-info) • [**Repository**](https://codeberg.org/lightrain/vite-plugin-version-info) • [**Issues**](https://codeberg.org/lightrain/vite-plugin-version-info/issues)
+
+## ✨ Features
+
+- Injects version string and commit date from Git and `package.json`
+- Fully customizable version format via pattern tokens
+- Locale-aware and timezone-aware commit date and time formatting
+- Detects missing license and appends customizable suffix
+- Adds branch suffix based on `NODE_ENV`
+- Injects global constants at build time — no runtime overhead or bundle size impact
+
+## 📦 Installation
+
+Install using your preferred package manager:
+
+```bash
+npm install -D vite-plugin-version-info
+# or
+pnpm add -D vite-plugin-version-info
+```
+
+## 🚀 Usage
+
+Add the plugin to your `vite.config.ts` or `vite.config.js`:
+
+```ts
+import versionInfo from 'vite-plugin-version-info';
+
+export default defineConfig({
+  plugins: [
+    /* other plugins */
+    versionInfo({
+      locale: 'en-GB',
+      commitHashLength: 8,
+      noLicenseSuffix: '-proprietary',
+      pattern: '{version}-{commitHash}{noLicenseSuffix}',
+    }),
+  ],
+});
+```
+
+Or, with all options omitted (using defaults):
+
+```ts
+import versionInfo from 'vite-plugin-version-info';
+
+export default defineConfig({
+  plugins: [
+    /* other plugins */
+    versionInfo(),
+  ],
+});
+```
+
+Then use the global constants injected by the plugin anywhere in your app:
+
+```ts
+console.log(`Build version: ${__APP_VERSION__} - committed on ${__COMMIT_DATE__}`);
+```
+
+Example output:
+
+```
+Build version: 1.2.3-4afb2a1e-proprietary - committed on July 7, 2025
+```
+
+Or, using defaults:
+
+```
+1.2.3-nonfree develop-4afb2a1e - commited on July 7, 2025
+```
+
+### 🧪 Injected Globals
+
+These globals are injected at build time and can be accessed anywhere in your UI code or logic.
+
+| Global            | Type     | Description                             |
+| ----------------- | -------- | --------------------------------------- |
+| `__APP_VERSION__` | `string` | Fully formatted version string          |
+| `__COMMIT_DATE__` | `string` | Formatted date of the latest Git commit |
+
+### 🛠️ Options
+
+| Option             | Type                         | Default                                                                   | Description                                                     |
+| ------------------ | ---------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------- |
+| `locale`           | `string`                     | `'en-US'`                                                                 | Locale used to format the commit date                           |
+| `commitHashLength` | `number`                     | `8`                                                                      | Number of characters to use from the Git commit hash            |
+| `intlOptions`      | `Intl.DateTimeFormatOptions` | `{ dateStyle: 'long' }`                                                   | Intl.DateTimeFormat options to customize commit date formatting |
+| `noLicenseSuffix`  | `string`                     | `'-nonfree'`                                                              | Suffix appended to version string if no license is found        |
+| `pattern`          | `string`                     | `'{version}{noLicenseSuffix} {currentBranch}-{commitHash}{branchSuffix}'` | Template string to format the final version string              |
+
+### 🧩 Pattern Tokens
+
+You can customize the `versionString` using a template string with the following tokens. These will be replaced at build time:
+
+| Token               | Description                                     | Example                                |
+| ------------------- | ----------------------------------------------- | -------------------------------------- |
+| `{version}`         | Version from your `package.json`                | `1.2.3`                                |
+| `{noLicenseSuffix}` | Appended if `license` field is missing          | `-nonfree`, `-unlicensed`, or empty    |
+| `{currentBranch}`   | Current Git branch name                         | `main`, `develop`, `feature/login-fix` |
+| `{commitHash}`      | Git commit hash truncated to `commitHashLength` | `4afb2a1e`                             |
+| `{branchSuffix}`    | `-dev` if `NODE_ENV` starts with `"dev"`        | `-dev` or empty                        |
+
+#### 🔧 Example Output
+
+Given the following plugin options:
+
+```ts
+{
+  pattern: '{version}{noLicenseSuffix}-{currentBranch}-{commitHash}{branchSuffix}',
+  commitHashLength: 8,
+}
+```
+
+And your environment:
+
+- `version` field in `package.json` is `1.2.3`
+- `license` field missing in `package.json`
+- Current git branch is `develop`
+- Last commit hash is `4afb2a1efddc3a34...` → shortened to `4afb2a1e`
+- `NODE_ENV=development`
+
+Then the result will be:
+
+```ts
+versionString = '1.2.3-nonfree-develop-4afb2a1e-dev';
+```
+
+You can fully control the format by editing the pattern string.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,126 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var child_process = require('child_process');
+var fs = require('fs');
+var path = require('path');
+var process = require('process');
+var url = require('url');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+function _interopNamespaceDefault(e) {
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var child_process__namespace = /*#__PURE__*/_interopNamespaceDefault(child_process);
+
+function formatDate(date, locale, options = {
+  dateStyle: "long",
+  timeZone: Intl.DateTimeFormat().resolvedOptions().timeZone
+}) {
+  return new Intl.DateTimeFormat(locale, options).format(date);
+}
+function formatVersionString(pattern, context) {
+  return pattern.replace(/\{(\w+)\}/g, (_, key) => {
+    return context[key] !== void 0 ? context[key] : `{${key}}`;
+  });
+}
+function getBranchSuffix() {
+  return process.env.NODE_ENV?.startsWith("dev") ? "-dev" : "";
+}
+function getCommitDate({ locale, intlOptions }) {
+  const output = runCommand('bash -c "git show -s --format=%cd --date=iso-strict|cat"');
+  let date = void 0;
+  try {
+    date = new Date(output);
+  } catch (e) {
+    console.error("Could not convert command output to Date:", output);
+    return "";
+  }
+  return formatDate(date, locale, intlOptions);
+}
+function getCurrentBranchName() {
+  return runCommand("git rev-parse --abbrev-ref HEAD");
+}
+function getCommitHash(short) {
+  return runCommand(`git rev-parse${short ? " --short" : ""} HEAD`);
+}
+function getVersionString({
+  commitHashLength,
+  noLicenseSuffix,
+  pattern
+}) {
+  const { version, license } = readPackageJson();
+  const currentBranch = getCurrentBranchName();
+  const licenseSuffix = license ? "" : noLicenseSuffix;
+  const commitHash = sliceCommitHash(getCommitHash(commitHashLength < 8), commitHashLength);
+  const branchSuffix = getBranchSuffix();
+  const context = {
+    version,
+    noLicenseSuffix: licenseSuffix,
+    currentBranch,
+    commitHash,
+    branchSuffix
+  };
+  return formatVersionString(pattern, context);
+}
+function runCommand(command) {
+  return child_process__namespace.execSync(command).toString().trim();
+}
+function readPackageJson() {
+  const file = url.fileURLToPath(new URL(path.join(process.cwd(), "package.json"), (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+  const json = fs.readFileSync(file, "utf8");
+  return JSON.parse(json);
+}
+function sliceCommitHash(hash, length) {
+  return hash.slice(0, length);
+}
+
+function plugin({
+  locale,
+  commitHashLength,
+  intlOptions,
+  noLicenseSuffix,
+  pattern
+} = {}) {
+  return {
+    name: "vite-plugin-version-info",
+    config() {
+      return {
+        define: {
+          __APP_VERSION__: JSON.stringify(
+            getVersionString({
+              commitHashLength: commitHashLength ?? 8,
+              noLicenseSuffix: noLicenseSuffix ?? "-nonfree",
+              pattern: pattern ?? "{version}{noLicenseSuffix} {currentBranch}-{commitHash}{branchSuffix}"
+            })
+          ),
+          __COMMIT_DATE__: JSON.stringify(
+            getCommitDate({
+              locale: locale ?? "en-US",
+              intlOptions: intlOptions ?? {
+                dateStyle: "long"
+              }
+            })
+          )
+        }
+      };
+    }
+  };
+}
+
+exports.default = plugin;

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Options for formatting the Git commit date.
+ */
+type CommitDateOptions = {
+    /**
+     * Locale for the formatted date (e.g., 'en-GB', 'en-US').
+     */
+    locale?: string;
+    /**
+     * Intl.DateTimeFormat options for customizing date output.
+     */
+    intlOptions?: Intl.DateTimeFormatOptions;
+};
+/**
+ * Options for customizing the version string.
+ */
+type VersionStringOptions = {
+    /**
+     * Suffix to append when no license is present (default: "-nonfree").
+     */
+    noLicenseSuffix?: string;
+    /**
+     * Template string for version output (e.g., "{version}-{commitHash}").
+     */
+    pattern?: string;
+    /**
+     * Length of Git commit hash (short = <8 chars, long otherwise).
+     */
+    commitHashLength?: number;
+};
+/**
+ * Combined plugin options for version and commit date customization.
+ */
+type VersionInfoPluginOptions = CommitDateOptions & VersionStringOptions;
+
+/**
+ * Vite plugin that injects Git version info and commit metadata into your frontend app.
+ *
+ * Injects `__APP_VERSION__` and `__COMMIT_DATE__` using the latest Git metadata.
+ *
+ * ### Example Usage
+ * ```ts
+ * console.log(__APP_VERSION__); // e.g., "1.2.3-dev-abc123"
+ * console.log(__COMMIT_DATE__); // e.g., "July 8, 2025"
+ * ```
+ *
+ * @param options - Plugin options to customize formatting and metadata injection
+ * @returns A Vite-compatible plugin object
+ */
+declare function plugin({ locale, commitHashLength, intlOptions, noLicenseSuffix, pattern, }?: VersionInfoPluginOptions): {
+    name: string;
+    config(): {
+        define: {
+            __APP_VERSION__: string;
+            __COMMIT_DATE__: string;
+        };
+    };
+};
+
+export { plugin as default };

package/dist/index.mjs

@@ -0,0 +1,102 @@
+import * as child_process from 'child_process';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import process from 'process';
+import { fileURLToPath } from 'url';
+
+function formatDate(date, locale, options = {
+  dateStyle: "long",
+  timeZone: Intl.DateTimeFormat().resolvedOptions().timeZone
+}) {
+  return new Intl.DateTimeFormat(locale, options).format(date);
+}
+function formatVersionString(pattern, context) {
+  return pattern.replace(/\{(\w+)\}/g, (_, key) => {
+    return context[key] !== void 0 ? context[key] : `{${key}}`;
+  });
+}
+function getBranchSuffix() {
+  return process.env.NODE_ENV?.startsWith("dev") ? "-dev" : "";
+}
+function getCommitDate({ locale, intlOptions }) {
+  const output = runCommand('bash -c "git show -s --format=%cd --date=iso-strict|cat"');
+  let date = void 0;
+  try {
+    date = new Date(output);
+  } catch (e) {
+    console.error("Could not convert command output to Date:", output);
+    return "";
+  }
+  return formatDate(date, locale, intlOptions);
+}
+function getCurrentBranchName() {
+  return runCommand("git rev-parse --abbrev-ref HEAD");
+}
+function getCommitHash(short) {
+  return runCommand(`git rev-parse${short ? " --short" : ""} HEAD`);
+}
+function getVersionString({
+  commitHashLength,
+  noLicenseSuffix,
+  pattern
+}) {
+  const { version, license } = readPackageJson();
+  const currentBranch = getCurrentBranchName();
+  const licenseSuffix = license ? "" : noLicenseSuffix;
+  const commitHash = sliceCommitHash(getCommitHash(commitHashLength < 8), commitHashLength);
+  const branchSuffix = getBranchSuffix();
+  const context = {
+    version,
+    noLicenseSuffix: licenseSuffix,
+    currentBranch,
+    commitHash,
+    branchSuffix
+  };
+  return formatVersionString(pattern, context);
+}
+function runCommand(command) {
+  return child_process.execSync(command).toString().trim();
+}
+function readPackageJson() {
+  const file = fileURLToPath(new URL(join(process.cwd(), "package.json"), import.meta.url));
+  const json = readFileSync(file, "utf8");
+  return JSON.parse(json);
+}
+function sliceCommitHash(hash, length) {
+  return hash.slice(0, length);
+}
+
+function plugin({
+  locale,
+  commitHashLength,
+  intlOptions,
+  noLicenseSuffix,
+  pattern
+} = {}) {
+  return {
+    name: "vite-plugin-version-info",
+    config() {
+      return {
+        define: {
+          __APP_VERSION__: JSON.stringify(
+            getVersionString({
+              commitHashLength: commitHashLength ?? 8,
+              noLicenseSuffix: noLicenseSuffix ?? "-nonfree",
+              pattern: pattern ?? "{version}{noLicenseSuffix} {currentBranch}-{commitHash}{branchSuffix}"
+            })
+          ),
+          __COMMIT_DATE__: JSON.stringify(
+            getCommitDate({
+              locale: locale ?? "en-US",
+              intlOptions: intlOptions ?? {
+                dateStyle: "long"
+              }
+            })
+          )
+        }
+      };
+    }
+  };
+}
+
+export { plugin as default };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "vite-plugin-version-info",
+  "description": "A Vite plugin that injects software version metadata as build-time globals for easy display in your UI or console.",
+  "version": "1.0.0",
+  "license": "MIT",
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "package",
+    "version",
+    "git",
+    "commit",
+    "branch",
+    "date"
+  ],
+  "author": "lightrain <lightrain@humanity>",
+  "homepage": "https://codeberg.org/lightrain/vite-plugin-version-info#readme",
+  "bugs": {
+    "url": "https://codeberg.org/lightrain/vite-plugin-version-info/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://codeberg.org/lightrain/vite-plugin-version-info.git"
+  },
+  "readme": "",
+  "type": "module",
+  "peerDependencies": {
+    "vite": "^2.7.0 || ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/node": "^24.0.10",
+    "prettier": "^3.6.2",
+    "rollup": "^4.44.2",
+    "rollup-plugin-dts": "^6.2.1",
+    "rollup-plugin-esbuild": "^6.2.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.5"
+  },
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./*": "./dist/*"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c rollup.config.ts --configPlugin typescript",
+    "clean": "rm -rf dist",
+    "dev": "rollup -c rollup.config.ts --configPlugin typescript",
+    "format": "prettier --write ."
+  }
+}