Merge pull request #960 from r-lib/lintr

towards passing lintr checks

Author: lorenzwalthert

NEWS.md

@@ -43,6 +43,8 @@ editor_options:
     (#946).
 -   turned off `styler.print.Vertical` in vignettes so ANSI output of {prettycode} 
     not messing with {pkgdown} (\@IndrajeetPatil, #956, #957). 
+-   Improved code quality by fixing {lintr} warnings (#960).
+
 
 # styler 1.7.0
 

R/addins.R

@@ -37,8 +37,9 @@
 #' # save after styling when using the Addin
 #' options(styler.save_after_styling = TRUE)
 #' # only style with scope = "spaces" when using the Addin
+#' val <- "styler::tidyverse_style(scope = 'spaces')"
 #' options(
-#'   styler.addins_style_transformer = "styler::tidyverse_style(scope = 'spaces')"
+#'   styler.addins_style_transformer = val
 #' )
 #' }
 NULL
@@ -130,7 +131,11 @@ style_selection <- function() {
     base_indention = nchar(gsub("^( *).*", "\\1", text))
   )
   rstudioapi::modifyRange(
-    context$selection[[1]]$range, paste0(c(out, if (context$selection[[1]]$range$end[2] == 1) ""), collapse = "\n"),
+    context$selection[[1]]$range,
+    paste0(c(
+      out,
+      if (context$selection[[1]]$range$end[2] == 1) ""
+    ), collapse = "\n"),
     id = context$id
   )
   if (save_after_styling_is_active() == TRUE && context$path != "") {
@@ -212,9 +217,9 @@ try_transform_as_r_file <- function(context, transformer) {
     transformer(context$contents),
     error = function(e) {
       preamble_for_unsaved <- paste(
-        "Styling of unsaved files is only supported for R files with valid code.",
-        "Please save the file (as .R or .Rmd) and make sure that the R code in it",
-        "can be parsed. Then, try to style again."
+        "Styling of unsaved files is only supported for R files with valid ",
+        "code. Please save the file (as .R or .Rmd) and make sure that the R ",
+        "code in it can be parsed. Then, try to style again."
       )
 
       if (context$path == "") {

R/communicate.R

@@ -25,9 +25,17 @@ communicate_summary <- function(changed, ruler_width) {
   if (!getOption("styler.quiet", FALSE)) {
     cli::cat_rule(width = max(40, ruler_width))
     cat("Status\tCount\tLegend \n")
-    cli::cat_bullet("\t", sum(!changed, na.rm = TRUE), "\tFile unchanged.", bullet = "tick")
-    cli::cat_bullet("\t", sum(changed, na.rm = TRUE), "\tFile changed.", bullet = "info")
-    cli::cat_bullet(bullet = "cross", "\t", sum(is.na(changed)), "\tStyling threw an error.")
+    cli::cat_bullet(
+      "\t", sum(!changed, na.rm = TRUE), "\tFile unchanged.",
+      bullet = "tick"
+    )
+    cli::cat_bullet(
+      "\t", sum(changed, na.rm = TRUE), "\tFile changed.",
+      bullet = "info"
+    )
+    cli::cat_bullet(
+      bullet = "cross", "\t", sum(is.na(changed)), "\tStyling threw an error."
+    )
     cli::cat_rule(width = max(40, ruler_width))
   }
 }

R/detect-alignment-utils.R

@@ -108,9 +108,9 @@ alignment_serialize_column <- function(relevant_pd_by_line, column) {
 #' @keywords internal
 alignment_serialize_line <- function(relevant_pd_by_line, column) {
   # TODO
-  # better also add lover bound for column. If you already checked up to comma 2,
-  # you don't need to re-construct text again, just check if text between comma 2
-  # and 3 has the same length.
+  # better also add lover bound for column. If you already checked up to
+  # comma 2, you don't need to re-construct text again, just check if text
+  # between comma 2 and 3 has the same length.
   comma_idx <- which(relevant_pd_by_line$token == "','")
   n_cols <- length(comma_idx)
   if (column > n_cols) {

R/detect-alignment.R

@@ -116,7 +116,8 @@ token_is_on_aligned_line <- function(pd_flat) {
 
     # first col has no leading ,
     current_col <- nchar(by_line) - as.integer(column > 1)
-    # Problem `by_line` counting from comma before column 3, previous_line counting 1 space before ~
+    # Problem `by_line` counting from comma before column 3, previous_line
+    # counting 1 space before ~
     if (column > 1) {
       previous_line <- previous_line[
         intersect(names(previous_line), names(by_line))

R/environments.R

@@ -5,11 +5,11 @@
 #' around. Examples are [#187](https://github.com/r-lib/styler/issues/187),
 #' [#216](https://github.com/r-lib/styler/issues/216),
 #' [#100](https://github.com/r-lib/styler/issues/100) and others. With
-#' [#419](https://github.com/r-lib/styler/issues/419), the structure of the parse
-#' data changes and we need to dispatch for older versions. As it is inconvenient
-#' to pass a parser version down in the call stack in various places, the
-#' environment `env_current` is used to store the current version *globally*
-#' but internally.
+#' [#419](https://github.com/r-lib/styler/issues/419), the structure of the
+#' parse data changes and we need to dispatch for older versions. As it is
+#' inconvenient to pass a parser version down in the call stack in various
+#' places, the environment `env_current` is used to store the current version
+#' *globally* but internally.
 #'
 #' We version the parser as follows:
 #'

R/indent.R

@@ -8,8 +8,8 @@
 #' @keywords internal
 NULL
 
-#' @describeIn update_indention Is used to indent for and statements and function
-#'   definitions without parenthesis.
+#' @describeIn update_indention Is used to indent for and statements and
+#'   function definitions without parenthesis.
 #' @keywords internal
 indent_without_paren_for_while_fun <- function(pd, indent_by) {
   tokens <- c("FOR", "WHILE", "FUNCTION")
@@ -39,7 +39,9 @@ indent_without_paren_if_else <- function(pd, indent_by) {
   if (!is_if) {
     return(pd)
   }
-  needs_indention_now <- pd$lag_newlines[next_non_comment(pd, which(pd$token == "')'"))] > 0
+  needs_indention_now <- pd$lag_newlines[
+    next_non_comment(pd, which(pd$token == "')'"))
+  ] > 0
 
   if (needs_indention_now) {
     pd$indent[expr_after_if] <- indent_by
@@ -57,7 +59,9 @@ indent_without_paren_if_else <- function(pd, indent_by) {
       pd$child[[expr_after_else_idx]]$token[1] != "'{'" &&
       pd$child[[expr_after_else_idx]]$token[1] != "IF"
 
-  needs_indention_now <- pd$lag_newlines[next_non_comment(pd, which(pd$token == "ELSE"))] > 0
+  needs_indention_now <- pd$lag_newlines[
+    next_non_comment(pd, which(pd$token == "ELSE"))
+  ] > 0
 
   if (has_else_without_curly_or_else_chid && needs_indention_now) {
     pd$indent[seq(else_idx + 1, nrow(pd))] <- indent_by
@@ -231,7 +235,8 @@ pd_multi_line <- function(pd) {
 #' R/rules-spacing.R for tokens at the end of a line since this allows styling
 #' without touching indention.
 #' @param pd A parse table.
-#' @return A parse table with synchronized `lag_newlines` and `newlines` columns.
+#' @return A parse table with synchronized `lag_newlines` and `newlines`
+#'   columns.
 #' @seealso choose_indention
 #' @keywords internal
 update_newlines <- function(pd) {

R/nest.R

@@ -109,7 +109,8 @@ add_cache_block <- function(pd_nested) {
 #' @keywords internal
 drop_cached_children <- function(pd) {
   if (cache_is_activated()) {
-    pd_parent_first <- pd[order(pd$line1, pd$col1, -pd$line2, -pd$col2, as.integer(pd$terminal)), ]
+    order <- order(pd$line1, pd$col1, -pd$line2, -pd$col2, as.integer(pd$terminal))
+    pd_parent_first <- pd[order, ]
     pos_ids_to_keep <- pd_parent_first %>%
       split(cumsum(pd_parent_first$parent == 0)) %>%
       map(find_pos_id_to_keep) %>%
@@ -124,8 +125,9 @@ drop_cached_children <- function(pd) {
 #' Find the pos ids to keep
 #'
 #' To make a parse table shallow, we must know which ids to keep.
-#' `split(cumsum(pd_parent_first$parent == 0))` above puts comments with negative
-#' parents in the same block as proceeding expressions (but also with positive).
+#' `split(cumsum(pd_parent_first$parent == 0))` above puts comments with
+#' negative parents in the same block as proceeding expressions (but also with
+#' positive).
 #' `find_pos_id_to_keep()` must hence always keep negative comments. We did not
 #' use `split(cumsum(pd_parent_first$parent < 1))` because then every top-level
 #' comment is an expression on its own and processing takes much longer for
@@ -173,6 +175,7 @@ find_pos_id_to_keep <- function(pd) {
 #' option supports character vectors longer than one and the marker are not
 #' exactly matched, but using a  regular expression, which means you can have
 #' multiple marker on one line, e.g. `# nolint start styler: off`.
+# nolint end
 #' @name stylerignore
 #' @examples
 #' # as long as the order of the markers is correct, the lines are ignored.

R/nested-to-tree.R

@@ -12,7 +12,8 @@ create_tree <- function(text, structure_only = FALSE) {
     create_tree_from_pd_with_default_style_attributes(structure_only)
 }
 
-create_tree_from_pd_with_default_style_attributes <- function(pd, structure_only = FALSE) {
+create_tree_from_pd_with_default_style_attributes <- function(pd,
+                                                              structure_only = FALSE) {
   pd %>%
     create_node_from_nested_root(structure_only) %>%
     as.data.frame()
@@ -35,8 +36,12 @@ create_tree_from_pd_with_default_style_attributes <- function(pd, structure_only
 #'     {
 #'       code <- "a <- function(x) { if(x > 1) { 1+1 } else {x} }"
 #'       nested_pd <- styler:::compute_parse_data_nested(code)
-#'       initialized <- styler:::pre_visit(nested_pd, c(default_style_guide_attributes))
-#'       styler:::create_node_from_nested_root(initialized, structure_only = FALSE)
+#'       initialized <- styler:::pre_visit(
+#'         nested_pd, c(default_style_guide_attributes)
+#'       )
+#'       styler:::create_node_from_nested_root(initialized,
+#'         structure_only = FALSE
+#'       )
 #'     }
 #'   )
 #' }

R/parse.R

@@ -27,8 +27,8 @@ parse_safely <- function(text, ...) {
       abort(paste0(
         "The code to style seems to use Windows style line endings (CRLF). ",
         "styler currently only supports Unix style line endings (LF). ",
-        "Please change the EOL character in your editor to Unix style and try again.",
-        "\nThe parsing error was:\n", tried_parsing$message
+        "Please change the EOL character in your editor to Unix style and try ",
+        "again.\nThe parsing error was:\n", tried_parsing$message
       ))
     } else {
       abort(tried_parsing$message)