[Project Fluent] Basic internationalization support (would close PR #2553)

crates/atuin-client/Cargo.toml

@@ -4,7 +4,7 @@ edition = "2024"
 description = "client library for atuin"
 
 rust-version = { workspace = true }
-version = { workspace = true }
+version = "18.5.0-beta.2"
 authors = { workspace = true }
 license = { workspace = true }
 homepage = { workspace = true }
@@ -20,6 +20,7 @@ check-update = []
 
 [dependencies]
 atuin-common = { path = "../atuin-common", version = "18.5.0-beta.2" }
+atuin-macro = { path = "../atuin-macro", version = "18.5.0-beta.2" }
 
 log = { workspace = true }
 base64 = { workspace = true }
@@ -73,6 +74,11 @@ palette = { version = "0.7.5", features = ["serializing"] }
 lazy_static = "1.4.0"
 strum_macros = "0.26.3"
 strum = { version = "0.26.2", features = ["strum_macros"] }
+fluent = "0.16.1"
+i18n-embed = { version = "0.15.3", features = ["autoreload", "desktop-requester", "filesystem-assets", "fluent", "fluent-syntax", "fluent-system", "gettext-system", "locale_config", "notify", "tr", "walkdir"] }
+rust-embed = "8"
+i18n-embed-fl = "0.9.3"
+cargo-i18n = "0.2.13"
 
 [dev-dependencies]
 tokio = { version = "1", features = ["full"] }

crates/atuin-common/Cargo.toml

@@ -4,7 +4,7 @@ edition = "2024"
 description = "common library for atuin"
 
 rust-version = { workspace = true }
-version = { workspace = true }
+version = "18.5.0-beta.2" # required to be concrete for cargo i18n
 authors = { workspace = true }
 license = { workspace = true }
 homepage = { workspace = true }
@@ -13,6 +13,8 @@ repository = { workspace = true }
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+atuin-macro = { path = "../atuin-macro" }
+
 time = { workspace = true }
 serde = { workspace = true }
 uuid = { workspace = true }
@@ -25,8 +27,14 @@ directories = { workspace = true }
 sysinfo = "0.30.7"
 base64 = { workspace = true }
 getrandom = "0.2"
+sys-locale = "0.3.2"
 
 lazy_static = "1.4.0"
+i18n-embed = { version = "0.15.3", features = ["fluent", "fluent-system", "tr", "locale_config", "desktop-requester", "walkdir", "gettext-system", "autoreload", "filesystem-assets", "notify"] }
+rust-embed = "8"
+i18n-embed-fl = "0.9.3"
+slugify = "0.1.0"
+paste = "1.0.15"
 
 [dev-dependencies]
 pretty_assertions = { workspace = true }

crates/atuin-common/i18n.toml

@@ -0,0 +1,13 @@
+# (Required) The language identifier of the language used in the
+# source code for gettext system, and the primary fallback language
+# (for which all strings must be present) when using the fluent
+# system.
+fallback_language = "en-US"
+
+# Use the fluent localization system.
+[fluent]
+domain = "atuin"
+# (Required) The path to the assets directory.
+# The paths inside the assets directory should be structured like so:
+# `assets_dir/{language}/{domain}.ftl`
+assets_dir = "../../i18n"

crates/atuin-common/src/i18n.rs

@@ -0,0 +1,37 @@
+use i18n_embed::{DesktopLanguageRequester, fluent::{
+    FluentLanguageLoader, fluent_language_loader
+}};
+use rust_embed::RustEmbed;
+pub use i18n_embed_fl::fl;
+
+#[derive(RustEmbed)]
+#[folder = "../../i18n"] // path to the compiled localization resources
+struct Localizations;
+
+use lazy_static::lazy_static;
+pub use atuin_macro::tl;
+
+lazy_static! {
+    pub static ref LOADER: FluentLanguageLoader = {
+        // Load languages from central internationalization folder.
+        let language_loader: FluentLanguageLoader = fluent_language_loader!();
+        let requested_languages = DesktopLanguageRequester::requested_languages();
+
+        let _result = i18n_embed::select(
+            &language_loader, &Localizations, &requested_languages);
+        language_loader
+    };
+}
+
+#[macro_export]
+macro_rules! t {
+    ($message_id:literal) => {
+        $crate::i18n::tl!($crate::i18n::fl, $crate::i18n::LOADER, $message_id)
+    };
+
+    ($message_id:literal, $($args:expr),*) => {{
+        $crate::i18n::tl!($crate::i18n::fl, $crate::i18n::LOADER, $message_id, $($args), *)
+    }};
+}
+
+pub use t;

crates/atuin-common/src/lib.rs

@@ -57,3 +57,4 @@ pub mod api;
 pub mod record;
 pub mod shell;
 pub mod utils;
+pub mod i18n;

crates/atuin-macro/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name = "atuin-macro"
+edition = "2021"
+description = "macro library for atuin"
+
+rust-version = { workspace = true }
+version = "18.5.0-beta.2"
+authors = { workspace = true }
+license = { workspace = true }
+homepage = { workspace = true }
+repository = { workspace = true }
+
+[lib]
+proc-macro = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+time = { workspace = true }
+serde = { workspace = true }
+uuid = { workspace = true }
+typed-builder = { workspace = true }
+eyre = { workspace = true }
+sqlx = { workspace = true }
+semver = { workspace = true }
+thiserror = { workspace = true }
+directories = { workspace = true }
+sysinfo = "0.30.7"
+base64 = { workspace = true }
+getrandom = "0.2"
+sys-locale = "0.3.2"
+
+lazy_static = "1.4.0"
+i18n-embed = { version = "0.15.3", features = ["fluent", "fluent-system", "tr", "locale_config", "desktop-requester", "walkdir", "gettext-system", "autoreload", "filesystem-assets", "notify"] }
+rust-embed = "8"
+i18n-embed-fl = "0.9.3"
+slugify = "0.1.0"
+paste = "1.0.15"
+syn = "2.0.96"
+quote = "1.0.38"
+proc-macro2 = "1.0.93"

crates/atuin-macro/src/lib.rs

@@ -0,0 +1,52 @@
+#![forbid(unsafe_code)]
+extern crate proc_macro;
+
+use proc_macro::TokenStream;
+use quote::quote;
+use syn;
+use syn::parse::Parser;
+use slugify::slugify;
+
+#[proc_macro]
+pub fn tl(tokens: TokenStream) -> TokenStream {
+    let args = syn::punctuated::Punctuated::<syn::Expr, syn::Token![,]>::parse_terminated.parse(tokens).unwrap();
+    let mut arg_iter = args.iter();
+    let fl = arg_iter.next().unwrap();
+    let loader = arg_iter.next().unwrap();
+    let message_id: proc_macro2::TokenStream = match arg_iter.next() {
+        Some(syn::Expr::Group(arg)) => {
+            match *arg.expr.clone() {
+                syn::Expr::Lit(arg) => {
+                    let quoted: String = match arg.lit.clone() {
+                        syn::Lit::Str(message_id) => message_id.value(),
+                        _ => panic!("Message ID must be a literal string")
+                    };
+                    let slug = slugify!(quoted.as_str());
+                    quote!(#slug)
+                },
+                arg => panic!("Message ID {:?} must be a literal", arg)
+            }
+        },
+        Some(syn::Expr::Lit(arg)) => {
+            let quoted: String = match arg.lit.clone() {
+                syn::Lit::Str(message_id) => message_id.value(),
+                _ => panic!("Message ID must be a literal string")
+            };
+            let slug = slugify!(quoted.as_str());
+            quote!(#slug)
+        },
+        arg => panic!("Message ID {:?} must be a literal", arg)
+    };
+    let args: Vec<_> = arg_iter.collect();
+
+    if args.is_empty() {
+        TokenStream::from(quote!(
+            #fl!(#loader, #message_id)
+        ))
+    } else {
+        TokenStream::from(quote!(
+            #fl!(#loader, #message_id, #(#args),*)
+        ))
+    }
+}
+

crates/atuin/Cargo.toml

@@ -5,7 +5,7 @@ description = "atuin - magical shell history"
 readme = "./README.md"
 
 rust-version = { workspace = true }
-version = { workspace = true }
+version = "18.5.0-beta.2"
 authors = { workspace = true }
 license = { workspace = true }
 homepage = { workspace = true }
@@ -80,6 +80,9 @@ tracing-subscriber = { workspace = true }
 uuid = { workspace = true }
 sysinfo = "0.30.7"
 regex = "1.10.5"
+i18n-embed = { version = "0.15.3", features = ["fluent", "fluent-system", "tr", "locale_config", "desktop-requester", "walkdir", "gettext-system", "autoreload", "filesystem-assets", "notify"] }
+rust-embed = "8"
+i18n-embed-fl = "0.9.3"
 
 [target.'cfg(any(target_os = "windows", target_os = "macos"))'.dependencies]
 arboard = { version = "3.4", optional = true }

crates/atuin/i18n.toml

@@ -0,0 +1,14 @@
+# (Required) The language identifier of the language used in the
+# source code for gettext system, and the primary fallback language
+# (for which all strings must be present) when using the fluent
+# system.
+fallback_language = "en-US"
+
+# Use the fluent localization system.
+[fluent]
+domain = "atuin"
+
+# (Required) The path to the assets directory.
+# The paths inside the assets directory should be structured like so:
+# `assets_dir/{language}/{domain}.ftl`
+assets_dir = "../../i18n"

crates/atuin/src/command/external.rs

@@ -54,7 +54,11 @@ fn render_not_found(subcommand: &str, bin: &str) -> StyledStr {
     let _ = write!(output, "{error}error:{error:#} ");
     let _ = write!(
         output,
-        "unrecognized subcommand '{invalid}{subcommand}{invalid:#}' "
+        "{} ",
+        t!(
+            "unrecognized subcommand '%{subcommand}'",
+            subcommand = format!("{invalid}{subcommand}{invalid:#}")
+        )
     );
     let _ = write!(
         output,

crates/atuin/src/main.rs

@@ -1,5 +1,7 @@
 #![warn(clippy::pedantic, clippy::nursery)]
 #![allow(clippy::use_self, clippy::missing_const_for_fn)] // not 100% reliable
+#[macro_use]
+extern crate atuin_common;
 
 use clap::Parser;
 use eyre::Result;

i18n/en-GB/atuin.ftl

@@ -0,0 +1,2 @@
+unrecognized-subcommand-subcommand =
+  unrecognised subcommand '{ $subcommand }'

i18n/en-US/atuin.ftl

@@ -0,0 +1,2 @@
+unrecognized-subcommand-subcommand =
+  unrecognized subcommand '{ $subcommand }'