Avoid evaluation of code by default

Author: owenjonesuob

inst/hooks/exported/parsable-roxygen.R

@@ -2,10 +2,10 @@
 
 "Check whether roxygen comments within files are valid
 Usage:
-  parsable-roxygen [--no-eval] <files>...
+  parsable-roxygen [--eval] <files>...
 
 Options:
-  --no-eval  Parse, but do not evaluate, file contents - this also suppresses evaluation of `@eval` tags
+  --eval  Evaluate file contents after parsing - this is required if `@eval` tags must be evaluated
 
 " -> doc
 
@@ -17,10 +17,10 @@ out <- lapply(arguments$files, function(path) {
     msg <- capture.output(
       roxygen2::parse_file(
         path,
-        env = if (isTRUE(arguments$no_eval)) {
-          NULL
-        } else {
+        env = if (isTRUE(arguments$eval)) {
           roxygen2::env_file(path)
+        } else {
+          NULL
         }
       ),
       type = "message"

vignettes/available-hooks.Rmd

@@ -146,25 +146,27 @@ running `roxygen2::parse_file()` on them returns any messages.
 
 This hook does not modify files.
 
-**no eval**
+**eval**
 
-The `--no-eval` flag causes `roxygen2::parse_file()` to be run with`env = NULL`.
-This means each file will be parsed, but code will not be evaluated - neither
+By default, each file will be parsed, but code will not be evaluated - neither
 any explicit code in the file, nor any `@eval` tags within roxygen comments.
-This can be useful if your files contain anything other than
-"simple object declarations" (e.g. [box modules](https://github.com/klmr/box/)
-containing `box::use()` calls). When `--no-eval` is missing, this means dependencies 
-of the code to evaluate must be available for pre-commit. You may list these as 
-`additional_dependencies:` for the `parsable-roxygen` hook in 
+
+If your commentary contains `@eval` tags which you would prefer to evaluate, you
+can specify the `--eval` flag, which will cause the file's code to be evaluated
+in an environment created by `roxygen2::env_file()`. Note that dependencies of
+the code to evaluate must be available for pre-commit. You may list these as
+`additional_dependencies:` for the `parsable-roxygen` hook in
 `.pre-commit-config.yaml`.
 
 Inline R code within roxygen comments (i.e. within backticks) is **not**
-evaluated by this hook, whether or not `--no-eval` is specified. You would need to run the `roxygenize` hook for that.
+evaluated by this hook, whether or not `--eval` is specified. You would need
+to run the `roxygenize` hook for that.
 
       id: parsable-roxygen
-      args: [--no-eval]
+      args: [--eval]
 
 This hook was added in version 0.4.3.9000.
+
 ## `no-browser-statement`
 
 Guarantees you that you don't accidentally commit code with a