@hagicode/hagilight 0.9.1 → 0.9.2-dev.102.1.daf22c1

package/README.md

@@ -34,6 +34,21 @@ time from this package's own manifest, not from Astro. Existing
 feature-package attribution; switch that import to `@hagicode/hagilight/Footer`
 to opt in while keeping the same `locale` and `links` props.
 
+## Build line
+
+`hagilight()` adds a build line to the footer's copyright text, after the attribution: `Branch:`, `Commit:` (seven characters, with the full hash in the `title` attribute), and `Built:` (UTC time to the second). The line appears even with `hagilight({ enabled: false })`. Without this integration, `@hagicode/hagilight-core/Footer` renders no build text.
+
+The values come from `HAGILIGHT_BUILD_BRANCH` and `HAGILIGHT_BUILD_COMMIT`, then Git, then `unknown`; the core README gives the full order. CI systems often check out a detached HEAD, which reports `Branch: unknown`. Pass the branch in the build step:
+
+```yaml
+- name: Build site
+  env:
+    HAGILIGHT_BUILD_BRANCH: ${{ github.head_ref || github.ref_name }}
+  run: npm run build
+```
+
+`github.head_ref` is set on pull requests and `github.ref_name` on pushes. A shallow clone still reports its commit, because `git rev-parse HEAD` reads the checkout.
+
 ## Body images
 
 `hagilight()` registers the content-image plugin from `@hagicode/hagilight-core/content-images`. Markdown and MDX body images then get `loading="lazy"`, `decoding="async"`, and the class `hagilight-content-image`, with the author's values kept. This registration does not depend on `enabled`, so `hagilight({ enabled: false })` still registers the plugin.

package/dist/build-info-middleware.d.ts

@@ -0,0 +1,2 @@
+import type { MiddlewareHandler } from 'astro';
+export declare const onRequest: MiddlewareHandler;

package/dist/build-info-middleware.js

@@ -0,0 +1,5 @@
+import buildInfo from 'virtual:hagilight/build-info';
+export const onRequest = (context, next) => {
+    context.locals.hagilightBuild = buildInfo;
+    return next();
+};

package/dist/integration.js

@@ -2,12 +2,15 @@ import { existsSync, readdirSync, statSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import { extname, isAbsolute, resolve, win32 } from 'node:path';
 import sitemap from '@astrojs/sitemap';
+import { resolveBuildInfo } from '@hagicode/hagilight-core/build-info-resolver';
 import { checkContentImageRegistration, registerContentImages } from '@hagicode/hagilight-core/content-images';
 import { resolveFaviconHeadEntry } from '@hagicode/hagilight-core/favicon';
 import { resolveRssLocales } from '@hagicode/hagilight-core/rss';
 import { resolvePlainAstroRssOwner } from '@hagicode/hagilight-core/rss-ownership';
 const VIRTUAL_RSS_CONFIG = 'virtual:hagilight/rss-config';
 const VIRTUAL_RSS_CONFIG_RESOLVED = `\0${VIRTUAL_RSS_CONFIG}`;
+const VIRTUAL_BUILD_INFO = 'virtual:hagilight/build-info';
+const VIRTUAL_BUILD_INFO_RESOLVED = `\0${VIRTUAL_BUILD_INFO}`;
 const PAGE_SOURCE_EXTENSIONS = new Set(['.astro', '.html', '.js', '.jsx', '.md', '.mdx', '.ts', '.tsx']);
 const packageRoot = new URL('../', import.meta.url);
 const routeEntrypoint = (name) => fileURLToPath(new URL(name, packageRoot));
@@ -75,6 +78,9 @@ export function hagilight({ enabled = true, rss, contentImages } = {}) {
         hooks: {
             'astro:config:setup'({ config, injectRoute, addMiddleware, updateConfig, logger }) {
                 registerContentImages({ config, logger, enabled: contentImagesEnabled });
+                const buildInfo = resolveBuildInfo({ root: fileURLToPath(config.root) });
+                updateConfig({ vite: { plugins: [createBuildInfoPlugin(buildInfo)] } });
+                addMiddleware({ entrypoint: fileURLToPath(new URL('./build-info-middleware.js', import.meta.url)), order: 'pre' });
                 if (!enabled)
                     return;
                 resolveDiscoverySite(config.site);
@@ -240,6 +246,19 @@ function createVirtualPlugin({ modulePath, site, baseUrl, locales, defaultFeedUr
         },
     };
 }
+function createBuildInfoPlugin(buildInfo) {
+    return {
+        name: '@hagicode/hagilight:build-info',
+        resolveId(id) {
+            return id === VIRTUAL_BUILD_INFO ? VIRTUAL_BUILD_INFO_RESOLVED : null;
+        },
+        load(id) {
+            if (id !== VIRTUAL_BUILD_INFO_RESOLVED)
+                return null;
+            return `export default ${JSON.stringify(buildInfo)};`;
+        },
+    };
+}
 /** Inject the bundled HagiCode favicon unless the site head already declares an icon. */
 export function hagilightFavicon(options = {}) {
     if (!isRecord(options)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hagicode/hagilight",
-  "version": "0.9.1",
+  "version": "0.9.2-dev.102.1.daf22c1",
   "type": "module",
   "description": "Astro integrations and components for HagiCode sites",
   "repository": {
@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "@astrojs/sitemap": "^3.7.4",
-    "@hagicode/hagilight-core": "0.9.1"
+    "@hagicode/hagilight-core": "0.9.2-dev.102.1.daf22c1"
   },
   "keywords": [
     "astro-component",