Discover and check for rogue print statements

Author: stefanoborini

.pre-commit-config.yaml

@@ -73,6 +73,11 @@ repos:
           (?x)^(
           tests/testthat/in/.*|
           )$
+    -   id: no-print-statement
+        exclude: > 
+          (?x)^(
+          tests/testthat/in/.*|
+          )$
     -   id: no-debug-statement
         exclude: >
           (?x)^(

.pre-commit-hooks.yaml

@@ -28,6 +28,13 @@
     language: r
     files: '\.[rR]$'
     minimum_pre_commit_version: "2.13.0"
+-   id: no-print-statement
+    name: no-print-statement
+    description: check if a .R file contains a `print()` statement
+    entry: Rscript inst/hooks/exported/no-print-statement.R
+    language: r
+    files: '\.[rR]$'
+    minimum_pre_commit_version: "2.13.0"
 -   id: no-debug-statement
     name: no-debug-statement
     description: check if a .R file contains a `debug()` or `debugonce()` statement

inst/hooks/exported/no-print-statement.R

@@ -0,0 +1,13 @@
+#!/usr/bin/env Rscript
+
+files <- commandArgs(trailing = TRUE)
+no_print_statement <- function(path) {
+  pd <- getParseData(parse(path, keep.source = TRUE))
+  if (any(pd$text[pd$token == "SYMBOL_FUNCTION_CALL"] == "print")) {
+    stop("File `", path, "` contains a `print()` statement.", call. = FALSE)
+  }
+}
+
+for (file in files) {
+  temp <- no_print_statement(file)
+}

inst/pre-commit-config-pkg.yaml

@@ -44,6 +44,7 @@ repos:
     -   id: readme-rmd-rendered
     -   id: parsable-R
     -   id: no-browser-statement
+    -   id: no-print-statement
     -   id: no-debug-statement
     -   id: deps-in-desc
     -   id: pkgdown

inst/pre-commit-config-proj.yaml

@@ -40,6 +40,7 @@ repos:
     -   id: readme-rmd-rendered
     -   id: parsable-R
     -   id: no-browser-statement
+    -   id: no-print-statement
     -   id: no-debug-statement
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.2.3

inst/pre-commit-hooks.yaml

@@ -28,6 +28,13 @@
     language: r
     files: '\.[rR]$'
     minimum_pre_commit_version: "2.13.0"
+-   id: no-print-statement
+    name: no-print-statement
+    description: check if a .R file contains a `print()` statement
+    entry: Rscript inst/hooks/exported/no-print-statement.R
+    language: r
+    files: '\.[rR]$'
+    minimum_pre_commit_version: "2.13.0"
 -   id: no-debug-statement
     name: no-debug-statement
     description: check if a .R file contains a `debug()` or `debugonce()` statement

tests/testthat/in/no-print-statement-fail.R

@@ -0,0 +1 @@
+print()

tests/testthat/in/no-print-statement-success.R

@@ -0,0 +1 @@
+"print()"

tests/testthat/test-hooks.R

@@ -157,6 +157,22 @@ run_test(
   std_err = "contains a `browser()` statement."
 )
 
+### . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
+### no-print-statement                                                      ####
+# success
+run_test(
+  "no-print-statement",
+  suffix = "-success.R",
+  std_err = NULL
+)
+
+# failure
+run_test(
+  "no-print-statement",
+  suffix = "-fail.R",
+  std_err = "contains a `print()` statement."
+)
+
 ### . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
 ### no-debug-statement                                                    ####
 # success

vignettes/available-hooks.Rmd

@@ -146,6 +146,13 @@ Guarantees you that you don't accidentally commit code with a
 
 This hook does not modify files.
 
+## `no-print-statement`
+
+Guarantees you that you don't accidentally commit code with a
+`print()` statement in it.
+
+This hook does not modify files.
+
 ## `no-debug-statement`
 
 Guarantees you that you don't accidentally commit code with a `debug()`