Deprecate unnecessary_concatenation_linter() (#1862)

* Deprecate `unnecessary_concatenation_linter()`

In favour of `unnecessary_concatenation_linter()`

Closes #1797

* fix tests

* fix new lint

* minor docs

* update deprecated_linters list

* address review comments

* add tests for validations

* fix lint

Author: IndrajeetPatil

.lintr_new

@@ -27,7 +27,7 @@ linters: linters_with_defaults(
     strings_as_factors_linter(),
     unnecessary_nested_if_linter(),
     unnecessary_lambda_linter(),
-    unneeded_concatenation_linter(allow_single_expression = FALSE),
+    unnecessary_concatenation_linter(allow_single_expression = FALSE),
     yoda_test_linter()
   )
 exclusions: list(

DESCRIPTION

@@ -160,10 +160,10 @@ Collate:
     'tree_utils.R'
     'undesirable_function_linter.R'
     'undesirable_operator_linter.R'
+    'unnecessary_concatenation_linter.R'
     'unnecessary_lambda_linter.R'
     'unnecessary_nested_if_linter.R'
     'unnecessary_placeholder_linter.R'
-    'unneeded_concatenation_linter.R'
     'unreachable_code_linter.R'
     'unused_import_linter.R'
     'use_lintr.R'

NAMESPACE

@@ -123,6 +123,7 @@ export(trailing_blank_lines_linter)
 export(trailing_whitespace_linter)
 export(undesirable_function_linter)
 export(undesirable_operator_linter)
+export(unnecessary_concatenation_linter)
 export(unnecessary_lambda_linter)
 export(unnecessary_nested_if_linter)
 export(unnecessary_placeholder_linter)

NEWS.md

@@ -44,6 +44,9 @@
 
 * The new `indentation_linter()` is part of the default linters. See "New linters" for more details.
 
+* For naming consistency, `unneeded_concatenation_linter()` has been deprecated in favour of
+  `unnecessary_concatenation_linter()` (#1797, @IndrajeetPatil).
+
 ## New and improved features
 
 * New `get_r_string()` helper to get the R-equivalent value of a string, especially useful for R-4-style raw strings.

R/empty_assignment_linter.R

@@ -1,7 +1,7 @@
 #' Block assignment of `{}`
 #'
 #' Assignment of `{}` is the same as assignment of `NULL`; use the latter
-#'   for clarity. Closely related: [unneeded_concatenation_linter()].
+#'   for clarity. Closely related: [unnecessary_concatenation_linter()].
 #'
 #' @examples
 #' # will produce lints

R/linter_tags.R

@@ -4,7 +4,8 @@
 #'
 #' @param packages A character vector of packages to search for linters.
 #' @param tags Optional character vector of tags to search. Only linters with at least one matching tag will be
-#' returned. If `tags` is `NULL`, all linters will be returned.
+#' returned. If `tags` is `NULL`, all linters will be returned. See `available_tags("lintr")` to find out what
+#' tags are already used by lintr.
 #' @param exclude_tags Tags to exclude from the results. Linters with at least one matching tag will not be returned.
 #' If `except_tags` is `NULL`, no linters will be excluded.
 #'

R/lintr-deprecated.R

@@ -177,6 +177,24 @@ semicolon_terminator_linter <- function(semicolon = c("compound", "trailing")) {
   semicolon_linter(allow_compound, allow_trailing)
 }
 
+#' Unnecessary concatenation linter
+#' @rdname lintr-deprecated
+#' @export
+unneeded_concatenation_linter <- function(allow_single_expression = TRUE) {
+  lintr_deprecated(
+    old = "unneeded_concatenation_linter",
+    new = "unnecessary_concatenation_linter",
+    version = "3.1.0",
+    type = "Linter"
+  )
+
+  stopifnot(
+    is.logical(allow_single_expression),
+    length(allow_single_expression) == 1L
+  )
+  unnecessary_concatenation_linter(allow_single_expression = allow_single_expression)
+}
+
 #' @keywords internal
 #' @noRd
 find_line_fun <- function(content, newline_locs) {

R/unneeded_concatenation_linter.R renamed to R/unnecessary_concatenation_linter.R

@@ -13,45 +13,50 @@
 #' # will produce lints
 #' lint(
 #'   text = "x <- c()",
-#'   linters = unneeded_concatenation_linter()
+#'   linters = unnecessary_concatenation_linter()
 #' )
 #'
 #' lint(
 #'   text = "x <- c(TRUE)",
-#'   linters = unneeded_concatenation_linter()
+#'   linters = unnecessary_concatenation_linter()
 #' )
 #'
 #' lint(
 #'   text = "x <- c(1.5 + 2.5)",
-#'   linters = unneeded_concatenation_linter(allow_single_expression = FALSE)
+#'   linters = unnecessary_concatenation_linter(allow_single_expression = FALSE)
 #' )
 #'
 #' # okay
 #' lint(
 #'   text = "x <- NULL",
-#'   linters = unneeded_concatenation_linter()
+#'   linters = unnecessary_concatenation_linter()
 #' )
 #'
 #' # In case the intent here was to seed a vector of known size
 #' lint(
 #'   text = "x <- integer(4L)",
-#'   linters = unneeded_concatenation_linter()
+#'   linters = unnecessary_concatenation_linter()
 #' )
 #'
 #' lint(
 #'   text = "x <- TRUE",
-#'   linters = unneeded_concatenation_linter()
+#'   linters = unnecessary_concatenation_linter()
 #' )
 #'
 #' lint(
 #'   text = "x <- c(1.5 + 2.5)",
-#'   linters = unneeded_concatenation_linter(allow_single_expression = TRUE)
+#'   linters = unnecessary_concatenation_linter(allow_single_expression = TRUE)
 #' )
 #'
-#' @evalRd rd_tags("unneeded_concatenation_linter")
+#' @evalRd rd_tags("unnecessary_concatenation_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export
-unneeded_concatenation_linter <- function(allow_single_expression = TRUE) {
+unnecessary_concatenation_linter <- function(allow_single_expression = TRUE) { # nolint: object_length_linter.
+  stopifnot(
+    is.logical(allow_single_expression),
+    length(allow_single_expression) == 1L
+  )
+
   msg_empty <- paste(
     "Unneeded concatenation without arguments.",
     'Replace the "c" call by NULL or, whenever possible,',

inst/lintr/linters.csv

@@ -82,10 +82,11 @@ trailing_blank_lines_linter,style default
 trailing_whitespace_linter,style default configurable
 undesirable_function_linter,style efficiency configurable robustness best_practices
 undesirable_operator_linter,style efficiency configurable robustness best_practices
+unnecessary_concatenation_linter,style readability efficiency configurable
 unnecessary_lambda_linter,best_practices efficiency readability
 unnecessary_nested_if_linter,readability best_practices
 unnecessary_placeholder_linter,readability best_practices
-unneeded_concatenation_linter,style readability efficiency configurable
+unneeded_concatenation_linter,style readability efficiency configurable deprecated
 unreachable_code_linter,best_practices readability
 unused_import_linter,best_practices common_mistakes configurable executing
 vector_logic_linter,default efficiency best_practices