diff --git a/CHANGELOG.md b/CHANGELOG.md index 60c796a2f2d2..9331902b88b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1128,6 +1128,7 @@ Released 2018-09-13 [`ok_expect`]: https://rust-lang.github.io/rust-clippy/master/index.html#ok_expect [`op_ref`]: https://rust-lang.github.io/rust-clippy/master/index.html#op_ref [`option_and_then_some`]: https://rust-lang.github.io/rust-clippy/master/index.html#option_and_then_some +[`option_expect_used`]: https://rust-lang.github.io/rust-clippy/master/index.html#option_expect_used [`option_map_or_none`]: https://rust-lang.github.io/rust-clippy/master/index.html#option_map_or_none [`option_map_unit_fn`]: https://rust-lang.github.io/rust-clippy/master/index.html#option_map_unit_fn [`option_map_unwrap_or`]: https://rust-lang.github.io/rust-clippy/master/index.html#option_map_unwrap_or @@ -1167,6 +1168,7 @@ Released 2018-09-13 [`ref_in_deref`]: https://rust-lang.github.io/rust-clippy/master/index.html#ref_in_deref [`regex_macro`]: https://rust-lang.github.io/rust-clippy/master/index.html#regex_macro [`replace_consts`]: https://rust-lang.github.io/rust-clippy/master/index.html#replace_consts +[`result_expect_used`]: https://rust-lang.github.io/rust-clippy/master/index.html#result_expect_used [`result_map_unit_fn`]: https://rust-lang.github.io/rust-clippy/master/index.html#result_map_unit_fn [`result_map_unwrap_or_else`]: https://rust-lang.github.io/rust-clippy/master/index.html#result_map_unwrap_or_else [`result_unwrap_used`]: https://rust-lang.github.io/rust-clippy/master/index.html#result_unwrap_used diff --git a/README.md b/README.md index 262d9fe6ff2f..e61a80640401 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code. -[There are 328 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) +[There are 330 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html) We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you: diff --git a/clippy_lints/src/lib.rs b/clippy_lints/src/lib.rs index e87c7483e70d..25cdd87c6079 100644 --- a/clippy_lints/src/lib.rs +++ b/clippy_lints/src/lib.rs @@ -623,7 +623,9 @@ pub fn register_plugins(reg: &mut rustc_driver::plugin::Registry<'_>, conf: &Con mem_forget::MEM_FORGET, methods::CLONE_ON_REF_PTR, methods::GET_UNWRAP, + methods::OPTION_EXPECT_USED, methods::OPTION_UNWRAP_USED, + methods::RESULT_EXPECT_USED, methods::RESULT_UNWRAP_USED, methods::WRONG_PUB_SELF_CONVENTION, misc::FLOAT_CMP_CONST, diff --git a/clippy_lints/src/methods/mod.rs b/clippy_lints/src/methods/mod.rs index 3277135fdbff..ce08147a7a5b 100644 --- a/clippy_lints/src/methods/mod.rs +++ b/clippy_lints/src/methods/mod.rs @@ -110,9 +110,10 @@ declare_clippy_lint! { /// /// Better: /// - /// ```rust + /// ```ignore /// let opt = Some(1); /// opt?; + /// # Some::<()>(()) /// ``` pub OPTION_EXPECT_USED, restriction, @@ -138,9 +139,10 @@ declare_clippy_lint! { /// /// Better: /// - /// ```rust + /// ``` /// let res: Result = Ok(1); /// res?; + /// # Ok::<(), ()>(()) /// ``` pub RESULT_EXPECT_USED, restriction, diff --git a/clippy_lints/src/panic_unimplemented.rs b/clippy_lints/src/panic_unimplemented.rs index 94efb5acc000..87ef5f9034c8 100644 --- a/clippy_lints/src/panic_unimplemented.rs +++ b/clippy_lints/src/panic_unimplemented.rs @@ -38,7 +38,7 @@ declare_clippy_lint! { /// ``` pub PANIC, restriction, - "missing parameters in `panic!` calls" + "usage of the `panic!` macro" } declare_clippy_lint! { diff --git a/src/lintlist/mod.rs b/src/lintlist/mod.rs index 40883a8d33d6..46c019d7c65a 100644 --- a/src/lintlist/mod.rs +++ b/src/lintlist/mod.rs @@ -6,7 +6,7 @@ pub use lint::Lint; pub use lint::LINT_LEVELS; // begin lint list, do not remove this comment, it’s used in `update_lints` -pub const ALL_LINTS: [Lint; 328] = [ +pub const ALL_LINTS: [Lint; 330] = [ Lint { name: "absurd_extreme_comparisons", group: "correctness", @@ -1386,6 +1386,13 @@ pub const ALL_LINTS: [Lint; 328] = [ deprecation: None, module: "methods", }, + Lint { + name: "option_expect_used", + group: "restriction", + desc: "using `Option.expect()`, which might be better handled", + deprecation: None, + module: "methods", + }, Lint { name: "option_map_or_none", group: "style", @@ -1452,7 +1459,7 @@ pub const ALL_LINTS: [Lint; 328] = [ Lint { name: "panic", group: "restriction", - desc: "missing parameters in `panic!` calls", + desc: "usage of the `panic!` macro", deprecation: None, module: "panic_unimplemented", }, @@ -1652,6 +1659,13 @@ pub const ALL_LINTS: [Lint; 328] = [ deprecation: None, module: "replace_consts", }, + Lint { + name: "result_expect_used", + group: "restriction", + desc: "using `Result.expect()`, which might be better handled", + deprecation: None, + module: "methods", + }, Lint { name: "result_map_unit_fn", group: "complexity", diff --git a/tests/ui/expect.rs b/tests/ui/expect.rs new file mode 100644 index 000000000000..0bd4252c49aa --- /dev/null +++ b/tests/ui/expect.rs @@ -0,0 +1,16 @@ +#![warn(clippy::option_expect_used, clippy::result_expect_used)] + +fn expect_option() { + let opt = Some(0); + let _ = opt.expect(""); +} + +fn expect_result() { + let res: Result = Ok(0); + let _ = res.expect(""); +} + +fn main() { + expect_option(); + expect_result(); +} diff --git a/tests/ui/expect.stderr b/tests/ui/expect.stderr new file mode 100644 index 000000000000..4f954f611a69 --- /dev/null +++ b/tests/ui/expect.stderr @@ -0,0 +1,18 @@ +error: used expect() on an Option value. If this value is an None it will panic + --> $DIR/expect.rs:5:13 + | +LL | let _ = opt.expect(""); + | ^^^^^^^^^^^^^^ + | + = note: `-D clippy::option-expect-used` implied by `-D warnings` + +error: used expect() on a Result value. If this value is an Err it will panic + --> $DIR/expect.rs:10:13 + | +LL | let _ = res.expect(""); + | ^^^^^^^^^^^^^^ + | + = note: `-D clippy::result-expect-used` implied by `-D warnings` + +error: aborting due to 2 previous errors + diff --git a/tests/ui/methods.rs b/tests/ui/methods.rs index ca8358754ee9..847a0f0f3395 100644 --- a/tests/ui/methods.rs +++ b/tests/ui/methods.rs @@ -1,13 +1,7 @@ // aux-build:option_helpers.rs // compile-flags: --edition 2018 -#![warn( - clippy::all, - clippy::pedantic, - clippy::option_unwrap_used, - clippy::option_expect_used, - clippy::result_expect_used -)] +#![warn(clippy::all, clippy::pedantic)] #![allow( clippy::blacklisted_name, clippy::default_trait_access, @@ -307,8 +301,8 @@ fn search_is_some() { let _ = foo.rposition().is_some(); } -#[allow(clippy::similar_names)] fn main() { - let opt = Some(0); - let _ = opt.unwrap(); + option_methods(); + filter_next(); + search_is_some(); } diff --git a/tests/ui/methods.stderr b/tests/ui/methods.stderr index c3dc08be00b9..af7bd4a6a9d9 100644 --- a/tests/ui/methods.stderr +++ b/tests/ui/methods.stderr @@ -206,13 +206,5 @@ LL | | } LL | | ).is_some(); | |______________________________^ -error: used unwrap() on an Option value. If you don't want to handle the None case gracefully, consider using expect() to provide a better panic message - --> $DIR/methods.rs:307:13 - | -LL | let _ = opt.unwrap(); - | ^^^^^^^^^^^^ - | - = note: `-D clippy::option-unwrap-used` implied by `-D warnings` - -error: aborting due to 24 previous errors +error: aborting due to 23 previous errors diff --git a/tests/ui/panic.rs b/tests/ui/panic.rs index dee3104774cb..6e004aa9a924 100644 --- a/tests/ui/panic.rs +++ b/tests/ui/panic.rs @@ -1,12 +1,61 @@ -#![warn(clippy::panic)] +#![warn(clippy::panic_params)] #![allow(clippy::assertions_on_constants)] +fn missing() { + if true { + panic!("{}"); + } else if false { + panic!("{:?}"); + } else { + assert!(true, "here be missing values: {}"); + } -fn panic() { - let a = 2; - panic!(); - let b = a + 2; + panic!("{{{this}}}"); +} + +fn ok_single() { + panic!("foo bar"); +} + +fn ok_inner() { + // Test for #768 + assert!("foo bar".contains(&format!("foo {}", "bar"))); +} + +fn ok_multiple() { + panic!("{}", "This is {ok}"); +} + +fn ok_bracket() { + match 42 { + 1337 => panic!("{so is this"), + 666 => panic!("so is this}"), + _ => panic!("}so is that{"), + } +} + +const ONE: u32 = 1; + +fn ok_nomsg() { + assert!({ 1 == ONE }); + assert!(if 1 == ONE { ONE == 1 } else { false }); +} + +fn ok_escaped() { + panic!("{{ why should this not be ok? }}"); + panic!(" or {{ that ?"); + panic!(" or }} this ?"); + panic!(" {or {{ that ?"); + panic!(" }or }} this ?"); + panic!("{{ test }"); + panic!("{case }}"); } fn main() { - panic(); + missing(); + ok_single(); + ok_multiple(); + ok_bracket(); + ok_inner(); + ok_nomsg(); + ok_escaped(); } diff --git a/tests/ui/panic.stderr b/tests/ui/panic.stderr index cfef1a16e49e..1f8ff8ccf557 100644 --- a/tests/ui/panic.stderr +++ b/tests/ui/panic.stderr @@ -1,10 +1,28 @@ -error: `panic` should not be present in production code - --> $DIR/panic.rs:6:5 +error: you probably are missing some parameter in your format string + --> $DIR/panic.rs:5:16 | -LL | panic!(); - | ^^^^^^^^^ +LL | panic!("{}"); + | ^^^^ | - = note: `-D clippy::panic` implied by `-D warnings` + = note: `-D clippy::panic-params` implied by `-D warnings` -error: aborting due to previous error +error: you probably are missing some parameter in your format string + --> $DIR/panic.rs:7:16 + | +LL | panic!("{:?}"); + | ^^^^^^ + +error: you probably are missing some parameter in your format string + --> $DIR/panic.rs:9:23 + | +LL | assert!(true, "here be missing values: {}"); + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +error: you probably are missing some parameter in your format string + --> $DIR/panic.rs:12:12 + | +LL | panic!("{{{this}}}"); + | ^^^^^^^^^^^^ + +error: aborting due to 4 previous errors diff --git a/tests/ui/panic_unimplemented.rs b/tests/ui/panic_unimplemented.rs deleted file mode 100644 index f3dae3bbde65..000000000000 --- a/tests/ui/panic_unimplemented.rs +++ /dev/null @@ -1,82 +0,0 @@ -#![warn(clippy::panic_params, clippy::unimplemented, clippy::unreachable, clippy::todo)] -#![allow(clippy::assertions_on_constants)] -fn missing() { - if true { - panic!("{}"); - } else if false { - panic!("{:?}"); - } else { - assert!(true, "here be missing values: {}"); - } - - panic!("{{{this}}}"); -} - -fn ok_single() { - panic!("foo bar"); -} - -fn ok_inner() { - // Test for #768 - assert!("foo bar".contains(&format!("foo {}", "bar"))); -} - -fn ok_multiple() { - panic!("{}", "This is {ok}"); -} - -fn ok_bracket() { - match 42 { - 1337 => panic!("{so is this"), - 666 => panic!("so is this}"), - _ => panic!("}so is that{"), - } -} - -const ONE: u32 = 1; - -fn ok_nomsg() { - assert!({ 1 == ONE }); - assert!(if 1 == ONE { ONE == 1 } else { false }); -} - -fn ok_escaped() { - panic!("{{ why should this not be ok? }}"); - panic!(" or {{ that ?"); - panic!(" or }} this ?"); - panic!(" {or {{ that ?"); - panic!(" }or }} this ?"); - panic!("{{ test }"); - panic!("{case }}"); -} - -fn unimplemented() { - let a = 2; - unimplemented!(); - let b = a + 2; -} - -fn unreachable() { - let a = 2; - unreachable!(); - let b = a + 2; -} - -fn todo() { - let a = 2; - todo!(); - let b = a + 2; -} - -fn main() { - missing(); - ok_single(); - ok_multiple(); - ok_bracket(); - ok_inner(); - ok_nomsg(); - ok_escaped(); - unimplemented(); - unreachable(); - todo(); -} diff --git a/tests/ui/panic_unimplemented.stderr b/tests/ui/panic_unimplemented.stderr deleted file mode 100644 index 6d847e8df3eb..000000000000 --- a/tests/ui/panic_unimplemented.stderr +++ /dev/null @@ -1,52 +0,0 @@ -error: you probably are missing some parameter in your format string - --> $DIR/panic_unimplemented.rs:5:16 - | -LL | panic!("{}"); - | ^^^^ - | - = note: `-D clippy::panic-params` implied by `-D warnings` - -error: you probably are missing some parameter in your format string - --> $DIR/panic_unimplemented.rs:7:16 - | -LL | panic!("{:?}"); - | ^^^^^^ - -error: you probably are missing some parameter in your format string - --> $DIR/panic_unimplemented.rs:9:23 - | -LL | assert!(true, "here be missing values: {}"); - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -error: you probably are missing some parameter in your format string - --> $DIR/panic_unimplemented.rs:12:12 - | -LL | panic!("{{{this}}}"); - | ^^^^^^^^^^^^ - -error: `unimplemented` should not be present in production code - --> $DIR/panic_unimplemented.rs:55:5 - | -LL | unimplemented!(); - | ^^^^^^^^^^^^^^^^^ - | - = note: `-D clippy::unimplemented` implied by `-D warnings` - -error: `unreachable` should not be present in production code - --> $DIR/panic_unimplemented.rs:61:5 - | -LL | unreachable!(); - | ^^^^^^^^^^^^^^^ - | - = note: `-D clippy::unreachable` implied by `-D warnings` - -error: `todo` should not be present in production code - --> $DIR/panic_unimplemented.rs:67:5 - | -LL | todo!(); - | ^^^^^^^^ - | - = note: `-D clippy::todo` implied by `-D warnings` - -error: aborting due to 7 previous errors - diff --git a/tests/ui/panicking_macros.rs b/tests/ui/panicking_macros.rs new file mode 100644 index 000000000000..dabb695368db --- /dev/null +++ b/tests/ui/panicking_macros.rs @@ -0,0 +1,33 @@ +#![warn(clippy::unimplemented, clippy::unreachable, clippy::todo, clippy::panic)] +#![allow(clippy::assertions_on_constants)] + +fn panic() { + let a = 2; + panic!(); + let b = a + 2; +} + +fn todo() { + let a = 2; + todo!(); + let b = a + 2; +} + +fn unimplemented() { + let a = 2; + unimplemented!(); + let b = a + 2; +} + +fn unreachable() { + let a = 2; + unreachable!(); + let b = a + 2; +} + +fn main() { + panic(); + todo(); + unimplemented(); + unreachable(); +} diff --git a/tests/ui/panicking_macros.stderr b/tests/ui/panicking_macros.stderr new file mode 100644 index 000000000000..72319bc7e458 --- /dev/null +++ b/tests/ui/panicking_macros.stderr @@ -0,0 +1,34 @@ +error: `panic` should not be present in production code + --> $DIR/panicking_macros.rs:6:5 + | +LL | panic!(); + | ^^^^^^^^^ + | + = note: `-D clippy::panic` implied by `-D warnings` + +error: `todo` should not be present in production code + --> $DIR/panicking_macros.rs:12:5 + | +LL | todo!(); + | ^^^^^^^^ + | + = note: `-D clippy::todo` implied by `-D warnings` + +error: `unimplemented` should not be present in production code + --> $DIR/panicking_macros.rs:18:5 + | +LL | unimplemented!(); + | ^^^^^^^^^^^^^^^^^ + | + = note: `-D clippy::unimplemented` implied by `-D warnings` + +error: `unreachable` should not be present in production code + --> $DIR/panicking_macros.rs:24:5 + | +LL | unreachable!(); + | ^^^^^^^^^^^^^^^ + | + = note: `-D clippy::unreachable` implied by `-D warnings` + +error: aborting due to 4 previous errors + diff --git a/tests/ui/unwrap.rs b/tests/ui/unwrap.rs new file mode 100644 index 000000000000..fcd1fcd14d48 --- /dev/null +++ b/tests/ui/unwrap.rs @@ -0,0 +1,16 @@ +#![warn(clippy::option_unwrap_used, clippy::result_unwrap_used)] + +fn unwrap_option() { + let opt = Some(0); + let _ = opt.unwrap(); +} + +fn unwrap_result() { + let res: Result = Ok(0); + let _ = res.unwrap(); +} + +fn main() { + unwrap_option(); + unwrap_result(); +} diff --git a/tests/ui/unwrap.stderr b/tests/ui/unwrap.stderr new file mode 100644 index 000000000000..cde3ceffd9d3 --- /dev/null +++ b/tests/ui/unwrap.stderr @@ -0,0 +1,18 @@ +error: used unwrap() on an Option value. If you don't want to handle the None case gracefully, consider using expect() to provide a better panic message + --> $DIR/unwrap.rs:5:13 + | +LL | let _ = opt.unwrap(); + | ^^^^^^^^^^^^ + | + = note: `-D clippy::option-unwrap-used` implied by `-D warnings` + +error: used unwrap() on a Result value. If you don't want to handle the Err case gracefully, consider using expect() to provide a better panic message + --> $DIR/unwrap.rs:10:13 + | +LL | let _ = res.unwrap(); + | ^^^^^^^^^^^^ + | + = note: `-D clippy::result-unwrap-used` implied by `-D warnings` + +error: aborting due to 2 previous errors +