Localization support
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- cli, internationalization
Research direction
Start by reviewing the existing i18n branch and the ParametricBuilder and CommandGraph entry points mentioned in the issue, then trace hard-coded runtime messages and command annotation descriptions and help. Compare the proposed Java ResourceBundle approach with current behavior and the discussion in the nine comments. Done requires an agreed, flexible localization design covering internal messages and external command text.
Written by the indexing model from the issue text.
Description
Intake should provide some sort of support for localizations. This affects two fields:
- Internal localization: All hard-coded strings should be externalized in a Java ResourceBundle and some behaviour might need to be updated in order to work as expected in an localized environment. Some points might need discussion:
- Intake has several internal runtime exceptions that the end-user should never see (e.g.
ParametricException). These might not need localization. - It might be a good idea to allow users to alter or replace the internal localization logic by providing custom translations. In that case the two entry points are
ParametricBuilderandCommandGraph.
- Intake has several internal runtime exceptions that the end-user should never see (e.g.
- External localization: The values in command annotations, specifically description and help, need localization support. The entry point here is the
ParametricBuilder.- If localizations use key -> value relationships, as enforced by Java resource bundles, description and help methods would need to return the key. This contradicts the current behaviour where both methods return the actual value, so a support for that old, non localised behaviour is needed.
On both fields, the support should be as flexible as possible and do not enforce any specific way of handling Locales on the user.
Since I need localization support in MyWarp, I have implemented a limited localization support in my own Intake fork (i18n branch). I would be happy to contribute these changes in a PR so there is something to discuss about, if the general direction fits.
- Dominant language
- Java
- Stars
- 102
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from EngineHub/Intake
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
All issues in EngineHub/Intake
Similar issues
-
component/data-layer
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
-
RegistryExceptionHandler uses self-referencing basePackageClasses instead of a controller classOpenbug finsim-registry good-first-issue
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
? - Needs Triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
NVIDIA/cudf-spark#17063 ·
Maintainers usually reply within 2 days
-
status:pending type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100