|
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). |
|
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 | + |
111 | 115 |
|
112 | 116 | Thanks to all the people who made this release possible: |
113 | 117 |
|
|
0 commit comments