styler 1.1.0

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 favour of xfun (#442).

Thanks to all contributors for patches, issues and the like: @jonmcalder, @krlmlr, @IndrajeetPatil, @kalibera, @Hasnep, @kiranmaiganji, @dirkschumacher, @ClaytonJY, @wlandau, @maurolepore,

styler 1.0.2

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.

styler 1.0.1

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

styler 1.0.0

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)