11个版本 (4个重大更新)

0.5.0 2023年8月29日
0.4.2 2023年4月30日
0.4.0 2023年2月7日
0.3.2 2023年1月10日
0.1.0 2022年12月22日

#1586 in 过程宏


用于 r18

MIT 协议

27KB
482 行代码

🔞

crate.io docs build

r18 是一个旨在简化Rust项目国际化过程的库。

最低支持版本 >= 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 以获取更多选项。

致谢

依赖项

~0.8–8.5MB
~73K SLoC