Use catf() over messagef() where appropriate

MichaelChirico · MichaelChirico · commit d43d35530135 · 2025-12-19T00:41:57.000-08:00
diff --git a/R/custom-translators.R b/R/custom-translators.R
@@ -1,18 +1,22 @@
+catf = function(fmt, ..., sep=" ", domain="R-potools") {
+  cat(gettextf(fmt, ..., domain=domain), sep=sep)
+}
+
 # tends to make some really repetitive messages with call.=TRUE, so always turn it off
-stopf = function(fmt, ..., domain = NULL) {
-  stop(gettextf(fmt, ..., domain = NULL), domain = NA, call. = FALSE)
+stopf = function(fmt, ..., domain="R-potools") {
+  stop(gettextf(fmt, ..., domain=domain), domain = NA, call. = FALSE)
 }
 
 # uncovered for now, used in msgmerge.R
-warningf = function(fmt, ..., immediate. = FALSE, noBreaks. = FALSE) {
-  warning(gettextf(fmt, ..., domain = NULL), domain = NA, call. = FALSE, immediate. = immediate., noBreaks. = noBreaks.)
+warningf = function(fmt, ..., immediate.=FALSE, noBreaks.=FALSE, domain="R-potools") {
+  warning(gettextf(fmt, ..., domain=domain), domain = NA, call. = FALSE, immediate. = immediate., noBreaks. = noBreaks.)
 }
 
-messagef = function(fmt, ..., appendLF = TRUE) {
-  message(gettextf(fmt, ..., domain = NULL), domain = NA, appendLF = appendLF)
+messagef = function(fmt, ..., appendLF=TRUE, domain="R-potools") {
+  message(gettextf(fmt, ..., domain=domain), domain = NA, appendLF = appendLF)
 }
 
 # not actually used yet in package src, so commenting out for test coverage, but leaving in for illustration
 # packageStartupMessagef = function(fmt, ..., appendLF = TRUE) {
-#   packageStartupMessage(gettextf(fmt, ..., domain = NULL), domain = NA, appendLF = appendLF)
+#   packageStartupMessage(gettextf(fmt, ..., domain = domain), domain = NA, appendLF = appendLF)
 # }
diff --git a/R/explain_plurals.R b/R/explain_plurals.R
@@ -24,10 +24,11 @@ po_explain_plurals <- function(language, index) {
 
   plural_metadata = .potools$PLURAL_RANGE_STRINGS[language_metadata, .SD, on = "plural"]
   if (missing(index)) {
-    language_metadata[, message(domain = NA, sprintf(
+    language_metadata[, messagef(
       ngettext(nplurals, "%s (%s) has %d plural form.", "%s (%s) has %d plural forms."),
-      full_name_eng, full_name_native, nplurals
-    ))]
+      full_name_eng, full_name_native, nplurals,
+      domain = NA
+    )]
     plural_metadata[, message(domain = NA, paste(
       gettextf("  - plural_index = %d applies %s", plural_index, range_translation = gettext(range)),
       collapse = "\n"
diff --git a/R/find_fuzzy_messages.R b/R/find_fuzzy_messages.R
@@ -2,20 +2,26 @@ find_fuzzy_messages <- function(message_data, lang_file) {
   old_message_data = get_po_messages(lang_file)
 
   if (any(idx <- old_message_data$fuzzy == 2L)) {
-    messagef('Found %d translations marked as deprecated in %s.', sum(idx), lang_file)
-    message('Typically, this means the corresponding error messages have been refactored.')
-    message('Reproducing these messages here for your reference since they might still provide some utility.')
+    messagef(
+      paste(
+        'Found %d translations marked as deprecated in %s.',
+        'Typically, this means the corresponding error messages have been refactored.',
+        'Reproducing these messages here for your reference since they might still provide some utility.',
+        sep = '\n'
+      ),
+      sum(idx), lang_file
+    )
 
     dashes = strrep('-', 0.9*getOption('width'))
     old_message_data[idx & type == 'singular', {
       if (.N > 0L) {
-        message(' ** SINGULAR MESSAGES **')
+        cat(' ** SINGULAR MESSAGES **\n')
         cat(rbind(dashes, msgid, msgstr), sep='\n')
       }
     }]
     old_message_data[idx & type == 'plural', {
       if (.N > 0L) {
-        message(' ** PLURAL MESSAGES **')
+        cat(' ** PLURAL MESSAGES **\n')
         cat(do.call(rbind, c(list(dashes), msgid_plural, msgstr_plural)), sep='\n')
       }
     }]
diff --git a/R/get_message_data.R b/R/get_message_data.R
@@ -92,7 +92,7 @@ get_message_data = function(
     }
   }
 
-  if (verbose && dir.exists(file.path(dir, "R"))) message('Getting R-level messages...')
+  if (verbose && dir.exists(file.path(dir, "R"))) cat('Getting R-level messages...\n')
   r_message_data = get_r_messages(
     dir,
     # nolint next: backport_linter. False positive on 'R'.
@@ -101,7 +101,7 @@ get_message_data = function(
     is_base = is_base
   )
 
-  if (verbose && dir.exists(file.path(dir, "src"))) message('Getting src-level messages...')
+  if (verbose && dir.exists(file.path(dir, "src"))) cat('Getting src-level messages...\n')
   src_message_data = get_src_messages(
     dir,
     custom_translation_functions = custom_translation_functions$src,
diff --git a/R/msgmerge.R b/R/msgmerge.R
@@ -12,14 +12,14 @@ run_msgmerge <- function(po_file, pot_file, previous = FALSE, verbose = TRUE) {
   )
 
   if (verbose) {
-    message("Running system command msgmerge ", paste(msgmerge_args, collapse = " "), "...")
+    catf("Running system command msgmerge %s ...\n", paste(msgmerge_args, collapse = " "))
   }
   val <- system2("msgmerge", msgmerge_args, stdout = TRUE, stderr = TRUE)
   if (!identical(attr(val, "status", exact = TRUE), NULL)) {
     # nocov these warnings? i don't know how to trigger them as of this writing.
     warningf("Running msgmerge on './po/%s' failed:\n  %s", basename(po_file), paste(val, collapse = "\n"))
   } else if (verbose) {
-    messagef(paste(val, collapse = "\n"))
+    writeLines(val)
   }
 
   res <- tools::checkPoFile(po_file, strictPlural = TRUE)
@@ -45,7 +45,7 @@ run_msgfmt = function(po_file, mo_file, verbose) {
     cmd = glue("msgfmt -o {shQuote(mo_file)} {shQuote(po_file)}") # nocov
   }
   if (verbose) {
-    message("Running system command ", cmd, "...")
+    catf("Running system command %s ...\n", cmd)
   }
   if (system(cmd) != 0L) {
     warningf(
@@ -88,13 +88,13 @@ run_msginit <- function(po_path, pot_path, locale, width = 80L, verbose = TRUE)
     "--no-translator" # don't consult user-email etc
   )
   if (verbose) {
-    message("Running system command msginit ", paste(msginit_args, collapse = " "), "...")
+    catf("Running system command msginit %s...\n", paste(msginit_args, collapse = " "))
   }
   val <- system2("msginit", msginit_args, stdout = TRUE, stderr = TRUE)
   if (!identical(attr(val, "status", exact = TRUE), NULL)) {
     stopf("Running msginit on '%s' failed", pot_path)
   } else if (verbose) {
-    messagef(paste(val, collapse = "\n"))
+    writeLines(val)
   }
   invisible()
 }
diff --git a/R/po_compile.R b/R/po_compile.R
@@ -24,8 +24,8 @@ po_compile = function(dir = ".", package = NULL, lazy = TRUE, verbose = TRUE) {
     to_delete <- mo_dirs[!basename(mo_dirs) %in% c(po_metadata$language, "en@quot")]
 
     for (dir in to_delete) {
-      if (verbose) messagef(
-        "Found a compiled translation for %s at %s, but no corresponding .po; deleting",
+      if (verbose) catf(
+        "Found a compiled translation for %s at %s, but no corresponding .po; deleting\n",
         basename(dir), dirname(dir)
       )
       unlink(dir, recursive = TRUE)
@@ -34,7 +34,7 @@ po_compile = function(dir = ".", package = NULL, lazy = TRUE, verbose = TRUE) {
 
   for (ii in seq_len(nrow(po_metadata))) {
     row_ii <- po_metadata[ii]
-    if (verbose) messagef("Recompiling '%s' %s translation", row_ii$language, row_ii$type)
+    if (verbose) catf("Recompiling '%s' %s translation\n", row_ii$language, row_ii$type)
     run_msgfmt(row_ii$po, row_ii$mo, verbose = verbose)
   }
 
diff --git a/R/po_create.R b/R/po_create.R
@@ -22,10 +22,10 @@ po_create <- function(languages, dir = ".", verbose = !is_testing()) {
   for (ii in seq_len(nrow(po_files))) {
     row_ii <- po_files[ii]
     if (file.exists(row_ii$po_path)) {
-      if (verbose) messagef("Updating '%s' %s translation", row_ii$language, row_ii$type)
+      if (verbose) catf("Updating '%s' %s translation\n", row_ii$language, row_ii$type)
       run_msgmerge(row_ii$po_path, row_ii$pot_path, previous = TRUE, verbose = verbose)
     } else {
-      if (verbose) messagef("Creating '%s' %s translation", row_ii$language, row_ii$type)
+      if (verbose) catf("Creating '%s' %s translation\n", row_ii$language, row_ii$type)
       run_msginit(row_ii$po_path, row_ii$pot_path, locale = row_ii$language, verbose = verbose)
     }
   }
diff --git a/R/po_extract.R b/R/po_extract.R
@@ -27,12 +27,10 @@ po_extract <- function(
 
   n <- nrow(message_data)
   if (!n) {
-    if (verbose) message('No messages to translate')
+    if (verbose) catf('No messages to translate\n')
     return(invisible())
   }
-  # TODO: messagef() is double-translating the ngettext() result...
-  #   it needs an escape valve
-  if (verbose) messagef(ngettext(n, "Found %i message", "Found %i messages"), n)
+  if (verbose) catf(ngettext(n, "Found %i message", "Found %i messages"), n, domain=NA)
 
   po_dir <- file.path(dir, 'po')
   dir.create(po_dir, showWarnings = FALSE)
diff --git a/R/po_update.R b/R/po_update.R
@@ -37,7 +37,7 @@ po_update <- function(dir = ".", lazy = TRUE, verbose = !is_testing()) {
 
   for (ii in seq_len(nrow(meta))) {
     row_ii <- meta[ii]
-    if (verbose) messagef("Updating '%s' %s translation", row_ii$language, row_ii$type)
+    if (verbose) catf("Updating '%s' %s translation\n", row_ii$language, row_ii$type)
     run_msgmerge(row_ii$po, row_ii$pot, previous = TRUE, verbose = verbose)
   }
 
diff --git a/R/translate_package.R b/R/translate_package.R
@@ -344,21 +344,21 @@ translate_package = function(
     if (tr_update) {
       # is it worthwhile to try and distinguish the creation time of the
       #  R pot file and the src pot file? probably not...
-      messagef(
-        "Updating translation template for package '%s' (last updated %s)",
+      catf(
+        "Updating translation template for package '%s' (last updated %s)\n",
         package,
         format(file.info(r_potfile)$atime)
       )
     } else {
-      messagef("Starting translations for package '%s'", package)
+      catf("Starting translations for package '%s'\n", package)
     }
   }
   if (!tr_update) dir.create(po_dir, showWarnings = FALSE)
 
   message_data = get_message_data(dir, custom_translation_functions, verbose=verbose)
 
   if (!nrow(message_data)) {
-    if (verbose) message('No messages to translate; finishing')
+    if (verbose) cat('No messages to translate; finishing\n')
     return(invisible())
   }
 
@@ -369,7 +369,7 @@ translate_package = function(
   set_prompt_conn()
   on.exit(unset_prompt_conn())
 
-  if (verbose) message('Running message diagnostics...')
+  if (verbose) cat('Running message diagnostics...\n')
 
   for (diagnostic in diagnostics) {
     diagnostic <- match.fun(diagnostic)
@@ -387,13 +387,13 @@ translate_package = function(
   if (l10n_info()[["UTF-8"]]) {
     # on UTF-8 machines we install the en@quot messages too
     # TODO: streamline this -- en_quote is definitely doing some redundant stuff
-    message('Generating en@quot translations')
+    cat('Generating en@quot translations\n')
     update_en_quot_mo_files(dir, verbose)
   }
 
 
   if (is.null(languages)) {
-    if (verbose) message('No languages provided; finishing')
+    if (verbose) cat('No languages provided; finishing\n')
     return(invisible())
   }
 
@@ -411,8 +411,8 @@ translate_package = function(
     lang_file <- file.path(po_dir, glue("R-{language}.po"))
     if (tr_update && file.exists(lang_file)) {
       if (verbose) {
-        messagef(
-          'Found existing R translations for %s (%s/%s) in %s. Running msgmerge...',
+        catf(
+          'Found existing R translations for %s (%s/%s) in %s. Running msgmerge...\n',
           language, metadata$full_name_eng, metadata$full_name_native, lang_file
         )
       }
@@ -426,8 +426,8 @@ translate_package = function(
     lang_file <- file.path(po_dir, glue("{language}.po"))
     if (tr_update && file.exists(lang_file)) {
       if (verbose) {
-        messagef(
-          'Found existing src translations for %s (%s/%s) in %s. Running msgmerge...',
+        catf(
+          'Found existing src translations for %s (%s/%s) in %s. Running msgmerge...\n',
           language, metadata$full_name_eng, metadata$full_name_native, lang_file
         )
       }
@@ -448,15 +448,15 @@ translate_package = function(
     ]
 
     if (!length(new_idx)) {
-      if (verbose) messagef('Translations for %s are up to date! Skipping.', language)
+      if (verbose) catf('Translations for %s are up to date! Skipping.\n', language)
       next
     }
     if (verbose) {
-      messagef(
-        'Beginning new translations for %s (%s/%s); found %d untranslated messages',
+      catf(
+        'Beginning new translations for %s (%s/%s); found %d untranslated messages\n',
         language, metadata$full_name_eng, metadata$full_name_native, length(new_idx)
       )
-      message("(To quit translating, press 'Esc'; progress will be saved)")
+      cat("(To quit translating, press 'Esc'; progress will be saved)\n")
     }
 
     po_params$author = prompt('Thanks! Who should be credited with these translations?')
diff --git a/R/update_metadata.R b/R/update_metadata.R
@@ -3,9 +3,11 @@
 update_metadata = function(language) {
   metadata = data.table(code = language)
 
-  messagef("'%s' is not a known language. ", language, appendLF=FALSE)
   # perhaps refer to http://docs.translatehouse.org/projects/localization-guide/en/latest/l10n/pluralforms.html instead
-  message("Please help supply some metadata about it. You can check https://l10n.gnome.org/teams/<language>")
+  catf(
+    "'%s' is not a known language. Please help supply some metadata about it. You can check %s.\n",
+    language, "https://l10n.gnome.org/teams/<language>"
+  )
   metadata[ , "full_name_eng" := prompt("How would you refer to this language in English?")]
   metadata[ , "full_name_native" := prompt("How would you refer to this language in the language itself?")]
   metadata[ , "nplurals" := prompt(
@@ -38,7 +40,7 @@ update_metadata = function(language) {
   }
   .potools$KNOWN_LANGUAGES = rbind(.potools$KNOWN_LANGUAGES, metadata)
   setkeyv(.potools$KNOWN_LANGUAGES, "code")
-  message("Thanks! Please file an issue on GitHub to get this language recognized permanently")
+  cat("Thanks! Please file an issue on GitHub to get this language recognized permanently\n")
   metadata
 }
 
diff --git a/R/write_po_file.R b/R/write_po_file.R
@@ -36,7 +36,7 @@ write_po_files <- function(message_data, po_dir, params, template = FALSE, use_b
     ))
   }
 
-  if (verbose) messagef('Writing %s', r_file)
+  if (verbose) catf('Writing %s\n', r_file)
 
   write_po_file(
     message_data[message_source == "R"],
diff --git a/tests/testthat/_snaps/unix/po_create.md b/tests/testthat/_snaps/unix/po_create.md
@@ -2,7 +2,7 @@
 
     Code
       po_create("jp", verbose = TRUE)
-    Message
+    Output
       Creating 'jp' R translation
       Running system command msginit -i './po/R-test.pot' -o './po/R-jp.po' -l 'jp' -w 80 --no-translator...
       Created ./po/R-jp.po.
@@ -11,8 +11,8 @@
 
     Code
       po_create("jp", verbose = TRUE)
-    Message
+    Output
       Updating 'jp' R translation
-      Running system command msgmerge --update './po/R-jp.po' --backup=off --previous './po/R-test.pot'...
+      Running system command msgmerge --update './po/R-jp.po' --backup=off --previous './po/R-test.pot' ...
       . done.
 
diff --git a/tests/testthat/_snaps/unix/po_update.md b/tests/testthat/_snaps/unix/po_update.md
@@ -2,11 +2,11 @@
 
     Code
       po_update(verbose = TRUE, lazy = FALSE)
-    Message
+    Output
       Updating 'fr' R translation
-      Running system command msgmerge --update './po/R-fr.po' --backup=off --previous './po/R-test.pot'.
+      Running system command msgmerge --update './po/R-fr.po' --backup=off --previous './po/R-test.pot' .
       . done.
       Updating 'ja' R translation
-      Running system command msgmerge --update './po/R-ja.po' --backup=off --previous './po/R-test.pot'.
+      Running system command msgmerge --update './po/R-ja.po' --backup=off --previous './po/R-test.pot' .
       . done.
 
diff --git a/tests/testthat/helpers.R b/tests/testthat/helpers.R
@@ -16,7 +16,7 @@ restore_package <- function(dir, expr, tmp_conn) {
     on.exit(options(old), add = TRUE)
   }
 
-  invisible(capture.output(expr))
+  invisible(expr)
 }
 
 # TODO: I think this can just be replaced by expect_match and expect_no_match in current testthat dev
diff --git a/tests/testthat/test-translate-package.R b/tests/testthat/test-translate-package.R
diff --git a/tests/testthat/test_packages/r_msg/inst/po/en@quot/LC_MESSAGES/R-rMsg.mo b/tests/testthat/test_packages/r_msg/inst/po/en@quot/LC_MESSAGES/R-rMsg.mo
diff --git a/tests/testthat/test_packages/r_msg/po/R-rMsg.pot b/tests/testthat/test_packages/r_msg/po/R-rMsg.pot

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ get_message_data = function(`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
`95`		`- if (verbose && dir.exists(file.path(dir, "R"))) message('Getting R-level messages...')`
	`95`	`+ if (verbose && dir.exists(file.path(dir, "R"))) cat('Getting R-level messages...\n')`
`96`	`96`	`r_message_data = get_r_messages(`
`97`	`97`	`dir,`
`98`	`98`	`# nolint next: backport_linter. False positive on 'R'.`
`@@ -101,7 +101,7 @@ get_message_data = function(`
`101`	`101`	`is_base = is_base`
`102`	`102`	`)`
`103`	`103`
`104`		`- if (verbose && dir.exists(file.path(dir, "src"))) message('Getting src-level messages...')`
	`104`	`+ if (verbose && dir.exists(file.path(dir, "src"))) cat('Getting src-level messages...\n')`
`105`	`105`	`src_message_data = get_src_messages(`
`106`	`106`	`dir,`
`107`	`107`	`custom_translation_functions = custom_translation_functions$src,`
Original file line number	Diff line number	Diff line change
`@@ -12,14 +12,14 @@ run_msgmerge <- function(po_file, pot_file, previous = FALSE, verbose = TRUE) {`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`if (verbose) {`
`15`		`- message("Running system command msgmerge ", paste(msgmerge_args, collapse = " "), "...")`
	`15`	`+ catf("Running system command msgmerge %s ...\n", paste(msgmerge_args, collapse = " "))`
`16`	`16`	`}`
`17`	`17`	`val <- system2("msgmerge", msgmerge_args, stdout = TRUE, stderr = TRUE)`
`18`	`18`	`if (!identical(attr(val, "status", exact = TRUE), NULL)) {`
`19`	`19`	`# nocov these warnings? i don't know how to trigger them as of this writing.`
`20`	`20`	`warningf("Running msgmerge on './po/%s' failed:\n %s", basename(po_file), paste(val, collapse = "\n"))`
`21`	`21`	`} else if (verbose) {`
`22`		`- messagef(paste(val, collapse = "\n"))`
	`22`	`+ writeLines(val)`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`res <- tools::checkPoFile(po_file, strictPlural = TRUE)`
`@@ -45,7 +45,7 @@ run_msgfmt = function(po_file, mo_file, verbose) {`
`45`	`45`	`cmd = glue("msgfmt -o {shQuote(mo_file)} {shQuote(po_file)}") # nocov`
`46`	`46`	`}`
`47`	`47`	`if (verbose) {`
`48`		`- message("Running system command ", cmd, "...")`
	`48`	`+ catf("Running system command %s ...\n", cmd)`
`49`	`49`	`}`
`50`	`50`	`if (system(cmd) != 0L) {`
`51`	`51`	`warningf(`
`@@ -88,13 +88,13 @@ run_msginit <- function(po_path, pot_path, locale, width = 80L, verbose = TRUE)`
`88`	`88`	`"--no-translator" # don't consult user-email etc`
`89`	`89`	`)`
`90`	`90`	`if (verbose) {`
`91`		`- message("Running system command msginit ", paste(msginit_args, collapse = " "), "...")`
	`91`	`+ catf("Running system command msginit %s...\n", paste(msginit_args, collapse = " "))`
`92`	`92`	`}`
`93`	`93`	`val <- system2("msginit", msginit_args, stdout = TRUE, stderr = TRUE)`
`94`	`94`	`if (!identical(attr(val, "status", exact = TRUE), NULL)) {`
`95`	`95`	`stopf("Running msginit on '%s' failed", pot_path)`
`96`	`96`	`} else if (verbose) {`
`97`		`- messagef(paste(val, collapse = "\n"))`
	`97`	`+ writeLines(val)`
`98`	`98`	`}`
`99`	`99`	`invisible()`
`100`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,10 @@ po_create <- function(languages, dir = ".", verbose = !is_testing()) {`
`22`	`22`	`for (ii in seq_len(nrow(po_files))) {`
`23`	`23`	`row_ii <- po_files[ii]`
`24`	`24`	`if (file.exists(row_ii$po_path)) {`
`25`		`- if (verbose) messagef("Updating '%s' %s translation", row_ii$language, row_ii$type)`
	`25`	`+ if (verbose) catf("Updating '%s' %s translation\n", row_ii$language, row_ii$type)`
`26`	`26`	`run_msgmerge(row_ii$po_path, row_ii$pot_path, previous = TRUE, verbose = verbose)`
`27`	`27`	`} else {`
`28`		`- if (verbose) messagef("Creating '%s' %s translation", row_ii$language, row_ii$type)`
	`28`	`+ if (verbose) catf("Creating '%s' %s translation\n", row_ii$language, row_ii$type)`
`29`	`29`	`run_msginit(row_ii$po_path, row_ii$pot_path, locale = row_ii$language, verbose = verbose)`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ po_update <- function(dir = ".", lazy = TRUE, verbose = !is_testing()) {`
`37`	`37`
`38`	`38`	`for (ii in seq_len(nrow(meta))) {`
`39`	`39`	`row_ii <- meta[ii]`
`40`		`- if (verbose) messagef("Updating '%s' %s translation", row_ii$language, row_ii$type)`
	`40`	`+ if (verbose) catf("Updating '%s' %s translation\n", row_ii$language, row_ii$type)`
`41`	`41`	`run_msgmerge(row_ii$po, row_ii$pot, previous = TRUE, verbose = verbose)`
`42`	`42`	`}`
`43`	`43`