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

Implement new all_linters() function to easily access all linters #1843

Closed
IndrajeetPatil opened this issue Dec 13, 2022 · 2 comments · Fixed by #1854
Closed

Implement new all_linters() function to easily access all linters #1843

IndrajeetPatil opened this issue Dec 13, 2022 · 2 comments · Fixed by #1854
Assignees
Labels
consistency 🍎 🍏 feature a feature request or enhancement

Comments

@IndrajeetPatil
Copy link
Collaborator

To be consistent with linters_with_defaults():

library(lintr)

invisible(linters_with_defaults())

invisible(linters_with_tags())
#> Error in linters_with_tags(): argument "tags" is missing, with no default

Created on 2022-12-13 with reprex v2.0.2

Note that this would be a backward-compatible change, and shouldn't create any issues for existing linting workflows. It does make the API a bit more consistent for the future usage.

@AshesITR
Copy link
Collaborator

Actually I think linters_with_tags() is very unclear code and should error, as it does now. On the other hand linters_with_defaults() expresses that the user wants to use default recommendations.

We could instead introduce all_linters(packages = "lintr").
WDYT?

@IndrajeetPatil
Copy link
Collaborator Author

Yeah, that sounds like a veggie name and solution to me.

I can work on it. 🫡

@IndrajeetPatil IndrajeetPatil self-assigned this Dec 14, 2022
@IndrajeetPatil IndrajeetPatil added this to the 3.1.0 milestone Dec 14, 2022
@IndrajeetPatil IndrajeetPatil added the feature a feature request or enhancement label Dec 14, 2022
@IndrajeetPatil IndrajeetPatil changed the title Default to tags = NULL in linters_with_tags() Implement new all_linters() function to easily access all linters Dec 19, 2022
IndrajeetPatil added a commit that referenced this issue Dec 19, 2022
)

* Implement `all_linters()` wrapper to access all available linters

Closes #1843

* Integrate with `use_lintr()`

* more cross-referencing; update README

* also update vignette

* add ellipsis argument; remove library calls in README

* add test for ...

* showcase `all_linters(...)`

* change example

* remove unnecessary trailing slashes

* remove family tags

* more edits to docs to address code review

* fix vignette build issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency 🍎 🍏 feature a feature request or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants