Skip to content

@lorenzwalthert lorenzwalthert released this Oct 17, 2019 · 4 commits to master since this release

styler 1.2.0

Breaking changes

  • 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).

New features

  • Aligned function calls are detected and kept as is 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).

Minor improvements and fixes

  • 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).

Adaption

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

Assets 2

@lorenzwalthert lorenzwalthert released this May 6, 2019 · 121 commits to master since this release

This is primarily a maintenance release upon the request of the CRAN team
(#490).

Major changes

  • 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).

Minor changes

  • 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).

Adaption of styler

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.

Assets 2

@lorenzwalthert lorenzwalthert released this Nov 20, 2018 · 238 commits to master since this release

This release introduces new features and is fully backward-compatible. It also
adapts to changes in the R parser committed into R devel (#419).

Major Changes

  • 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).

Minor Changes

  • 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.

Assets 2

@lorenzwalthert lorenzwalthert released this Jun 26, 2018 · 383 commits to master since this release

This is a maintenance release without any breaking API changes.

Major Changes

  • Fixed indention for named multi-line function calls (#372).
  • Non-R code chunks in .Rmd files are now respected and won’t get styled (#386).

Minor 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.

Assets 2

@lorenzwalthert lorenzwalthert released this Mar 9, 2018 · 458 commits to master since this release

This is a maintenance release without any breaking API changes.

Major & dependency related 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).

Minor changes

  • We're now recognizing and respecting 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).
  • Various bug fixes and edge case improvements.

Thanks to all contributors for patches, issues and the like:
@devSJR, @krlmlr, @yutannihilation, @samhinshaw, @martin-mfg, @jjramsey,
@RMHogervorst, @wlandau, @llrs, @aaronrudkin, @crew102, @jkgrain, @jennybc,
@joranE.

Assets 2

@lorenzwalthert lorenzwalthert released this Dec 11, 2017 · 552 commits to master since this release

Initial release.

stylers

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(...))

style guides

These functions are the style guides implemented.

tidyverse_style(
  scope = "tokens", 
  strict = TRUE, 
  indent_by = 2, 
  start_comments_with_one_space = FALSE, 
  reindention = tidyverse_reindention(), 
  math_token_spacing = tidyverse_math_token_spacing()
)
tidyverse_reindention()
tidyverse_math_token_spacing())

style guide creators

This function is used to create a style guide.

create_style_guide(
  initialize = default_style_guide_attributes, 
  line_break = NULL, 
  space = NULL, 
  token = NULL, 
  indention = NULL, 
  use_raw_indention = FALSE, 
  reindention = tidyverse_reindention()
)

Helpers

These are helper functions used to specify the style guides in use.

specify_math_token_spacing(
  zero = NULL, 
  one = c("'+'", "'-'", "'*'", "'/'", "'^'")
)

specify_reindention(
  regex_pattern = NULL, 
  indention = 0, 
  comments_only = TRUE
)
initialize_default_attributes(pd_flat)
Assets 2
You can’t perform that action at this time.