feat(i18n): enhance types

[olafsulich]

Description

Automatically generates types for internalization file (en-US.json). The script runs on the server start and on a file change (webpack / hot reload). Every change to the en-US.json will cause an update of i18n.d.ts.

The t function now checks for dynamic value types. There's also a unified syntax for passing variables, we eliminate multiple ways (with an object and without) of passing dynamic values. Works with single and multiple values.

What it means?

• the only allowed variables would be those presented in the translation text
• ts will let us know when we forgot to pass a variable / pass a wrong one / pass a variable for a text that doesn't have specified one

Before:

// en-US.json
{
 hi: 'hi',
 hello: 'hello {text}'
}

---

t('hi') // ✅ <-- correct

t('hi', 'world') // ✅ <-- incorrect, doesn't throw an error
t('hi', {name: 'world'}) // ✅ <-- incorrect, doesn't throw an error

---

t('hello', 'world') // ✅ <-- correct
t('hello', {text: 'world'}) // ✅ <-- correct

t('hello', {name: 'world'}) // ✅ <-- incorrect, doesn't throw an error
t('hello') // ✅ <-- incorrect, doesn't throw an error

After:

// en-US.json
{
 hi: 'hi',
 hello: 'hello {text}'
}

---

t('hi') // ✅ <-- correct

t('hi', 'world') // ❌ <-- incorrect, throws an error (redundant argument, wrong syntax)
t('hi', {name: 'world'}) // ❌ <-- incorrect, throws an error (redundant argument)

---

t('hello', {text: 'world'}) // ✅ <-- correct

t('hello', 'world') // ❌ <-- incorrect, throws an error (wrong syntax)
t('hello', {name: 'world'}) // ❌ <-- incorrect, throws an error (wrong value "name")
t('hello') // ❌ <-- incorrect, throws an error (missing value)

I've fixed many places to use the new way. I've left some places with @ts-expect-error - I don't want to break anything / it should be done in other PRs.

Checklist

• mentions the JIRA issue in the PR name (Ex. WPB-423)
• PR has been self reviewed by the author;
• Hard-to-understand areas of the code have been commented;
• If it is a core feature, unit tests have been added;

[olafsulich]

an important file

[olafsulich]

a lot of changes there, but it had to be done, because of the type, logic remains the same as it was

[olafsulich]

an important file

[olafsulich]

unfortunately, the args are mandatory here (instead of typing each parameter separately), because we have to mark substitutions either optional (the ? sign) with undefined type, or required with the Substitutions<Id> type

[olafsulich]

an important file

[olafsulich]

i've thought about creating a normal .ts file, but IMO .d.ts is fine in this case

the normal .ts file would require additional import + type assertion the json

[olafsulich]

an important file

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 47.56098% with 43 lines in your changes missing coverage. Please review.

Project coverage is 46.55%. Comparing base (f2c0cf6) to head (38e6b37).
Report is 2 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev   #18347      +/-   ##
==========================================
- Coverage   46.56%   46.55%   -0.02%     
==========================================
  Files         834      834              
  Lines       26016    26029      +13     
  Branches     5905     5905              
==========================================
+ Hits        12114    12117       +3     
- Misses      12387    12395       +8     
- Partials     1515     1517       +2     

[przemvs]

LGTM!

[sonarqubecloud]

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.8% Duplication on New Code

See analysis details on SonarQube Cloud