Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General Issue: Remove {styler} dependency #426

Closed
lorenzwalthert opened this issue Apr 7, 2024 · 2 comments · Fixed by #431
Closed

General Issue: Remove {styler} dependency #426

lorenzwalthert opened this issue Apr 7, 2024 · 2 comments · Fixed by #431

Comments

@lorenzwalthert
Copy link

Background Information

Hi, author of the formatting package {styler} here. As I judge from a search in your source code, there is no functionality that uses {styler}, in other words {styler} is not a runtime dependency. You may recommend people to format their code when they contribute, so {styler} is a development dependency. Adding {styler} as a dependency (via Imports: or Suggests:) to your package has the following drawbacks:

  • Your user's may install a package they don't need (assuming most people who install your package are useres, not developers). This costs additional bandwith, installation time, disk space etc... If they need it, they can just manually install it.
  • I as a maintainer of {styler} have to run reverse dependency checks (R CMD Check your package with my new version of {styler}) upon submitting to CRAN e.g. with {revdepcheck}. {styler} has more than 40 reverse dependencies, which makes this a long process.

For that reason, I suggest you to drop that dependency from your package. If you want to ensure your code remains styled, I recommend {precommit} to apply {styler} on each commit or other tools described in the third-party integrations website of {styler}.

Definition of Done

For the removal to take effect, a CRAN submission of your package is required (but the issue is not urgent). For tracking, this issue is referenced in r-lib/styler#1121.

@bms63
Copy link
Collaborator

bms63 commented Apr 7, 2024

HI @lorenzwalthert will we remove styler from Suggests. We have a planned release in June that will incorporate this removal. Thanks again for your great package!!

@pharmaverse/admiral maybe there is a few more we could prune?

@lorenzwalthert
Copy link
Author

Great, as you can see in r-lib/styler#1121, I opened a few other issues, some in the pharmaverse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants