feat(docs): allow edit any locale file (#2099)

config/i18n.ts

@@ -9,12 +9,12 @@ interface LocaleObjectData extends LocaleObject {
   pluralRule?: PluralizationRule
 }
 
-const countryLocaleVariants: Record<string, LocaleObjectData[]> = {
+export const countryLocaleVariants: Record<string, (LocaleObjectData & { country?: boolean }) []> = {
   ar: [
     // ar.json contains ar-EG translations
     // { code: 'ar-DZ', name: 'Arabic (Algeria)' },
     // { code: 'ar-BH', name: 'Arabic (Bahrain)' },
-    { code: 'ar-EG', name: 'العربية' },
+    { country: true, code: 'ar-EG', name: 'العربية' },
     // { code: 'ar-EG', name: 'Arabic (Egypt)' },
     // { code: 'ar-IQ', name: 'Arabic (Iraq)' },
     // { code: 'ar-JO', name: 'Arabic (Jordan)' },
@@ -32,13 +32,13 @@ const countryLocaleVariants: Record<string, LocaleObjectData[]> = {
   ],
   en: [
     // en.json contains en-US translations
-    { code: 'en-US', name: 'English (US)' },
+    { country: true, code: 'en-US', name: 'English (US)' },
     { code: 'en-GB', name: 'English (UK)' },
   ],
   ca: [
     // ca.json contains ca-ES translations
     // { code: 'ca-AD', name: 'Català (Andorra)' },
-    { code: 'ca-ES', name: 'Català (Espanya)' },
+    { country: true, code: 'ca-ES', name: 'Català (Espanya)' },
     { code: 'ca-valencia', name: 'Català (valencià)' },
     // { code: 'ca-FR', name: 'Català (França)' },
     // { code: 'ca-IT', name: 'Català (Itàlia)' },
@@ -52,7 +52,7 @@ const countryLocaleVariants: Record<string, LocaleObjectData[]> = {
     // { code: 'es-CR', name: 'Español (Costa Rica)' },
     // { code: 'es-DO', name: 'Español (República Dominicana)' },
     // { code: 'es-EC', name: 'Español (Ecuador)' },
-    { code: 'es-ES', name: 'Español (España)' },
+    { country: true, code: 'es-ES', name: 'Español (España)' },
     // TODO: Support es-419, if we include spanish country variants remove also fix on utils/language.ts module
     { code: 'es-419', name: 'Español (Latinoamérica)' },
     // { code: 'es-GT', name: 'Español (Guatemala)' },
@@ -69,7 +69,7 @@ const countryLocaleVariants: Record<string, LocaleObjectData[]> = {
   ],
   pt: [
     // pt.json contains pt-PT translations
-    { code: 'pt-PT', name: 'Português (Portugal)' },
+    { country: true, code: 'pt-PT', name: 'Português (Portugal)' },
     { code: 'pt-BR', name: 'Português (Brasil)' },
   ],
 }

docs/components/global/TranslationState.vue

@@ -107,7 +107,7 @@ async function copyToClipboard() {
         </tr>
       </thead>
       <tbody>
-        <template v-for="({ title, file, translated, missing, outdated, total, isSource }, key) in localesStatuses" :key="key">
+        <template v-for="({ title, useFile, translated, missing, outdated, total, isSource }, key) in localesStatuses" :key="key">
           <tr
             v-if="totalReference > 0"
             :class="[{ expandable: !isSource }]"
@@ -121,11 +121,25 @@ async function copyToClipboard() {
               </div>
             </td>
             <template v-if="isSource">
-              <td colspan="5" class="source-text">
+              <td colspan="4" class="source-text">
                 <div>
                   {{ total }} keys as source
                 </div>
               </td>
+              <td>
+                <NuxtLink
+                  :href="`https://pr.new/github.com/elk-zone/elk/tree/main/locales/${useFile}`"
+                  target="_blank"
+                  class="codeflow"
+                  title="Raise a PR with Codeflow (opens in new window)"
+                  @click.stop
+                >
+                  Edit
+                  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24">
+                    <path fill="currentColor" d="M5 21q-.825 0-1.413-.587Q3 19.825 3 19V5q0-.825.587-1.413Q4.175 3 5 3h7v2H5v14h14v-7h2v7q0 .825-.587 1.413Q19.825 21 19 21Zm4.7-5.3l-1.4-1.4L17.6 5H14V3h7v7h-2V6.4Z" />
+                  </svg>
+                </NuxtLink>
+              </td>
             </template>
             <template v-else>
               <td>
@@ -140,8 +154,7 @@ async function copyToClipboard() {
               <td><strong>{{ `${total}` }}</strong></td>
               <td>
                 <NuxtLink
-                  v-if="outdated.length > 0 || missing.length > 0"
-                  :href="`https://pr.new/github.com/elk-zone/elk/tree/main/locales/${file}`"
+                  :href="`https://pr.new/github.com/elk-zone/elk/tree/main/locales/${useFile}`"
                   target="_blank"
                   class="codeflow"
                   title="Raise a PR with Codeflow (opens in new window)"

docs/types.ts

@@ -1,6 +1,7 @@
 export interface LocaleEntry {
   title: string
   file: string
+  useFile: string
   translated: string[]
   missing: string[]
   outdated: string[]

locales/es.json

@@ -98,6 +98,8 @@
     "error": "ERROR",
     "fetching": "Cargando...",
     "in": "en",
+    "no_bookmarks": "Sin publicaciones marcadas todavía",
+    "no_favourites": "Sin publicaciones favoritas todavía",
     "not_found": "404 No Encontrado",
     "offline_desc": "Al parecer no tienes conexión a internet. Por favor, comprueba tu conexión a la red."
   },
@@ -211,7 +213,7 @@
         "title": "Acciones"
       },
       "media": {
-        "title": "Media"
+        "title": "Multimedia"
       },
       "navigation": {
         "go_to_home": "Inicio",
@@ -293,6 +295,7 @@
     "followed_you_count": "{0} personas te siguieron|{0} persona te siguió|{0} personas te siguieron",
     "missing_type": "MISSING notification.type:",
     "reblogged_post": "retooteó tu publicación",
+    "reported": "{0} reportó {1}",
     "request_to_follow": "ha solicitado seguirte",
     "signed_up": "registrado",
     "update_status": "ha actualizado su publicación"
@@ -444,12 +447,14 @@
       "hide_boost_count": "Ocultar contador de retoots",
       "hide_favorite_count": "Ocultar número de publicaciones favoritas",
       "hide_follower_count": "Ocultar número de seguidores",
+      "hide_news": "Ocultar noticias",
       "hide_reply_count": "Ocultar número de respuestas",
       "hide_translation": "Ocultar traducción",
       "hide_username_emojis": "Ocultar emojis en el nombre de usuario",
       "hide_username_emojis_description": "Oculta los emojis de los nombres de usuarios en la línea de tiempo. Los emojis permanecerán visibles en sus perfiles.",
       "label": "Preferencias",
       "title": "Funcionalidades experimentales",
+      "use_star_favorite_icon": "Utilizar icono de estrella para favoritos",
       "user_picker": "Selector de usuarios",
       "virtual_scroll": "Desplazamiento virtual",
       "wellbeing": "Bienestar",
@@ -523,6 +528,7 @@
     "replying_to": "Respondiendo a {0}",
     "show_full_thread": "Mostrar hilo completo",
     "someone": "alguien",
+    "spoiler_media_hidden": "Multimedia oculta",
     "spoiler_show_less": "Mostrar menos",
     "spoiler_show_more": "Mostrar más",
     "thread": "Hilo",

scripts/prepare-translation-status.ts

@@ -2,7 +2,7 @@ import { Buffer } from 'node:buffer'
 import flatten from 'flat'
 import { createResolver } from '@nuxt/kit'
 import fs from 'fs-extra'
-import { currentLocales } from '../config/i18n'
+import { countryLocaleVariants, currentLocales } from '../config/i18n'
 import type { LocaleEntry } from '../docs/types'
 import type { ElkTranslationStatus } from '~/types/translation-status'
 
@@ -63,10 +63,11 @@ async function prepareTranslationStatus() {
   const entries: Record<string, any> = await readI18nFile(sourceLanguageLocale[1])
   const flatEntries = flatten<typeof entries, Record<string, string>>(entries)
   const total = Object.keys(flatEntries).length
-  const data: Record<string, LocaleEntry> = {
+  const data: Record<string, LocaleEntry & { useFile: string }> = {
     en: {
       translated: [],
       file: 'en.json',
+      useFile: 'en.json',
       missing: [],
       outdated: [],
       title: 'English (source)',
@@ -77,8 +78,16 @@ async function prepareTranslationStatus() {
 
   await Promise.all(localeData.filter(l => l[0] !== 'en-US').map(async ([code, file, title]) => {
     console.info(`Comparing ${code}...`, title)
+    let useFile = file[file.length - 1]
+    const entry = countryLocaleVariants[file[0].slice(0, file[0].indexOf('.'))]
+    if (entry) {
+      const countryFile = entry.find(e => e.code === code && e.country === true)
+      if (countryFile)
+        useFile = file[0]
+    }
     data[code] = {
       title,
+      useFile,
       file: Array.isArray(file) ? file[file.length - 1] : file,
       translated: [],
       missing: [],