Release scheduling

[lorenzwalthert]

In this issue, I plan to discuss future release scheduling of styler for every upcoming release. The template for checks:

Prepare for release:

* [ ] `devtools::check_win_devel()`
* [ ] `rhub::check_for_cran()`
* [ ] `revdepcheck::revdep_check(num_workers = 4)`
* [ ] [Polish NEWS](http://style.tidyverse.org/news.html#before-release)
* [ ] If new failures, update `email.yml` then `revdepcheck::revdep_email_maintainers()`

Perform release:

* [ ] Create RC branch (for bigger releases)
* [ ] Bump version (in DESCRIPTION and NEWS)
* [ ] `devtools::check_win_devel()` (again!)
* [ ] `devtools::submit_cran()`
* [ ] `pkgdown::build_site()`
* [ ] Approve email

Wait for CRAN...

* [ ] Tag release
* [ ] Merge RC back to master branch
* [ ] Bump dev version
* [ ] Write blog post
* [ ] Tweet
* [ ] Add link to blog post in pkgdown news menu

Template from <https://github.com/r-lib/usethis/issues/338>

[lorenzwalthert]

Because #419 needs to be fixed before Nov. 20, we should roll-out a new CRAN release of styler. Currently, the draft of NEWS.md shows reads as follows:

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
  (Style for examples in roxygen or .Rd files #332) as well as Rnw files (Support for .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 (syntax highlighting in print.vertical() #417).
• the README was redesigned (New README #413).
• semi-colon expression that contained multiple assignments was fixed(fixing block identification for semi-colon expression #404).

Minor Changes

• cursor position is remembered for styling via Addin (Remember cursor position for styling via Addin #416).
• adapted spacing around tilde for multi-token expressions(Spacing around tilde for multi-token expressions #424) and brace
  edge case (Spacing after inserted curly braces #425).
• only add brackets to piped function call if RHS is a symbol (Only add brackets to piped function call if RHS is a symbol #422).
• increased coverage again to over 90% (Increase coverage #412).
• moved rule that turns single quotes into double quotes to token modifier in
  `tidyverse_style_guide() (Transformer categories and UTF-8 note #406).
• remove line-breaks before commas (Comma line break #405).

[lorenzwalthert]

@krlmlr current version number is 1.0.2. Should we go for 1.1.0 for the new release since we have quite a few new features?

[krlmlr]

1.1.0 seems fine (and is on CRAN now?).

[lorenzwalthert]

@krlmlr what do you think should we go for another release soon? I think there are some substantial improvements according to NEWS.md and the last release was ~4 months ago. From 1.1.1 -> 1.2? I think it's a bit unfortunate but the caching feature #538 probably won't make it into that release because of a pending request to dependency R.cache. Maybe we need to resolve that otherwise though.

styler dev

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 (Fix style_file() so it works for a vector of files from different directories #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
  files styled is only changed when the content is changed (Only write back when contents changed #532).

New features

• Aligned function calls are detected and kept as is if they match the styler
  definition for aligned function calls
  (Detect alignment #537).

• curlyl-curly ({{) syntactic sugar introduced with rlang 0.4.0 is now
  explicitly handled, as opposed previously where it was just treated as two
  consequtive curly braces (Support for curly-curly syntactic sugar #528).

• style_pkg(), style_dir() and the Addins can now style .Rprofile, and
  hidden files are now also styled (support Rprofile styling #530).

Minor improvements and fixes

• brace expressions in function calls are formatted in a less compact way. This
  improves the formatting of tryCatch() in many cases (Force brace expression in function calls be on their own line #543).

• escape characters in roxygen code examples are now correctly escaped (Deparse Rd to correctly escape characters #512).

• style selection Addin now preserves line break when the last line selected is
  an entire line (Make Addin for selection styling respecting line breaks in general #520).

• style file Addin can now properly handle cancelling (When setting style is aborted, exit properly #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 (Function declarations should gain braces for body if strict = TRUE #536).

• advice for contributors in CONTRIBUTING.md was updated (More specific advice #508).

[krlmlr]

I do like the caching idea a lot. We could merge, bearing in mind that we pay some cost for these empty files, and think about optimization later?

I'd say 1.2.0.

[lorenzwalthert]

Well, I am not sure if it would cause some problems and edge cases when upgrading from the first to the second version (although the idea was to isolate the cache for each version of styler, see #538).

[krlmlr]

If the change makes it into R.cache, it should be back-compatible anyway. But I agree to wait for a bit -- release to CRAN, then merge #538 so that it gains a tiny bit more exposure.

[lorenzwalthert]

We also have #541 which we should fix.

[lorenzwalthert]

Don't think we need this open anymore.