0f5338cd90
The `restriction` group contains many lints which are not about necessarily “bad” things, but style choices — perhaps even style choices which contradict conventional Rust style — or are otherwise very situational. This results in silly wording like “Why is this bad? It isn't, but ...”, which I’ve seen confuse a newcomer at least once. To improve this situation, this commit replaces the “Why is this bad?” section heading with “Why restrict this?”, for most, but not all, restriction lints. I left alone the ones whose placement in the restriction group is more incidental. In order to make this make sense, I had to remove the “It isn't, but” texts from the contents of the sections. Sometimes further changes were needed, or there were obvious fixes to make, and I went ahead and made those changes without attempting to split them into another commit, even though many of them are not strictly necessary for the “Why restrict this?” project.
55 lines
1.5 KiB
Rust
55 lines
1.5 KiB
Rust
use clippy_utils::diagnostics::span_lint_and_help;
|
|
use rustc_ast::ast::{Item, ItemKind, VisibilityKind};
|
|
use rustc_lint::{EarlyContext, EarlyLintPass};
|
|
use rustc_session::declare_lint_pass;
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Restricts the usage of `pub use ...`
|
|
///
|
|
/// ### Why restrict this?
|
|
/// A project may wish to limit `pub use` instances to prevent
|
|
/// unintentional exports, or to encourage placing exported items directly in public modules.
|
|
///
|
|
/// ### Example
|
|
/// ```no_run
|
|
/// pub mod outer {
|
|
/// mod inner {
|
|
/// pub struct Test {}
|
|
/// }
|
|
/// pub use inner::Test;
|
|
/// }
|
|
///
|
|
/// use outer::Test;
|
|
/// ```
|
|
/// Use instead:
|
|
/// ```no_run
|
|
/// pub mod outer {
|
|
/// pub struct Test {}
|
|
/// }
|
|
///
|
|
/// use outer::Test;
|
|
/// ```
|
|
#[clippy::version = "1.62.0"]
|
|
pub PUB_USE,
|
|
restriction,
|
|
"restricts the usage of `pub use`"
|
|
}
|
|
declare_lint_pass!(PubUse => [PUB_USE]);
|
|
|
|
impl EarlyLintPass for PubUse {
|
|
fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) {
|
|
if let ItemKind::Use(_) = item.kind
|
|
&& let VisibilityKind::Public = item.vis.kind
|
|
{
|
|
span_lint_and_help(
|
|
cx,
|
|
PUB_USE,
|
|
item.span,
|
|
"using `pub use`",
|
|
None,
|
|
"move the exported item to a public module instead",
|
|
);
|
|
}
|
|
}
|
|
}
|