feat: deal with trailing trimming and force and extensions in R styling

antidotum/tergo/.Rbuildignore

@@ -3,3 +3,4 @@
 ^\.lintr
 ^pre-commit\.sh
 ^update_authors\.R
+^\_pkgdown\.yml

antidotum/tergo/.lintr

@@ -1,3 +1,4 @@
 linters: linters_with_defaults(
-    line_length_linter(120L)
+    line_length_linter(120L),
+    cyclocomp_linter(complexity_limit = 50L)
   )

antidotum/tergo/DESCRIPTION

@@ -23,6 +23,6 @@ Suggests:
     devtools,
     pkgdown,
     desc
-URL: https://r.tergo.pagacz.io,
+URL: https://rtergo.pagacz.io,
     https://github.com/kpagacz/tergo
 BugReports: https://github.com/kpagacz/tergo/issues

antidotum/tergo/R/extendr-wrappers.R

@@ -36,5 +36,5 @@ get_config <- function(path) .Call(wrap__get_config, path)
 #' @export
 get_default_config <- function() .Call(wrap__get_default_config)
 
-
 # nolint end
+

antidotum/tergo/R/styling.R

@@ -6,24 +6,47 @@
 #' 1. The configuration passed to the function.
 #' 2. The configuration file.
 #'
-#' @param config_file (`character`) the path to the configuration file
-#' @param configuration (`list`) the path to the configuration for formatting
+#' @param config_file (`character`) The path to the configuration file
+#' @param configuration (`list`) The path to the configuration for formatting
+#' @param ... additional parameters to [tergo::style_pkg()]
 #'
 #' @export
 #' @examples
 #' style()
 #' style(config_file = "tergo.toml", configuration = list())
-style <- function(config_file = "tergo.toml", configuration = list()) {
+style <- function(config_file = "tergo.toml", configuration = list(), ...) {
   style_pkg(path = getwd(), config_file = config_file, configuration = configuration)
 }
 
 #' Style a package
 #'
 #' @inheritParams style
-#' @param path (`character`) the path to the package
+#' @param path (`character`) The path to the package.
+#' @param force (`logical(1`) Whether to format the files even
+#' if no package was found. `TRUE` - format the `.R` and `.r` files
+#' found in the directory (recursive). `FALSE` exit without formatting
+#' anything.
+#' @param extensions (`character`) The extensions of the files to format.
 #'
 #' @export
-style_pkg <- function(path = ".", config_file = "tergo.toml", configuration = list()) {
+style_pkg <- function(path = ".",
+                      config_file = "tergo.toml",
+                      configuration = list(),
+                      force = FALSE,
+                      extensions = c(".R", ".r")) {
+  if (!is.character(path) || length(path) != 1) {
+    stop("Path must be a character")
+  }
+  if (!is.character(config_file) || length(config_file) != 1) {
+    stop("Config file must be a character")
+  }
+  if (!is.logical(force) || length(force) != 1) {
+    stop("Force must be a logical")
+  }
+  if (!is.list(configuration)) {
+    stop("Configuration must be a list")
+  }
+
   # Read a configuration file
   wd <- path
   config <- NULL
@@ -55,9 +78,14 @@ style_pkg <- function(path = ".", config_file = "tergo.toml", configuration = li
       break
     }
   }
-  files <- list.files(package_root, recursive = TRUE, full.names = TRUE)
-  files <- Filter(function(file) any(endsWith(file, c(".R", ".r"))), files)
 
+  if (!file.exists(file.path(package_root, "DESCRIPTION")) && !force) {
+    message("No package detected. Exiting without formatting anything.")
+    return(invisible())
+  }
+
+  files <- list.files(package_root, recursive = TRUE, full.names = TRUE)
+  files <- Filter(function(file) any(endsWith(file, extensions)), files)
   # Format
   for (file in files) {
     tryCatch(

antidotum/tergo/README.md

@@ -46,7 +46,7 @@ install.packages('tergo', repos = c('https://kpagacz.r-universe.dev', 'https://c
 
 ## Usage
 
-See the R manual for the reference - <r.tergo.pagacz.io>.
+See the [R manual](rtergo.pagacz.io) for the reference.
 
 To style your package, run:
 

antidotum/tergo/src/rust/Cargo.toml

@@ -8,7 +8,7 @@ crate-type = ["staticlib"]
 name = "tergo"
 
 [dependencies]
-tergo-lib = "0.2.4"
+tergo-lib = "0.2.5"
 toml = "0.8.19"
 extendr-api = "*"
 

antidotum/tergo/tools/configure.R

@@ -152,8 +152,10 @@ check_cargo <- function() {
 
 ### Check cargo toolchain ###
 
-cargo_check_result <- tryCatch(check_cargo(), # Defer errors if it's raised by functions here
-string2path_error_cargo_check = function(e) e$message)
+cargo_check_result <- tryCatch(
+  check_cargo(), # Defer errors if it's raised by functions here
+  string2path_error_cargo_check = function(e) e$message
+)
 
 # If cargo is confirmed fine, exit here. But, even if the cargo is not available
 # or too old, it's not the end of the world. There might be a pre-compiled
@@ -180,4 +182,3 @@ Please refer to <https://www.rust-lang.org/tools/install> to install Rust.
   )
 )
 quit("no", status = 2)
-

antidotum/tergo/update_authors.R

@@ -129,4 +129,3 @@ cat(
   file = "LICENSE.note",
   append = TRUE
 )
-

balnea/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tergo-lib"
-version = "0.2.4"
+version = "0.2.5"
 edition = "2021"
 description = "A tool to format R code"
 license = "MIT"
@@ -14,7 +14,7 @@ path = "src/lib.rs"
 [dependencies]
 tokenizer = { package = "tergo-tokenizer", path = "../aqua", version = "0.2.1" }
 parser = { package = "tergo-parser", path = "../spongia", version = "0.2.1" }
-formatter = { package = "tergo-formatter", path = "../unguentum", version = "0.2.2" }
+formatter = { package = "tergo-formatter", path = "../unguentum", version = "0.2.4" }
 log = "0.4.21"
 env_logger = "0.11.3"
 serde = { version = "1.0.210", features = ["derive"] }

unguentum/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tergo-formatter"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 description = "Formatter for tergo"

unguentum/src/lib.rs

@@ -12,6 +12,7 @@ use crate::format::Mode;
 use log::trace;
 use parser::ast::Expression;
 use post_format_hooks::trim_line_endings;
+use post_format_hooks::trim_trailing_line;
 use std::collections::VecDeque;
 use std::rc::Rc;
 
@@ -54,11 +55,10 @@ pub fn format_code<T: config::FormattingConfig>(
     let mut formatted = simple_doc_to_string(simple_doc);
 
     // Post-format hooks
-    let post_format_hooks = vec![trim_line_endings];
+    let post_format_hooks = vec![trim_line_endings, trim_trailing_line];
     for hook in post_format_hooks {
         formatted = hook(formatted);
     }
 
-    // Add a new line because trimming whitespace removes the trailing line
     formatted
 }

unguentum/src/post_format_hooks.rs

@@ -6,3 +6,10 @@ pub(crate) fn trim_line_endings(s: String) -> String {
             acc
         })
 }
+
+pub(crate) fn trim_trailing_line(mut s: String) -> String {
+    let trimmed = s.trim_end();
+    s.truncate(trimmed.len());
+    s.push('\n');
+    s
+}