feat: Reinstate lint infrastructure as GHA (#396)

Co-authored-by: Kirill Müller <krlmlr@users.noreply.github.com>
Co-authored-by: Kirill Müller <kirill@cynkra.com>

Author: MichaelChirico

.Rbuildignore

@@ -1,6 +1,6 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
-^\.lintr$
+^\.lintr\.R$
 ^cran-comments\.md$
 ^revdep-dev$
 ^man-roxygen$

.github/workflows/lint.yaml

@@ -0,0 +1,32 @@
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: lint
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: |
+            r-lib/lintr
+            local::.
+          needs: lint
+
+      - name: Lint
+        run: lintr::lint_package()
+        shell: Rscript {0}
+        env:
+          LINTR_ERROR_ON_LINT: true

.gitignore

@@ -8,3 +8,7 @@ inst/doc
 CRAN-RELEASE
 CRAN-SUBMISSION
 .vscode
+
+*.Rcheck
+*.tar.gz
+

.lintr

@@ -0,0 +1,27 @@
+linters <- modify_defaults(
+  all_linters(),
+  absolute_path_linter = NULL,
+  commented_code_linter = NULL,
+  condition_call_linter = NULL,
+  cyclocomp_linter = NULL,
+  expect_identical_linter = NULL,
+  function_argument_linter = NULL,
+  if_switch_linter = NULL, # false positive: r-lib/lintr#2835
+  implicit_assignment_linter = NULL,
+  implicit_integer_linter = NULL,
+  keyword_quote_linter = NULL,
+  line_length_linter = NULL,
+  missing_argument_linter = NULL,
+  namespace_linter = NULL,
+  nonportable_path_linter = NULL,
+  nzchar_linter = NULL,
+  object_length_linter = NULL,
+  object_name_linter = NULL,
+  object_overwrite_linter = NULL,
+  object_usage_linter = NULL,
+  one_call_pipe_linter = NULL,
+  strings_as_factors_linter = NULL,
+  todo_comment_linter = NULL,
+  undesirable_function_linter = NULL,
+  unused_import_linter = NULL
+)

.lintr.R

@@ -36,7 +36,6 @@ Suggests:
     debugme,
     devtools,
     knitr,
-    lintr,
     pkgload,
     rmarkdown,
     RSQLite,

DESCRIPTION

@@ -86,11 +86,13 @@ pmap <- function(.l, .f, ...) {
   ))
 }
 .rlang_purrr_args_recycle <- function(args) {
+  # nolint next: lengths_linter.
   lengths <- map_int(args, length)
   n <- max(lengths)
 
-  stopifnot(all(lengths == 1L | lengths == n))
+  stopifnot(lengths == 1L | lengths == n)
   to_recycle <- lengths == 1L
+  # nolint next: unnecessary_lambda_linter.
   args[to_recycle] <- map(args[to_recycle], function(x) rep.int(x, n))
 
   args

R/compat-purrr.R

@@ -49,7 +49,8 @@ dbi_generics <- function(version) {
 
   if (version < "1.7.99.11") {
     generics <- setdiff(generics, c(
-      "dbBindArrow"
+      "dbBindArrow",
+      NULL
     ))
   }
 

R/dbi.R

@@ -25,6 +25,7 @@ expect_all_args_have_default_values <- function(object) {
 has_method <- function(method_name) {
   function(x) {
     my_class <- class(x)
+    # nolint next: expect_comparison_linter. Using 'info', absent from expect_gt().
     expect_true(
       length(findMethod(method_name, my_class)) > 0L,
       paste("object of class", my_class, "has no", method_name, "method")
@@ -55,15 +56,15 @@ expect_equal_df <- function(actual, expected) {
 
   list_cols <- map_lgl(expected, is.list)
 
-  if (!any(list_cols)) {
-    order_actual <- do.call(order, actual)
-    order_expected <- do.call(order, expected)
-  } else {
+  if (any(list_cols)) {
     expect_false(all(list_cols))
     expect_equal(anyDuplicated(actual[!list_cols]), 0)
     expect_equal(anyDuplicated(expected[!list_cols]), 0)
     order_actual <- do.call(order, actual[!list_cols])
     order_expected <- do.call(order, expected[!list_cols])
+  } else {
+    order_actual <- do.call(order, actual)
+    order_expected <- do.call(order, expected)
   }
 
   has_rownames_actual <- is.character(attr(actual, "row.names"))

R/expectations.R

@@ -92,7 +92,7 @@ run_tests <- function(ctx, tests, skip, run_only, test_suite) {
 
   if (any(skip_flag)) {
     test_that(paste0(test_context, ": skipped tests"), {
-      skip(paste0("DBItest::run_tests(): by request: ", paste(names(tests)[skip_flag], collapse = ", ")))
+      skip(paste0("DBItest::run_tests(): by request: ", toString(names(tests)[skip_flag])))
     })
   }