Lang _ to iso refactor

Author: padms

packages/energyvision/src/configs/satelliteConfig.ts

@@ -2,80 +2,73 @@
   {
     id: The key for this language
     title: The title as it will be labeled in Sanity studio
-    iso: Iso version of the language, used by Next.js localisation and react-intl
-    name: Name as used in the Sanity localisation feature (this one is hard to explain :sweat_smile:)
-    locale: The actual locale name as used by Next.js and locale folders/structure ([site]/locale)
+    iso: ISO locale code (e.g., "en-GB"), used for document lang field and Next.js routing
+    locale: Two-letter locale code (e.g., "en"), used for URL routing and next-intl config
   }
 */
 export type Language = {
   id: string
   title: string
   iso: string
-  name: string
   locale: string
 }
 const languages = [
   {
     id: 'english',
     title: 'English (UK)',
     iso: 'en-GB',
-    name: 'en_GB',
     locale: 'en',
   },
   {
     id: 'norwegian',
     title: 'Norwegian',
     iso: 'nb-NO',
-    name: 'nb_NO',
     locale: 'no',
   },
   {
     id: 'portuguese',
     title: 'Portuguese (BR)',
     iso: 'pt-BR',
-    name: 'pt_BR',
     locale: 'pt',
   },
-  { id: 'german', title: 'German', iso: 'de-DE', name: 'de_DE', locale: 'de' },
+  { id: 'german', title: 'German', iso: 'de-DE', locale: 'de' },
   {
     id: 'spanish-ar',
     title: 'Spanish',
     iso: 'es-AR',
-    name: 'es_AR',
     locale: 'es',
   },
-  { id: 'polish', title: 'Polish', iso: 'pl-PL', name: 'pl_PL', locale: 'pl' },
+  { id: 'polish', title: 'Polish', iso: 'pl-PL', locale: 'pl' },
   {
     id: 'japanese',
     title: 'Japanese',
     iso: 'ja-JP',
-    name: 'ja_JP',
     locale: 'ja',
   },
-  { id: 'korean', title: 'Korean', iso: 'ko-KR', name: 'ko_KR', locale: 'ko' },
-  { id: 'welsh', title: 'Welsh', iso: 'cy-CY', name: 'cy_CY', locale: 'cy' },
+  { id: 'korean', title: 'Korean', iso: 'ko-KR', locale: 'ko' },
+  { id: 'welsh', title: 'Welsh', iso: 'cy-CY', locale: 'cy' },
 ]
 
 /**
  * @type {Record<string, string>}
  */
 export const newsSlug: Record<string, string> = {
-  en_GB: 'news',
-  nb_NO: 'nyheter',
-  pt_BR: 'noticias',
-  pl_PL: 'aktualnosci',
-  de_DE: 'aktuelles',
-  ja_JP: 'news',
-  ko_KR: 'news',
-  cy_CY: 'newyddion',
+  'en-GB': 'news',
+  'nb-NO': 'nyheter',
+  'pt-BR': 'noticias',
+  'pl-PL': 'aktualnosci',
+  'de-DE': 'aktuelles',
+  'ja-JP': 'news',
+  'ko-KR': 'news',
+  'cy-CY': 'newyddion',
 }
 
 /**
  * @type {Record<string, string>}
  */
 export const magazineSlug: Record<string, string> = {
-  en_GB: 'magazine',
-  nb_NO: 'magasin',
+  'en-GB': 'magazine',
+  'nb-NO': 'magasin',
 }
 
 /*
@@ -187,9 +180,7 @@ const websiteDomains: Partial<
 /**
  * @returns {{
  *  id: string
- *  title: string
  *  iso: string
- *  name: string
  *  locale: string
  * }[]}
  */
