Merge 816a718 into 9305b62

Author: lorenzwalthert

.gitattributes

@@ -1 +1 @@
-tests/testthat/**/*_tree linguist-generated=true
+tests/testthat/**/*_tree linguist-generated=true

.github/workflows/R-CMD-check.yaml

@@ -27,9 +27,10 @@ jobs:
       matrix:
         config:
           - {os: macOS-latest,   r: 'release'}
+          - {os: windows-latest, r: 'devel'}
           - {os: windows-latest, r: 'release'}
-          - {os: windows-latest, r: '3.6', rspm: "https://packagemanager.rstudio.com/cran/latest"}
-          - {os: ubuntu-18.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.0.0 (ubuntu-18.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
+          - {os: windows-latest, r: '3.6',     rspm: "https://packagemanager.rstudio.com/cran/latest"}
+          - {os: ubuntu-18.04,   r: 'devel',   rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.0.0 (ubuntu-18.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
           - {os: ubuntu-18.04,   r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
           - {os: ubuntu-18.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
           - {os: ubuntu-18.04,   r: '3.6',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}

.github/workflows/check-full.yaml

@@ -1,6 +1,6 @@
 on:
   push:
-    branches: master
+    branches: main
 
 name: pkgdown
 

.github/workflows/pkgdown.yaml

@@ -1,10 +1,10 @@
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 name: test-coverage
 

.github/workflows/test-coverage.yaml

@@ -4,17 +4,22 @@ default_stages: [commit]
 
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.1.3.9014
+    rev: v0.1.3.9139
     hooks:
     -   id: style-files
         args: [--style_pkg=styler, --style_fun=tidyverse_style]
         exclude:  >
           (?x)^(
-          tests/testthat/.*/.*\.R(md)?|
+          tests/testthat/.*/.*\.R(md|nw)?|
           vignettes/customizing_styler\.Rmd|
           tests/testthat/public-api/xyzfile-rnw/random4\.Rnw|
+          vignettes/detect-alignment\.Rmd|
+          tests/testmanual/addins/.*invalid.*|
+          tests/testmanual/addins/r-valid\.R|
           )$
     -   id: roxygenize
+        additional_dependencies:
+        - r-lib/pkgapi
     -   id: use-tidy-description
     -   id: spell-check
         exclude: >
@@ -49,7 +54,8 @@ repos:
           tests/testthat/public-api/xyzaddin/addin_region-.*|
           tests/testmanual/addins/r-invalid\.R|
           tests/testthat/escaping/basic-escape-out\.R|
-          tests/testthat/indention_operators/base_pipe_and_assignment-.*|
+          tests/testthat/indention_operators/.*pipe.*|
+          tests/testthat/line_breaks_and_other/.*pipe.*|
           tests/testthat/exception_handling/parser-error.R|
           )$
     -   id: no-browser-statement
@@ -58,14 +64,15 @@ repos:
           tests/testthat/public-api/xyzaddin/addin_region-.*|
           tests/testmanual/addins/r-invalid\.R|
           tests/testthat/escaping/basic-escape-out\.R|
-          tests/testthat/indention_operators/base_pipe_and_assignment-.*|
+          tests/testthat/indention_operators/.*pipe.*|
+          tests/testthat/line_breaks_and_other/.*pipe.*|
           tests/testthat/exception_handling/parser-error.R|
           )$
     -   id: deps-in-desc
         exclude: >
           (?x)^(
           touchstone/.*|
-          tests/testmanual/addins/r-invalid\.R|
+          tests/testmanual/addins/.*invalid.*|
           tests/testthat/escaping/basic-escape-out\.R|
           tests/testthat/rnw/011-conditional-eval-out\.Rnw|
           tests/testthat/.*\.R(md)?
@@ -76,7 +83,13 @@ repos:
     -   id: check-added-large-files
         args: ['--maxkb=200']
     -   id: end-of-file-fixer
-        exclude: '\.Rd'
+        exclude: >
+          (?x)^(
+          \.Rd|
+          tests/testthat/exception_handling/empty_file\.R|
+          tests/testthat/parse_comments/eol_eof_spaces-.*|
+          tests/testthat/reference-objects/.*|
+          )$
 -   repo: local
     hooks:
     -   id: forbid-to-commit

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 Type: Package
 Package: styler
 Title: Non-Invasive Pretty Printing of R Code
-Version: 1.6.2
+Version: 1.6.2.9000
 Authors@R: 
     c(person(given = "Kirill",
              family = "Müller",
@@ -16,8 +16,9 @@ Description: Pretty-prints R code without changing the user's formatting
 License: MIT + file LICENSE
 URL: https://github.com/r-lib/styler, https://styler.r-lib.org
 BugReports: https://github.com/r-lib/styler/issues
+Depends:
+    R (>= 3.4.0)
 Imports: 
-    backports (>= 1.1.0),
     cli (>= 1.1.0),
     glue,
     magrittr (>= 2.0.0),
@@ -29,7 +30,6 @@ Imports:
     tibble (>= 1.4.2),
     tools,
     withr (>= 1.0.0),
-    xfun (>= 0.1)
 Suggests: 
     data.tree (>= 0.1.6),
     digest,
@@ -46,7 +46,7 @@ VignetteBuilder:
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "collate",
     "pkgapi::api_roclet"))
-RoxygenNote: 7.1.1.9001
+RoxygenNote: 7.1.2
 Collate: 
     'addins.R'
     'communicate.R'

DESCRIPTION

@@ -1,4 +1,21 @@
-# styler 1.2
+# styler 1.6.2.9000 (Development version)
+
+* Alignment detection respects stylerignore (#850).
+* Add vignette on distributing style guide (#846, #861).
+* Enable pre-commit.ci (#843).
+* new R option `styler.cache_root` (defaulting to `"styler"`) that determines 
+  the sub-directory under the {R.cache} cache directory that {styler} uses. Non-
+  default caches won't be cleaned up by {styler}. We suggest `"styler-perm"` 
+  (also used by {precommit}).
+* rename default branch to main (#859).
+* Fix argument name `filetype` in Example for `style_dir()` (#855).
+* ensure a trailing blank line also if the input is cached (#867).
+* Bump minimal R requirement to 3.4 in line with the [tidyverse](https://www.tidyverse.org/blog/2019/04/r-version-support/), which 
+  allowed to remove the dependency at {backports} and some exception handling.
+* Remove dependency on {xfun} (#866).
+* use bootstrap 5 with {pkgdown} 2.0
+
+# styler 1.6.2
 
 * clean up cache files older than one week (#842).
 

NEWS.md

@@ -3,8 +3,8 @@
 #' Helper functions for styling via RStudio Addins.
 #' @section Addins:
 #' - Set style: Select the style transformers to use. For flexibility, the user
-#'   input is passed to the `transformers` argument, not the `style` argument, so
-#'   entering `styler::tidyverse_style(scope = "spaces")` in the Addin is
+#'   input is passed to the `transformers` argument, not the `style` argument,
+#'   so entering `styler::tidyverse_style(scope = "spaces")` in the Addin is
 #'   equivalent to `styler::style_text("1+1", scope = "spaces")` and
 #'   `styler::style_text("1+1", transformers = styler::tidyverse_style(scope = "spaces"))`
 #'   if the text to style is `1+1`. The style transformers are memorized

R/addins.R

@@ -7,7 +7,7 @@
 #' @inheritParams can_verify_roundtrip
 #' @keywords internal
 communicate_warning <- function(changed, transformers) {
-  if (any(changed, na.rm = TRUE) && 
+  if (any(changed, na.rm = TRUE) &&
     !can_verify_roundtrip(transformers) &&
     !getOption("styler.quiet", FALSE)
   ) {

R/communicate.R

@@ -49,6 +49,10 @@ token_is_on_aligned_line <- function(pd_flat) {
   pd_flat$lag_newlines <- pd_flat$pos_id <- NULL
   pd_flat$.lag_spaces <- lag(pd_flat$spaces)
   pd_by_line <- split(pd_flat, line_idx)
+  pd_by_line[purrr::map_lgl(pd_by_line, ~ any(.x$stylerignore))] <- NULL
+  if (length(pd_by_line) < 1) {
+    return(TRUE)
+  }
   last_line_is_closing_brace_only <- nrow(last(pd_by_line)) == 1
   relevant_idx <- seq2(2, ifelse(last_line_is_closing_brace_only,
     length(pd_by_line) - 1,
@@ -86,7 +90,11 @@ token_is_on_aligned_line <- function(pd_flat) {
   }
 
   pd_by_line <- alignment_drop_comments(pd_by_line) %>%
-    alignment_ensure_no_closing_brace(last_line_is_closing_brace_only) %>%
+    alignment_ensure_no_closing_brace(last_line_is_closing_brace_only)
+  if (length(pd_by_line) < 1) {
+    return(TRUE)
+  }
+  pd_by_line <- pd_by_line %>%
     alignment_ensure_trailing_comma()
   # now, pd only contains arguments separated by values, ideal for iterating
   # over columns.

R/detect-alignment.R

@@ -42,7 +42,7 @@ transform_utf8_one <- function(path, fun, dry) {
         } else if (dry == "on") {
           # don't do anything
         } else if (dry == "off") {
-          xfun::write_utf8(new, path)
+          write_utf8(new, path)
         } else {
           # not implemented
         }
@@ -114,3 +114,10 @@ read_utf8_bare <- function(con, warn = TRUE) {
 invalid_utf8 <- function(x) {
   which(!is.na(x) & is.na(iconv(x, "UTF-8", "UTF-8")))
 }
+
+#' Drop-in replacement for `xfun::write_utf8()`
+#' @keywords internal
+write_utf8 <- function(text, con, ...) {
+  withr::local_options(encoding = "native.enc")
+  writeLines(enc2utf8(text), con, ..., useBytes = TRUE)
+}

R/io.R

@@ -127,7 +127,6 @@ add_id_and_short <- function(pd) {
 #' @importFrom magrittr or
 #' @keywords internal
 ensure_correct_txt <- function(pd, text) {
-  ensure_valid_pd(pd)
   is_problematic_text <- or(
     is_insufficiently_parsed_string(pd),
     is_insufficiently_parsed_number(pd)
@@ -173,30 +172,6 @@ ensure_correct_txt <- function(pd, text) {
     arrange_pos_id()
 }
 
-#' Ensure that the parse data is valid
-#'
-#' Test whether all non-terminals have at least one child and throw an error
-#' otherwise. As this is check is rather expensive, it is only
-#' carried out for configurations we have good reasons to expect problems.
-#' @param pd A parse table.
-#' @importFrom rlang abort
-#' @keywords internal
-ensure_valid_pd <- function(pd) {
-  if (getRversion() < "3.2") {
-    non_terminals <- pd %>%
-      filter(terminal == FALSE)
-    valid_pd <- non_terminals$id %>%
-      map_lgl(~ .x %in% pd$parent) %>%
-      all()
-    if (!valid_pd) {
-      abort(paste(
-        "The parse data is not valid and the problem is most likely related",
-        "to the parser in base R. Please install R >= 3.2 and try again."
-      ))
-    }
-  }
-  TRUE
-}
 
 #' Identify strings that were not fully parsed
 #'

R/parse.R

@@ -22,7 +22,7 @@ identify_start_to_stop_of_roxygen_examples_from_text <- function(text) {
 }
 
 identify_start_to_stop_of_roxygen_examples <- function(path) {
-  content <- xfun::read_utf8(path)
+  content <- read_utf8_bare(path)
   identify_start_to_stop_of_roxygen_examples_from_text(content)
 }
 

R/roxygen-examples-find.R

@@ -41,7 +41,8 @@
 #' # brace expressions go on new line if part of a pipe, in function call...
 #' c(
 #'   data %>%
-#'     filter(bar) %>% {
+#'     filter(bar) %>%
+#'     {
 #'       cor(.$col1, .$col2, use = "complete.obs")
 #'     }
 #' )

R/rules-line-breaks.R

@@ -110,7 +110,7 @@ transform_and_check <- function(in_item, out_item,
                                 write_tree = NA,
                                 out_tree = "_tree", ...) {
   write_tree <- set_arg_write_tree(write_tree)
-  read_in <- xfun::read_utf8(in_item)
+  read_in <- read_utf8_bare(in_item)
   if (write_tree) {
     create_tree(read_in) %>%
       write.table(out_tree,
@@ -337,6 +337,7 @@ activate_testthat_cache <- purrr::partial(cache_activate, "testthat")
 #' @param .local_envir The environment to use for scoping.
 #' @details
 #' * make styler quiet.
+#' @keywords internal
 local_test_setup <- function(cache = FALSE,
                              .local_envir = parent.frame()) {
   current_cache <- cache_info(format = "tabular")

R/testing.R

@@ -88,7 +88,7 @@ make_transformer <- function(transformers,
   assert_transformers(transformers)
 
   function(text) {
-    text <- trimws(text, which = "right")
+    text <- ensure_last_n_empty(trimws(text, which = "right"), n = 0L)
     should_use_cache <- cache_is_activated()
 
     if (should_use_cache) {
@@ -232,7 +232,7 @@ parse_transform_serialize_r <- function(text,
     return("")
   }
   transformers <- transformers_drop(
-    if (getRversion() < 3.4) text else pd_nested$text[!pd_nested$is_cached],
+    pd_nested$text[!pd_nested$is_cached],
     transformers
   )
 

R/transform-files.R

@@ -229,7 +229,7 @@ style_text <- function(text,
 #' @family stylers
 #' @examples
 #' \dontrun{
-#' style_dir("path/to/dir", file_type = c("rmd", ".R"))
+#' style_dir("path/to/dir", filetype = c("rmd", ".R"))
 #'
 #' # the following is identical (because of ... and defaults)
 #' # but the first is most convenient:
@@ -312,7 +312,7 @@ prettify_any <- function(transformers,
 #' @inheritSection style_pkg Round trip validation
 #' @examples
 #' file <- tempfile("styler", fileext = ".R")
-#' xfun::write_utf8("1++1", file)
+#' writeLines("1++1", file)
 #'
 #' # the following is identical (because of ... and defaults),
 #' # but the first is most convenient:
@@ -325,7 +325,7 @@ prettify_any <- function(transformers,
 #' # name levels explicitly to not style less invasive levels
 #' style_file(file, scope = I(c("tokens", "spaces")), strict = TRUE)
 #'
-#' xfun::read_utf8(file)
+#' readLines(file)
 #' unlink(file)
 #' @family stylers
 #' @export