@robsun/create-keystone-app 0.2.7 → 0.2.9

package/template/scripts/generate-i18n-types.js

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+/**
+ * i18n Type Definition Generator
+ *
+ * Generates TypeScript type definitions from JSON locale files
+ * for type-safe translations in your application.
+ *
+ * Usage:
+ *   node scripts/generate-i18n-types.js
+ *
+ * Output:
+ *   apps/web/src/types/i18n.d.ts
+ */
+
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const rootDir = path.resolve(__dirname, '..')
+const webSrcDir = path.join(rootDir, 'apps/web/src')
+
+// Configuration
+const LOCALE_DIRS = [
+  // Platform locales from keystone-web-core (reference only, not generated)
+  // Module locales
+  path.join(webSrcDir, 'modules'),
+]
+
+const OUTPUT_FILE = path.join(webSrcDir, 'types/i18n.d.ts')
+
+/**
+ * Recursively flattens a nested object into dot-notation keys
+ */
+function flattenKeys(obj, prefix = '') {
+  const keys = []
+  for (const [key, value] of Object.entries(obj)) {
+    const fullKey = prefix ? `${prefix}.${key}` : key
+    if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+      keys.push(...flattenKeys(value, fullKey))
+    } else {
+      keys.push(fullKey)
+    }
+  }
+  return keys
+}
+
+/**
+ * Finds all locale JSON files in a directory
+ */
+function findLocaleFiles(dir) {
+  const files = []
+  if (!fs.existsSync(dir)) return files
+
+  const entries = fs.readdirSync(dir, { withFileTypes: true })
+  for (const entry of entries) {
+    const fullPath = path.join(dir, entry.name)
+    if (entry.isDirectory()) {
+      // Look for locales directory
+      if (entry.name === 'locales') {
+        const zhDir = path.join(fullPath, 'zh-CN')
+        if (fs.existsSync(zhDir)) {
+          const jsonFiles = fs.readdirSync(zhDir).filter(f => f.endsWith('.json'))
+          for (const jsonFile of jsonFiles) {
+            files.push({
+              namespace: path.basename(jsonFile, '.json'),
+              path: path.join(zhDir, jsonFile),
+            })
+          }
+        }
+      } else {
+        files.push(...findLocaleFiles(fullPath))
+      }
+    }
+  }
+  return files
+}
+
+/**
+ * Generates TypeScript type definitions
+ */
+function generateTypes() {
+  const namespaces = new Map()
+
+  // Collect all locale files
+  for (const localeDir of LOCALE_DIRS) {
+    const files = findLocaleFiles(localeDir)
+    for (const file of files) {
+      try {
+        const content = fs.readFileSync(file.path, 'utf-8')
+        const json = JSON.parse(content)
+        const keys = flattenKeys(json)
+        namespaces.set(file.namespace, keys)
+      } catch (err) {
+        console.warn(`Warning: Could not parse ${file.path}:`, err.message)
+      }
+    }
+  }
+
+  if (namespaces.size === 0) {
+    console.log('No locale files found. Skipping type generation.')
+    return
+  }
+
+  // Generate TypeScript content
+  let output = `// Auto-generated by scripts/generate-i18n-types.js
+// Do not edit manually
+
+import 'react-i18next'
+
+declare module 'react-i18next' {
+  interface CustomTypeOptions {
+    defaultNS: 'common'
+    resources: {
+`
+
+  for (const [namespace, keys] of namespaces) {
+    output += `      ${namespace}: {\n`
+    for (const key of keys) {
+      // Create nested type from dot notation
+      output += `        '${key}': string\n`
+    }
+    output += `      }\n`
+  }
+
+  output += `    }
+  }
+}
+
+// Type-safe translation keys
+`
+
+  for (const [namespace, keys] of namespaces) {
+    const typeName = namespace.charAt(0).toUpperCase() + namespace.slice(1) + 'Keys'
+    output += `export type ${typeName} = \n`
+    output += keys.map(k => `  | '${k}'`).join('\n')
+    output += '\n\n'
+  }
+
+  // Ensure output directory exists
+  const outputDir = path.dirname(OUTPUT_FILE)
+  if (!fs.existsSync(outputDir)) {
+    fs.mkdirSync(outputDir, { recursive: true })
+  }
+
+  // Write output file
+  fs.writeFileSync(OUTPUT_FILE, output, 'utf-8')
+  console.log(`Generated i18n types: ${OUTPUT_FILE}`)
+  console.log(`Namespaces: ${[...namespaces.keys()].join(', ')}`)
+}
+
+// Run generator
+generateTypes()