From 328aad43347ee95ed6a80e17ab7672f6d1040e8e Mon Sep 17 00:00:00 2001
From: Qin Guan <qinguan20040914@gmail.com>
Date: Sun, 24 Sep 2023 16:56:47 +0800
Subject: [PATCH] feat: build info

---
 components/admin/home/events-table.vue |  4 ++--
 components/app/home/news.vue           |  2 +-
 components/app/profile/page.vue        | 14 ++++++++++++++
 modules/build-info.ts                  | 26 ++++++++++++++++++++++++++
 nuxt.config.ts                         |  1 +
 package.json                           |  4 +++-
 pnpm-lock.yaml                         | 21 ++++++++++++---------
 shared/types.ts                        | 13 +++++++++++++
 8 files changed, 72 insertions(+), 13 deletions(-)
 create mode 100644 modules/build-info.ts

diff --git a/components/admin/home/events-table.vue b/components/admin/home/events-table.vue
index ac6affd..324fed8 100644
--- a/components/admin/home/events-table.vue
+++ b/components/admin/home/events-table.vue
@@ -53,10 +53,10 @@ const { data: events } = useEvents()
                 {{ event.name }}
               </td>
               <td class="label-cell">
-                {{ dayjs(event.startDateTime).format('DD-MM-YYYY hh:mm') }}
+                {{ dayjs(event.startDateTime).format('DD-MM-YYYY HH:mm') }}
               </td>
               <td class="label-cell">
-                {{ dayjs(event.endDateTime).format('DD-MM-YYYY hh:mm') }}
+                {{ dayjs(event.endDateTime).format('DD-MM-YYYY HH:mm') }}
               </td>
               <td class="numeric-cell">
                 {{ event.attendees.length }}
diff --git a/components/app/home/news.vue b/components/app/home/news.vue
index b42fa83..3ff7b55 100644
--- a/components/app/home/news.vue
+++ b/components/app/home/news.vue
@@ -23,7 +23,7 @@ const { data: news, isLoading: newsIsLoading } = useNewsArticles()
         <f7Card v-for="article in news" :key="article.id" class="m-0!">
           <f7CardHeader class="h-45 rounded-[16px]! overflow-hidden bg-center bg-contain relative" valign="bottom" :style="`background-image: url(${article.heroImageUrl})`">
             <div class="absolute inset-0 bg-gradient-to-b from-transparent dark:to-black/70 to-white/70" />
-            <span class="z-10">
+            <span class="z-10 font-semibold">
               {{ article.title }}
             </span>
           </f7CardHeader>
diff --git a/components/app/profile/page.vue b/components/app/profile/page.vue
index 250a60a..522e03c 100644
--- a/components/app/profile/page.vue
+++ b/components/app/profile/page.vue
@@ -1,7 +1,10 @@
 <script setup lang="ts">
 import { f7BlockTitle, f7Link, f7List, f7ListButton, f7ListInput, f7ListItem, f7NavRight, f7NavTitle, f7NavTitleLarge, f7Navbar, f7Page, f7Popup, f7View } from 'framework7-vue'
+import dayjs from 'dayjs'
 import { devDependencies } from '~/package.json'
 
