| # Fluent |
| |
| `fluent-rs` is a Rust implementation of [Project Fluent][], a localization |
| framework designed to unleash the entire expressive power of natural language |
| translations. |
| |
| [](https://crates.io/crates/fluent-bundle) |
| [](https://github.com/projectfluent/fluent-rs/actions/workflows/test.yaml) |
| [](https://coveralls.io/github/projectfluent/fluent-rs?branch=main) |
| |
| Project Fluent keeps simple things simple and makes complex things possible. |
| The syntax used for describing translations is easy to read and understand. At |
| the same time it allows, when necessary, to represent complex concepts from |
| natural languages like gender, plurals, conjugations, and others. |
| |
| [Documentation][] |
| |
| [Project Fluent]: http://projectfluent.org |
| [Documentation]: https://docs.rs/fluent/ |
| |
| Usage |
| ----- |
| |
| ```rust |
| use fluent_bundle::{FluentBundle, FluentResource}; |
| use unic_langid::langid; |
| |
| fn main() { |
| let ftl_string = "hello-world = Hello, world!".to_owned(); |
| let res = FluentResource::try_new(ftl_string) |
| .expect("Could not parse an FTL string."); |
| |
| let langid_en = langid!("en"); |
| let mut bundle = FluentBundle::new(vec![langid_en]); |
| |
| bundle.add_resource(&res) |
| .expect("Failed to add FTL resources to the bundle."); |
| |
| let msg = bundle.get_message("hello-world") |
| .expect("Failed to retrieve a message."); |
| let val = msg.value.expect("Message has no value."); |
| |
| let mut errors = vec![]; |
| let value = bundle.format_pattern(val, None, &mut errors); |
| |
| assert_eq!(&value, "Hello, world!"); |
| } |
| ``` |
| |
| |
| Status |
| ------ |
| |
| The implementation is in its early stages and supports only some of the Project |
| Fluent's spec. Consult the [list of milestones][] for more information about |
| release planning and scope. |
| |
| [list of milestones]: https://github.com/projectfluent/fluent-rs/milestones |
| |
| |
| Local Development |
| ----------------- |
| |
| cargo build |
| cargo test |
| cargo bench |
| cargo run --example simple-app |
| |
| When submitting a PR please use [`cargo fmt`][] (nightly). |
| |
| [`cargo fmt`]: https://github.com/rust-lang-nursery/rustfmt |
| |
| |
| Learn the FTL syntax |
| -------------------- |
| |
| FTL is a localization file format used for describing translation resources. |
| FTL stands for _Fluent Translation List_. |
| |
| FTL is designed to be simple to read, but at the same time allows to represent |
| complex concepts from natural languages like gender, plurals, conjugations, and |
| others. |
| |
| hello-user = Hello, { $username }! |
| |
| [Read the Fluent Syntax Guide][] in order to learn more about the syntax. If |
| you're a tool author you may be interested in the formal [EBNF grammar][]. |
| |
| [Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ |
| [EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec |
| |
| |
| Get Involved |
| ------------ |
| |
| `fluent-rs` is open-source, licensed under both the Apache 2.0 and MIT licenses. We |
| encourage everyone to take a look at our code and we'll listen to your |
| feedback. |
| |
| |
| Discuss |
| ------- |
| |
| We'd love to hear your thoughts on Project Fluent! Whether you're a localizer |
| looking for a better way to express yourself in your language, or a developer |
| trying to make your app localizable and multilingual, or a hacker looking for |
| a project to contribute to, please do get in touch on the mailing list and the |
| IRC channel. |
| |
| - Discourse: https://discourse.mozilla.org/c/fluent |
| - Matrix channel: <a href="https://chat.mozilla.org/#/room/#fluent:mozilla.org">#fluent:mozilla.org</a> |
