#本地化

r18

一个简单的 Rust 国际化包

9 个版本 (4 个破坏性版本)

0.5.0 2023年8月29日
0.4.3 2023年4月30日
0.4.1 2023年3月5日
0.4.0 2023年2月7日
0.1.0 2022年12月22日

#120 in 国际化(i18n)

MIT 许可证

12KB
97

🔞

crate.io docs build

r18 是一个旨在简化 Rust 项目国际化的包。

MSRV >= 1.70.0 (稳定版)

用法

r18 添加为您的项目依赖项

[dependencies]
r18 = "*"

创建一个符合 IETF BCP 47 语言标签的 JSON 翻译文件,例如以下(您可以通过 CLI 工具 生成它)

// PATH: ./tr/zh-CN.json
{
    "Hello, {}": "你好,{}"
}

然后将 r18::init! 添加到代码的全局作用域中,其中包含翻译文件所在的目录(以下示例为 ./tr)。

r18::init!("tr");

初始化 r18 后,使用 auto_detect! 自动检测区域设置并加载翻译模型。
如果您想,您还可以使用 set_locale! 手动设置区域设置。
上述过程完成后,使用 tr! 获取已翻译的文本。

r18::init!("tr");

fn main() {
    r18::auto_detect!(); // get locale & set

    let name = "ho-229";
    println!("{}", tr!("Hello, {}", name));

    // reset locale to disable translation
    r18::set_locale!("");
    assert_eq!("Hello, ho-229", tr!("Hello, {}", name));
}

回退配置

有时您的翻译可能与用户的区域设置不完全匹配,但通常,这并不意味着您的翻译不能使用。在这种情况下,我们需要回退功能。

默认情况下,如果翻译与用户的区域设置不匹配,r18 将回退到最高字母顺序的相同语言的翻译。

您还可以在放置其他翻译文件的 config.json 中指定语言的回退翻译。

示例。

{
    "fallback": {
        "zh": "zh-TW"
    }
}

您可以在 这里 找到一个完整的示例。您可以使用以下命令运行示例

cargo run -p example

CLI 工具使用方法

运行以下命令安装 cargo r18

cargo install cargo-r18

创建翻译目录并按上述方式编写代码后,您可以使用以下命令生成翻译文件(例如 TODO.zh-CN.json)

cargo r18 generate zh-CN

此外,您可以通过

cargo r18 update

限制: cargo r18 只扫描名为 inittr 的宏,它无法识别哪些属于 r18 或不属于,您在使用 cargo r18 之前应确保您的源代码中没有类似的宏。

运行 cargo r18 -h 以获取更多选项。

贡献者

依赖项

~4–13MB
~142K SLoC