Add --load_package to lintr

Author: agvandervelde

inst/hooks/exported/lintr.R

@@ -3,11 +3,15 @@
 
 "Run lintr on R files during a precommit.
 Usage:
-  lintr [--warn_only] <files>...
+  lintr [options] <files>...
+
 Options:
-  --warn_only  Print lint warnings instead of blocking the commit. Should be
-               used with `verbose: True` in `.pre-commit-config.yaml`.
-               Otherwise, lints will never be shown to the user.
+  --warn_only     Print lint warnings instead of blocking the commit. Should be
+                  used with `verbose: True` in `.pre-commit-config.yaml`.
+                  Otherwise, lints will never be shown to the user.
+  --load_package  Use `pkgload::load_all()` to load subject package prior to
+                  running lintr.
+
 " -> doc
 
 arguments <- precommit::precommit_docopt(doc)
@@ -23,6 +27,11 @@ if (any(lintr_staged)) {
   )
 }
 
+if (arguments$load_package) {
+  cat("Attempting to load package\n")
+  pkgload::load_all()
+}
+
 for (path in arguments$files) {
   lints <- lintr::lint(path)
   if (length(lints) > 0) {

tests/testthat/test-docopt.R

@@ -7,14 +7,16 @@ test_that("custom docopt interface parses as expected", {
     c("Another file with spaces.R", "Yet another file with spaces (YAFWS).R", "--warn_only"),
     c("--warn_only", "Another file with spaces.R"),
     c("--warn_only", "Another file with spaces.R", "Yet another file with spaces (YAFWS).R"),
-    c("Another file with spaces.R", "--warn_only", "Yet another file with spaces (YAFWS).R")
+    c("Another file with spaces.R", "--warn_only", "Yet another file with spaces (YAFWS).R"),
+    c("--load_package", "Another file with spaces.R", "Yet another file with spaces (YAFWS).R")
   )
 
   "Run lintr on R files during a precommit.
 Usage:
-  cmdtest [--warn_only] <files>...
+  cmdtest [options] <files>...
 Options:
-  --warn_only  Placeholder for test.
+  --warn_only     Placeholder for test.
+  --load_package  Placeholder for test.
 " -> doc
 
   for (args in args_variants) {
@@ -35,5 +37,12 @@ Options:
       expect_false(new_args$warn_only)
       expect_false(new_args$`--warn_only`)
     }
+    if ("--load_package" %in% args) {
+      expect_true(new_args$load_package)
+      expect_true(new_args$`--load_package`)
+    } else {
+      expect_false(new_args$load_package)
+      expect_false(new_args$`--load_package`)
+    }
   }
 })

vignettes/available-hooks.Rmd

@@ -347,6 +347,13 @@ in a `.lintr` config file in Debian Control Field Format as specified in
 the [`.lintr`
 documentation](https://github.com/r-lib/lintr#project-configuration).
 
+When linting a package, `load_package` lintr uses `pkgload::load_all()`
+to load the package before running `lintr::lint()`.
+
+      id: lintr
+      args: [--load_package]
+      verbose: true
+
 This hook does not modify any file.
 
 ## `codemeta-description-updated`