openzim / zimit-frontend

Zimit Public Web UI
https://zimit.kiwix.org
GNU General Public License v3.0
10 stars 8 forks source link

Add solution to check consistency of translations #72

Open benoit74 opened 1 month ago

benoit74 commented 1 month ago

With https://github.com/openzim/zimit-frontend/pull/69, we have introduced i18n.

However, currently there is no tooling to ensure consistency:

advait-zx commented 1 month ago

Flag any keys that are present in the JSON files but not used in the code how can i contribute to this issue

benoit74 commented 1 month ago

I think we first need to check if such a tool does not already exist. Be aware that while all translated strings are stored in JSON files, they are used both in .vue and Jinja2 templates. They could theoretically soon be used in .py files.

If it does not exist, then I would suggest to develop a small Python script doing the job. Be aware that we need both directions, i.e. flag any keys present in the JSON but not used in the code AND flag any keys used in the code but not present in at least en and qqq JSON files.

This Python script should exit with non-zero exit code when problem(s) are detected, and we can add this script to invoke tasks.py and the the QA CI.

I will soon merge #69, so this will be easier to work on.

benoit74 commented 1 month ago

@advait-zx do you confirm you will work on it, shall I assign you the issue?

advait-zx commented 1 month ago

yeah but i will need help for this issue

benoit74 commented 1 month ago

Isn't what I've described a sufficient start point to make progress and if needed prepare a PR? If not unfortunately I can't help more than that.