-
Notifications
You must be signed in to change notification settings - Fork 642
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
Warn when file()
matches a collection of files
#5507
Open
bentsherman
wants to merge
4
commits into
master
Choose a base branch
from
warn-file-function
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Is it appropriate to document |
Signed-off-by: Ben Sherman <[email protected]>
Agreed, better to describe |
I've added a minor suggestion. Otherwise, the docs look good. |
Co-authored-by: Christopher Hakkaart <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
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.
Looking at the standard library functions with an eye towards static type checking, the only problematic function is
file()
which can return a single file or list of files based on the glob pattern.Rather than introduce some new function, I think we can transition
file()
to be properly typed:file()
matches a collection of filesfile()
toPath
and raise an error if the glob pattern matches zero or multiple filesNote that the glob pattern is still useful for
file()
when you know it will match only one file but you don't want to spell it out. Raising an error when this assumption is wrong seems like the right approach to me, but of course we should keep it as a warning just for now.Not sure whether you want to add a test for the warning, but you can see it in action here: