[WIP] Added locales folder for translations and added translation to strings that are used

Author: florian-nagel

locales/app.yml

@@ -0,0 +1,34 @@
+_version: 2
+
+"Dry running:":
+  en: "Dry running:"
+"Rebooting...":
+  en: "Rebooting..."
+"Plugins upgraded":
+  en: "Plugins upgraded"
+"Would self-update":
+  en: "Would self-update"
+"Pulling":
+  en: "Pulling"
+"No Breaking changes":
+  en: "No Breaking changes"
+"in":
+  en: "in"
+"Dropping you to shell. Fix what you need and then exit the shell.":
+  en: "Dropping you to shell. Fix what you need and then exit the shell."
+"Topgrade launched in a new tmux session":
+  en: "Topgrade launched in a new tmux session"
+"Topgrade upgraded to ":
+  en: "Topgrade upgraded to "
+"Topgrade is up-to-date":
+  en: "Topgrade is up-to-date"
+"Updating modules...":
+  en: "Updating modules..."
+"Powershell Modules Update":
+  en: "Powershell Modules Update"
+"Powershell is not installed":
+  en: "Powershell is not installed"
+"Error detecting current distribution:":
+  en: "Error detecting current distribution:"
+"Error:":
+  en: "Error:"

src/breaking_changes.rs

@@ -18,6 +18,7 @@ use std::{
     path::PathBuf,
     str::FromStr,
 };
+use rust_i18n::t;
 
 /// Version string x.y.z
 static VERSION_STR: &str = env!("CARGO_PKG_VERSION");
@@ -121,9 +122,9 @@ pub(crate) fn print_breaking_changes() {
     let header = format!("Topgrade {VERSION_STR} Breaking Changes");
     print_separator(header);
     let contents = if BREAKINGCHANGES.is_empty() {
-        "No Breaking changes"
+        t!("No Breaking changes").to_string()
     } else {
-        BREAKINGCHANGES
+        BREAKINGCHANGES.to_string()
     };
     println!("{contents}\n");
 }

src/executor.rs

@@ -4,6 +4,7 @@ use std::path::Path;
 use std::process::{Child, Command, ExitStatus, Output};
 
 use color_eyre::eyre::Result;
+use rust_i18n::t;
 use tracing::debug;
 
 use crate::command::CommandExt;
