Generate a warning on an implicit input specification. #4072
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
The ability to implicitly specify inputs as referencing flakes of the same name is not specifically identified by the documentation (and it's not clear if this behavior is intended to remain in the future). If there is a typographical mismatch between an explicit input name and the argument used for the `output`, this will result in a more obscure error "cannot find flake 'flake:foo' in the flake registries", which leads the user in the direction of managing the registries instead of noticing the mis-spelling. By adding a warning when an implicit input is created, it can make it easier for the user to identify whether this was intended or whether they have made an erroneous typo resulting in mismatched names.
|
As an update, I now see where these are documented in RFC0049, but I still think that the warning is useful for the reason above. |
|
I marked this as stale due to inactivity. → More info |
|
This is ready for merge. |
|
I marked this as stale due to inactivity. → More info |
Ericson2314
added
UX
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.
The ability to implicitly specify inputs as referencing flakes of the
same name is not specifically identified by the documentation (and
it's not clear if this behavior is intended to remain in the future).
If there is a typographical mismatch between an explicit input name
and the argument used for the
output, this will result in a moreobscure error "cannot find flake 'flake:foo' in the flake registries",
which leads the user in the direction of managing the registries
instead of noticing the mis-spelling.
By adding a warning when an implicit input is created, it can make it
easier for the user to identify whether this was intended or whether
they have made an erroneous typo resulting in mismatched names.