Throw an error for @importFrom unknown export #1458
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I can't make snapshots from my current machine, so I'll try and pull them from the GHA artifacts. Should be ready for review anyway. |
hadley
reviewed
Nov 3, 2023
hadley
reviewed
Nov 3, 2023
hadley
reviewed
Nov 4, 2023
|
Thanks! |
MichaelChirico
commented
Jan 15, 2024
| pkg <- x$val[1L] | ||
| if (requireNamespace(pkg, quietly = TRUE)) { | ||
| importing <- x$val[-1L] | ||
| unknown_idx <- !importing %in% getNamespaceExports(pkg) |
There was a problem hiding this comment.
two issues with this PR in retrospect as surfaced by #1570:
importingcan be like"%>%"or`%>%`or'%>%'butgetNamespaceExports()will always just be the plain symbol (%>%)importing[!unknown_idx]might drop everything --> output becomesimportFrom($PKG,)
How would you recommend approaching these?
- Is a bit tricky because we have to normalize the quotes, I guess we can do
gsub("^(`|'|\")(.*)\\1$", "\\1", importing). This could be a helper alongsidehas_quotes()Initially, I was worried about collision where you try and import a really weirdly-named object likeas.name("'%>%'"), but I guess {roxygen2} has always made that difficult. And a quick search doesn't turn up any usage of this anyway: https://github.com/search?q=lang%3AR+%2F%5Cn%5Cs*%28%22%27.*%27%22%7C%27%22.*%22%27%7C%60%22.*%22%60%7C%60%27.*%27%60%7C%22%60.*%60%22%7C%27%60.*%60%27%29%5Cs*%3C-%2F+-path%3A.Rd&type=code - Should this method just
return(NULL)ifall(unknown_idx)?
There was a problem hiding this comment.
- Yeah, I think
strip_quotes()seems reasonable. - Yes, I think so.
There was a problem hiding this comment.
thanks! that's basically how I did #1574 so let's continue there.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1409.
This is a rough / off-the-cuff version. Wanted to checkpoint here to get high-level feedback, there's still TODO:
cli)