@@ -209,7 +210,8 @@ pub struct DryCommand {
 impl DryCommand {
     fn dry_run(&self) {
         print!(
-            "Dry running: {} {}",
+            "{} {} {}",
+            t!("Dry running:"),
             self.program.to_string_lossy(),
             shell_words::join(
                 self.args
@@ -219,7 +221,7 @@ impl DryCommand {
             )
         );
         match &self.directory {
-            Some(dir) => println!(" in {}", dir.to_string_lossy()),
+            Some(dir) => println!(" {} {}", t!("in"), dir.to_string_lossy()),
             None => println!(),
         };
     }

src/main.rs

@@ -18,6 +18,7 @@ use etcetera::base_strategy::Windows;
 #[cfg(unix)]
 use etcetera::base_strategy::Xdg;
 use once_cell::sync::Lazy;
+use rust_i18n::{i18n, t};
 use tracing::debug;
 
 use self::config::{CommandLineArgs, Config, Step};
@@ -54,6 +55,8 @@ pub(crate) static XDG_DIRS: Lazy<Xdg> = Lazy::new(|| Xdg::new().expect("No home
 #[cfg(windows)]
 pub(crate) static WINDOWS_DIRS: Lazy<Windows> = Lazy::new(|| Windows::new().expect("No home directory"));
 
+i18n!("locales", fallback = "en");
+
 fn run() -> Result<()> {
     install_color_eyre()?;
     ctrlc::set_handler();
@@ -97,7 +100,7 @@ fn run() -> Result<()> {
     };
 
     if opt.show_config_reference() {
-        print!("{}", config::EXAMPLE_CONFIG);
+        print!("{}", config::EXAMPLE_CONFIG); // TODO: Find a way to use a translated example config
         return Ok(());
     }
 
@@ -210,7 +213,7 @@ fn run() -> Result<()> {
                 runner.execute(Step::System, "System update", || distribution.upgrade(&ctx))?;
             }
             Err(e) => {
-                println!("Error detecting current distribution: {e}");
+                println!("{} {e}", t!("Error detecting current distribution:"));
             }
         }
         runner.execute(Step::ConfigUpdate, "config-update", || linux::run_config_update(&ctx))?;
@@ -524,7 +527,7 @@ fn main() {
                 // The `Debug` implementation of `eyre::Result` prints a multi-line
                 // error message that includes all the 'causes' added with
                 // `.with_context(...)` calls.
-                println!("Error: {error:?}");
+                println!("{} {error:?}", t!("Error:"));
             }
             exit(1);
         }

src/self_update.rs

@@ -5,6 +5,7 @@ use std::process::Command;
 
 use crate::config::Step;
 use color_eyre::eyre::{bail, Result};
+use rust_i18n::t;
 use self_update_crate::backends::github::Update;
 use self_update_crate::update::UpdateStatus;
 
@@ -18,7 +19,7 @@ pub fn self_update(ctx: &ExecutionContext) -> Result<()> {
     print_separator("Self update");
 
     if ctx.run_type().dry() {
-        println!("Would self-update");
+        println!("{}", t!("Would self-update"));
         Ok(())
     } else {
         let assume_yes = ctx.config().yes(Step::SelfUpdate);
@@ -38,17 +39,17 @@ pub fn self_update(ctx: &ExecutionContext) -> Result<()> {
             .update_extended()?;
 
         if let UpdateStatus::Updated(release) = &result {
-            println!("\nTopgrade upgraded to {}:\n", release.version);
+            println!("\n{}{}:\n", t!("Topgrade upgraded to "), release.version);
             if let Some(body) = &release.body {
                 println!("{body}");
             }
         } else {
-            println!("Topgrade is up-to-date");
+            println!("{}", t!("Topgrade is up-to-date"));
         }
 
         {
             if result.updated() {
-                print_info("Respawning...");
+                print_info(t!("Respawning..."));
                 let mut command = Command::new(current_exe?);
                 command.args(env::args().skip(1)).env("TOPGRADE_NO_SELF_UPGRADE", "");
 

src/steps/git.rs

@@ -20,6 +20,7 @@ use crate::terminal::print_separator;
 use crate::utils::{require, PathExt};
 use crate::{error::SkipStep, terminal::print_warning, HOME_DIR};
 use etcetera::base_strategy::BaseStrategy;
+use rust_i18n::t;
 
 #[cfg(unix)]
 use crate::XDG_DIRS;
@@ -296,7 +297,7 @@ impl RepoStep {
         let before_revision = get_head_revision(&self.git, &repo);
 
         if ctx.config().verbose() {
-            println!("{} {}", style("Pulling").cyan().bold(), repo.as_ref().display());
+            println!("{} {}", style(t!("Pulling")).cyan().bold(), repo.as_ref().display());
         }
 
         let mut command = AsyncCommand::new(&self.git);
@@ -322,7 +323,7 @@ impl RepoStep {
             .wrap_err_with(|| format!("Failed to pull {}", repo.as_ref().display()));
 
         if result.is_err() {
-            println!("{} pulling {}", style("Failed").red().bold(), repo.as_ref().display());
+            println!("{} {} {}", style("Failed").red().bold(), t!("pulling"), repo.as_ref().display());
         } else {
             let after_revision = get_head_revision(&self.git, repo.as_ref());
 

src/steps/kakoune.rs

@@ -1,6 +1,7 @@
 use crate::terminal::print_separator;
 use crate::utils::require;
 use color_eyre::eyre::Result;
+use rust_i18n::t;
 
 use crate::execution_context::ExecutionContext;
 
@@ -17,7 +18,7 @@ pub fn upgrade_kak_plug(ctx: &ExecutionContext) -> Result<()> {
         .args(["-ui", "dummy", "-e", UPGRADE_KAK])
         .output()?;
 
-    println!("Plugins upgraded");
+    println!("{}", t!("Plugins upgraded"));
 
     Ok(())
 }

src/steps/os/unix.rs

@@ -13,6 +13,7 @@ use color_eyre::eyre::Context;
 use color_eyre::eyre::Result;
 use home;
 use ini::Ini;
+use rust_i18n::t;
 use tracing::debug;
 
 #[cfg(target_os = "linux")]
@@ -719,6 +720,6 @@ pub fn run_maza(ctx: &ExecutionContext) -> Result<()> {
 }
 
 pub fn reboot() -> Result<()> {
-    print!("Rebooting...");
+    print!("{}", t!("Rebooting..."));
     Command::new("sudo").arg("reboot").status_checked()
 }

src/steps/powershell.rs

@@ -4,6 +4,7 @@ use std::path::PathBuf;
 use std::process::Command;
 
 use color_eyre::eyre::Result;
+use rust_i18n::t;
 
 use crate::command::CommandExt;
 use crate::execution_context::ExecutionContext;
@@ -62,9 +63,9 @@ impl Powershell {
     }
 
     pub fn update_modules(&self, ctx: &ExecutionContext) -> Result<()> {
-        let powershell = require_option(self.path.as_ref(), String::from("Powershell is not installed"))?;
+        let powershell = require_option(self.path.as_ref(), t!("Powershell is not installed").to_string())?;
 
-        print_separator("Powershell Modules Update");
+        print_separator(t!("Powershell Modules Update"));
 
         let mut cmd = vec!["Update-Module"];
 
@@ -76,7 +77,7 @@ impl Powershell {
             cmd.push("-Force")
         }
 
-        println!("Updating modules...");
+        println!("{}", t!("Updating modules..."));
         ctx.run_type()
             .execute(powershell)
             // This probably doesn't need `shell_words::join`.

src/steps/tmux.rs

@@ -16,6 +16,7 @@ use crate::{
 
 #[cfg(unix)]
 use std::os::unix::process::CommandExt as _;
+use rust_i18n::t;
 
 pub fn run_tpm(ctx: &ExecutionContext) -> Result<()> {
     let tpm = HOME_DIR.join(".tmux/plugins/tpm/bin/update_plugins").require()?;
@@ -149,7 +150,7 @@ pub fn run_in_tmux(args: Vec<String>) -> Result<()> {
         let err = tmux.build().args(["attach-session", "-t", &session]).exec();
         Err(eyre!("{err}")).context("Failed to `execvp(3)` tmux")
     } else {
-        println!("Topgrade launched in a new tmux session");
+        println!("{}", t!("Topgrade launched in a new tmux session"));
         Ok(())
     }
 }

src/steps/vim.rs

@@ -15,6 +15,7 @@ use std::{
     io::{self, Write},
     process::Command,
 };
+use rust_i18n::t;
 use tracing::debug;
 
 const UPGRADE_VIM: &str = include_str!("upgrade.vim");
@@ -64,7 +65,7 @@ fn upgrade(command: &mut Executor, ctx: &ExecutionContext) -> Result<()> {
         if !status.success() {
             return Err(TopgradeError::ProcessFailed(command.get_program(), status).into());
         } else {
-            println!("Plugins upgraded")
+            println!("{}", t!("Plugins upgraded"))
         }
     }
 

src/terminal.rs

@@ -11,6 +11,7 @@ use color_eyre::eyre::Context;
 use console::{style, Key, Term};
 use lazy_static::lazy_static;
 use notify_rust::{Notification, Timeout};
+use rust_i18n::t;
 use tracing::{debug, error};
 #[cfg(windows)]
 use which_crate::which;
@@ -224,7 +225,7 @@ impl Terminal {
             match self.term.read_key() {
                 Ok(Key::Char('y')) | Ok(Key::Char('Y')) => break Ok(true),
                 Ok(Key::Char('s')) | Ok(Key::Char('S')) => {
-                    println!("\n\nDropping you to shell. Fix what you need and then exit the shell.\n");
+                    println!("\n\n{}\n", t!("Dropping you to shell. Fix what you need and then exit the shell."));
                     if let Err(err) = run_shell().context("Failed to run shell") {
                         self.term.write_fmt(format_args!("{err:?}\n{prompt_inner}")).ok();
                     } else {