@@ -206,7 +197,7 @@ const logAndFallback = (dataset: DatasetsKeys) => {
 }
 
 export const localNewsTags: Record<string, string[]> = {
-  en_GB: ['ev', 'uk', 'us'],
+  'en-GB': ['ev', 'uk', 'us'],
 }
 
 /**
@@ -234,3 +225,9 @@ export const getAllDomainUrls = () => {
   return Object.values(websiteDomains).map(dataset => dataset.url)
   //return Object.keys(datasets).map((dataset) => websiteDomains[dataset]?.url)
 }
+
+/**
+ * Converts ISO locale code to Sanity schema field name format
+ * Example: "en-GB" → "en_GB", "nb-NO" → "nb_NO"
+ */
+export const isoToSchemaName = (iso: string): string => iso.replace('-', '_')

search/common/language.test.ts

@@ -6,7 +6,7 @@ describe('Language function tests', () => {
     const sut = languageFromIso
 
     describe('With english iso code', () => {
-      const english = { internalCode: 'en_GB', isoCode: 'en-GB' }
+      const english = { internalCode: 'en-GB', isoCode: 'en-GB' }
       const res = sut('en-GB')
       it('english language object is returned', () => {
         E.foldW(

search/common/language.ts

@@ -7,8 +7,8 @@ export type Language = {
   isoCode: string
 }
 
-const english = { internalCode: 'en_GB', isoCode: 'en-GB' }
-const norwegian = { internalCode: 'nb_NO', isoCode: 'nb-NO' }
+const english = { internalCode: 'en-GB', isoCode: 'en-GB' }
+const norwegian = { internalCode: 'nb-NO', isoCode: 'nb-NO' }
 
 type LanguageMappingsType = Language[]
 const languageMappings: LanguageMappingsType = [english, norwegian]

studio/actions/CustomDuplicateAction.ts

@@ -21,7 +21,7 @@ export function createCustomDuplicateAction(originalAction: DocumentActionCompon
           return null
         }
 
-        if (lang == defaultLanguage.name) {
+        if (lang == defaultLanguage.iso) {
           // allow duplicate action only on base language
           originalResult.onHandle && originalResult.onHandle()
         } else {

studio/actions/customDelete/DeleteTranslationAction.tsx

@@ -16,7 +16,7 @@ export const DeleteTranslationAction: DocumentActionComponent = (props) => {
 
   const doc = props.draft || props.published
   const documentLanguage = doc ? doc[languageField] : null
-  const isDefaultLanguageDocument = defaultLanguage.name === documentLanguage
+  const isDefaultLanguageDocument = defaultLanguage.iso === documentLanguage
 
   const { id: documentId } = props
   const [isDialogOpen, setDialogOpen] = useState(false)

studio/actions/customDelete/components/DeleteTranslationDialog/index.tsx

@@ -63,7 +63,7 @@ export default function DeleteTranslationDialog(props: DeleteTranslationDialogPr
 
   return (
     <Stack space={4}>
-      {translations && translations.length > 0 && doc.lang === defaultLanguage.name ? (
+      {translations && translations.length > 0 && doc.lang === defaultLanguage.iso ? (
         <>
           <Text>Delete this document and its translations?</Text>
           {translatedDocs.length > 0 &&

studio/helpers/referenceFilters.ts

@@ -1,7 +1,7 @@
 import { SanityDocument } from 'sanity'
 import { defaultLanguage } from '../languages'
 
-export const langOrDefault = (lang: string | unknown) => lang || defaultLanguage.name
+export const langOrDefault = (lang: string | unknown) => lang || defaultLanguage.iso
 
 export const filterByLang = ({ document }: { document: SanityDocument }) => ({
   filter: `lang == $lang`,

studio/initialValueTemplates.ts

@@ -1,14 +1,13 @@
 import type { Template } from 'sanity'
-import { defaultLanguage, languages } from './languages'
+import { defaultLanguage, isoToSchemaName, languages } from './languages'
 import textSnippets from './schemas/textSnippets'
-import { magazineSlug, newsSlug } from './sitesConfig'
 import { Flags } from './src/lib/datasetHelpers'
 
 const ParentRoutesTemplates: Template<any, any>[] = languages.map(
-  ({ name, title }) => ({
-    id: `parent-route-${name}`,
+  ({ iso, title }) => ({
+    id: `parent-route-${iso}`,
     title: `Parent route - ${title}`,
-    schemaType: `route_${name}`,
+    schemaType: `route_${isoToSchemaName(iso)}`,
     parameters: [{ name: 'parentId', type: 'string' }],
     value: (params: Record<string, unknown>) => ({
       parent: { _type: 'reference', _ref: params.parentId },
@@ -24,8 +23,8 @@ const TextSnippetsTemplates: Template<any, any>[] = Object.keys(
   schemaType: `textSnippet`,
   parameters: [{ name: 'defaultValue', type: 'string' }],
   value: (params: Record<string, unknown>) => {
-    const fields = languages.map(({ name }) => ({
-      [name]: params.defaultValue,
+    const fields = languages.map(({ iso }) => ({
+      [isoToSchemaName(iso)]: params.defaultValue,
     }))
     return Object.assign({}, ...fields)
   },
@@ -94,7 +93,7 @@ const localNewsWithTagTemplate: Template<any, any> = {
   ],
   value: (params: Record<string, unknown>) => ({
     localNewsTag: params.localNewsTag,
-    lang: params.lang || defaultLanguage.name,
+    lang: params.lang || defaultLanguage.iso,
   }),
 }
 

studio/languages.ts

@@ -1,9 +1,11 @@
 import {
   defaultWebLanguage,
   getLanguages,
+  isoToSchemaName,
 } from '@energyvision/shared/satelliteConfig'
 import { dataset } from './sanity.client'
 
+export { isoToSchemaName }
 export const languages = getLanguages(dataset)
 
 export const defaultLanguage = languages[0]

studio/migrations/lang-underscore-to-hyphen/index.ts

@@ -0,0 +1,52 @@
+import { at, defineMigration, set } from 'sanity/migrate'
+
+/**
+ * Migrates all documents' `lang` field from underscore format (e.g. "en_GB")
+ * to ISO hyphen format (e.g. "en-GB").
+ *
+ * Also updates the `language` field inside `translation.metadata` translations
+ * arrays, which was added by the i18n-doc-v6 migration.
+ *
+ * Steps:
+ *  1. Backup:  pnpm sanity dataset export <dataset>
+ *  2. Dry run: pnpm sanity migration run lang-underscore-to-hyphen --project=<PROJECT_ID> --dataset=<DATASET>
+ *  3. Migrate: pnpm sanity migration run lang-underscore-to-hyphen --project=<PROJECT_ID> --dataset=<DATASET> --no-dry-run
+ *
+ * Run against every dataset:
+ *   global, global-development, brazil, germany, argentina, poland,
+ *   japan, southkorea, celticsea, sponsorship, equinorfunds, storage, secret
+ */
+
+const LANG_REGEX = /^[a-z]{2}_[A-Z]{2}$/
+
+const toIso = (lang: string) => lang.replace('_', '-')
+
+export default defineMigration({
+  title: 'lang underscore → hyphen (en_GB → en-GB)',
+
+  migrate: {
+    document(doc, _context) {
+      const patches = []
+
+      // 1. Update top-level `lang` field on any document that has it
+      if (typeof doc.lang === 'string' && LANG_REGEX.test(doc.lang)) {
+        patches.push(at('lang', set(toIso(doc.lang))))
+      }
+
+      // 2. Update `language` field inside translation.metadata translations array
+      if (doc._type === 'translation.metadata' && Array.isArray(doc.translations)) {
+        ;(doc.translations as Array<{ _key: string; language?: string }>).forEach((item, index) => {
+          if (typeof item.language === 'string' && LANG_REGEX.test(item.language)) {
+            patches.push(at(`translations[${index}].language`, set(toIso(item.language))))
+          }
+          // Also update _key if it matches the old format
+          if (typeof item._key === 'string' && LANG_REGEX.test(item._key)) {
+            patches.push(at(`translations[${index}]._key`, set(toIso(item._key))))
+          }
+        })
+      }
+
+      return patches.length > 0 ? patches : undefined
+    },
+  },
+})