feat: add build stamp to settings

jamiebrynes7 · Jan 3, 2025 · 414c6e6 · 414c6e6
1 parent 3d6ec0c
commit 414c6e6
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 3 deletions.
diff --git a/plugin/package-lock.json b/plugin/package-lock.json
diff --git a/plugin/src/i18n/langs/en.ts b/plugin/src/i18n/langs/en.ts
@@ -70,6 +70,10 @@ export const en: Translations = {
         label: "Enable debug logging",
         description: "Whether debug logging should be enabled",
       },
+      buildStamp: {
+        label: "Build stamp",
+        description: "Stamp for the build of this plugin",
+      },
     },
     deprecation: {
       warningMessage: "This setting is deprecated and will be removed in a future release.",

diff --git a/plugin/src/i18n/translation.ts b/plugin/src/i18n/translation.ts
@@ -66,6 +66,10 @@ export type Translations = {
         label: string;
         description: string;
       };
+      buildStamp: {
+        label: string;
+        description: string;
+      };
     };
     deprecation: {
       warningMessage: string;

diff --git a/plugin/src/stamp.ts b/plugin/src/stamp.ts
@@ -0,0 +1 @@
+export const BuildStamp = "SYNC_WITH_TODOIST_BUILD_STAMP";
diff --git a/plugin/src/ui/settings/index.tsx b/plugin/src/ui/settings/index.tsx
@@ -10,6 +10,7 @@ import { AutoRefreshIntervalControl } from "./AutoRefreshIntervalControl";
 import { Setting } from "./SettingItem";
 import { TokenChecker } from "./TokenChecker";
 import "./styles.scss";
+import { BuildStamp } from "@/stamp";
 
 export class SettingsTab extends PluginSettingTab {
   private readonly plugin: TodoistPlugin;
@@ -188,6 +189,12 @@ const SettingsRoot: React.FC<Props> = ({ plugin }) => {
       >
         <Setting.ToggleControl {...toggleProps("debugLogging")} />
       </Setting.Root>
+      <Setting.Root
+        name={i18n.advanced.buildStamp.label}
+        description={i18n.advanced.buildStamp.description}
+      >
+        <span className="setting-item-build-stamp">{BuildStamp}</span>
+      </Setting.Root>
     </PluginContext.Provider>
   );
 };
diff --git a/plugin/src/ui/settings/styles.scss b/plugin/src/ui/settings/styles.scss
@@ -35,3 +35,7 @@
     margin-left: 0.5em;
   }
 }
+
+.setting-item-build-stamp {
+  font-size: var(--font-smaller);
+}
diff --git a/plugin/vite.config.mts b/plugin/vite.config.mts
@@ -1,10 +1,13 @@
-import path, { resolve } from "path";
+import { execSync } from "node:child_process";
+import path, { resolve } from "node:path";
 import replace from "@rollup/plugin-replace";
 import { loadEnv } from "vite";
 import { viteStaticCopy } from "vite-plugin-static-copy";
 import tsConfigPaths from "vite-tsconfig-paths";
 import { configDefaults, defineConfig } from "vitest/config";
 
+const { version } = require("./package.json");
+
 function getOutDir(): string | undefined {
   const env = loadEnv("prod", process.cwd());
   if (env?.VITE_ENV !== "dev") {
@@ -19,6 +22,12 @@ function getOutDir(): string | undefined {
   return path.join(vaultDir, ".obsidian", "plugins", "todoist-sync-plugin");
 }
 
+function getBuildStamp(): string {
+  const commitSha = execSync("git rev-parse --short HEAD").toString().trim();
+  const timestamp = new Date().toISOString().slice(2, 16).replace(/[-:]/g, "");
+  return `v${version}-${commitSha}-${timestamp}`;
+}
+
 export default defineConfig({
   plugins: [
     tsConfigPaths(),
@@ -32,6 +41,7 @@ export default defineConfig({
     }),
     replace({
       "process.env.NODE_ENV": JSON.stringify(process.env.NODE_ENV),
+      SYNC_WITH_TODOIST_BUILD_STAMP: getBuildStamp(),
     }),
   ],
   build: {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export const BuildStamp = "SYNC_WITH_TODOIST_BUILD_STAMP";