chore: enforce unreachable_pub lint
#3735
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 am in favor of this. |
|
Another data point for this: #3741 |
This was referenced Apr 6, 2023
thomaseizinger
force-pushed
the
fix/unreachable-pub
branch
from
3a18948
to
498b1c4
Compare
|
@mxinden: Here is the initial version of enforcing this lint. I've applied most of the fixes with a script. Some of the What is a bit surprising but also great is that fact that we seemed to correctly export all structs and not miss anything that is actually unreachable. |
thomaseizinger
force-pushed
the
fix/unreachable-pub
branch
from
90b45d5
to
456f9f7
Compare
|
I am also adding the script I used to fix the warnings. I imagine once we remove some deprecations and / or add new modules, it might come in handy again. Please don't judge me for my poor Python skills 🙈 |
umgefahren
pushed a commit
to umgefahren/rust-libp2p
that referenced
this pull request
Mar 8, 2024
The `unreachable_pub` lint makes us aware of uses of `pub` that are not actually reachable from the crate root. This is considered good because it means reading a `pub` somewhere means it is actually public API. Some of our crates are quite large and keeping their entire API surface in your head is difficult. We should strive for most items being `pub(crate)`. This lint helps us enforce that. Pull-Request: libp2p#3735.
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.
Description
The
unreachable_publint makes us aware of uses ofpubthat are not actually reachable from the crate root. This is considered good because it means reading apubsomewhere means it is actually public API. Some of our crates are quite large and keeping their entire API surface in your head is difficult.We should strive for most items being
pub(crate). This lint helps us enforce that.Notes & open questions
Draft because not yet complete. There is a lot of code to go through so I think we want some kind of automation to do this for us.Change checklist