Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magiclen/json-gettext
A library for getting text from JSON usually for internationalization.
https://github.com/magiclen/json-gettext
gettext internationalization json localization rocket rust
Last synced: 28 days ago
JSON representation
A library for getting text from JSON usually for internationalization.
- Host: GitHub
- URL: https://github.com/magiclen/json-gettext
- Owner: magiclen
- License: mit
- Created: 2018-08-21T07:17:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-10T09:58:30.000Z (about 1 year ago)
- Last Synced: 2024-05-03T04:47:48.684Z (8 months ago)
- Topics: gettext, internationalization, json, localization, rocket, rust
- Language: Rust
- Homepage:
- Size: 114 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JSON Get Text
====================
[](https://github.com/magiclen/json-gettext/actions/workflows/ci.yml)
This is a library for getting text from JSON usually for internationalization.
## Example
```rust
#[macro_use] extern crate json_gettext;
let ctx = static_json_gettext_build!(
"en_US";
"en_US" => "langs/en_US.json",
"zh_TW" => "langs/zh_TW.json"
).unwrap();
assert_eq!("Hello, world!", get_text!(ctx, "hello").unwrap());
assert_eq!("哈囉，世界！", get_text!(ctx, "zh_TW", "hello").unwrap());
```
## Rocket Support
This crate supports the Rocket framework. In order to reload changed json files instead of recompiling the program you have to enable the `rocket` feature for this crate.
```toml
[dependencies.json-gettext]
version = "*"
features = ["rocket"]
```
Then, use the `static_json_gettext_build_for_rocket` macro instead of the `static_json_gettext_build` macro to build a `JSONGetText`(`JSONGetTextManager`).
```rust
#[macro_use] extern crate json_gettext;
#[macro_use] extern crate rocket;
use rocket::State;
use rocket::response::Redirect;
use json_gettext::JSONGetTextManager;
#[get("/")]
fn index(ctx: &State) -> Redirect {
Redirect::temporary(uri!(hello(lang = ctx.get_default_key())))
}
#[get("/")]
fn hello(ctx: &State, lang: String) -> String {
format!("Ron: {}", get_text!(ctx, lang, "hello").unwrap().as_str().unwrap())
}
#[launch]
fn rocket() -> _ {
rocket::build()
.attach(static_json_gettext_build_for_rocket!(
"en_US";
"en_US" => "langs/en_US.json",
"zh_TW" => "langs/zh_TW.json"
))
.mount("/", routes![index, hello])
}
```
If you are not using the `release` profile, `JSONGetTextManager` can reload the json files automatically if needed.
## `unic-langid` Support
Since string comparison could be slow, the `language_region_pair` feature, the `language` feature or the `region` feature can be enabled to change key's type to `(Language, Option)`, `Language` or `Region` respectively where `Language` and `Region` structs are in the `unic-langid` crate.
In this case, the `key!` macro would be useful for generating a `Key` instance from a literal string.
For example,
```toml
[dependencies.json-gettext]
version = "*"
features = ["language_region_pair", "rocket"]
```
```rust
#[macro_use]
extern crate rocket;
#[macro_use]
extern crate rocket_accept_language;
#[macro_use]
extern crate json_gettext;
use rocket::State;
use rocket_accept_language::unic_langid::subtags::Language;
use rocket_accept_language::AcceptLanguage;
use json_gettext::{JSONGetTextManager, Key};
const LANGUAGE_EN: Language = language!("en");
#[get("/")]
fn index(ctx: &State, accept_language: &AcceptLanguage) -> String {
let (language, region) = accept_language.get_first_language_region().unwrap_or((LANGUAGE_EN, None));
format!("Ron: {}", get_text!(ctx, Key(language, region), "hello").unwrap().as_str().unwrap())
}
#[launch]
fn rocket() -> _ {
rocket::build()
.attach(static_json_gettext_build_for_rocket!(
key!("en");
key!("en") => "langs/en_US.json",
key!("zh_TW") => "langs/zh_TW.json",
))
.mount("/", routes![index])
}
```
## Crates.io
https://crates.io/crates/json-gettext
## Documentation
https://docs.rs/json-gettext
## License
[MIT](LICENSE)