|
1 | | -# styler 1.3.2.9000 (Development) |
| 1 | +# styler 1.4.0 |
2 | 2 |
|
3 | 3 | ## API Changes |
4 | 4 |
|
| 5 | +**new** |
| 6 | + |
5 | 7 | - `style_file()` and friends gain argument `dry` to control if changes should be |
6 | 8 | applied to files or not (#634). |
7 | 9 |
|
|
10 | 12 | styling a selection picks that up, e.g. you can style a function body and |
11 | 13 | indention is preserved (#725). |
12 | 14 |
|
13 | | -- added an option (`styler.test_dir_writeable`) that changes test behavior to |
14 | | - not directly modify test files in the current directory (#548). |
15 | | - |
16 | 15 | - added an option for disabling all communication when using the package |
17 | 16 | (`styler.quiet`) (#640). |
18 | 17 |
|
|
23 | 22 | style tokens, you had to always also style spaces, indention, line breaks as |
24 | 23 | well (#705, #707). |
25 | 24 |
|
| 25 | +- added an option (`styler.test_dir_writeable`) that changes test behavior to |
| 26 | + not directly modify test files in the current directory (#548). |
| 27 | + |
26 | 28 | - New argument `transformers_drop` in `create_style_guide()` to be populated |
27 | 29 | with new helper function `specify_transformers_drop()` for specifying |
28 | 30 | conditions under which transformers are not going to be used and can therefore |
29 | 31 | be omitted without effecting the result of styling (#711). |
30 | 32 |
|
| 33 | +**deprecated** |
| 34 | + |
| 35 | +- The environment variable `save_after_styling` is deprecated in favor of the R |
| 36 | + option `styler.save_after_styling` to control if a file is saved after styling |
| 37 | + with the RStudio Addin. Note than in RStudio >= 1.3.0, you can auto-save edits |
| 38 | + in general (Code -> Saving -> Auto-Save), e.g. on idle editor or focus loss, |
| 39 | + so this feature becomes less relevant (#631, #726). |
| 40 | + |
| 41 | + |
31 | 42 | ## Major changes |
32 | 43 |
|
33 | 44 | - styler is now distributed under the MIT license (#751). |
34 | 45 |
|
35 | 46 | - Documentation overhaul: New README, new "Get started" pkgdown page, new |
36 | 47 | vignettes on `strict = FALSE`, `Adoption` renamed to `Third-party |
37 | | - integrations`, minor other doc improvements (#741, #643, #618, #614, #677, |
38 | | - #651, #667, #672, #687, #752, #754). |
| 48 | + integrations` (#741), adding search to pkgdown (#623), group functions in |
| 49 | + pkgdown reference page (#625), minor other doc improvements (#643, #618, #614, |
| 50 | + #677, #651, #667, #672, #687, #752, #754). |
39 | 51 |
|
40 | 52 | - `@exampleIsf` roxygen tag for conditional examples is now supported (#743). |
41 | 53 |
|
42 | | -- The environment variable `save_after_styling` is deprecated in favor of the R |
43 | | - option `styler.save_after_styling` to control if a file is saved after styling |
44 | | - with the RStudio Addin. Note than in RStudio >= 1.3.0, you can auto-save edits |
45 | | - in general (Code -> Saving -> Auto-Save), e.g. on idle editor or focus loss, |
46 | | - so this feature becomes less relevant (#631, #726). |
47 | | - |
48 | 54 | - blank lines in function calls and headers are now removed, for the former only |
49 | 55 | when there are no comments before or after the blank line (#629, #630, #635, |
50 | 56 | #723). |
51 | 57 |
|
52 | | -- speed improvements: ~10% when cache is activated because transformers are not |
53 | | - captured as character anymore (#679), ~3% in low-level optimization (#691). 7% |
54 | | - by requiring magrittr 2.0 (#681), ~8% by dropping unused transformers (#711), |
55 | | - 4% by avoiding unnecessary sorting in internals (#739). |
| 58 | +- speed improvements: 15% faster on new code, 70% on repeated styling of |
| 59 | + compliant code (The latter is not so relevant because it was almost |
| 60 | + instantaneous already). Most relevant contributions were #679, #691, #681, |
| 61 | + #711, #739. |
56 | 62 |
|
57 | 63 | - `#<<` is now recognized as the xaringan marker and no space is added after`#` |
58 | 64 | (#700). |
|
75 | 81 |
|
76 | 82 | - empty lines are now removed between pipes and assignments (#645, #710). |
77 | 83 |
|
78 | | -- overhaul pgkdown site: Add search (#623), group function in Reference (#625). |
79 | | - |
80 | 84 | - multiple `@examples` roxygen tags in a code block of `#'` are no longer |
81 | 85 | squashed (#748). |
82 | 86 |
|
|
98 | 102 |
|
99 | 103 | - simplification of internals (#692). |
100 | 104 |
|
101 | | -- include `test-*` files in styling pre-commit hook (#724). |
102 | | - |
103 | 105 | ## Infrastructure changes |
104 | 106 |
|
105 | 107 | - switched from travis and AppVeyor to GitHub Actions (#653, #660). |
|
108 | 110 | [lorenzwalthert/touchstone](https://github.com/lorenzwalthert/touchstone) |
109 | 111 | (#674, #684, #698). |
110 | 112 |
|
| 113 | +- include `test-*` files in styling pre-commit hook (#724). |
| 114 | + |
| 115 | + |
| 116 | +Thanks to all the people who made this release possible: |
| 117 | + |
| 118 | +[@assignUser](https://github.com/assignUser), [@ColmanHumphrey](https://github.com/ColmanHumphrey), [@davidchall](https://github.com/davidchall), [@espinielli](https://github.com/espinielli), [@giko45](https://github.com/giko45), [@hadley](https://github.com/hadley), [@IndrajeetPatil](https://github.com/IndrajeetPatil), [@intiben](https://github.com/intiben), [@jamespeapen](https://github.com/jamespeapen), [@jthomasmock](https://github.com/jthomasmock), [@Kalaschnik](https://github.com/Kalaschnik), [@kevinushey](https://github.com/kevinushey), [@krlmlr](https://github.com/krlmlr), [@lcolladotor](https://github.com/lcolladotor), [@MichaelChirico](https://github.com/MichaelChirico), [@michaelquinn32](https://github.com/michaelquinn32), [@mine-cetinkaya-rundel](https://github.com/mine-cetinkaya-rundel), [@pat-s](https://github.com/pat-s), [@PMassicotte](https://github.com/PMassicotte), [@QuLogic](https://github.com/QuLogic), [@renkun-ken](https://github.com/renkun-ken), [@RichardJActon](https://github.com/RichardJActon), [@seed-of-apricot](https://github.com/seed-of-apricot), [@select-id-from-users](https://github.com/select-id-from-users), [@SimonDedman](https://github.com/SimonDedman), [@stefanoborini](https://github.com/stefanoborini), [@swsoyee](https://github.com/swsoyee), and [@Winterstorm-j](https://github.com/Winterstorm-j). |
| 119 | + |
111 | 120 | # styler 1.3.2 |
112 | 121 |
|
113 | 122 | Release upon request by the CRAN team. |
@@ -200,7 +209,7 @@ Thanks to all contributors involved, in particular |
200 | 209 | [@davidski](https://github.com/davidski), |
201 | 210 | [@IndrajeetPatil](https://github.com/IndrajeetPatil), |
202 | 211 | [@pat-s](https://github.com/pat-s), and |
203 | | -[@programming-wizard](https://github.com/programming-wizard). |
| 212 | +[@programming-wizard](https://github.com). |
204 | 213 |
|
205 | 214 | # styler 1.2.0 |
206 | 215 |
|
@@ -325,7 +334,7 @@ else you can use styler functionality: |
325 | 334 | frames with `drake::drake_plan_source()`. |
326 | 335 |
|
327 | 336 | * Adding styler as a fixer to the [ale |
328 | | - Plug-in](https://github.com/w0rp/ale/pull/2401#issuecomment-485942966) for |
| 337 | + Plug-in](https://github.com/dense-analysis/ale/pull/2401) for |
329 | 338 | VIM. |
330 | 339 |
|
331 | 340 | Thanks to all contributors involved, in particular |
|
0 commit comments