Skip to content

Commit

Permalink
Configure fluent-testing for publishing (#247)
Browse files Browse the repository at this point in the history
- Adds dual licence files
- Adds readme
- Adds appropriate metadata to Cargo.toml
  • Loading branch information
nordzilla authored Oct 27, 2022
1 parent 8fc7678 commit 9e62af6
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 6 deletions.
26 changes: 22 additions & 4 deletions fluent-testing/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
[package]
name = "fluent-testing"
version = "0.2.0"
authors = ["Zibi Braniecki <zibi@braniecki.net>"]
description = """
A collection of mock scenarios for testing fluent-rs components.
"""
version = "0.0.2"
authors = [
"Zibi Braniecki <zibi@braniecki.net>",
"Erik Nordin <enordin@mozilla.com>"
]
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
homepage = "https://www.projectfluent.org"
license = "Apache-2.0/MIT"
repository = "https://github.com/projectfluent/fluent-rs"
readme = "README.md"
keywords = ["localization", "l10n", "i18n", "intl", "internationalization"]
categories = ["localization", "internationalization"]
include = [
"src/**/*",
"resources/**/*",
"Cargo.toml",
"README.md",
"LICENSE-APACHE",
"LICENSE-MIT"
]

[dependencies]
fluent-bundle = { version = "0.15.2", path = "../fluent-bundle" }
Expand Down
1 change: 1 addition & 0 deletions fluent-testing/LICENSE-APACHE
1 change: 1 addition & 0 deletions fluent-testing/LICENSE-MIT
74 changes: 74 additions & 0 deletions fluent-testing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Fluent

`fluent-testing` is a collection of mock scenarios for testing fluent-rs components.

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]: https://projectfluent.org
[Documentation]: https://docs.rs/fluent/

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 run --example simple-fallback

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]: https://projectfluent.org/fluent/guide/
[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec


Get Involved
------------

`fluent-rs` is open-source, licensed under the Apache License, Version 2.0. 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
- IRC channel: [irc://irc.mozilla.org/l20n](irc://irc.mozilla.org/l20n)
2 changes: 1 addition & 1 deletion fluent-testing/src/scenarios/empty_resource_all_locales.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use crate::queries;
/// effect on the ability to generate a bundle and look up other present values.
pub fn get_scenario() -> Scenario {
Scenario::new(
"empty",
"empty_resource_all_locales",
vec![
FileSource::new("browser", "browser/{locale}/", vec!["en-US", "pl"]),
FileSource::new("empty", "empty-resource/{locale}/", vec!["en-US", "pl"]),
Expand Down
2 changes: 1 addition & 1 deletion fluent-testing/src/scenarios/empty_resource_one_locale.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use crate::queries;
/// only for that value.
pub fn get_scenario() -> Scenario {
Scenario::new(
"empty",
"empty_resource_one_locale",
vec![
FileSource::new("browser", "browser/{locale}/", vec!["en-US", "pl"]),
FileSource::new("empty", "empty-resource/{locale}/", vec!["en-US", "pl"]),
Expand Down

0 comments on commit 9e62af6

Please sign in to comment.