Add validate method to `lit-localize` so that missing tranlsations can be caught before release
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21.8k
- Forks
- 1.1k
- Avg merge
- 18h 25m
- Merged PRs (30d)
- 2
Description
Should this be an RFC?
- This is not a substantial change
Which package is this a feature request for?
Localize (@lit/localize)
Description
Ideally lit should have some way to lint xliff translations to catch missing ones before a product is released through through a CI check. Maybe a command like:
lit-localize check that will return a non-zero exit code if a translation is missing.
I'm happy to pick this up if someone wants to assign it to me so I can keep track.
Alternatives and Workarounds
I'm not seeing a lot of xliff check stuff in my initial searches. Maybe the easiest workaround is to manually write a checker using an xml parser.
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.
Research direction
Start by locating the @lit/localize package's CLI entry point and its existing XLIFF translation handling. Define the validation behavior around the proposed lit-localize check command, including a non-zero exit code when translations are missing, and verify it with tests for complete and incomplete XLIFF input.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, localization
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100