Add new parameter fill_translations to leptos_fluent! (#293)

mondeja · web-flow · commit 9041cbb3bba4 · 2025-03-06T21:09:02.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## Unreleased - [0.2.6]
+
+### New features
+
+- Add a new parameter `fill_translations` to `leptos_fluent!` macro to add
+  messages found in `tr!` and `move_tr!` macros to Fluent translations files.
+
 ## 2025-03-06 - [0.2.5]
 
 ### Bug fixes
@@ -654,6 +661,7 @@ version to `0.1` during installation.
 
 - Added all ISO-639-1 and ISO-639-2 languages.
 
+[0.2.6]: https://github.com/mondeja/leptos-fluent/compare/v0.2.5...master
 [0.2.5]: https://github.com/mondeja/leptos-fluent/compare/v0.2.4...v0.2.5
 [0.2.4]: https://github.com/mondeja/leptos-fluent/compare/v0.2.3...v0.2.4
 [0.2.3]: https://github.com/mondeja/leptos-fluent/compare/v0.2.2...v0.2.3
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/book/src/leptos_fluent.md b/book/src/leptos_fluent.md
@@ -247,6 +247,32 @@ Must be a [glob] relative to the _Cargo.toml_ file.
   }
   ```
 
+### `fill_translations`
+
+Add new messages found in `tr!` and `move_tr!` macros to translations files.
+
+- For single crate projects:
+
+  ```rust
+  leptos_fluent! {
+      locales: "./locales",
+      translations: [TRANSLATIONS],
+      fill_translations: "./src/**/*.rs",
+      // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  }
+  ```
+
+- For workspace projects:
+
+  ```rust
+  leptos_fluent! {
+      locales: "./locales",
+      translations: [TRANSLATIONS],
+      fill_translations: "../{app,components}/src/**/*.rs",
+      // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  }
+  ```
+
 ### <span style="opacity:.5">CSR </span> | `sync_html_tag_lang`
 
 Synchronize the global [`<html lang="...">` attribute] with current language
diff --git a/examples/csr-minimal/src/lib.rs b/examples/csr-minimal/src/lib.rs
@@ -15,6 +15,8 @@ pub fn I18n(children: Children) -> impl IntoView {
         children: children(),
         translations: [TRANSLATIONS],
         locales: "./locales",
+        check_translations: "./src/**/*.rs",
+        fill_translations: "./src/**/*.rs",
     }
 }
 
diff --git a/leptos-fluent-macros/Cargo.toml b/leptos-fluent-macros/Cargo.toml
@@ -2,7 +2,7 @@
 name = "leptos-fluent-macros"
 description = "Macros for leptos-fluent"
 edition.workspace = true
-version = "0.2.5"
+version = "0.2.6"
 rust-version = "1.79.0"
 license = "MIT"
 documentation.workspace = true
diff --git a/leptos-fluent-macros/src/fluent_entries.rs b/leptos-fluent-macros/src/fluent_entries.rs
@@ -5,8 +5,7 @@ use fluent_syntax::ast::{
 use std::collections::HashMap;
 use std::rc::Rc;
 
-pub(in crate::translations_checker) type FluentEntries =
-    HashMap<Rc<String>, Vec<FluentEntry>>;
+pub(crate) type FluentEntries = HashMap<Rc<String>, Vec<FluentEntry>>;
 
 #[cfg_attr(any(debug_assertions, feature = "tracing"), derive(Debug))]
 #[derive(Clone, PartialEq)]
@@ -39,7 +38,7 @@ struct MaybeReferencedFluentEntry {
 
 #[cfg_attr(any(debug_assertions, feature = "tracing"), derive(Debug))]
 #[derive(Clone, PartialEq)]
-pub(in crate::translations_checker) struct FluentEntry {
+pub(crate) struct FluentEntry {
     pub(crate) message_name: String,
     pub(crate) placeables: Vec<String>,
 }
diff --git a/leptos-fluent-macros/src/lib.rs b/leptos-fluent-macros/src/lib.rs
@@ -11,11 +11,17 @@ extern crate proc_macro;
 pub(crate) mod cookie;
 mod exprpath;
 mod files_tracker;
+#[cfg(not(feature = "ssr"))]
+pub(crate) mod fluent_entries;
 mod fluent_resources;
 mod languages;
 mod loader;
 #[cfg(not(feature = "ssr"))]
+pub(crate) mod tr_macros;
+#[cfg(not(feature = "ssr"))]
 mod translations_checker;
+#[cfg(not(feature = "ssr"))]
+mod translations_filler;
 
 pub(crate) use exprpath::evaluate_exprpath;
 use files_tracker::build_files_tracker_quote;
@@ -109,6 +115,7 @@ pub fn leptos_fluent(
         locales_path,
         core_locales_path,
         check_translations,
+        fill_translations,
         provide_meta_context,
         sync_html_tag_lang,
         sync_html_tag_dir,
@@ -1671,6 +1678,8 @@ pub fn leptos_fluent(
                         maybe_some_litstr_param(&raw_languages_path);
                     let check_translations_quote =
                         maybe_some_litstr_param(&check_translations);
+                    let fill_translations_quote =
+                        maybe_some_litstr_param(&fill_translations);
                     let sync_html_tag_lang_quote =
                         lit_bool_exprs(&sync_html_tag_lang);
                     let sync_html_tag_dir_quote =
@@ -1811,6 +1820,7 @@ pub fn leptos_fluent(
                             core_locales: #core_locales_quote,
                             languages: #languages_quote,
                             check_translations: #check_translations_quote,
+                            fill_translations: #fill_translations_quote,
                             sync_html_tag_lang: #sync_html_tag_lang_quote,
                             sync_html_tag_dir: #sync_html_tag_dir_quote,
                             url_param: #url_param_quote,
diff --git a/leptos-fluent-macros/src/loader.rs b/leptos-fluent-macros/src/loader.rs
@@ -400,6 +400,7 @@ pub(crate) struct I18nLoader {
     pub locales_path: String,
     pub core_locales_path: Option<String>,
     pub check_translations: Option<String>,
+    pub fill_translations: Option<String>,
     pub provide_meta_context: Vec<LitBool>,
     pub sync_html_tag_lang: Vec<LitBoolExpr>,
     pub sync_html_tag_dir: Vec<LitBoolExpr>,
@@ -459,6 +460,7 @@ impl Parse for I18nLoader {
         let mut core_locales_path: Option<syn::LitStr> = None;
         let mut translations: Option<Translations> = None;
         let mut check_translations: Option<syn::LitStr> = None;
+        let mut fill_translations: Option<syn::LitStr> = None;
         let mut provide_meta_context: Vec<LitBool> = Vec::new();
         let mut sync_html_tag_lang: Vec<LitBoolExpr> = Vec::new();
         let mut sync_html_tag_dir: Vec<LitBoolExpr> = Vec::new();
@@ -681,6 +683,17 @@ impl Parse for I18nLoader {
                     k,
                     check_translations
                 );
+            } else if k == "fill_translations" {
+                struct_field_init_shorthand_not_supported!(
+                    struct_field_init_shorthand,
+                    k
+                );
+                fill_translations = Some(input.parse()?);
+                evaluate_compile_time_exprpath_set_none!(
+                    exprpath,
+                    k,
+                    fill_translations
+                );
             } else if k == "sync_html_tag_lang" {
                 let mut param = LitBoolExpr::new();
                 clone_runtime_exprpath!(exprpath, param);
@@ -1455,40 +1468,113 @@ impl Parse for I18nLoader {
         }
 
         #[cfg(not(feature = "ssr"))]
-        if let Some(ref check_translations_globstr) = check_translations {
-            {
-                let (fluent_resources, ref fluent_file_paths) =
-                    fluent_resources_and_file_paths;
-                let (check_messages, errors) = crate::translations_checker::run(
-                    &check_translations_globstr.value(),
-                    &workspace_path,
-                    &fluent_resources,
-                    fluent_file_paths,
-                    &core_locales_path_str,
-                    &core_locales_content,
-                );
+        if check_translations.is_some() || fill_translations.is_some() {
+            let mut f_resources_and_file_paths =
+                fluent_resources_and_file_paths.clone();
+
+            if let Some(ref fill_translations_globstr) = fill_translations {
+                {
+                    let (ref fluent_resources, ref fluent_file_paths) =
+                        f_resources_and_file_paths;
+                    let (fill_messages, errors) =
+                        crate::translations_filler::run(
+                            &fill_translations_globstr.value(),
+                            &workspace_path,
+                            fluent_resources,
+                            fluent_file_paths,
+                            &core_locales_path_str,
+                            &core_locales_content,
+                        );
+
+                    let mut report = String::new();
+                    if !fill_messages.is_empty() {
+                        report.push_str(
+                            "Translations filled by leptos-fluent:\n",
+                        );
+                        for (file_path, message_names) in fill_messages {
+                            report.push_str(&format!("  {file_path}\n",));
+                            for message_name in message_names {
+                                report.push_str(&format!(
+                                    "    - {message_name}\n",
+                                ));
+                            }
+                        }
+                    }
+                    if !report.is_empty() {
+                        report.push('\n');
+                        eprintln!("{report}");
+
+                        // resources must be recreated because new fluent entries
+                        // have been added to them
+                        let (
+                            f_resources_and_file_paths_,
+                            resources_file_paths_errors,
+                        ) = build_fluent_resources_and_file_paths(
+                            &locales_path_str,
+                        );
+                        if !resources_file_paths_errors.is_empty() {
+                            return Err(syn::Error::new(
+                                locales_path.unwrap().span(),
+                                format!(
+                                    "Errors while reading fluent resources from {}:\n- {}",
+                                    locales_path_str,
+                                    resources_file_paths_errors.join("\n- "),
+                                ),
+                            ));
+                        }
+                        f_resources_and_file_paths =
+                            f_resources_and_file_paths_;
+                    }
 
-                let mut report = String::new();
-                if !check_messages.is_empty() {
-                    report.push_str(&format!(
-                        "Translations check failed:\n- {}",
-                        check_messages.join("\n- "),
-                    ));
                     if !errors.is_empty() {
-                        report.push_str("\n\n");
+                        let message = &format!(
+                            "Unrecoverable errors:\n- {}",
+                            errors.join("\n- "),
+                        );
+                        return Err(syn::Error::new(
+                            fill_translations_globstr.span(),
+                            message,
+                        ));
                     }
                 }
-                if !errors.is_empty() {
-                    report.push_str(&format!(
-                        "Unrecoverable errors:\n- {}",
-                        errors.join("\n- "),
-                    ));
-                }
-                if !report.is_empty() {
-                    return Err(syn::Error::new(
-                        check_translations_globstr.span(),
-                        report,
-                    ));
+            }
+
+            if let Some(ref check_translations_globstr) = check_translations {
+                {
+                    let (ref fluent_resources, ref fluent_file_paths) =
+                        f_resources_and_file_paths;
+                    let (check_messages, errors) =
+                        crate::translations_checker::run(
+                            &check_translations_globstr.value(),
+                            &workspace_path,
+                            fluent_resources,
+                            fluent_file_paths,
+                            &core_locales_path_str,
+                            &core_locales_content,
+                        );
+
+                    let mut report = String::new();
+                    if !check_messages.is_empty() {
+                        report.push_str(&format!(
+                            "Translations check failed:\n- {}",
+                            check_messages.join("\n- "),
+                        ));
+                        if !errors.is_empty() {
+                            report.push_str("\n\n");
+                        }
+                    }
+                    if !errors.is_empty() {
+                        report.push_str(&format!(
+                            "Unrecoverable errors:\n- {}",
+                            errors.join("\n- "),
+                        ));
+                    }
+                    if !report.is_empty() {
+                        return Err(syn::Error::new(
+                            check_translations_globstr.span(),
+                            report,
+                        ));
+                    }
                 }
             }
         }
@@ -1516,6 +1602,7 @@ impl Parse for I18nLoader {
             locales_path: locales_path.unwrap().value(),
             core_locales_path: core_locales_path_str,
             check_translations: check_translations.map(|x| x.value()),
+            fill_translations: fill_translations.map(|x| x.value()),
             provide_meta_context,
             sync_html_tag_lang,
             sync_html_tag_dir,
diff --git a/leptos-fluent-macros/src/tr_macros.rs b/leptos-fluent-macros/src/tr_macros.rs
@@ -3,11 +3,11 @@ use std::path::Path;
 use syn::visit::Visit;
 
 pub(crate) fn gather_tr_macro_defs_from_rs_files(
-    check_translations_globstr: &Path,
+    globstr: &Path,
     #[cfg(not(test))] workspace_path: &Path,
 ) -> (Vec<TranslationMacro>, Vec<String>) {
     let mut errors = Vec::new();
-    let glob_pattern = check_translations_globstr.to_string_lossy();
+    let glob_pattern = globstr.to_string_lossy();
 
     match globwalk::glob(&glob_pattern) {
         Ok(paths) => {
diff --git a/leptos-fluent-macros/src/translations_checker/mod.rs b/leptos-fluent-macros/src/translations_checker/mod.rs
@@ -1,15 +1,11 @@
-mod fluent_entries;
-mod tr_macros;
-
+use crate::fluent_entries::{build_fluent_entries, FluentEntries};
+use crate::tr_macros::{gather_tr_macro_defs_from_rs_files, TranslationMacro};
 use crate::{FluentFilePaths, FluentResources};
-use fluent_entries::build_fluent_entries;
-use fluent_entries::FluentEntries;
 use std::path::Path;
-use tr_macros::{gather_tr_macro_defs_from_rs_files, TranslationMacro};
 
 #[cfg_attr(feature = "tracing", tracing::instrument(level = "trace", skip_all))]
 pub(crate) fn run(
-    check_translations_globstr: &str,
+    globstr: &str,
     workspace_path: &Path,
     fluent_resources: &FluentResources,
     fluent_file_paths: &FluentFilePaths,
@@ -19,7 +15,7 @@ pub(crate) fn run(
     let mut errors = Vec::new();
 
     let (tr_macros, tr_macros_errors) = gather_tr_macro_defs_from_rs_files(
-        &workspace_path.join(check_translations_globstr),
+        &workspace_path.join(globstr),
         #[cfg(not(test))]
         workspace_path,
     );
diff --git a/leptos-fluent-macros/src/translations_filler/mod.rs b/leptos-fluent-macros/src/translations_filler/mod.rs
diff --git a/leptos-fluent/Cargo.toml b/leptos-fluent/Cargo.toml
diff --git a/leptos-fluent/src/lib.rs b/leptos-fluent/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ pub fn I18n(children: Children) -> impl IntoView {`
`15`	`15`	`children: children(),`
`16`	`16`	`translations: [TRANSLATIONS],`
`17`	`17`	`locales: "./locales",`
	`18`	`+ check_translations: "./src/*/.rs",`
	`19`	`+ fill_translations: "./src/*/.rs",`
`18`	`20`	`}`
`19`	`21`	`}`
`20`	`22`