@hagicode/hagilight-starlight 0.9.1 → 0.9.2

package/Footer.astro

@@ -3,6 +3,7 @@ import Copyright from '@hagicode/hagilight-core/Copyright';
 import DefaultFooter from '@astrojs/starlight/components/Footer.astro';
 import { siteLinkGaAttributes } from '@hagicode/hagilight-core/analytics-events';
 import { resolveSiteLinks, type SiteLinksOptions } from '@hagicode/hagilight-core/links';
+import { buildInfoItems, type BuildInfo } from '@hagicode/hagilight-core/build-info';
 import manifest from './package.json';
 
 interface Props {
@@ -10,6 +11,7 @@ interface Props {
   links?: SiteLinksOptions;
   rssFeedUrl?: string;
   rssLocaleFeedUrls?: Readonly<Record<string, string>>;
+  buildInfo?: BuildInfo;
 }
 
 const {
@@ -17,7 +19,9 @@ const {
   links,
   rssFeedUrl,
   rssLocaleFeedUrls,
+  buildInfo,
 } = Astro.props;
+const buildItems = buildInfoItems(buildInfo);
 if (typeof manifest.version !== 'string' || manifest.version.trim().length === 0) {
   throw new Error('@hagicode/hagilight-starlight requires a nonempty string version in its package.json.');
 }
@@ -106,6 +110,17 @@ const resolvedLinks = resolveSiteLinks(currentLanguage ?? locale, {
   <Copyright name="HagiCode" />
   {' | '}
   <span class="hagilight-copyright__attribution">Powered By hagilight-starlight@{manifest.version}</span>
+  {buildItems.map((item) => (
+    <>
+      {' | '}
+      <span
+        class="hagilight-copyright__build"
+        data-build-field={item.field}
+        title={item.title}
+        data-build-commit={item.title}
+      >{item.label}: {item.datetime ? <time datetime={item.datetime}>{item.text}</time> : item.text}</span>
+    </>
+  ))}
 </p>
 
 <style>
@@ -166,4 +181,8 @@ const resolvedLinks = resolveSiteLinks(currentLanguage ?? locale, {
   .hagilight-copyright__attribution {
     overflow-wrap: anywhere;
   }
+
+  .hagilight-copyright__build {
+    overflow-wrap: anywhere;
+  }
 </style>

package/README.md

@@ -41,6 +41,10 @@ Disable the picker to keep Starlight's built-in toggle or compose `@hagicode/hag
 hagilight({ themes: { enabled: false } })
 ```
 
+### Build line
+
+The plugin footer shows the same build line as the Astro package: `Branch:`, `Commit:`, and `Built:` after the attribution. It is always on and has no option of its own. The values come from `HAGILIGHT_BUILD_BRANCH` and `HAGILIGHT_BUILD_COMMIT`, then Git, then `unknown`; the core README gives the order. Detached-HEAD CI checkouts report `Branch: unknown` unless the build step sets `HAGILIGHT_BUILD_BRANCH`, as shown in the Astro README. Footer components mounted directly in a page (`@hagicode/hagilight-starlight/Footer` and `PromotoFooter`) render no build text.
+
 ### Body images
 
 `hagilight()` registers the content-image plugin from `@hagicode/hagilight-core/content-images` for the whole site. Every Markdown or MDX body image outside a `<picture>` element gets `loading="lazy"`, `decoding="async"`, and the class `hagilight-content-image`. Values the author set are kept, and logos and showcase images are not changed.

package/dist/index.js

@@ -1,6 +1,7 @@
 import { randomUUID } from 'node:crypto';
 import { fileURLToPath } from 'node:url';
 import { resolveFaviconHeadEntry } from '@hagicode/hagilight-core/favicon';
+import { resolveBuildInfo } from '@hagicode/hagilight-core/build-info-resolver';
 import { checkContentImageRegistration, registerContentImages } from '@hagicode/hagilight-core/content-images';
 import { resolveRssLocales } from '@hagicode/hagilight-core/rss';
 import { RSS_OWNER, registerStarlightRssOwner, } from '@hagicode/hagilight-core/rss-ownership';
@@ -239,6 +240,7 @@ import options from '${optionsId}';
   links={options.links}
   rssFeedUrl={options.rssFeedUrl}
   rssLocaleFeedUrls={options.rssLocaleFeedUrls}
+  buildInfo={options.buildInfo}
 />
 ${promotionRender}
 ${analyticsRender}
@@ -279,6 +281,7 @@ const isNotFound = /(?:^|\\/)404(?:\\.html)?\\/?$/u.test(Astro.url.pathname);
         ...(componentIds.markdownContent ? [[componentIds.markdownContent, markdownContentSource]] : []),
         ...(componentIds.head ? [[componentIds.head, headSource]] : []),
     ]);
+    let buildInfo;
     const vitePlugin = {
         name: `@hagicode/hagilight-starlight:${instanceId}`,
         resolveId(id) {
@@ -293,6 +296,7 @@ const isNotFound = /(?:^|\\/)404(?:\\.html)?\\/?$/u.test(Astro.url.pathname);
                     ...serializedOptions,
                     rssFeedUrl: getConfiguredRssFeed(),
                     rssLocaleFeedUrls,
+                    buildInfo,
                 })};`;
             }
             if (moduleId === rssConfigId)
@@ -306,6 +310,7 @@ const isNotFound = /(?:^|\\/)404(?:\\.html)?\\/?$/u.test(Astro.url.pathname);
         hooks: {
             'astro:config:setup'({ config, injectRoute, updateConfig, logger }) {
                 registerContentImages({ config, logger, enabled: contentImagesEnabled });
+                buildInfo = resolveBuildInfo({ root: fileURLToPath(config.root) });
                 if (generateRss) {
                     injectRoute({
                         pattern: '/rss.xml',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hagicode/hagilight-starlight",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "type": "module",
   "description": "Starlight plugin and components for HagiCode documentation",
   "repository": {
@@ -53,7 +53,7 @@
     "assets/showcase/*"
   ],
   "dependencies": {
-    "@hagicode/hagilight-core": "0.9.1"
+    "@hagicode/hagilight-core": "0.9.2"
   },
   "peerDependencies": {
     "@astrojs/starlight": "^0.42.4",