Add option for suppressing styler communication

[michaelquinn32]

This implements FR #637

[michaelquinn32]

Hi Lorenz!

Thanks for the patience. I finally got around to this. One thing. I looked a little bit, but couldn't find if or where styler's communication was tested. Mind sharing a code pointer?

Thanks!

[lorenzwalthert]

Thanks. Two things to debate:

• You implemented as a boolean option. This only allows two modes. Do we ever want to support more than two modes? I.e. moderately verbose?
• In {usethis}, the option is called usethis.quiet. I don't know if the tidyverse has embraced standardisation for options that manage communication. Maybe we should investigate that.

Tests for communication are here: https://github.com/r-lib/styler/blob/master/tests/testthat/test-public_api.R

[michaelquinn32]

I can't think of a situation where "less verbose" makes sense. For my use case, either the messaging is useful (which it almost always is), or it is interfering with something like stdout.

I'm happy to update the flag name. Alignment with other packages is good.

[codecov-io]

Codecov Report

Merging #640 into master will decrease coverage by 0.06%.
The diff coverage is 85.71%.

@@            Coverage Diff             @@
##           master     #640      +/-   ##
==========================================
- Coverage   90.41%   90.35%   -0.07%     
==========================================
  Files          47       47              
  Lines        2181     2188       +7     
==========================================
+ Hits         1972     1977       +5     
- Misses        209      211       +2     

Impacted Files	Coverage Δ
R/addins.R	0.00% <0.00%> (ø)
R/zzz.R	0.00% <0.00%> (ø)
R/communicate.R	92.30% <100.00%> (+2.30%)	⬆️
R/transform-files.R	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 85a81fb...3400e9a. Read the comment docs.

[lorenzwalthert]

How come that a significant part of NEWS.md got reformatted in 32f659c?

[michaelquinn32]

Because I have an autoformatter that needs to be manually disabled 🤦‍♂️.

Sorry, it's fixed.

[lorenzwalthert]

Out of curiosity: Which formatter do you use? Could we add that to {precommit} as a hook?

[lorenzwalthert]

Thanks @michaelquinn32.

[michaelquinn32]

A precommit would be great!

I'm using an internal formatter, but I don't think it matters all that much. prettier, for example, supports markdown: https://github.com/prettier/prettier

[lorenzwalthert]

They already made a pre-commit compatible hooks themself: https://prettier.io/docs/en/precommit.html#option-3-pre-commithttpsgithubcompre-commitpre-commit