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

Remove {styler} dependency #140

Closed
lorenzwalthert opened this issue May 24, 2023 · 4 comments · Fixed by #156
Closed

Remove {styler} dependency #140

lorenzwalthert opened this issue May 24, 2023 · 4 comments · Fixed by #156

Comments

@lorenzwalthert
Copy link

lorenzwalthert commented May 24, 2023

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 recommend people to format their code when they contribute, so {styler} is a development dependency. Adding {styler} as a dependency 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}.

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

@bms63
Copy link
Collaborator

bms63 commented Jun 3, 2023

@atorus-research/xportr-development-team shall we remove the styler dependency in Suggests?

We have it in our pipelines already - maybe a note around this in our wiki?

@vedhav
Copy link
Collaborator

vedhav commented Jun 3, 2023

I think we can remove it from Suggests and add an installation step for styler in the CI pipeline. WDYT?

@bms63
Copy link
Collaborator

bms63 commented Jun 5, 2023

Yes lets remove it.

@lorenzwalthert
Copy link
Author

Thanks guys for the prompt reaction 👍

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

Successfully merging a pull request may close this issue.

3 participants