NEWS.md
This release was requested by the CRAN team since parser error messages changed, which were hard-coded in some unit tests (#1180).
Minor changes
CI
Testing
We thank everyone who helped making this release possible.
@AshesITR, @averissimo, @IndrajeetPatil, @lorenzwalthert, @mcanouil, @moodymudskipper, @olivroy, @sbanville-delfi, @sorhawell, @ssh352, @swo, and @vertesy.
This release was requested by the CRAN team to fix CRAN warning on invalid numeric version inputs (#1143).
Minor changes
We thank everyone who helped making this release possible.
@krlmlr, @lorenzwalthert, @MichaelChirico, @olivroy, @rkrug, and @rossdrucker.
This release was requested by CRAN due to accidentally populating a user cache while building vignettes for R >= 4.3.0.
Thanks to everyone who contributed to this release: @olivroy and @krlmlr.
This release contains speed-ups between 20% and 40% depending on your use case thanks to replacing {base} functionality with {vctrs} (#1114). With the speed boost introduced in version 1.8.0 in Oct. 2022, {styler} is now up to 2x as fast as before release 1.8.0.
This release was created upon a request by the CRAN team to actively manage not just cached files but also the potentially empty cache directories they live in (#1118). Here are the changes in detail:
rlang::with_handlers() (#1103).repeat (#1113).test-public_api.R for better sharding (#1109).actions/checkout to version 3 in GitHub Actions (#1098).Thanks for everyone contributing to this release:
@IndrajeetPatil, @krlmlr, @kyleam, @MichaelChirico, @mvanaman, @olivroy, and @vvarik.
Bug fixes
{{ and comments that can yield invalid code (#1070).Other
"qmd" as a valid filetype (#1091).Thanks for everyone who contributed to this release:
Features
indent_by two spaces.
# old style: remains compliant and won't be re-styled
my_fun <- function(long_argument = 2,
indent_up_to_first = "x") {
# ...
}
# new style: now also compliant and won't be re-styled
my_fun <- function(
long_argument = 2,
indent_double = "x") {
# ...
}You can also use the R package {codegrip} to toggle between the two modes (#1083).
Bug fixes
{{ and comments now yields parsable output (#1088).Other user-facing changes
styler.cache_root is not set (#1063).Infrastructure
Internals
purrr::when() with if statements (#1066).@examplesIf for conditionally running examples (#1071).A big shout out to anyone who contributed to this release:
@balthasars, @hadley, @IndrajeetPatil, @juliangrimm225 and @krlmlr.
Features
Other
... in withr::local_options() was introduced only in v.2.3.0 (#1051).set_linebreak_after_ggplot2_plus() to set_line_break_after_ggplot2_plus() for consistency (@Polkas, #1049).rlang::%||% (#1041).This release was requested by CRAN to resolve an R CMD Check note (#1044). A big hand to everyone who made this release possible:
Dave Jarvis, @IndrajeetPatil, @lorenzwalthert, @MichaelChirico, @Polkas, and @Robinlovelace.
{styler} 1.8.0 comes with a host of new features, around 40% speed improvement, bug fixes and the removal of 8 recursive dependencies. We also welcome @IndrajeetPatil as a new contributor to {styler}, who has contributed significantly to this and and previous releases.
Features
style_dir() and style_pkg() now default to styling all supported file formats (.R, .Rmd, .Rmarkdown, .Rnw, and .qmd) in the (package) directory (#965, #931, #1033).
style_pkg() now excludes the auto-generated R/cpp11.R file (#977).
minimum needed R version is now bumped to 3.5 (#986).
alignment is now detected for function declaration in a similar way as for function calls (#968).
new R option styler.ignore_alignment controls if alignment should be detected (and preserved) or not (#932).
Bug Fixes
alignment is detected in tibble::tribble() (and similar) calls with more than 3 columns when left aligned (#945).
fix alignment detection for one column, mixed named/unnamed (#1035).
if there are only empty lines in a code chunk, they are all removed (#936).
apply rules for [ to [[ and its closing counterpair (#1030)
there is now at most one line break after { and before # (#952, #1022).
line breaks may be added to function calls to ensure indention symmetry for round braces (#975).
the cache is also invalidated on changing the stylerignore markers (#932).
{ is not put on a new line after = and in function() { for some edge cases (#939).
while ({}) statements are now handled the same way as function statements with regards to breaking lines (#967).
parsing of {roxygen2} example comments now also works for edge cases when there is no literal code immediately following after the end of the example section (#940).
files with no tokens in it are now transformed into zero-byte files (#962).
Documentation
git checkout v1.0.0.styler.colored_print.vertical in vignettes so ANSI output of {prettycode} not messing with {pkgdown} (#956, #957).Performance and code quality improvements
unlist() (#998).nrow arg in new_tibble() calls (#1003).if() + else() instead of ifelse() (#1006).styler_df() signature (#1009).odd() and even() were removed (#989).Dependency related changes
In total, 8 recursive dependencies are removed: {ellipsis}, {pillar}, {rematch2}, {tibble}, {utf8}, {fansi}, {lifecycle}, {pkgconfig}.
Infrastructure
A big hand to everyone who made this release possible:
@behrman, @EngineerDanny, @gavinsimpson, @IndrajeetPatil, @jabenninghoff, @krlmlr, @lorenzwalthert, @MichaelChirico, @moodymudskipper, @RaymondBalise, @Robinlovelace, @sebffischer, @sgorm123, @stefanoborini, and @wdkrnls.
else follows directly after if, line breaks are removed (#935).API changes
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}).
stylerignore markers are now interpreted as regular expressions instead of comments that must match exactly. This allows to specify multiple markers in one regular expression for styler.ignore_start and styler.ignore_stop, e.g. to use markers for lintr and styler on the same line, you can use options(styler.ignore_start = "nolint start|styler: off":
# nolint start, styler: off
1 +1
# nolint end
# styler: onAs a consequence of this approach, the defaults for styler.ignore_start and styler.ignore_stop omit the # (#849).
Features
usethis::use_github_action("style") (#914).Documentation
filetype in Example for style_dir() (#855).Bug fixes
substitute(x %>% y) don’t get () added anymore for one level deep (not more yet, see #889), as this can change outcome of the code (#876)..onLoad() method no longer broken with {cli} >= 3.1 (#893).+ should no longer give any error on styling when there are comments and line breaks under certain circumstances (#905).c("x" = 2)) are now correctly detected (#881).~ causes now indention, like +, -, | etc. (#902).Warning: Unknown or uninitialised column: was fixed (#885).EQ_SUB (=), the corresponding key is moved to that line too (#923).indenty_by is now also respected when curly braces are added to an if statement by {styler} (#915).OutDec is set to a non-default value (#912).Infrastructure
*-in_tree files in .Rbuildignore (#879).v2._ (#929).Thanks to all contributors that made this release possible:
@bersbersbers, @daniel-wrench, @dbykova, @EngrStudent, @hadley, @IndrajeetPatil, @jam1015, @jooyoungseo, @kalaschnik, @kaytif, @kpagacz, @krlmlr, @lionel-, @lorenzwalthert, @maelle, @MichaelChirico, @mine-cetinkaya-rundel, @neuwirthe, @Polkas, @pwang2, @sebffischer, @ShixiangWang, @ssh352, and @xjtusjtu.
Files with .Rmarkdown extension are now recognized as an R markdown files in style_file() and friends (#824).
Don’t break line before comments in pipes (#822).
Ordinary comments (starting with #) that break a roxygen code example block (starting with #') are now recognized and preserved (#830).
@examplesIf conditions longer than one line after styling throw an error for compatibility with {roxygen2} (#833).
R Markdown chunk headers are no longer required to be parsable R code (#832).
Break the line between %>% and { inside and outside function calls (#825).
Add language server to third-party integration vignette (#835).
improved test setup with fixtures and similar (#798).
We’d like to thank all people who helped making this release possible:
@bersbersbers, @eutwt, @IndrajeetPatil, @j-mammen, @jennybc, @JohannesNE, @jonkeane, @lorenzwalthert, and @MichaelChirico.
Code with left alignment after = in function calls is now recognized as aligned and won’t be reformatted (#774, #777).
Similarly, left aligned after comma is now detected (#785, #786).
# previously detected
call(
x = 12345, "It's old",
y2 = 17, "before"
)
tribble(
~x, ~y,
"another", 1:3,
"b", 1211234
)
# newly detected
call(
x = 2, p = "another",
y = "hhjkjkbew", x = 3
)
tribble(
~x, ~y,
"another", 1:3,
"b", 1211234
)Also see vignette("detect-alignment").
tidy = FALSE in an Rmd or Rnw code header are not styled anymore. This can be handy when the code can’t be parsed, e.g. within a learnr tutorial (#790).#> is recognized as an output marker and no space is added after # (#771).} and else are removed (#793).= #\n is indented correctly (#814).exclude_dirs in style_pkg() is now properly respected if it is a sub-directory of a directory that is scheduled for styling (e.g. test/testthat/some/dir) (#811).cache_activate() and cache_deactivate() now respect the R option styler.quiet (#797).multi_line attribute in parse table is now integer, not boolean (#782).We’d like to thank everyone who has furthered the development of the latest release of styler through their contributions in issues and pull requests:
@ardydavari, @gadenbuie, @IndrajeetPatil, @jasonhan-vassar, @laresbernardo, @lorenzwalthert, @MichaelChirico, @Moohan, @njtierney, @pat-s, @psychelzh, @pvalders, @RoyalTS, and @russHyde.
base_indention. This also fixes the Addin for styling a selection with base indention repeatedly (#764).styler_* helpfiles (#762).L when styled (#761).Thanks to everyone who contributed to this release:
@krlmlr, @lorenzwalthert, and @renkun-ken.
new
style_file() and friends gain argument dry to control if changes should be applied to files or not (#634).
style_file() and friends gain argument base_indention (defaulting to 0) to control by how much the output code is indented (#649, #692). The Addin for styling a selection picks that up, e.g. you can style a function body and indention is preserved (#725).
added an option for disabling all communication when using the package (styler.quiet) (#640).
scope in tidyverse_style() can now be specified with higher granularity through I(), e.g. I(c('spaces', 'tokens')) allows us to style spaces and tokens without styling line breaks and indention. Previously, only a string was allowed and all less invasive scopes were included, e.g. if you wanted to style tokens, you had to always also style spaces, indention, line breaks as well (#705, #707).
added an option (styler.test_dir_writeable) that changes test behavior to not directly modify test files in the current directory (#548).
New argument transformers_drop in create_style_guide() to be populated with new helper function specify_transformers_drop() for specifying conditions under which transformers are not going to be used and can therefore be omitted without effecting the result of styling (#711).
deprecated
save_after_styling is deprecated in favor of the R option styler.save_after_styling to control if a file is saved after styling with the RStudio Addin. Note than in RStudio >= 1.3.0, you can auto-save edits in general (Code -> Saving -> Auto-Save), e.g. on idle editor or focus loss, so this feature becomes less relevant (#631, #726).styler is now distributed under the MIT license (#751).
Documentation overhaul: New README, new “Get started” pkgdown page, new vignettes on strict = FALSE, Adoption renamed to Third-party integrations (#741), adding search to pkgdown (#623), group functions in pkgdown reference page (#625), minor other doc improvements (#643, #618, #614, #677, #651, #667, #672, #687, #752, #754).
@exampleIsf roxygen tag for conditional examples is now supported (#743).
blank lines in function calls and headers are now removed, for the former only when there are no comments before or after the blank line (#629, #630, #635, #723).
speed improvements: 15% faster on new code, 70% on repeated styling of compliant code (The latter is not so relevant because it was almost instantaneous already). Most relevant contributions were #679, #691, #681, #711, #739.
#<< is now recognized as the xaringan marker and no space is added after# (#700).
style_dir() and style_pkg() now apply directory exclusion recursively with exclude_dirs (#676).
switch() now has line breaks after every argument to match the tidyverse style guide (#722, #727).
unary + before a function call does not give an error anymore, as before version 1.3.0 (#697).
certain combinations of stylerignore markers and cached expressions now don’t give an error anymore (#738).
cache is now correctly invalidated when style guide arguments change (#647).
empty lines are now removed between pipes and assignments (#645, #710).
multiple @examples roxygen tags in a code block of #' are no longer squashed (#748).
roxygen code examples starting on the same line as the @examples tag are no longer moved to the next line (#748).
always strip trailing spaces and make cache insensitive to it (#626).
style_text() can now style all input that is.character(), not just if it inherits from classes character, utf8 or vertical (#693).
logical operators within square braces are now moved from the start of a line to the end of the previous line (#709).
spaces are now removed before [ and [[ (#713).
The internal create_tree() only used in testing of styler now works when the cache is activated (#688).
simplification of internals (#692).
switched from travis and AppVeyor to GitHub Actions (#653, #660).
Added basic continuous benchmarking with lorenzwalthert/touchstone (#674, #684, #698).
include test-* files in styling pre-commit hook (#724).
Thanks to all the people who made this release possible:
@assignUser, @ColmanHumphrey, @davidchall, @espinielli, @giko45, @hadley, @IndrajeetPatil, @intiben, @jamespeapen, @jthomasmock, @Kalaschnik, @kevinushey, @krlmlr, @lcolladotor, @MichaelChirico, @michaelquinn32, @mine-cetinkaya-rundel, @pat-s, @PMassicotte, @QuLogic, @renkun-ken, @RichardJActon, @seed-of-apricot, @select-id-from-users, @SimonDedman, @stefanoborini, @swsoyee, and @Winterstorm-j.
Release upon request by the CRAN team.
Emergency release. In case multiple expressions are on one line and only some of them are cached, styler can remove code. To reach this state, some of the expressions must have been styled previously alone and the cache must be active. Example:
library(styler)
cache_activate()
#> Using cache 1.3.0 at ~/.Rcache/styler/1.3.0.
style_text("1")
#> 1
style_text("1 # comment")
#> # commentThis is obviously detrimental. We have added additional tests and fixed the problem (#593, #595), but we want repeat the warning from ?style_file that all style APIs apart from style_text() overwrite code and that styler can only check the AST remains valid with scope < "tokens". So use this if you are conservative. Or deactivate the cache with deactivate_cache() until it has fully matured.
We thank the people who have contributed to this release:
@ellessenne and @renkun-ken.
style_pkg() and style_dir() gain a new argument exclude_dirs to exclude directories from styling, by default renv and packrat. Note that the defaults won’t change the behavior of style_pkg() because it does anyways does not style these directories and they were set for consistency.
style_file() and friends now strip ./ in file paths returned invisibly, i.e. ./script.R becomes script.R (#568).
ignore certain lines using # styler: off and #styler: on or custom markers, see ?stylerignore (#560).
styler caches results of styling, so applying styler to code it has styled before will be instantaneous. This brings large speed boosts in many situations, e.g. when style_pkg() is run but only a few files have changed since the last styling or when using the styler pre-commit hook. Because styler caches by expression, you will also get speed boosts in large files with many expressions when you only change a few of them. See ?caching for details (#538, #578).
create_style_guide() gains two arguments style_guide_name and style_guide_version that are carried as meta data, in particular to version third-party style guides and ensure the proper functioning of caching. This change is completely invisible to users who don’t create and distribute their own style guide like tidyverse_style() (#572).
lines are now broken after + in ggplot2 calls for strict = TRUE (#569).
function documentation now contains many more line breaks due to roxygen2 update to version 7.0.1 (#566).
spaces next to the braces in subsetting expressions [ and [[ are now removed (#580).
Adapt to changes in the R parser to make styler pass R CMD check again. (#583).
Thanks to all contributors involved, in particular @colearendt, @davidski, @IndrajeetPatil, @pat-s, and @programming-wizard.
style_file() now correctly styles multiple files from different directories. We no longer display the file name of the styled file, but the absolute path. This is also reflected in the invisible return value of the function (#522).
style_file() and friends do not write content back to a file when styling does not cause any changes in the file. This means the modification date of styled files is only changed when the content is changed (#532).
Aligned function calls are detected and remain unchanged if they match the styler definition for aligned function calls (#537).
curly-curly ({{) syntactic sugar introduced with rlang 0.4.0 is now explicitly handled, where previously it was just treated as two consecutive curly braces (#528).
style_pkg(), style_dir() and the Addins can now style .Rprofile, and hidden files are now also styled (#530).
Roxygen code examples: leverage roxygen2 for correct escaping of expressions that contain \, in particular in dontrun{} and friends, allow quoted braces that are not matched (#729).
Brace expressions in function calls are formatted in a less compact way to improve readability. Typical use case: tryCatch() (#543).
Arguments in function declarations in a context which is indented multiple times should now be correct. This typically affects R6::R6Class() (#546).
Escape characters in roxygen code examples are now correctly escaped (#512).
Special characters such as \n in strings are now preserved in text and not turned into literal values like a line break (#554).
Style selection Addin now preserves line break when the last line selected is an entire line (#520).
Style file Addin can now properly handle cancelling (#511).
The body of a multi-line function declaration is now indented correctly for strict = FALSE and also wrapped in curly braces for strict = TRUE (#536).
Advice for contributors in CONTRIBUTING.md was updated (#508).
style-files in https://github.com/lorenzwalthert/precommit.Thanks to all contributors involved, in particular
@Banana1530, @batpigandme, @cpsievert, @ellessenne, @Emiller88, @hadley, @IndrajeetPatil, @krlmlr, @lorenzwalthert, @lwjohnst86, @michaelquinn32, @mine-cetinkaya-rundel, @Moohan, @nxskok, @oliverbeagley, @pat-s, @reddy-ia, and @russHyde
This is primarily a maintenance release upon the request of the CRAN team (#490).
Users can now control style configurations for styler Addins (#463, #500), using the Set style Addin. See ?styler::styler_addins for details.
return() is now always put in braces and put on a new line when used in a conditional statement (#492).
%>% almost always causes a line break now for strict = TRUE (#503).
style_pkg() now also styles the “demo” directory by default (#453).
multi-line strings are now styled more consistently (#459).
indention in roxygen code example styling (#455) and EOF spacing (#469) was fixed.
indention for for loop edge case (#457) and comments in pipe chain (#482) were fixed.
line-break styling around comma is improved (#479).
bug that can cause an error when the variable text in any name space before styler on the search path was defined and did not have length 1 is fixed (#484).
slightly confusing warning about empty strings caused with roxygen code examples and Rmd was removed.
right apostrophe to let package pass R CMD Check in strict Latin-1 locale was removed (#490, reason for release).
Since it’s never been mentioned in the release notes, we also mention here where else you can use styler functionality:
usethis::use_tidy_style() styles your project according to the tidyverse style guide.
reprex::reprex(style = TRUE) to prettify reprex code before printing. To permanently use style = TRUE without specifying it every time, you can add the following line to your .Rprofile (via usethis::edit_r_profile()): options(reprex.styler = TRUE).
you can pretty-print your R code in RMarkdown reports without having styler modifying the source. This feature is implemented as a code chunk option in knitr. use tidy = "styler" in the header of a code chunks (e.g. ```{r name-of-the-chunk, tidy = "styler"}), or knitr::opts_chunk$set(tidy = "styler") at the top of your RMarkdown script.
pretty-printing of drake workflow data frames with drake::drake_plan_source().
Adding styler as a fixer to the ale Plug-in for VIM.
Thanks to all contributors involved, in particular @ArthurPERE, @hadley, @igordot, @IndrajeetPatil, @jackwasey, @jcrodriguez1989, @jennybc, @jonmcalder, @katrinleinweber, @krlmlr, @lorenzwalthert, @michaelquinn32, @msberends, @raynamharris, @riccardoporreca, @rjake, @Robinlovelace, @skirmer, @thalesmello, @tobiasgerstenberg, @tvatter, @wdearden, @wmayner, and @yech1990.
This release introduces new features and is fully backward-compatible. It also adapts to changes in the R parser committed into R devel (#419).
styler can now style roxygen code examples in the source code of package (#332) as well as Rnw files (#431).
the print method for the output of style_text() (print.vertical()) now returns syntax-highlighted code by default, controllable via the option styler.colored_print.vertical (#417).
the README was redesigned (#413).
semi-colon expression that contained multiple assignments was fixed (#404).
cursor position is remembered for styling via Addin (#416).
adapt spacing around tilde for multi-token expressions(#424) and brace edge case (#425).
only add brackets to piped function call if RHS is a symbol (#422).
increase coverage again to over 90% (#412).
move rule that turns single quotes into double quotes to token modifier in `tidyverse_style_guide() (#406).
remove line-breaks before commas (#405).
removed package dependency enc in favor of xfun (#442).
Thanks to all contributors for patches, issues and the like: @jonmcalder, @krlmlr, @IndrajeetPatil, @kalibera, @Hasnep, @kiranmaiganji, @dirkschumacher, @ClaytonJY, @wlandau, @maurolepore
This is a maintenance release without any breaking API changes.
Fixing an edge case in which, if very long strings were present in the code, tokens could be replaced with wrong text (#384).
Spacing around tilde in formulas depends now on whether there is a LHS in the formula (#379).
Spaces are now also added around EQ_SUB (=) (#380).
Added CONTRIBUTING.md to outline guidelines for contributing to styler.
More informative error messages for parsing problems (#401, #400).
Improved documentation (#387).
Thanks to all contributors for patches, issues and the like: @katrinleinweber, @krlmlr, @dchiu911, @ramnathv, @aedobbyn, @Bio7, @tonytonov, @samhinshaw, @fny, @vnijs, @martin-mfg, @NGaffney, @dchiu911.
This is a maintenance release without any breaking API changes.
Removed implicit dplyr dependency via purrr:::map_dfr() (thanks @jimhester, #324).
Added required minimal version dependency for purr (>= 0.2.3) (#338).
We rely on the tibble package which was optimized for speed in v1.4.2 so styler should run ~2x as fast (#348). For that reason, styler now depends on tibble >= 1.4.2.
In the dependency enc, a bug was fixed that removed/changed non-ASCII characters. Hence, styler now depends on enc >= 0.2 (#348).
We’re now recognizing and respecting more DSLs used in R comments: rplumber (#*, #306), shebang #/! (#345), knitr chunk headers for spinning (#+ / #-, #362).
Named arguments can stay on the first line if call is multi-line (#318).
No space anymore with tidyverse_style() after !! since with rlang 0.2, !! now binds tighter (#322), spacing around ~ (#316), no space anymore around ^ (#308).
Code chunks in Rmd documents that don’t use the R engine are no longer formatted (#313).
Various bug fixes and edge case improvements.
Thanks to all contributors for patches, issues and the like: @devSJR, @klrmlr, @yutannihilation, @samhinshaw, @martin-mfg, @jjramsey, @RMHogervorst, @wlandau, @llrs, @aaronrudkin, @crew102, @jkgrain, @jennybc, @joranE.
Initial release.
These are functions used to style code. They style a directory, a whole package, a file or a string.
style_dir(path = ".",
..., style = tidyverse_style, transformers = style(...),
filetype = "R", recursive = TRUE, exclude_files = NULL
)
style_pkg(pkg = ".",
..., style = tidyverse_style, transformers = style(...), filetype = "R",
exclude_files = "R/RcppExports.R"
)
style_file(path,
..., style = tidyverse_style, transformers = style(...)
)
style_text(text, ..., style = tidyverse_style, transformers = style(...))