localizer-rs

Localizer helps localize (translate) your rust applications using json files.

About this project

Localizer is a tool to translate text using json files.

Installing

Run the following command to add the package to your dependencies:


$ cargo add localizer-rs
...

Git

To clone the repository locally using git run git clone https://github.com/ElBe-Development/localizer-rs.git.

Usage

To use localizer-rs, you need a directory (eg. translations) with your translations files (eg. en.json). You then need to follow these steps:

Import the localizer-rs crate:
```
use localizer_rs;
```

Create a new config object:


let config = localizer_rs::Config::new("DIRECTORY NAME", "LANGUAGE NAME");

Translate your text:


config.t("key", vec!["placeholder", "value"]);

Example

With the following en.json file.


{
    "error": "{{color.red}}{{bold}}Error:{{end}} Something went wrong: {{details}}."
}

And the following rust code.


use localizer_rs;

fn main() {
    let config: localizer_rs::Config = localizer_rs::Config::new("translations", "en");

    println!("{:}", config.t("error", vec![("details", "Path not found")]));
}

You will get the following output:


Error: Something went wrong: Path not found.

Where Error: is red and bold.

Contact

To contact us, get help or just chat with others, you can visit our discord server.

2.1 KiB Raw Blame History