feat(i18n): add en.meta.json generation script

Author: shuuji3

package.json

@@ -127,6 +127,7 @@
     "@storybook/addon-a11y": "catalog:storybook",
     "@storybook/addon-docs": "catalog:storybook",
     "@storybook/addon-themes": "catalog:storybook",
+    "@types/dot-object": "2.1.6",
     "@types/node": "24.10.13",
     "@types/sanitize-html": "2.16.0",
     "@types/semver": "7.7.1",

pnpm-lock.yaml

@@ -1,15 +1,79 @@
 import { execSync } from 'node:child_process'
-import { relative } from 'node:path'
+import * as path from 'node:path'
+import * as fs from 'node:fs'
+import type { EnJson, EnMetaJson } from './types.d.ts'
 
-export function git(command: string): string {
-  return execSync(command, { encoding: 'utf-8' }).trim()
+export function git(command: string) {
+  try {
+    return execSync(`git ${command}`, { encoding: 'utf-8' }).trim()
+  } catch {
+    console.error(`🚨 Git command failed: git ${command}`)
+    return null
+  }
 }
 
-export function getCurrentCommitHash(): string {
-  return git('git rev-parse HEAD')
+function readJson<T>(filePath: string): T {
+  return JSON.parse(fs.readFileSync(filePath, 'utf-8')) as T
 }
 
-export function getPreviousEnJson(fileName: string): string {
-  const relativePath = relative(process.cwd(), fileName)
-  return git(`git show HEAD^:${relativePath}`)
+export function getCurrentCommitHash() {
+  return git('rev-parse HEAD')
+}
+
+export function getPreviousCommitHash(parsedOldEnMetaJson: EnMetaJson) {
+  const lastCommit = parsedOldEnMetaJson.$meta?.last_updated_commit
+  if (lastCommit) {
+    return lastCommit
+  }
+  return git('rev-parse HEAD~1')
+}
+
+export function getNewEnJson(enJsonPath: string): EnJson {
+  if (fs.existsSync(enJsonPath)) {
+    return readJson<EnMetaJson>(enJsonPath)
+  }
+  return {} as EnMetaJson
+}
+
+export function getOldEnJson(oldEnMeta: EnMetaJson, enJsonPath: string): EnJson {
+  const previousHash = getPreviousCommitHash(oldEnMeta)
+  if (previousHash) {
+    const relativePath = path.relative(process.cwd(), enJsonPath)
+    const previousContent = git(`show "${previousHash}:${relativePath}"`)
+    if (previousContent) {
+      return JSON.parse(previousContent) as EnMetaJson
+    }
+  }
+  return {} as EnMetaJson
+}
+
+export function getOldEnMetaJson(enMetaJsonPath: string): EnMetaJson {
+  if (fs.existsSync(enMetaJsonPath)) {
+    return readJson<EnMetaJson>(enMetaJsonPath)
+  }
+  return {} as EnMetaJson
+}
+
+function omitMeta<T extends object>(obj: T): Omit<T, '$meta'> {
+  const { $meta: _, ...rest } = obj as T & { $meta?: unknown }
+  return rest
+}
+
+export function checkTranslationChanges(oldMeta: EnMetaJson, newMeta: EnMetaJson): boolean {
+  const oldObj = omitMeta(oldMeta)
+  const newObj = omitMeta(newMeta)
+  return JSON.stringify(oldObj) !== JSON.stringify(newObj)
+}
+
+export function createUpdatedEnMetaJson(
+  commitHash: string | null,
+  content: EnMetaJson,
+): EnMetaJson {
+  return {
+    $meta: {
+      last_updated_commit: commitHash,
+      updated_at: new Date().toISOString(),
+    },
+    ...content,
+  } as EnMetaJson
 }

scripts/i18n-meta/git-utils.ts

@@ -8,5 +8,9 @@ export type MetaEntry = {
 }
 
 export type EnMetaJson = {
+  $meta?: {
+    last_updated_commit: string
+    updated_at: string
+  }
   [key: string]: string | MetaEntry | EnMetaJson
 }

scripts/i18n-meta/types.d.ts

@@ -1,7 +1,14 @@
-import { existsSync, readFileSync, writeFileSync } from 'node:fs'
+import { writeFileSync } from 'node:fs'
 import { resolve } from 'node:path'
 import dot from 'dot-object'
-import { getCurrentCommitHash, getPreviousEnJson } from './git-utils.ts'
+import {
+  checkTranslationChanges,
+  createUpdatedEnMetaJson,
+  getCurrentCommitHash,
+  getNewEnJson,
+  getOldEnJson,
+  getOldEnMetaJson,
+} from './git-utils.ts'
 import type { EnJson, EnMetaJson, MetaEntry } from './types.d.ts'
 
 const enJsonPath = resolve('i18n/locales/en.json')
@@ -11,29 +18,27 @@ const enMetaJsonPath = resolve('i18n/locales/en.meta.json')
  * Update a metadata JSON file for English translations.
  */
 export function updateEnMetaJson() {
-  const newEnJsonRaw = readFileSync(enJsonPath, 'utf-8')
-  const oldEnJsonRaw = getPreviousEnJson(enJsonPath)
+  const newEnJson = getNewEnJson(enJsonPath)
+  const oldEnMetaJson = getOldEnMetaJson(enMetaJsonPath)
+  const oldEnJson = getOldEnJson(oldEnMetaJson, enJsonPath)
 
-  let oldEnMetaJsonRaw = '{}'
-  if (existsSync(enMetaJsonPath)) {
-    oldEnMetaJsonRaw = readFileSync(enMetaJsonPath, 'utf-8')
+  const currentCommitHash = getCurrentCommitHash()
+  const enMetaJson = currentCommitHash
+    ? makeEnMetaJson(newEnJson, oldEnJson, oldEnMetaJson, currentCommitHash)
+    : ({} as EnMetaJson)
+
+  const hasChanges = checkTranslationChanges(oldEnMetaJson, enMetaJson)
+  if (!hasChanges) {
+    console.info('ℹ️ No translation changes – en.meta.json left untouched')
+    return
   }
 
-  const latestCommitHash = getCurrentCommitHash()
-  const enMetaJson = makeEnMetaJson(
-    JSON.parse(newEnJsonRaw),
-    JSON.parse(oldEnJsonRaw),
-    JSON.parse(oldEnMetaJsonRaw),
-    latestCommitHash,
-  )
+  const finalMeta = createUpdatedEnMetaJson(currentCommitHash, enMetaJson)
 
-  writeFileSync(enMetaJsonPath, JSON.stringify(enMetaJson, null, 2) + '\n', 'utf-8')
-  console.log(`📃 Generated ${enMetaJsonPath}`)
+  writeFileSync(enMetaJsonPath, JSON.stringify(finalMeta, null, 2) + '\n', 'utf-8')
+  console.log(`✅ Updated en.meta.json – last_updated_commit: ${currentCommitHash}`)
 }
 
-/**
- * Creates a metadata JSON object by comparing current and previous versions.
- */
 export function makeEnMetaJson(
   newEnJson: EnJson,
   oldEnJson: EnJson,