this post was submitted on 21 Aug 2023
40 points (100.0% liked)

Programming

17354 readers
419 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]



founded 1 year ago
MODERATORS
 

For a current project, I’ve been struggling with my language files. They’re all JSON files, and will always fallback to English if translations aren’t available.

My problem is that when a new key is required, I use my english file by default. This leads to situations where my client wants to translate new keys to other languages, and I have to spend time looking at all files, figuring out which keys i haven’t added there.

Essentially I want to get to a point where I can give all the translation files to my client, and he returns them with the translated content.

What do you guys use for managing this? And how would you solve the situation i’ve found myself in.

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 3 points 1 year ago* (last edited 1 year ago) (2 children)

If you are using TypeScript it's quite easy to create a system where the type system will enforce the existence of all translations. I think it should be possible to create a similar solution for other languages as well.

For example:

const enTranslations = { MENU: '' };

const plTranslations: typeof enTranslations = { MENU: '' } as const;

const t = (key: keyof typeof enTranslations) => get language() == 'pl' ? plTranslations[key] : enTranslations[key];

Missing keys will fail compilation. If you want to skip check you can always use //@ts-ignore

Additionally the type system will enforce only valid translation keys so you won't be able to make a typo it forget to add English translation.

[–] [email protected] 2 points 1 year ago (3 children)

I think I actually just want a system, which will take my English file as the default, and add the missing keys to the rest of the language files.

[–] [email protected] 3 points 1 year ago* (last edited 1 year ago) (1 children)

Perhaps, the "fallback to English translations file at runtime" is obscuring errors.
Might be worth redefining the system to throw an error when a translation key in the chosen language isn't found. Even if that's only done in Dev, whereas the fallback happens in prod.
This will ensure a translation file has all the keys, even if the values are still default.

Some tooling for you to easily add a new key, and have it also add that to all language files as [word] or something. So, the English word is still used, but the square brackets shows that it's untranslated.
Maybe some tooling to find all values that have the [], to generate a translation to-do list.
Probably a tool to create a new translation file as well, which would duplicate the English file, but apply the "this is not translated" pattern to all the values

[–] [email protected] 1 points 1 year ago (1 children)

Are warnings no thing anymore?

[–] [email protected] 1 points 1 year ago (1 children)
[–] [email protected] 1 points 1 year ago

Jenkins didn't at my last job.

[–] [email protected] 1 points 1 year ago (1 children)

Obviously I don't know your codebase but couldn't you do something like the following?

function loadTranslations(locale) {
  const fallbackTranslations = require("/i18n/en.json");
  const translations = require(`/i18n/${locale}.json`);
  return {
     ...fallbackTranslations,
    ...translations
  };
}
[–] [email protected] 1 points 1 year ago* (last edited 1 year ago) (1 children)

That won't work quite well because a lot of it is nested. But shouldn't be too hard to account for that in a couple of lines of code.

[–] [email protected] 2 points 1 year ago* (last edited 1 year ago) (1 children)

Yeah, I don't know the exact structure of your translation files but a deep merge of your fallback files and the requested locale file should be enough.

[–] [email protected] 1 points 1 year ago

Sounds like that will be indeed the easiest and quickest solution for this project.

[–] [email protected] 1 points 1 year ago

Quite a lot of IDEs will key you just click "add missing properties" action on the translation object to create a language file.

[–] [email protected] 1 points 1 year ago* (last edited 1 year ago) (1 children)

It's also quite ready to transform this file to JSON and send it to translators through any service that supports his format.