unplugin-build-meta 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-PRESENT Lucas Nørgård
+
+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,253 @@
+# unplugin-build-meta
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+
+Import build metadata into your JavaScript/TypeScript projects for Vite, Webpack, Rollup, esbuild and more. Powered by [unplugin](https://github.com/unjs/unplugin).
+
+<p align="center">
+<br />
+<a href="https://stackblitz.com/github/luxass/unplugin-build-meta/tree/main/examples/vite-vue?file=vite.config.ts"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" /></a>
+</p>
+
+## Install
+
+```bash
+npm install -D unplugin-build-meta
+```
+
+## Usage
+
+> [!TIP]
+> You can view all examples [here](./examples).
+
+<details>
+<summary>Vite</summary><br/>
+
+```ts
+// vite.config.ts
+import buildMeta from "unplugin-build-meta/vite";
+
+export default defineConfig({
+  plugins: [
+    buildMeta({ /* options */ }),
+  ],
+});
+```
+
+<br/></details>
+
+<details>
+<summary>Rollup</summary><br/>
+
+```ts
+// rollup.config.js
+import buildMeta from "unplugin-build-meta/rollup";
+
+export default {
+  plugins: [
+    buildMeta({ /* options */ }),
+  ],
+};
+```
+
+<br/></details>
+
+<details>
+<summary>Webpack</summary><br/>
+
+```ts
+// webpack.config.js
+module.exports = {
+  /* ... */
+  plugins: [
+    require("unplugin-build-meta/webpack").default({ /* options */ }),
+  ],
+};
+```
+
+<br/></details>
+
+<details>
+<summary>Nuxt</summary><br/>
+
+```ts
+// nuxt.config.js
+export default defineNuxtConfig({
+  modules: [
+    ["unplugin-build-meta/nuxt", { /* options */ }]
+  ],
+});
+```
+
+<br/></details>
+
+<details>
+<summary>Astro</summary><br/>
+
+```ts
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import buildMeta from "unplugin-build-meta/astro";
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    buildMeta({
+      /* options */
+    })
+  ]
+});
+```
+
+<br/></details>
+
+<details>
+<summary>esbuild</summary><br/>
+
+```ts
+// esbuild.config.js
+import { build } from "esbuild";
+import buildMeta from "unplugin-build-meta/esbuild";
+
+build({
+  /* ... */
+  plugins: [
+    buildMeta({
+      /* options */
+    }),
+  ],
+});
+```
+
+<br/></details>
+
+<details>
+<summary>Farm</summary><br/>
+
+```ts
+// farm.config.ts
+import { defineConfig } from "@farmfe/core";
+import vue from "@vitejs/plugin-vue";
+import buildMeta from "unplugin-build-meta/farm";
+
+export default defineConfig({
+  vitePlugins: [
+    vue(),
+  ],
+  plugins: [
+    buildMeta({
+      /* options */
+    })
+  ]
+});
+```
+
+<br/></details>
+
+<details>
+<summary>Rspack</summary><br/>
+
+```ts
+// rspack.config.mjs
+import rspack from "@rspack/core";
+import buildMeta from "unplugin-build-meta/rspack";
+
+/** @type {import('@rspack/core').Configuration} */
+export default {
+  plugins: [
+    new rspack.HtmlRspackPlugin({
+      template: "./index.html"
+    }),
+    buildMeta()
+  ],
+};
+```
+
+<br/></details>
+
+<details>
+<summary>Rolldown (Experimental)</summary><br/>
+
+```ts
+// rolldown.config.js
+import { defineConfig } from "rolldown";
+import buildMeta from "unplugin-build-meta/rolldown";
+
+export default defineConfig({
+  input: "./index.js",
+  plugins: [
+    buildMeta({
+      /* options */
+    }),
+  ],
+});
+```
+
+<br/></details>
+
+## Configuration
+
+```ts
+buildMeta({
+  modules: ["git"] // Configure which modules to include
+});
+```
+
+## Modules
+
+### Git Module
+
+The git module provides access to repository metadata from your code.
+
+Import it in your code:
+
+```ts
+// Import all git metadata
+import * as git from "virtual:build-meta/git";
+
+// Or import specific values
+import { branch, sha, shortSha } from "virtual:build-meta/git";
+```
+
+Available properties (all properties are nullable):
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `branch` | `string \| null` | Current git branch name |
+| `sha` | `string \| null` | Full git commit hash |
+| `shortSha` | `string \| null` | First 10 characters of the commit hash |
+| `latestCommitMessage` | `string \| null` | Latest commit message |
+| `commitAuthorName` | `string \| null` | Commit author name |
+| `commitAuthorEmail` | `string \| null` | Commit author email |
+| `commitAuthorDate` | `string \| null` | Commit author date |
+| `commitCommitterName` | `string \| null` | Committer name |
+| `commitCommitterEmail` | `string \| null` | Committer email |
+| `commitCommitterDate` | `string \| null` | Committer date |
+| `tag` | `string \| null` | Current tag (if any) |
+| `tags` | `string[] \| null` | All tags pointing at current commit |
+| `lastTag` | `string \| null` | Latest tag in the repository |
+| `repositoryUrl` | `string \| null` | Repository URL (for GitHub repositories) |
+
+### TypeScript
+
+To get proper type support, make sure to include the type declarations:
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "unplugin-build-meta/types"
+    ]
+  }
+}
+```
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).
+
+[npm-version-src]: https://img.shields.io/npm/v/unplugin-build-meta?style=flat&colorA=18181B&colorB=4169E1
+[npm-version-href]: https://npmjs.com/package/unplugin-build-meta
+[npm-downloads-src]: https://img.shields.io/npm/dm/unplugin-build-meta?style=flat&colorA=18181B&colorB=4169E1
+[npm-downloads-href]: https://npmjs.com/package/unplugin-build-meta

package/dist/astro.cjs

@@ -0,0 +1,21 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk2TPIXTEWcjs = require('./chunk-2TPIXTEW.cjs');
+require('./chunk-SSXJV7C2.cjs');
+
+// src/astro.ts
+function BuildMetaIntegration(options) {
+  return {
+    name: _chunk2TPIXTEWcjs.PLUGIN_NAME,
+    hooks: {
+      "astro:config:setup": async (astro) => {
+        astro.config.vite.plugins ||= [];
+        astro.config.vite.plugins.push(_chunk2TPIXTEWcjs.unplugin.vite(options));
+      }
+    }
+  };
+}
+
+
+exports.default = BuildMetaIntegration;

package/dist/astro.d.cts

@@ -0,0 +1,20 @@
+import { AstroIntegration } from 'astro';
+import { B as BuildMetaOptions } from './types-dRhtxdLo.cjs';
+import 'unplugin';
+
+/**
+ * Astro integration
+ *
+ * @example
+ * ```ts
+ * // astro.config.mjs
+ * import buildMeta from "unplugin-build-meta/astro"
+ *
+ * export default defineConfig({
+ *   integrations: [buildMeta()],
+ * })
+ * ```
+ */
+declare function BuildMetaIntegration(options: BuildMetaOptions): AstroIntegration;
+
+export { BuildMetaIntegration as default };

package/dist/astro.d.ts

@@ -0,0 +1,20 @@
+import { AstroIntegration } from 'astro';
+import { B as BuildMetaOptions } from './types-dRhtxdLo.js';
+import 'unplugin';
+
+/**
+ * Astro integration
+ *
+ * @example
+ * ```ts
+ * // astro.config.mjs
+ * import buildMeta from "unplugin-build-meta/astro"
+ *
+ * export default defineConfig({
+ *   integrations: [buildMeta()],
+ * })
+ * ```
+ */
+declare function BuildMetaIntegration(options: BuildMetaOptions): AstroIntegration;
+
+export { BuildMetaIntegration as default };

package/dist/astro.mjs

@@ -0,0 +1,21 @@
+import {
+  PLUGIN_NAME,
+  unplugin
+} from "./chunk-MMKRPHVS.mjs";
+import "./chunk-RJEZ2A3A.mjs";
+
+// src/astro.ts
+function BuildMetaIntegration(options) {
+  return {
+    name: PLUGIN_NAME,
+    hooks: {
+      "astro:config:setup": async (astro) => {
+        astro.config.vite.plugins ||= [];
+        astro.config.vite.plugins.push(unplugin.vite(options));
+      }
+    }
+  };
+}
+export {
+  BuildMetaIntegration as default
+};

package/dist/chunk-2TPIXTEW.cjs

@@ -0,0 +1,154 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+
+var _chunkSSXJV7C2cjs = require('./chunk-SSXJV7C2.cjs');
+
+// src/core/index.ts
+var _unplugin = require('unplugin');
+
+// src/core/constants.ts
+var PLUGIN_NAME = "unplugin-build-meta";
+var NUXT_CONFIG_KEY = "buildMeta";
+
+// src/core/modules/git.ts
+var _giturlparse = require('git-url-parse'); var _giturlparse2 = _interopRequireDefault(_giturlparse);
+var _simplegit = require('simple-git');
+var git_default = _chunkSSXJV7C2cjs.defineBuildMetaModule.call(void 0, {
+  name: "git",
+  load: async () => {
+    const git = _simplegit.simpleGit.call(void 0, );
+    const info = {};
+    function generateOutput(data) {
+      const keys = [
+        "repositoryUrl",
+        "sha",
+        "shortSha",
+        "branch",
+        "tag",
+        "tags",
+        "lastTag",
+        "commitAuthorName",
+        "commitAuthorEmail",
+        "commitAuthorDate",
+        "commitCommitterName",
+        "commitCommitterEmail",
+        "commitCommitterDate",
+        "latestCommitMessage"
+      ];
+      return keys.map(
+        (key) => `export const ${key} = ${data && data[key] !== void 0 ? JSON.stringify(data[key]) : "null"}`
+      ).join("\n");
+    }
+    try {
+      const isRepo = await git.checkIsRepo();
+      if (!isRepo) {
+        return generateOutput();
+      }
+    } catch (error) {
+      console.error("failed to check if directory is a git repository:", error);
+      return generateOutput();
+    }
+    try {
+      const branchInfo = await git.branch([]);
+      info.branch = branchInfo.current;
+    } catch (error) {
+      console.error("failed to fetch branch information:", error);
+    }
+    try {
+      const log = await git.log(["-1"]);
+      if (log.latest) {
+        info.sha = log.latest.hash;
+        info.shortSha = _optionalChain([log, 'access', _ => _.latest, 'access', _2 => _2.hash, 'optionalAccess', _3 => _3.slice, 'call', _4 => _4(0, 10)]);
+        info.latestCommitMessage = log.latest.message;
+        info.commitAuthorName = log.latest.author_name;
+        info.commitAuthorEmail = log.latest.author_email;
+        info.commitAuthorDate = log.latest.date;
+      }
+    } catch (error) {
+      console.error("failed to fetch commit information:", error);
+    }
+    try {
+      const committerInfo = await git.show(["-s", "--format=%cn%n%ce%n%cd"]);
+      const committerLines = committerInfo.split("\n").map((line) => line.trim());
+      if (committerLines.length >= 3) {
+        info.commitCommitterName = committerLines[0];
+        info.commitCommitterEmail = committerLines[1];
+        info.commitCommitterDate = committerLines[2];
+      }
+    } catch (error) {
+      console.error("failed to fetch committer information:", error);
+    }
+    try {
+      const hash = await git.revparse(["HEAD"]);
+      const tagsResult = await git.tags(["--points-at", hash]);
+      const allTags = await git.tags();
+      info.tags = tagsResult.all;
+      info.tag = tagsResult.all[tagsResult.all.length - 1];
+      info.lastTag = allTags.latest;
+    } catch (error) {
+      console.error("failed to fetch tags information:", error);
+    }
+    try {
+      const remotes = await git.getRemotes(true);
+      const origin = remotes.find((remote) => remote.name === "origin");
+      if (_optionalChain([origin, 'optionalAccess', _5 => _5.refs, 'access', _6 => _6.fetch])) {
+        const parsed = _giturlparse2.default.call(void 0, origin.refs.fetch);
+        if (parsed.resource === "github.com" && parsed.full_name) {
+          info.repositoryUrl = `https://github.com/${parsed.full_name}`;
+        }
+      }
+    } catch (error) {
+      console.error("failed to fetch GitHub URL:", error);
+    }
+    return generateOutput(info);
+  }
+});
+
+// src/core/index.ts
+var PREFIX = "virtual:build-meta/";
+var PREFIX_WITH_NULL = `\0${PREFIX}`;
+var unpluginFactory = (options = {}) => {
+  const { modules: _modules = [] } = options;
+  const modules = [];
+  for (const module of _modules) {
+    if (typeof module === "object" && "name" in module) {
+      modules.push(module);
+      continue;
+    }
+    if (module === "git") {
+      modules.push(git_default);
+    }
+  }
+  return {
+    name: PLUGIN_NAME,
+    enforce: "pre",
+    resolveId(id) {
+      if (!id.startsWith(PREFIX)) return;
+      id = id.slice(PREFIX.length);
+      if (!modules.map((m) => m.name).includes(id)) {
+        return;
+      }
+      return `${PREFIX_WITH_NULL}${id}`;
+    },
+    loadInclude(id) {
+      if (!id.startsWith(PREFIX_WITH_NULL)) return false;
+      return modules.map((m) => m.name).includes(id.slice(PREFIX_WITH_NULL.length));
+    },
+    async load(id) {
+      if (!id.startsWith(PREFIX_WITH_NULL)) return;
+      id = id.slice(PREFIX_WITH_NULL.length);
+      for (const mod of Object.values(modules)) {
+        if (id === mod.name) {
+          return mod.load(this, id);
+        }
+      }
+    }
+  };
+};
+var unplugin = /* @__PURE__ */ _unplugin.createUnplugin.call(void 0, unpluginFactory);
+
+
+
+
+
+
+exports.PLUGIN_NAME = PLUGIN_NAME; exports.NUXT_CONFIG_KEY = NUXT_CONFIG_KEY; exports.unpluginFactory = unpluginFactory; exports.unplugin = unplugin;

