4 stable releases
1.2.0 | Oct 6, 2023 |
---|---|
1.1.1 | Sep 15, 2023 |
1.1.0 | Sep 14, 2023 |
1.0.0 | Sep 14, 2023 |
#117 in Internationalization (i18n)
81KB
229 lines
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("translations", "en");
-
Translate your text:
localizer_rs::t!(config, "key", "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!("{:}", localizer_rs::t!(config, "error", "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.
Dependencies
~0.5–1MB
~20K SLoC