mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-12-21 10:33:27 +00:00
d647696c1f
So, some context for this, well, more a story. I'm not used to scripting, I've never really scripted anything, even if it's a valuable skill. I just never really needed it. Now, `@flip1995` correctly suggested using a script for this in `rust-clippy#7813`...
And I decided to write a script using nushell because why not? This was a mistake... I spend way more time on this than I would like to admit. It has definitely been more than 4 hours. It shouldn't take that long, but me being new to scripting and nushell just wasn't a good mixture... Anyway, here is the script that creates another script which adds the versions. Fun...
Just execute this on the `gh-pages` branch and the resulting `replacer.sh` in `clippy_lints` and it should all work.
```nu
mv v0.0.212 rust-1.00.0;
mv beta rust-1.57.0;
mv master rust-1.58.0;
let paths = (open ./rust-1.58.0/lints.json | select id id_span | flatten | select id path);
let versions = (
ls | where name =~ "rust-" | select name | format {name}/lints.json |
each { open $it | select id | insert version $it | str substring "5,11" version} |
group-by id | rotate counter-clockwise id version |
update version {get version | first 1} | flatten | select id version);
$paths | each { |row|
let version = ($versions | where id == ($row.id) | format {version})
let idu = ($row.id | str upcase)
$"sed -i '0,/($idu),/{s/pub ($idu),/#[clippy::version = "($version)"]\n pub ($idu),/}' ($row.path)"
} | str collect ";" | str find-replace --all '1.00.0' 'pre 1.29.0' | save "replacer.sh";
```
And this still has some problems, but at this point I just want to be done -.-
108 lines
3.5 KiB
Rust
108 lines
3.5 KiB
Rust
use clippy_utils::diagnostics::span_lint_and_then;
|
|
use clippy_utils::source::indent_of;
|
|
use if_chain::if_chain;
|
|
use rustc_errors::Applicability;
|
|
use rustc_hir::{Item, ItemKind};
|
|
use rustc_lint::{LateContext, LateLintPass};
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
|
use rustc_span::sym;
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Warns on any exported `enum`s that are not tagged `#[non_exhaustive]`
|
|
///
|
|
/// ### Why is this bad?
|
|
/// Exhaustive enums are typically fine, but a project which does
|
|
/// not wish to make a stability commitment around exported enums may wish to
|
|
/// disable them by default.
|
|
///
|
|
/// ### Example
|
|
/// ```rust
|
|
/// enum Foo {
|
|
/// Bar,
|
|
/// Baz
|
|
/// }
|
|
/// ```
|
|
/// Use instead:
|
|
/// ```rust
|
|
/// #[non_exhaustive]
|
|
/// enum Foo {
|
|
/// Bar,
|
|
/// Baz
|
|
/// }
|
|
/// ```
|
|
#[clippy::version = "1.51.0"]
|
|
pub EXHAUSTIVE_ENUMS,
|
|
restriction,
|
|
"detects exported enums that have not been marked #[non_exhaustive]"
|
|
}
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Warns on any exported `structs`s that are not tagged `#[non_exhaustive]`
|
|
///
|
|
/// ### Why is this bad?
|
|
/// Exhaustive structs are typically fine, but a project which does
|
|
/// not wish to make a stability commitment around exported structs may wish to
|
|
/// disable them by default.
|
|
///
|
|
/// ### Example
|
|
/// ```rust
|
|
/// struct Foo {
|
|
/// bar: u8,
|
|
/// baz: String,
|
|
/// }
|
|
/// ```
|
|
/// Use instead:
|
|
/// ```rust
|
|
/// #[non_exhaustive]
|
|
/// struct Foo {
|
|
/// bar: u8,
|
|
/// baz: String,
|
|
/// }
|
|
/// ```
|
|
#[clippy::version = "1.51.0"]
|
|
pub EXHAUSTIVE_STRUCTS,
|
|
restriction,
|
|
"detects exported structs that have not been marked #[non_exhaustive]"
|
|
}
|
|
|
|
declare_lint_pass!(ExhaustiveItems => [EXHAUSTIVE_ENUMS, EXHAUSTIVE_STRUCTS]);
|
|
|
|
impl LateLintPass<'_> for ExhaustiveItems {
|
|
fn check_item(&mut self, cx: &LateContext<'_>, item: &Item<'_>) {
|
|
if_chain! {
|
|
if let ItemKind::Enum(..) | ItemKind::Struct(..) = item.kind;
|
|
if cx.access_levels.is_exported(item.def_id);
|
|
let attrs = cx.tcx.hir().attrs(item.hir_id());
|
|
if !attrs.iter().any(|a| a.has_name(sym::non_exhaustive));
|
|
then {
|
|
let (lint, msg) = if let ItemKind::Struct(ref v, ..) = item.kind {
|
|
if v.fields().iter().any(|f| !f.vis.node.is_pub()) {
|
|
// skip structs with private fields
|
|
return;
|
|
}
|
|
(EXHAUSTIVE_STRUCTS, "exported structs should not be exhaustive")
|
|
} else {
|
|
(EXHAUSTIVE_ENUMS, "exported enums should not be exhaustive")
|
|
};
|
|
let suggestion_span = item.span.shrink_to_lo();
|
|
let indent = " ".repeat(indent_of(cx, item.span).unwrap_or(0));
|
|
span_lint_and_then(
|
|
cx,
|
|
lint,
|
|
item.span,
|
|
msg,
|
|
|diag| {
|
|
let sugg = format!("#[non_exhaustive]\n{}", indent);
|
|
diag.span_suggestion(suggestion_span,
|
|
"try adding #[non_exhaustive]",
|
|
sugg,
|
|
Applicability::MaybeIncorrect);
|
|
}
|
|
);
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|