internationalization-rs/README.md

71 lines
2.2 KiB
Markdown
Raw Normal View History

2019-10-03 11:56:43 +00:00
# Internationalization
2019-10-09 00:37:41 +00:00
![LICENSE](https://img.shields.io/crates/l/internationalization)
[![Crates.io Version](https://img.shields.io/crates/v/internationalization.svg)](https://crates.io/crates/internationalization)
[![Coverage Status](https://coveralls.io/repos/github/terry90/internationalization-rs/badge.svg?branch=master)](https://coveralls.io/github/terry90/internationalization-rs?branch=master)
2019-10-09 00:41:34 +00:00
[![Build Status](https://travis-ci.org/terry90/internationalization-rs.svg?branch=master)](https://travis-ci.org/terry90/internationalization-rs)
2019-10-09 00:37:41 +00:00
An simple compile time i18n implementation in Rust.
It throws a compilation error if the translation key is not present, but since the `lang` argument is dynamic it will panic if the language has not been added for the matching key.
2019-10-03 11:56:43 +00:00
> API documentation [https://crates.io/crates/internationalization](https://crates.io/crates/internationalization)
## Usage
2019-10-09 00:37:41 +00:00
Have a `locales/` folder somewhere in your app, root, src, anywhere. with `.json` files, nested in folders or not.
It uses a glob pattern: `**/locales/**/*.json` to match your translation files.
the files must look like this:
```json
{
"err.answer.all": {
"fr": "Échec lors de la récupération des réponses",
"en": "Failed to retrieve answers"
},
"err.answer.delete.failed": {
"fr": "Échec lors de la suppression de la réponse",
"en": "Failed to delete answer"
}
}
```
Any number of languages can be added, but you should provide them for everything since it will panic if a language is not found when queried for a key.
In your app, jsut call the `t!` macro
2019-10-03 11:56:43 +00:00
```rust
fn main() {
2019-10-09 00:37:41 +00:00
let lang = "en";
let res = t!("err.not_allowed", lang);
2019-10-03 11:56:43 +00:00
assert_eq!("You are not allowed to do this", res);
}
```
2019-10-09 00:37:41 +00:00
## Installation
Internationalization is available on [crates.io](https://crates.io/crates/internationalization), include it in your `Cargo.toml`:
```toml
[dependencies]
internationalization = "0.0.2"
```
Then include it in your code like this:
```rust
#[macro_use]
extern crate internationalization;
```
Or use the macro where you want to use it:
```rust
use internationalization::t;
```
## Note
Internationalization will not work if no `PWD` env var is set at compile time.