Starting with localization
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
TL;DR: I want to add a new util for locale generation and provide locale-aware functionality in uucore
uutils is currently following the C locale for most of its operations and the locale settings of the system are mostly ignored. This has led to issues and PRs like these:
- https://github.com/uutils/coreutils/issues/3584
- https://github.com/uutils/coreutils/issues/3123
- https://github.com/uutils/coreutils/issues/2149
- https://github.com/uutils/coreutils/issues/3132
- https://github.com/uutils/coreutils/issues/1872 (much locale-related missing functionality)
We've mostly been putting this off due to missing libraries in Rust, but recently, this has changed with the release of icu4x. It covers many of the things we need like locale-aware datetime formatting, locale-aware collation, etc..
However, it requires data to operate on, which is different from the usual data generated by locale-gen and friends (if I understand correctly). There are essentially 2 viable ways to include data with icu4x[^1]:
- Store a blob on the filesystem to read at runtime (
BlobDataProvider). - Encode the data as Rust code included in the binary (
BakedDataProvider).
Since we don't know up front what locales we might need, I think we need to use the BlobDataProvider and allow the user to generate their own locale data on command. So, I propose we do the following:
- Add a new util, called
locale-genor something similar- This util downloads and stores the locale data in a global directory (I'm not sure where, could also be controlled by an environment variable).
- This util would be a wrapper around the
icu_datagencrate[^2]. - It could also read from system config files and install any necessary locales based on the system config automatically.
- Since this util needs access to the internet, we will run into similar issues like we did with
uudocback when it automatically downloaded examples, so it needs to be optional.[^3]
- Create locale-aware functionality in
uucoreas much as possible, so that the utils themselves don't have to bother with checking the right environment variables, loading the icu data, etc..- For example, to check the collation locale, the
LC_COLLATE,LC_ALLandLANGenv vars need to be checked. - For the utils, we then just expose a
sort/collatefunction that checks (and caches) the locale and performs the correct collation.
- For example, to check the collation locale, the
- Change the utils to use the locale-aware functions provided by
uucore.
Do you see any problems with this approach? Are there alternatives we should explore first?
[^1]: They also have FsDataProvider which is meant for development only.
[^2]: This crate also has a CLI, but we need to tailor it for use with coreutils, by setting nicer defaults for our purpose.
[^3]: icu_datagen uses reqwest, which will lead to similar problems as in https://github.com/uutils/coreutils/pull/3184
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 reviewing the existing uucore locale handling and the icu_datagen crate and CLI described in the issue; no specific files or tests are identified. Compare the proposed locale-gen, data storage, optional networking, environment-variable handling, and locale-aware uucore APIs, then establish an agreed design and implementation scope before coding.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, localization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100