Warn when trying to reference types in hidden modules #1940
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
Closes elixir-lang#1932 When a module is hidden, its types will also be hidden. We check for two conditions and warn the user if both are met: - The module defining the type is hidden - The type itself is hidden If the type is undefined, the standard warning is displayed instead.
josevalim
approved these changes
Aug 12, 2024
There was a problem hiding this comment.
This looks good to me but I have a feeling this was tried before and we reverted it for some reason. I will let @wojtekmach merge it accordingly.
|
@josevalim we were already warning under these circumstances. This PR improves the error message! @voughtdq thank you! |
wojtekmach
reviewed
Aug 15, 2024
| {{:type, AutolinkTest.Foo, :bad, 0}, :hidden} | ||
| {{:type, AutolinkTest.Foo, :bad, 0}, :hidden}, | ||
| {{:module, AutoLinkTest.Hidden}, :hidden}, | ||
| {{:type, AutoLinkTest.Hidden, :my_type, 0}, :hidden} |
There was a problem hiding this comment.
note to self: The testing setup is not fantastic. I don't know off the top of my head whether here :hidden is supposed to reflect the type is hidden or the type is (so to speak) public but because it is in hidden module it ends up hidden. This is an implementation detail.
A more robust way to test this would be more end-to-end:
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 #1932
When a module is hidden, its types will also be hidden. We check for two conditions and warn the user if both are met:
It does not seem possible to do this check for Erlang modules.