Merge pull request #231 from lorenzwalthert/exclude_files

allow exclusion of files with style_pkg()  and style_dir

Author: lorenzwalthert

API

@@ -6,9 +6,9 @@ create_style_guide(initialize = initialize_attributes, line_break = NULL, space
 regex_none()
 specify_math_token_spacing(zero = NULL, one = c("'+'", "'-'", "'*'", "'/'", "'^'"))
 specify_reindention(regex_pattern = regex_none(), indention = 0, comments_only = TRUE)
-style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), recursive = TRUE)
+style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), recursive = TRUE, exclude_files = NULL)
 style_file(path, ..., style = tidyverse_style, transformers = style(...))
-style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...))
+style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...), exclude_files = "R/RcppExports.R")
 style_text(text, ..., style = tidyverse_style, transformers = style(...))
 tidyverse_math_token_spacing()
 tidyverse_reindention()

R/ws.R

@@ -18,6 +18,8 @@ NULL
 #' @param transformers A set of transformer functions. This argument is most
 #'   conveniently constructed via the `style` argument and `...`. See
 #'   'Examples'.
+#' @param exclude_files Character vector with paths to files that should be
+#'   excluded from styling.
 #' @section Warning:
 #' This function overwrites files (if styling results in a change of the
 #' code to be formatted). It is strongly suggested to only style files
@@ -34,12 +36,13 @@ NULL
 style_pkg <- function(pkg = ".",
                       ...,
                       style = tidyverse_style,
-                      transformers = style(...)) {
+                      transformers = style(...),
+                      exclude_files = "R/RcppExports.R") {
   pkg_root <- rprojroot::find_package_root_file(path = pkg)
-  withr::with_dir(pkg_root, prettify_local(transformers))
+  withr::with_dir(pkg_root, prettify_local(transformers, exclude_files))
 }
 
-prettify_local <- function(transformers) {
+prettify_local <- function(transformers, exclude_files) {
   r_files <- dir(
     path = "R", pattern = "[.][rR]$", recursive = TRUE, full.names = TRUE
   )
@@ -50,7 +53,7 @@ prettify_local <- function(transformers) {
     recursive = TRUE, full.names = TRUE
   )
 
-  files <- c(r_files, test_files)
+  files <- setdiff(c(r_files, test_files), exclude_files)
 
   transform_files(files, transformers)
 }
@@ -98,9 +101,10 @@ style_dir <- function(path = ".",
                       ...,
                       style = tidyverse_style,
                       transformers = style(...),
-                      recursive = TRUE) {
+                      recursive = TRUE,
+                      exclude_files = NULL) {
   withr::with_dir(
-    path, prettify_any(transformers, recursive = recursive)
+    path, prettify_any(transformers, recursive, exclude_files)
   )
 }
 
@@ -110,9 +114,11 @@ style_dir <- function(path = ".",
 #' @inheritParams style_pkg
 #' @param recursive A logical value indicating whether or not files in subdirectories
 #'   should be styled as well.
-prettify_any <- function(transformers, recursive) {
-  files <- dir(path = ".", pattern = "[.][rR]$", recursive = recursive, full.names = TRUE)
-  transform_files(files, transformers)
+prettify_any <- function(transformers, recursive, exclude_files) {
+  files <- dir(
+    path = ".", pattern = "[.][rR]$", recursive = recursive, full.names = TRUE
+  )
+  transform_files(setdiff(files, exclude_files), transformers)
 
 }