kazupon/vue-i18n

Change the way missing translation keys are detected

Open

#563 opened on Apr 16, 2019

View on GitHub
 (14 comments) (10 reactions) (0 assignees)JavaScript (7,181 stars) (886 forks)batch import
Type: Improvementgood first issue

Description

Hello,

Our translations are handled with Crowdin and one particularity with Crowdin is that, if a key wasn't translated yet and we sync them; Crowdin will return the key with an empty string instead of returning the file without the missing keys.

The thing is that, vue-i18n considers the empty string as an already-translated key, so it will uses it instead of fallbacking to the default version (english).

It would be great to override this default rule, so I can say that: "If my key is missing OR my key is empty, fallback to the default version".

An implementation suggestion would be a handler in the config that returns true or false if the key passed should be considered as missing?

Contributor guide

Tech stack
vuejavascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Vue.jsUnderstanding of i18n concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Examine the vue i18n source code, particularly the `t` function and how it handles missing keys. Look for the fallback mechanism in the core library. Consider implementing a new configuration option, such as `missingKeyHandler`, that allows users to define custom logic to determine when a key should be considered missing. The implementation would involve modifying the translation resolution logic to check the custom handler before falling back.