package/dist/chunk-BJB5XFUG.mjs

@@ -0,0 +1,11 @@
+import {
+  unpluginFactory
+} from "./chunk-MMKRPHVS.mjs";
+
+// src/webpack.ts
+import { createWebpackPlugin } from "unplugin";
+var webpack_default = createWebpackPlugin(unpluginFactory);
+
+export {
+  webpack_default
+};

package/dist/chunk-FH2TLW2E.cjs

@@ -0,0 +1,11 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk2TPIXTEWcjs = require('./chunk-2TPIXTEW.cjs');
+
+// src/vite.ts
+var _unplugin = require('unplugin');
+var vite_default = _unplugin.createVitePlugin.call(void 0, _chunk2TPIXTEWcjs.unpluginFactory);
+
+
+
+exports.vite_default = vite_default;

package/dist/chunk-MMKRPHVS.mjs

@@ -0,0 +1,154 @@
+import {
+  defineBuildMetaModule
+} from "./chunk-RJEZ2A3A.mjs";
+
+// src/core/index.ts
+import { createUnplugin } from "unplugin";
+
+// src/core/constants.ts
+var PLUGIN_NAME = "unplugin-build-meta";
+var NUXT_CONFIG_KEY = "buildMeta";
+
+// src/core/modules/git.ts
+import parseGitUrl from "git-url-parse";
+import { simpleGit } from "simple-git";
+var git_default = defineBuildMetaModule({
+  name: "git",
+  load: async () => {
+    const git = simpleGit();
+    const info = {};
+    function generateOutput(data) {
+      const keys = [
+        "repositoryUrl",
+        "sha",
+        "shortSha",
+        "branch",
+        "tag",
+        "tags",
+        "lastTag",
+        "commitAuthorName",
+        "commitAuthorEmail",
+        "commitAuthorDate",
+        "commitCommitterName",
+        "commitCommitterEmail",
+        "commitCommitterDate",
+        "latestCommitMessage"
+      ];
+      return keys.map(
+        (key) => `export const ${key} = ${data && data[key] !== void 0 ? JSON.stringify(data[key]) : "null"}`
+      ).join("\n");
+    }
+    try {
+      const isRepo = await git.checkIsRepo();
+      if (!isRepo) {
+        return generateOutput();
+      }
+    } catch (error) {
+      console.error("failed to check if directory is a git repository:", error);
+      return generateOutput();
+    }
+    try {
+      const branchInfo = await git.branch([]);
+      info.branch = branchInfo.current;
+    } catch (error) {
+      console.error("failed to fetch branch information:", error);
+    }
+    try {
+      const log = await git.log(["-1"]);
+      if (log.latest) {
+        info.sha = log.latest.hash;
+        info.shortSha = log.latest.hash?.slice(0, 10);
+        info.latestCommitMessage = log.latest.message;
+        info.commitAuthorName = log.latest.author_name;
+        info.commitAuthorEmail = log.latest.author_email;
+        info.commitAuthorDate = log.latest.date;
+      }
+    } catch (error) {
+      console.error("failed to fetch commit information:", error);
+    }
+    try {
+      const committerInfo = await git.show(["-s", "--format=%cn%n%ce%n%cd"]);
+      const committerLines = committerInfo.split("\n").map((line) => line.trim());
+      if (committerLines.length >= 3) {
+        info.commitCommitterName = committerLines[0];
+        info.commitCommitterEmail = committerLines[1];
+        info.commitCommitterDate = committerLines[2];
+      }
+    } catch (error) {
+      console.error("failed to fetch committer information:", error);
+    }
+    try {
+      const hash = await git.revparse(["HEAD"]);
+      const tagsResult = await git.tags(["--points-at", hash]);
+      const allTags = await git.tags();
+      info.tags = tagsResult.all;
+      info.tag = tagsResult.all[tagsResult.all.length - 1];
+      info.lastTag = allTags.latest;
+    } catch (error) {
+      console.error("failed to fetch tags information:", error);
+    }
+    try {
+      const remotes = await git.getRemotes(true);
+      const origin = remotes.find((remote) => remote.name === "origin");
+      if (origin?.refs.fetch) {
+        const parsed = parseGitUrl(origin.refs.fetch);
+        if (parsed.resource === "github.com" && parsed.full_name) {
+          info.repositoryUrl = `https://github.com/${parsed.full_name}`;
+        }
+      }
+    } catch (error) {
+      console.error("failed to fetch GitHub URL:", error);
+    }
+    return generateOutput(info);
+  }
+});
+
+// src/core/index.ts
+var PREFIX = "virtual:build-meta/";
+var PREFIX_WITH_NULL = `\0${PREFIX}`;
+var unpluginFactory = (options = {}) => {
+  const { modules: _modules = [] } = options;
+  const modules = [];
+  for (const module of _modules) {
+    if (typeof module === "object" && "name" in module) {
+      modules.push(module);
+      continue;
+    }
+    if (module === "git") {
+      modules.push(git_default);
+    }
+  }
+  return {
+    name: PLUGIN_NAME,
+    enforce: "pre",
+    resolveId(id) {
+      if (!id.startsWith(PREFIX)) return;
+      id = id.slice(PREFIX.length);
+      if (!modules.map((m) => m.name).includes(id)) {
+        return;
+      }
+      return `${PREFIX_WITH_NULL}${id}`;
+    },
+    loadInclude(id) {
+      if (!id.startsWith(PREFIX_WITH_NULL)) return false;
+      return modules.map((m) => m.name).includes(id.slice(PREFIX_WITH_NULL.length));
+    },
+    async load(id) {
+      if (!id.startsWith(PREFIX_WITH_NULL)) return;
+      id = id.slice(PREFIX_WITH_NULL.length);
+      for (const mod of Object.values(modules)) {
+        if (id === mod.name) {
+          return mod.load(this, id);
+        }
+      }
+    }
+  };
+};
+var unplugin = /* @__PURE__ */ createUnplugin(unpluginFactory);
+
+export {
+  PLUGIN_NAME,
+  NUXT_CONFIG_KEY,
+  unpluginFactory,
+  unplugin
+};

package/dist/chunk-RJEZ2A3A.mjs

@@ -0,0 +1,8 @@
+// src/module.ts
+function defineBuildMetaModule(module) {
+  return module;
+}
+
+export {
+  defineBuildMetaModule
+};