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
4.4 KiB
Rust
108 lines
4.4 KiB
Rust
use clippy_utils::diagnostics::{span_lint_and_help, span_lint_and_sugg};
|
|
use clippy_utils::higher::FormatArgsExpn;
|
|
use clippy_utils::{is_expn_of, match_function_call, paths};
|
|
use if_chain::if_chain;
|
|
use rustc_errors::Applicability;
|
|
use rustc_hir::{Expr, ExprKind};
|
|
use rustc_lint::{LateContext, LateLintPass};
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
|
use rustc_span::sym;
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Checks for usage of `write!()` / `writeln()!` which can be
|
|
/// replaced with `(e)print!()` / `(e)println!()`
|
|
///
|
|
/// ### Why is this bad?
|
|
/// Using `(e)println! is clearer and more concise
|
|
///
|
|
/// ### Example
|
|
/// ```rust
|
|
/// # use std::io::Write;
|
|
/// # let bar = "furchtbar";
|
|
/// // this would be clearer as `eprintln!("foo: {:?}", bar);`
|
|
/// writeln!(&mut std::io::stderr(), "foo: {:?}", bar).unwrap();
|
|
/// ```
|
|
#[clippy::version = "pre 1.29.0"]
|
|
pub EXPLICIT_WRITE,
|
|
complexity,
|
|
"using the `write!()` family of functions instead of the `print!()` family of functions, when using the latter would work"
|
|
}
|
|
|
|
declare_lint_pass!(ExplicitWrite => [EXPLICIT_WRITE]);
|
|
|
|
impl<'tcx> LateLintPass<'tcx> for ExplicitWrite {
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
|
if_chain! {
|
|
// match call to unwrap
|
|
if let ExprKind::MethodCall(unwrap_fun, _, [write_call], _) = expr.kind;
|
|
if unwrap_fun.ident.name == sym::unwrap;
|
|
// match call to write_fmt
|
|
if let ExprKind::MethodCall(write_fun, _, [write_recv, write_arg], _) = write_call.kind;
|
|
if write_fun.ident.name == sym!(write_fmt);
|
|
// match calls to std::io::stdout() / std::io::stderr ()
|
|
if let Some(dest_name) = if match_function_call(cx, write_recv, &paths::STDOUT).is_some() {
|
|
Some("stdout")
|
|
} else if match_function_call(cx, write_recv, &paths::STDERR).is_some() {
|
|
Some("stderr")
|
|
} else {
|
|
None
|
|
};
|
|
if let Some(format_args) = FormatArgsExpn::parse(write_arg);
|
|
then {
|
|
let calling_macro =
|
|
// ordering is important here, since `writeln!` uses `write!` internally
|
|
if is_expn_of(write_call.span, "writeln").is_some() {
|
|
Some("writeln")
|
|
} else if is_expn_of(write_call.span, "write").is_some() {
|
|
Some("write")
|
|
} else {
|
|
None
|
|
};
|
|
let prefix = if dest_name == "stderr" {
|
|
"e"
|
|
} else {
|
|
""
|
|
};
|
|
|
|
// We need to remove the last trailing newline from the string because the
|
|
// underlying `fmt::write` function doesn't know whether `println!` or `print!` was
|
|
// used.
|
|
let (used, sugg_mac) = if let Some(macro_name) = calling_macro {
|
|
(
|
|
format!("{}!({}(), ...)", macro_name, dest_name),
|
|
macro_name.replace("write", "print"),
|
|
)
|
|
} else {
|
|
(
|
|
format!("{}().write_fmt(...)", dest_name),
|
|
"print".into(),
|
|
)
|
|
};
|
|
let msg = format!("use of `{}.unwrap()`", used);
|
|
if let [write_output] = *format_args.format_string_symbols {
|
|
let mut write_output = write_output.to_string();
|
|
if write_output.ends_with('\n') {
|
|
write_output.pop();
|
|
}
|
|
|
|
let sugg = format!("{}{}!(\"{}\")", prefix, sugg_mac, write_output.escape_default());
|
|
span_lint_and_sugg(
|
|
cx,
|
|
EXPLICIT_WRITE,
|
|
expr.span,
|
|
&msg,
|
|
"try this",
|
|
sugg,
|
|
Applicability::MachineApplicable
|
|
);
|
|
} else {
|
|
// We don't have a proper suggestion
|
|
let help = format!("consider using `{}{}!` instead", prefix, sugg_mac);
|
|
span_lint_and_help(cx, EXPLICIT_WRITE, expr.span, &msg, None, &help);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|