Create a CI script to detect missing i18n keys across locales
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 76/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- node.js, typescript
Research direction
Start by inspecting the locale files under packages/i18n/src/locales/, using en-US.ts as the reference, and check the repository's package.json scripts. Create the requested script to recursively report missing keys and run it with the check:i18n command. Done means missing keys are identified per locale and the command exits with code 1 when any are found.
Written by the indexing model from the issue text.
Description
Currently there's no automated way to check if all locale files have the same keys. We'd like a script that runs in CI.
What to do:
- Create
scripts/check-i18n-keys.mjs(the repo's scripts are zx-based.mjsfiles, see existingscripts/*.mjs) - The script should:
- Load all locale namespace files from
packages/i18n/src/locales/<locale>/*.ts(each locale is a directory of namespace files likecommon.ts,agent.ts, ... — not a single file) - Recursively compare all object keys against
en-US(the reference) - Report missing keys per locale
- Exit with code 1 if any keys are missing
- Load all locale namespace files from
- Add it to
package.jsonscripts:"check:i18n": "node scripts/check-i18n-keys.mjs" - Optionally add to CI workflow
Skills needed: TypeScript/Node.js, basic object traversal
Estimated time: 2-3 hours
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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 nutstore/eo2weave
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
good first issue help wanted
Difficulty 2/5 Under an hour Newbie friendliness 68/100
-
good first issue help wanted
Difficulty 2/5 Under an hour Newbie friendliness 75/100
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
documentation good first issue help wanted
Difficulty 2/5 Half a day Newbie friendliness 82/100
All issues in nutstore/eo2weave
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100