Merge branch 'index_integer_literals' of https://github.com/IndrajeetPatil/styler into index_integer_literals

Author: IndrajeetPatil

.github/workflows/touchstone-receive.yaml

@@ -4,7 +4,18 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref }}
   cancel-in-progress: true
 
-on: pull_request
+on:
+  pull_request:
+    paths:
+      # Directories with source code and benchmarking code
+      - "inst/**"
+      - "R/**"
+      - "src/**"
+      - "touchstone/**"
+      # Benchmarking config file
+      - ".github/workflows/touchstone-*.yaml"
+      # Package metadata
+      - DESCRIPTION
 
 jobs:
   prepare:

.pre-commit-config.yaml

@@ -6,10 +6,10 @@ default_language_version:
 
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.3.0
+    rev: v0.3.2.9003
     hooks:
     -   id: style-files
-        args: ['--ignore-start="^# styler: on$"', '--ignore-stop="^# styler: off$"']
+        args: ['--ignore-start="^# styler: off$"', '--ignore-stop="^# styler: on$"']
         exclude:  >
           (?x)^(
           tests/testthat/.*/.*\.R(md|nw)?|
@@ -86,7 +86,7 @@ repos:
           tests/testthat/.*\.R(md)?
           )$
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=200']
@@ -102,7 +102,7 @@ repos:
           tests/testthat/_snaps/.*|
           )$
 -   repo: https://github.com/lorenzwalthert/gitignore-tidy
-    rev: 9dd648a2cbce0c0ce09255695b63ea4823699bec
+    rev: a2260df7cc08de00d7312aeff68cea6bcba48c42
     hooks:
     -   id: tidy-gitignore
 -   repo: local
@@ -113,10 +113,3 @@ repos:
         language: fail
         files: '\.Rhistory|\.RData|\.Rds|\.rds$'
         # `exclude: <regex>` to allow committing specific files.
-    -   id: require-news-on-push
-        name: Require bullet in NEWS.md
-        description: NEWS.md must be updated with every PR.
-        entry: inst/hooks/require-news-update.R
-        stages: [push]
-        language: script
-        always_run: true

R/rules-line-breaks.R

@@ -22,11 +22,11 @@
 #'   code(to = execute)
 #' })
 #' call2(
-#'   x = 2,
-#'   {
+#'   x = 2, {
 #'     code(to = execute)
 #'   },
-#'   c = { # this is the named case
+#'   c = {
+#'     # this is the named case
 #'     g(x = 7)
 #'   }
 #' )
@@ -156,9 +156,10 @@ style_line_break_around_curly <- function(strict, pd) {
     opening_before <- (pd$token == "'{'")
     to_break <- lag(opening_before, default = FALSE) | closing_before
     len_to_break <- sum(to_break)
-    pd$lag_newlines[to_break] <- ifelse(rep(strict, len_to_break),
-      1L,
-      pmax(1L, pd$lag_newlines[to_break])
+    pd$lag_newlines[to_break] <- ifelse(
+      pd$token[to_break] == "COMMENT",
+      pmin(1L, pd$lag_newlines[to_break]),
+      if (strict) 1L else pmax(1L, pd$lag_newlines[to_break])
     )
   } else {
     is_else <- pd$token == "ELSE"

R/token-define.R

@@ -1,30 +1,32 @@
+# styler: off
 token <- rbind.data.frame(
-  c("&", "logical", "AND"),
-  c("&&", "logical", "AND2"),
-  c("|", "logical", "OR"),
-  c("||", "logical", "OR2"),
-  c(">", "logical", "GT"),
-  c("<", "logical", "LT"),
-  c("<=", "logical", "LE"),
-  c(">=", "logical", "GE"),
-  c("!=", "logical", "NE"),
-  c("==", "logical", "EQ"),
-  c("=", "assign_left", "EQ_SUB"),
-  c("=", "assign_left", "EQ_ASSIGN"),
-  c("<-", "assign_left", "LEFT_ASSIGN"),
-  c("->", "assign_right", "RIGHT_ASSIGN"),
-  c("+", "math", "'+'"),
-  c("-", "math", "'-'"),
-  c("*", "math", "'*'"),
-  c("/", "math", "'/'"),
-  c("^", "math", "'^'"),
-  c("~", "formula", "'~'"),
-  c("if", "cond", "IF"),
-  c("else", "cond", "ELSE"),
-  c("in", "loop_cond", "IN"),
-  c("while", "loop_cond", "WHILE"),
+  c("&",          "logical",          "AND"),
+  c("&&",         "logical",         "AND2"),
+  c("|",          "logical",           "OR"),
+  c("||",         "logical",          "OR2"),
+  c(">",          "logical",           "GT"),
+  c("<",          "logical",           "LT"),
+  c("<=",         "logical",           "LE"),
+  c(">=",         "logical",           "GE"),
+  c("!=",         "logical",           "NE"),
+  c("==",         "logical",           "EQ"),
+  c("=",      "assign_left",       "EQ_SUB"),
+  c("=",      "assign_left",    "EQ_ASSIGN"),
+  c("<-",     "assign_left",  "LEFT_ASSIGN"),
+  c("->",    "assign_right", "RIGHT_ASSIGN"),
+  c("+",             "math",          "'+'"),
+  c("-",             "math",          "'-'"),
+  c("*",             "math",          "'*'"),
+  c("/",             "math",          "'/'"),
+  c("^",             "math",          "'^'"),
+  c("~",          "formula",          "'~'"),
+  c("if",            "cond",           "IF"),
+  c("else",          "cond",         "ELSE"),
+  c("in",       "loop_cond",           "IN"),
+  c("while",    "loop_cond",        "WHILE"),
   stringsAsFactors = FALSE
 )
+# styler: on
 
 colnames(token) <- c("text", "class", "token")
 math_token <- token$token[token$class == "math"]

man/set_line_break_before_curly_opening.Rd

@@ -8,8 +8,7 @@ a <- function(x) {
       22 + 1
     ))
     if (x > 10) {
-      for (x in 22) {
-        # FIXME in operator only to be surrounded by one space. What about %in%?
+      for (x in 22) { # FIXME in operator only to be surrounded by one space. What about %in%?
         prin(x)
       }
     }

tests/testthat/indention_multiple/overall-out.R

@@ -0,0 +1,2 @@
+X_and_F_symbol_linter <- function() { # nolint: object_name.
+}

tests/testthat/line_breaks_and_other/comment-around-curly-in.R

@@ -0,0 +1,2 @@
+X_and_F_symbol_linter <- function() { # nolint: object_name.
+}

tests/testthat/line_breaks_and_other/comment-around-curly-out.R

@@ -137,7 +137,7 @@ test_that("no speedup when tranformer changes", {
   first <- system.time(style_text(text, transformers = t1))
   t1 <- tidyverse_style(indent_by = 4)
   second <- system.time(style_text(text, transformers = t1))
-  expect_false(first["elapsed"] / 1.3 > second["elapsed"])
+  expect_true(first["elapsed"] < 1.3 * second["elapsed"])
 })
 
 

tests/testthat/test-cache-high-level-api.R

@@ -68,3 +68,9 @@ test_that("line is correctly broken around = ", {
     transformer = style_text
   ), NA)
 })
+
+test_that("comments are not moved down after {", {
+  expect_warning(test_collection("line_breaks_and_other", "comment-around-curly",
+    transformer = style_text
+  ), NA)
+})