+const appConfig = useAppConfig()
+
 const { data: user } = useUser()
 const graduationYear = computed(() => {
   return `Class of ${user.value?.graduationYear}`
@@ -49,6 +52,17 @@ const { mutate: userSignOutMutate } = useUserSignOutMutation()
       </f7ListButton>
     </f7List>
 
+    <f7List>
+      <f7ListItem class="opacity-80 text-sm">
+        v{{ appConfig.buildInfo.version }}
+        <br>
+        <br>
+        Built on {{ dayjs(appConfig.buildInfo.time).format('DD/MM/YYYY HH:mm') }}
+        <br>
+        Commit: {{ appConfig.buildInfo.shortCommit }}
+      </f7ListItem>
+    </f7List>
+
     <f7Popup id="acknowledgements" push>
       <f7View>
         <f7Page>
diff --git a/modules/build-info.ts b/modules/build-info.ts
new file mode 100644
index 0000000..599c8ee
--- /dev/null
+++ b/modules/build-info.ts
@@ -0,0 +1,26 @@
+import Git from 'simple-git'
+import { defineNuxtModule } from '@nuxt/kit'
+import { version } from '../package.json'
+import type { BuildInfo } from '~/shared/types'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'web:build-env',
+  },
+  async setup(_options, nuxt) {
+    const git = Git()
+
+    const commit = await git.revparse(['HEAD'])
+    const shortCommit = await git.revparse(['--short=7', 'HEAD'])
+
+    const buildInfo: BuildInfo = {
+      version,
+      time: +Date.now(),
+      commit,
+      shortCommit,
+    }
+
+    nuxt.options.appConfig = nuxt.options.appConfig || {}
+    nuxt.options.appConfig.buildInfo = buildInfo
+  },
+})
diff --git a/nuxt.config.ts b/nuxt.config.ts
index f365e61..f18eda5 100644
--- a/nuxt.config.ts
+++ b/nuxt.config.ts
@@ -15,6 +15,7 @@ export default defineNuxtConfig({
     '@unocss/nuxt',
     '@vite-pwa/nuxt',
     '@vueuse/nuxt',
+    '~/modules/build-info',
   ],
 
   routeRules: {
diff --git a/package.json b/package.json
index 43dd6ac..07576cd 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,8 @@
 {
   "name": "nuxt-app",
   "type": "module",
-  "private": true,
+  "version": "0.0.1-alpha.1",
+  "license": "MIT",
   "scripts": {
     "build": "nuxt build",
     "dev": "nuxt dev",
@@ -38,6 +39,7 @@
     "material-icons": "^1.13.11",
     "nuxt": "^3.7.3",
     "nuxt-vuefire": "^0.3.0",
+    "simple-git": "^3.20.0",
     "vuefire": "^3.1.17",
     "web-auth-library": "^1.0.3",
     "zod": "^3.22.2"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 34195db..6f24f4a 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -7,7 +7,7 @@ settings:
 devDependencies:
   '@antfu/eslint-config':
     specifier: latest
-    version: 1.0.0-beta.4(eslint@8.49.0)(typescript@5.2.2)
+    version: 1.0.0-beta.6(eslint@8.49.0)(typescript@5.2.2)
   '@libsql/client':
     specifier: ^0.3.4
     version: 0.3.4
@@ -77,6 +77,9 @@ devDependencies:
   nuxt-vuefire:
     specifier: ^0.3.0
     version: 0.3.0(@firebase/app-types@0.9.0)(firebase@10.4.0)(rollup@2.79.1)(vuefire@3.1.17)
+  simple-git:
+    specifier: ^3.20.0
+    version: 3.20.0
   vuefire:
     specifier: ^3.1.17
     version: 3.1.17(firebase@10.4.0)(vue@3.3.4)
@@ -102,8 +105,8 @@ packages:
       '@jridgewell/trace-mapping': 0.3.19
     dev: true
 
-  /@antfu/eslint-config@1.0.0-beta.4(eslint@8.49.0)(typescript@5.2.2):
-    resolution: {integrity: sha512-4QLToVBpsMo0W8Xw6m2E64ALC2Aq0um3MPT7J1fWj3ySkvLAcGG0GP8F/tl/3iJvWBjKua2nyMNzO4IdEannZw==}
+  /@antfu/eslint-config@1.0.0-beta.6(eslint@8.49.0)(typescript@5.2.2):
+    resolution: {integrity: sha512-niRdTOSKrLgND+DyK+I5Mejy5xzjjDCCqGQV/KhefLDxZ5AGfEnClw00R5BvBHg7cBhcVoKbTqeFrjIgHaSX7g==}
     peerDependencies:
       eslint: '>=8.0.0'
     dependencies:
@@ -114,7 +117,7 @@ packages:
       '@typescript-eslint/parser': 6.7.2(eslint@8.49.0)(typescript@5.2.2)
       eslint: 8.49.0
       eslint-define-config: 1.23.0
-      eslint-plugin-antfu: 1.0.0-beta.4(eslint@8.49.0)(typescript@5.2.2)
+      eslint-plugin-antfu: 1.0.0-beta.6(eslint@8.49.0)(typescript@5.2.2)
       eslint-plugin-eslint-comments: 3.2.0(eslint@8.49.0)
       eslint-plugin-i: 2.28.1(@typescript-eslint/parser@6.7.2)(eslint@8.49.0)
       eslint-plugin-jsdoc: 46.8.2(eslint@8.49.0)
@@ -2696,7 +2699,7 @@ packages:
       pkg-types: 1.0.3
       rc9: 2.1.1
       semver: 7.5.4
-      simple-git: 3.19.1
+      simple-git: 3.20.0
       sirv: 2.0.3
       unimport: 3.3.0(rollup@2.79.1)
       vite: 4.4.9
@@ -5958,8 +5961,8 @@ packages:
       - supports-color
     dev: true
 
-  /eslint-plugin-antfu@1.0.0-beta.4(eslint@8.49.0)(typescript@5.2.2):
-    resolution: {integrity: sha512-SbN6Sp6t/4dyLgJkme+OHOifPp4pFCUXmhwY2cPBwUa1aC//olNl4Us9zuGDFoaHy0ArXDJu3SLPeqaFci1AoQ==}
+  /eslint-plugin-antfu@1.0.0-beta.6(eslint@8.49.0)(typescript@5.2.2):
+    resolution: {integrity: sha512-AbHAYYVv8BhjH4FkoSZWV+FxYwZUspqr0Zo5y4K0Jm8BhwXo6+UaQrpW3exxraJmsVTXty+Hlkcd4ysQV6DICw==}
     dependencies:
       '@typescript-eslint/utils': 6.7.2(eslint@8.49.0)(typescript@5.2.2)
     transitivePeerDependencies:
@@ -9966,8 +9969,8 @@ packages:
       simple-concat: 1.0.1
     dev: true
 
-  /simple-git@3.19.1:
-    resolution: {integrity: sha512-Ck+rcjVaE1HotraRAS8u/+xgTvToTuoMkT9/l9lvuP5jftwnYUp6DwuJzsKErHgfyRk8IB8pqGHWEbM3tLgV1w==}
+  /simple-git@3.20.0:
+    resolution: {integrity: sha512-ozK8tl2hvLts8ijTs18iFruE+RoqmC/mqZhjs/+V7gS5W68JpJ3+FCTmLVqmR59MaUQ52MfGQuWsIqfsTbbJ0Q==}
     dependencies:
       '@kwsites/file-exists': 1.1.1
       '@kwsites/promise-deferred': 1.1.1
diff --git a/shared/types.ts b/shared/types.ts
index a4ee391..76c3ea1 100644
--- a/shared/types.ts
+++ b/shared/types.ts
@@ -9,3 +9,16 @@ export type Event = InferSelectModel<typeof events>
 export type EventWithAttendees = Event & { attendees: UserRestrictedWithAdmissionKey[] }
 
 export type NewsArticle = InferSelectModel<typeof news>
+
+export interface BuildInfo {
+  version: string
+  commit: string
+  shortCommit: string
+  time: number
+}
+
+declare module '@nuxt/schema' {
+  interface NuxtAppConfig {
+    buildInfo: BuildInfo
+  }
+}