r18 0.2.0

A simply I18n crate for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# 🔞

[![crate.io](https://img.shields.io/crates/v/r18.svg)](https://crates.io/crates/r18)
[![docs](https://docs.rs/r18/badge.svg)](https://docs.rs/r18)
[![build](https://github.com/Limit-IM/r18/actions/workflows/rust.yml/badge.svg)](https://github.com/Limit-IM/r18/actions/workflows/rust.yml)

`r18` is a crate for internationalized Rust projects.

## Usage

Add `r18` to your project's dependencies.

```toml
[dependencies]
r18 = "0.1"
```

Create a `JSON` translation file whose name format is `BCP 47` language tag in a directory and write it as follows:

```json
// ./tr/zh-CN.json
{
    "Hello, {}": "你好，{}"
}
```

Then add `r18::init!` to the global area of your code with the translation file directory path (is `./tr` in this example) relative to your project root.

```rust
r18::init!("tr");
```

After initialization, use `auto_detect!` to detect locale and load translation model (optional, you can use `set_locale!` to set locale manually), then use `tr!` to translate your text which has been translated.

```rust
r18::init!("tr");

fn main() {
    r18::auto_detect!();

    let name = "ho-229";
    println!("{}", tr!("Hello, {}", name));

    // reset locale to disable translation
    r18::set_locale!("");
    assert_eq!("Hello, ho-229", tr!("Hello, {}", name));
}
```

For a complete example, you can see [here](./example/). you can run the example with:

```shell
cargo run -p example
```

## Alternative

* [rust-i18n](https://github.com/longbridgeapp/rust-i18n)