Merge branch 'main' into on-cap

Author: MichaelChirico

R/comparison_negation_linter.R

@@ -3,6 +3,34 @@
 #' `!(x == y)` is more readably expressed as `x != y`. The same is true of
 #'   other negations of simple comparisons like `!(x > y)` and `!(x <= y)`.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "!x == 2",
+#'   linters = comparison_negation_linter()
+#' )
+#'
+#' lint(
+#'   text = "!(x > 2)",
+#'   linters = comparison_negation_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "!(x == 2 & y > 2)",
+#'   linters = comparison_negation_linter()
+#' )
+#'
+#' lint(
+#'   text = "!(x & y)",
+#'   linters = comparison_negation_linter()
+#' )
+#'
+#' lint(
+#'   text = "x != 2",
+#'   linters = comparison_negation_linter()
+#' )
+#'
 #' @evalRd rd_tags("comparison_negation_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

R/get_source_expressions.R

@@ -68,8 +68,7 @@ get_source_expressions <- function(filename, lines = NULL) {
   }
 
   # Only regard explicit attribute terminal_newline=FALSE as FALSE and all other cases (e.g. NULL or TRUE) as TRUE.
-  # We don't use isFALSE since it is introduced in R 3.5.0.
-  terminal_newline <- !identical(attr(source_expression$lines, "terminal_newline", exact = TRUE), FALSE)
+  terminal_newline <- !isFALSE(attr(source_expression$lines, "terminal_newline", exact = TRUE))
 
   e <- NULL
   source_expression$lines <- extract_r_source(
@@ -493,19 +492,6 @@ get_source_expression <- function(source_expression, error = identity) {
     error = error
   )
 
-  # TODO: Remove when minimum R version is bumped to > 3.5
-  #
-  # This needs to be done twice to avoid a bug fixed in R 3.4.4
-  #   https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16041
-  parsed_content <- tryCatch(
-    parse(
-      text = source_expression$content,
-      srcfile = source_expression,
-      keep.source = TRUE
-    ),
-    error = error
-  )
-
   if (inherits(parsed_content, c("error", "lint"))) {
     assign("e", parsed_content, envir = parent.frame())
     parse_error <- TRUE

R/namespace.R

@@ -85,13 +85,7 @@ is_s3_generic <- function(fun) {
 
 .base_s3_generics <- unique(c(
   names(.knownS3Generics),
-  if (getRversion() >= "3.5.0") {
-    .S3_methods_table[, 1L]
-  } else {
-    # R < 3.5.0 doesn't provide .S3_methods_table
-    # fallback: search baseenv() for generic methods
-    imported_s3_generics(data.frame(pkg = "base", fun = ls(baseenv()), stringsAsFactors = FALSE))$fun
-  },
+  .S3_methods_table[, 1L],
   # Contains S3 generic groups, see ?base::groupGeneric and src/library/base/R/zzz.R
   ls(.GenericArgsEnv)
 ))

R/nonportable_path_linter.R

@@ -2,6 +2,19 @@
 #'
 #' Check that [file.path()] is used to construct safe and portable paths.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "'abcdefg/hijklmnop/qrst/uv/wxyz'",
+#'   linters = nonportable_path_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "file.path('abcdefg', 'hijklmnop', 'qrst', 'uv', 'wxyz')",
+#'   linters = nonportable_path_linter()
+#' )
+#'
 #' @inheritParams absolute_path_linter
 #' @evalRd rd_tags("nonportable_path_linter")
 #' @seealso

R/sample_int_linter.R

@@ -3,6 +3,34 @@
 #' [sample.int()] is preferable to `sample()` for the case of sampling numbers
 #'   between 1 and `n`. `sample` calls `sample.int()` "under the hood".
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "sample(1:10, 2)",
+#'   linters = sample_int_linter()
+#' )
+#'
+#' lint(
+#'   text = "sample(seq(4), 2)",
+#'   linters = sample_int_linter()
+#' )
+#'
+#' lint(
+#'   text = "sample(seq_len(8), 2)",
+#'   linters = sample_int_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "sample(seq(1, 5, by = 2), 2)",
+#'   linters = sample_int_linter()
+#' )
+#'
+#' lint(
+#'   text = "sample(letters, 2)",
+#'   linters = sample_int_linter()
+#' )
+#'
 #' @evalRd rd_tags("sample_int_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

R/scalar_in_linter.R

@@ -7,6 +7,24 @@
 #' `scalar %in% vector` is OK, because the alternative (`any(vector == scalar)`)
 #'   is more circuitous & potentially less clear.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "x %in% 1L",
+#'   linters = scalar_in_linter()
+#' )
+#'
+#' lint(
+#'   text = "x %chin% 'a'",
+#'   linters = scalar_in_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "x %in% 1:10",
+#'   linters = scalar_in_linter()
+#' )
+#'
 #' @evalRd rd_tags("scalar_in_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

R/stopifnot_all_linter.R

@@ -3,6 +3,29 @@
 #' `stopifnot(A)` actually checks `all(A)` "under the hood" if `A` is a vector,
 #'   and produces a better error message than `stopifnot(all(A))` does.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "stopifnot(all(x > 0))",
+#'   linters = stopifnot_all_linter()
+#' )
+#'
+#' lint(
+#'   text = "stopifnot(y > 3, all(x < 0))",
+#'   linters = stopifnot_all_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "stopifnot(is.null(x) || all(x > 0))",
+#'   linters = stopifnot_all_linter()
+#' )
+#'
+#' lint(
+#'   text = "assert_that(all(x > 0))",
+#'   linters = stopifnot_all_linter()
+#' )
+#'
 #' @evalRd rd_tags("stopifnot_all_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

R/terminal_close_linter.R

@@ -3,6 +3,37 @@
 #' Functions that end in `close(x)` are almost always better written by using
 #'   `on.exit(close(x))` close to where `x` is defined and/or opened.
 #'
+#' @examples
+#' # will produce lints
+#' code <- paste(
+#'   "f <- function(fl) {",
+#'   "  conn <- file(fl, open = 'r')",
+#'   "  readLines(conn)",
+#'   "  close(conn)",
+#'   "}",
+#'   sep = "\n"
+#' )
+#' writeLines(code)
+#' lint(
+#'   text = code,
+#'   linters = terminal_close_linter()
+#' )
+#'
+#' # okay
+#' code <- paste(
+#'   "f <- function(fl) {",
+#'   "  conn <- file(fl, open = 'r')",
+#'   "  on.exit(close(conn))",
+#'   "  readLines(conn)",
+#'   "}",
+#'   sep = "\n"
+#' )
+#' writeLines(code)
+#' lint(
+#'   text = code,
+#'   linters = terminal_close_linter()
+#' )
+#'
 #' @evalRd rd_tags("terminal_close_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export