Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marek-g/rust-translation
Library for localization (text translation) of Rust applications.
https://github.com/marek-g/rust-translation
Last synced: about 2 months ago
JSON representation
Library for localization (text translation) of Rust applications.
- Host: GitHub
- URL: https://github.com/marek-g/rust-translation
- Owner: marek-g
- License: apache-2.0
- Created: 2020-09-16T19:40:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-23T09:49:42.000Z (over 4 years ago)
- Last Synced: 2024-10-31T11:47:08.094Z (2 months ago)
- Language: Rust
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# translation
[](https://crates.io/crates/translation)
[](https://docs.rs/translation)
[](https://github.com/marek-g/rust-translation/blob/master/LICENSE-APACHE)
[](https://github.com/marek-g/rust-translation/blob/master/LICENSE-MIT)
Library for localization (text translation) of Rust applications.
## Features
- Autodetect user's locale (Windows, Unix).
- Small size - it doesn't depend on `regex` (like `locale_config` does).
- The localization files are embedded in the binary.
- It looks for localization files in the file system first, so new localization files can be added without application recompilation.
- It works great with `cargo-i18n`.
## Minimal example:
```rust
use translation::{tr_init, tr};
#[derive(rust_embed::RustEmbed)]
#[folder = "i18n/mo"]
struct Translations;
fn main() {
tr_init!("locale", Translations);
println!("{}", tr!("Hello, world!"));
}
```
The files from `i18n/mo` source folder are embedded in the executable file. The `tr_init!` macro looks for (in the following order):
- `locale/{lang}/LC_MESSAGES/{module_name}.mo` in the file system
- `locale/{lang}/{module_name}.mo` in the file system
- `{lang}/LC_MESSAGES/{module_name}.mo` in the embedded `Translations` struct
- `{lang}/{module_name}.mo` in the embedded `Translations` struct
The `locale` folder is looked for relative to the application executable file.
For more examples how to use `tr!` macro (arguments, plurals, context etc.) please refer to [`tr`](https://crates.io/crates/tr) crate documentation.
## Dependencies
Current solution depends on the following crates:
- [`tr`](https://crates.io/crates/tr) - the `tr!` macro
- [`gettext`](https://crates.io/crates/gettext) - reimplementation of gettext in Rust
- [`rust_embed`](https://crates.io/crates/rust_embed) - to embed locale in executable file
The crate was born because the `tr` crate (version 0.1.3 at the time of writing) is missing the `tr_init!` macro when used with `gettext` crate. Instead of creating pull request for `tr` crate I started experimenting with new crate and embedding translation files. In the future I plan to add support also for reading .po files directly (so no compilation step of .po files will be required).
## Usage
_Note. This instruction uses `cargo-i18` tool. Please also read https://github.com/kellpossible/cargo-i18n for more information._
### Configuration Steps
Install required tools:
```shell script
cargo install xtr
cargo install cargo-i18n
```
Add the following to your `Cargo.toml` dependencies:
```toml
translation = "1"
```
Create an `i18n.toml` file in the root directory of your crate:
```toml
fallback_language = "en"
[gettext]
target_languages = ["pl"]
output_dir = "i18n"
```
Run `cargo i18n` tool:
```shell script
cargo i18n
```
It scans the code and creates and updates the localization files. You can run it every time you want to update your localization files or compile `po` files.