-use crate::utils::{differing_macro_contexts, snippet_opt, span_help_and_lint, span_note_and_lint};
+use clippy_utils::diagnostics::{span_lint_and_help, span_lint_and_note};
+use clippy_utils::differing_macro_contexts;
+use clippy_utils::source::snippet_opt;
use if_chain::if_chain;
-use rustc::lint::in_external_macro;
+use rustc_ast::ast::{BinOpKind, Block, Expr, ExprKind, StmtKind, UnOp};
use rustc_lint::{EarlyContext, EarlyLintPass};
+use rustc_middle::lint::in_external_macro;
use rustc_session::{declare_lint_pass, declare_tool_lint};
-use syntax::ast::*;
+use rustc_span::source_map::Span;
declare_clippy_lint! {
- /// **What it does:** Checks for use of the non-existent `=*`, `=!` and `=-`
+ /// ### What it does
+ /// Checks for use of the non-existent `=*`, `=!` and `=-`
/// operators.
///
- /// **Why is this bad?** This is either a typo of `*=`, `!=` or `-=` or
+ /// ### Why is this bad?
+ /// This is either a typo of `*=`, `!=` or `-=` or
/// confusing.
///
- /// **Known problems:** None.
- ///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// a =- 42; // confusing, should it be `a -= 42` or `a = -42`?
/// ```
pub SUSPICIOUS_ASSIGNMENT_FORMATTING,
- style,
+ suspicious,
"suspicious formatting of `*=`, `-=` or `!=`"
}
declare_clippy_lint! {
- /// **What it does:** Checks the formatting of a unary operator on the right hand side
+ /// ### What it does
+ /// Checks the formatting of a unary operator on the right hand side
/// of a binary operator. It lints if there is no space between the binary and unary operators,
/// but there is a space between the unary and its operand.
///
- /// **Why is this bad?** This is either a typo in the binary operator or confusing.
- ///
- /// **Known problems:** None.
+ /// ### Why is this bad?
+ /// This is either a typo in the binary operator or confusing.
///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// if foo <- 30 { // this should be `foo < -30` but looks like a different operator
/// }
/// }
/// ```
pub SUSPICIOUS_UNARY_OP_FORMATTING,
- style,
+ suspicious,
"suspicious formatting of unary `-` or `!` on the RHS of a BinOp"
}
declare_clippy_lint! {
- /// **What it does:** Checks for formatting of `else`. It lints if the `else`
+ /// ### What it does
+ /// Checks for formatting of `else`. It lints if the `else`
/// is followed immediately by a newline or the `else` seems to be missing.
///
- /// **Why is this bad?** This is probably some refactoring remnant, even if the
+ /// ### Why is this bad?
+ /// This is probably some refactoring remnant, even if the
/// code is correct, it might look confusing.
///
- /// **Known problems:** None.
- ///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// if foo {
/// } { // looks like an `else` is missing here
/// }
/// ```
pub SUSPICIOUS_ELSE_FORMATTING,
- style,
+ suspicious,
"suspicious formatting of `else`"
}
declare_clippy_lint! {
- /// **What it does:** Checks for possible missing comma in an array. It lints if
+ /// ### What it does
+ /// Checks for possible missing comma in an array. It lints if
/// an array element is a binary operator expression and it lies on two lines.
///
- /// **Why is this bad?** This could lead to unexpected results.
- ///
- /// **Known problems:** None.
+ /// ### Why is this bad?
+ /// This could lead to unexpected results.
///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// let a = &[
/// -1, -2, -3 // <= no comma here
impl EarlyLintPass for Formatting {
fn check_block(&mut self, cx: &EarlyContext<'_>, block: &Block) {
for w in block.stmts.windows(2) {
- match (&w[0].kind, &w[1].kind) {
- (&StmtKind::Expr(ref first), &StmtKind::Expr(ref second))
- | (&StmtKind::Expr(ref first), &StmtKind::Semi(ref second)) => {
- check_missing_else(cx, first, second);
- },
- _ => (),
+ if let (StmtKind::Expr(first), StmtKind::Expr(second) | StmtKind::Semi(second)) = (&w[0].kind, &w[1].kind) {
+ check_missing_else(cx, first, second);
}
}
}
let op = UnOp::to_string(op);
let eqop_span = lhs.span.between(sub_rhs.span);
if eq_snippet.ends_with('=') {
- span_note_and_lint(
+ span_lint_and_note(
cx,
SUSPICIOUS_ASSIGNMENT_FORMATTING,
eqop_span,
really are doing `.. = ({op} ..)`",
op = op
),
- eqop_span,
+ None,
&format!("to remove this lint, use either `{op}=` or `= {op}`", op = op),
);
}
if !differing_macro_contexts(lhs.span, rhs.span) && !lhs.span.from_expansion();
// span between BinOp LHS and RHS
let binop_span = lhs.span.between(rhs.span);
- // if RHS is a UnOp
+ // if RHS is an UnOp
if let ExprKind::Unary(op, ref un_rhs) = rhs.kind;
// from UnOp operator to UnOp operand
let unop_operand_span = rhs.span.until(un_rhs.span);
then {
let unop_str = UnOp::to_string(op);
let eqop_span = lhs.span.between(un_rhs.span);
- span_help_and_lint(
+ span_lint_and_help(
cx,
SUSPICIOUS_UNARY_OP_FORMATTING,
eqop_span,
binop = binop_str,
unop = unop_str
),
+ None,
&format!(
"put a space between `{binop}` and `{unop}` and remove the space after `{unop}`",
binop = binop_str,
// the snippet should look like " else \n " with maybe comments anywhere
// it’s bad when there is a ‘\n’ after the “else”
if let Some(else_snippet) = snippet_opt(cx, else_span);
- if let Some(else_pos) = else_snippet.find("else");
- if else_snippet[else_pos..].contains('\n');
- let else_desc = if is_if(else_) { "if" } else { "{..}" };
+ if let Some((pre_else, post_else)) = else_snippet.split_once("else");
+ if let Some((_, post_else_post_eol)) = post_else.split_once('\n');
then {
- span_note_and_lint(
+ // Allow allman style braces `} \n else \n {`
+ if_chain! {
+ if is_block(else_);
+ if let Some((_, pre_else_post_eol)) = pre_else.split_once('\n');
+ // Exactly one eol before and after the else
+ if !pre_else_post_eol.contains('\n');
+ if !post_else_post_eol.contains('\n');
+ then {
+ return;
+ }
+ }
+
+ let else_desc = if is_if(else_) { "if" } else { "{..}" };
+ span_lint_and_note(
cx,
SUSPICIOUS_ELSE_FORMATTING,
else_span,
&format!("this is an `else {}` but the formatting might hide it", else_desc),
- else_span,
+ None,
&format!(
"to remove this lint, remove the `else` or remove the new line between \
`else` and `{}`",
bin_op == BinOpKind::And || bin_op == BinOpKind::Mul || bin_op == BinOpKind::Sub
}
+fn indentation(cx: &EarlyContext<'_>, span: Span) -> usize {
+ cx.sess.source_map().lookup_char_pos(span.lo()).col.0
+}
+
/// Implementation of the `POSSIBLE_MISSING_COMMA` lint for array
fn check_array(cx: &EarlyContext<'_>, expr: &Expr) {
if let ExprKind::Array(ref array) = expr.kind {
for element in array {
- if let ExprKind::Binary(ref op, ref lhs, _) = element.kind {
- if has_unary_equivalent(op.node) && !differing_macro_contexts(lhs.span, op.span) {
- let space_span = lhs.span.between(op.span);
- if let Some(space_snippet) = snippet_opt(cx, space_span) {
- let lint_span = lhs.span.with_lo(lhs.span.hi());
- if space_snippet.contains('\n') {
- span_note_and_lint(
- cx,
- POSSIBLE_MISSING_COMMA,
- lint_span,
- "possibly missing a comma here",
- lint_span,
- "to remove this lint, add a comma or write the expr in a single line",
- );
- }
- }
+ if_chain! {
+ if let ExprKind::Binary(ref op, ref lhs, _) = element.kind;
+ if has_unary_equivalent(op.node) && !differing_macro_contexts(lhs.span, op.span);
+ let space_span = lhs.span.between(op.span);
+ if let Some(space_snippet) = snippet_opt(cx, space_span);
+ let lint_span = lhs.span.with_lo(lhs.span.hi());
+ if space_snippet.contains('\n');
+ if indentation(cx, op.span) <= indentation(cx, lhs.span);
+ then {
+ span_lint_and_note(
+ cx,
+ POSSIBLE_MISSING_COMMA,
+ lint_span,
+ "possibly missing a comma here",
+ None,
+ "to remove this lint, add a comma or write the expr in a single line",
+ );
}
}
}
("an `else {..}`", "the next block")
};
- span_note_and_lint(
+ span_lint_and_note(
cx,
SUSPICIOUS_ELSE_FORMATTING,
else_span,
&format!("this looks like {} but the `else` is missing", looks_like),
- else_span,
+ None,
&format!(
"to remove this lint, add the missing `else` or add a new line before {}",
next_thing,
}
fn is_block(expr: &Expr) -> bool {
- if let ExprKind::Block(..) = expr.kind {
- true
- } else {
- false
- }
+ matches!(expr.kind, ExprKind::Block(..))
}
/// Check if the expression is an `if` or `if let`
fn is_if(expr: &Expr) -> bool {
- if let ExprKind::If(..) = expr.kind {
- true
- } else {
- false
- }
+ matches!(expr.kind, ExprKind::If(..))
}