Rename lint to index_refutable_slice and connected config

rust-lang · Sep 13, 2021 · 1ed88fa · 1ed88fa
1 parent 3824dae
commit 1ed88fa
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2559,7 +2559,6 @@ Released 2018-09-13
 [`assign_op_pattern`]: https://rust-lang.github.io/rust-clippy/master/index.html#assign_op_pattern
 [`assign_ops`]: https://rust-lang.github.io/rust-clippy/master/index.html#assign_ops
 [`async_yields_async`]: https://rust-lang.github.io/rust-clippy/master/index.html#async_yields_async
-[`avoidable_slice_indexing`]: https://rust-lang.github.io/rust-clippy/master/index.html#avoidable_slice_indexing
 [`await_holding_lock`]: https://rust-lang.github.io/rust-clippy/master/index.html#await_holding_lock
 [`await_holding_refcell_ref`]: https://rust-lang.github.io/rust-clippy/master/index.html#await_holding_refcell_ref
 [`bad_bit_mask`]: https://rust-lang.github.io/rust-clippy/master/index.html#bad_bit_mask
@@ -2698,6 +2697,7 @@ Released 2018-09-13
 [`imprecise_flops`]: https://rust-lang.github.io/rust-clippy/master/index.html#imprecise_flops
 [`inconsistent_digit_grouping`]: https://rust-lang.github.io/rust-clippy/master/index.html#inconsistent_digit_grouping
 [`inconsistent_struct_constructor`]: https://rust-lang.github.io/rust-clippy/master/index.html#inconsistent_struct_constructor
+[`index_refutable_slice`]: https://rust-lang.github.io/rust-clippy/master/index.html#index_refutable_slice
 [`indexing_slicing`]: https://rust-lang.github.io/rust-clippy/master/index.html#indexing_slicing
 [`ineffective_bit_mask`]: https://rust-lang.github.io/rust-clippy/master/index.html#ineffective_bit_mask
 [`inefficient_to_string`]: https://rust-lang.github.io/rust-clippy/master/index.html#inefficient_to_string

diff --git a/clippy_lints/src/avoidable_slice_indexing.rs → clippy_lints/src/index_refutable_slice.rs b/clippy_lints/src/avoidable_slice_indexing.rs → clippy_lints/src/index_refutable_slice.rs
@@ -45,34 +45,34 @@ declare_clippy_lint! {
     ///     println!("{}", first);
     /// }
     /// ```
-    pub AVOIDABLE_SLICE_INDEXING,
+    pub INDEX_REFUTABLE_SLICE,
     nursery,
     "avoid indexing on slices which could be deconstructed"
 }
 
 #[derive(Copy, Clone)]
-pub struct AvoidableSliceIndexing {
+pub struct IndexRefutableSlice {
     indexing_limit: u64,
     msrv: Option<RustcVersion>,
 }
 
-impl AvoidableSliceIndexing {
-    pub fn new(avoidable_slice_indexing_limit: u64, msrv: Option<RustcVersion>) -> Self {
+impl IndexRefutableSlice {
+    pub fn new(max_suggested_slice_pattern_length: u64, msrv: Option<RustcVersion>) -> Self {
         Self {
-            indexing_limit: avoidable_slice_indexing_limit,
+            indexing_limit: max_suggested_slice_pattern_length,
             msrv,
         }
     }
 }
 
-impl_lint_pass!(AvoidableSliceIndexing => [AVOIDABLE_SLICE_INDEXING]);
+impl_lint_pass!(IndexRefutableSlice => [INDEX_REFUTABLE_SLICE]);
 
-impl LateLintPass<'_> for AvoidableSliceIndexing {
+impl LateLintPass<'_> for IndexRefutableSlice {
     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx hir::Expr<'_>) {
         if_chain! {
             if !in_macro(expr.span) || is_expn_of(expr.span, "if_chain").is_some();
             if let Some(IfLet {let_pat, if_then, ..}) = IfLet::hir(cx, expr);
-            if !is_lint_allowed(cx, AVOIDABLE_SLICE_INDEXING, expr.hir_id);
+            if !is_lint_allowed(cx, INDEX_REFUTABLE_SLICE, expr.hir_id);
             if meets_msrv(self.msrv.as_ref(), &msrvs::SLICE_PATTERNS);
             if let Some(found_slices) = find_slice_values(cx, let_pat);
             if let Some(filtered_slices) = filter_lintable_slices(cx, found_slices, self.indexing_limit, if_then);
@@ -154,7 +154,7 @@ fn lint_slice(cx: &LateContext<'_>, slice: &SliceLintInformation) {
 
         span_lint_and_then(
             cx,
-            AVOIDABLE_SLICE_INDEXING,
+            INDEX_REFUTABLE_SLICE,
             slice.ident.span,
             "this binding can be a slice pattern to avoid indexing",
             |diag| {

diff --git a/clippy_lints/src/lib.rs b/clippy_lints/src/lib.rs
@@ -165,7 +165,6 @@ mod assertions_on_constants;
 mod assign_ops;
 mod async_yields_async;
 mod attrs;
-mod avoidable_slice_indexing;
 mod await_holding_invalid;
 mod bit_mask;
 mod blacklisted_name;
@@ -233,6 +232,7 @@ mod implicit_hasher;
 mod implicit_return;
 mod implicit_saturating_sub;
 mod inconsistent_struct_constructor;
+mod index_refutable_slice;
 mod indexing_slicing;
 mod infinite_iter;
 mod inherent_impl;
@@ -547,7 +547,6 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
         attrs::INLINE_ALWAYS,
         attrs::MISMATCHED_TARGET_OS,
         attrs::USELESS_ATTRIBUTE,
-        avoidable_slice_indexing::AVOIDABLE_SLICE_INDEXING,
         await_holding_invalid::AWAIT_HOLDING_LOCK,
         await_holding_invalid::AWAIT_HOLDING_REFCELL_REF,
         bit_mask::BAD_BIT_MASK,
@@ -664,6 +663,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
         implicit_return::IMPLICIT_RETURN,
         implicit_saturating_sub::IMPLICIT_SATURATING_SUB,
         inconsistent_struct_constructor::INCONSISTENT_STRUCT_CONSTRUCTOR,
+        index_refutable_slice::INDEX_REFUTABLE_SLICE,
         indexing_slicing::INDEXING_SLICING,
         indexing_slicing::OUT_OF_BOUNDS_INDEXING,
         infinite_iter::INFINITE_ITER,
@@ -1805,7 +1805,6 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
 
     store.register_group(true, "clippy::nursery", Some("clippy_nursery"), vec![
         LintId::of(attrs::EMPTY_LINE_AFTER_OUTER_ATTR),
-        LintId::of(avoidable_slice_indexing::AVOIDABLE_SLICE_INDEXING),
         LintId::of(cognitive_complexity::COGNITIVE_COMPLEXITY),
         LintId::of(copies::BRANCHES_SHARING_CODE),
         LintId::of(disallowed_method::DISALLOWED_METHOD),
@@ -1814,6 +1813,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
         LintId::of(floating_point_arithmetic::IMPRECISE_FLOPS),
         LintId::of(floating_point_arithmetic::SUBOPTIMAL_FLOPS),
         LintId::of(future_not_send::FUTURE_NOT_SEND),
+        LintId::of(index_refutable_slice::INDEX_REFUTABLE_SLICE),
         LintId::of(let_if_seq::USELESS_LET_IF_SEQ),
         LintId::of(missing_const_for_fn::MISSING_CONST_FOR_FN),
         LintId::of(mutable_debug_assertion::DEBUG_ASSERT_WITH_MUT_CALL),
@@ -1923,8 +1923,8 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
     store.register_early_pass(move || Box::new(unnested_or_patterns::UnnestedOrPatterns::new(msrv)));
 
     store.register_late_pass(|| Box::new(size_of_in_element_count::SizeOfInElementCount));
-    let avoidable_slice_indexing_limit = conf.avoidable_slice_indexing_limit;
-    store.register_late_pass(move || Box::new(avoidable_slice_indexing::AvoidableSliceIndexing::new(avoidable_slice_indexing_limit, msrv)));
+    let max_suggested_slice_pattern_length = conf.max_suggested_slice_pattern_length;
+    store.register_late_pass(move || Box::new(index_refutable_slice::IndexRefutableSlice::new(max_suggested_slice_pattern_length, msrv)));
     store.register_late_pass(|| Box::new(map_clone::MapClone));
     store.register_late_pass(|| Box::new(map_err_ignore::MapErrIgnore));
     store.register_late_pass(|| Box::new(shadow::Shadow));

diff --git a/clippy_lints/src/utils/conf.rs b/clippy_lints/src/utils/conf.rs
@@ -132,7 +132,7 @@ define_Conf! {
     ///
     /// Suppress lints whenever the suggested change would cause breakage for other crates.
     (avoid_breaking_exported_api: bool = true),
-    /// Lint: MANUAL_SPLIT_ONCE, MANUAL_STR_REPEAT, CLONED_INSTEAD_OF_COPIED, REDUNDANT_FIELD_NAMES, REDUNDANT_STATIC_LIFETIMES, FILTER_MAP_NEXT, CHECKED_CONVERSIONS, MANUAL_RANGE_CONTAINS, USE_SELF, MEM_REPLACE_WITH_DEFAULT, MANUAL_NON_EXHAUSTIVE, OPTION_AS_REF_DEREF, MAP_UNWRAP_OR, MATCH_LIKE_MATCHES_MACRO, MANUAL_STRIP, MISSING_CONST_FOR_FN, UNNESTED_OR_PATTERNS, FROM_OVER_INTO, PTR_AS_PTR, IF_THEN_SOME_ELSE_NONE, APPROX_CONSTANT, AVOIDABLE_SLICE_INDEXING.
+    /// Lint: MANUAL_SPLIT_ONCE, MANUAL_STR_REPEAT, CLONED_INSTEAD_OF_COPIED, REDUNDANT_FIELD_NAMES, REDUNDANT_STATIC_LIFETIMES, FILTER_MAP_NEXT, CHECKED_CONVERSIONS, MANUAL_RANGE_CONTAINS, USE_SELF, MEM_REPLACE_WITH_DEFAULT, MANUAL_NON_EXHAUSTIVE, OPTION_AS_REF_DEREF, MAP_UNWRAP_OR, MATCH_LIKE_MATCHES_MACRO, MANUAL_STRIP, MISSING_CONST_FOR_FN, UNNESTED_OR_PATTERNS, FROM_OVER_INTO, PTR_AS_PTR, IF_THEN_SOME_ELSE_NONE, APPROX_CONSTANT, INDEX_REFUTABLE_SLICE.
     ///
     /// The minimum rust version that the project supports
     (msrv: Option<String> = None),
@@ -276,12 +276,12 @@ define_Conf! {
     ///
     /// The list of unicode scripts allowed to be used in the scope.
     (allowed_scripts: Vec<String> = vec!["Latin".to_string()]),
-    /// Lint: AVOIDABLE_SLICE_INDEXING.
+    /// Lint: INDEX_REFUTABLE_SLICE.
     ///
     /// The limit after which slice indexing will not be linted as avoidable.
     ///
     /// As an example, the default limit of `3` would allow `slice[3]` but lint `slice[2]`.
-    (avoidable_slice_indexing_limit: u64 = 3),
+    (max_suggested_slice_pattern_length: u64 = 3),
 }
 
 /// Search for the configuration file.

diff --git a/tests/ui-toml/avoidable_slice_indexing_limit/clippy.toml b/tests/ui-toml/avoidable_slice_indexing_limit/clippy.toml
diff --git a/...g_limit/avoidable_slice_indexing_limit.rs → ..._length/avoidable_slice_indexing_limit.rs b/...g_limit/avoidable_slice_indexing_limit.rs → ..._length/avoidable_slice_indexing_limit.rs
@@ -1,4 +1,4 @@
-#![deny(clippy::avoidable_slice_indexing)]
+#![deny(clippy::index_refutable_slice)]
 
 fn below_limit() {
     let slice: Option<&[u32]> = Some(&[1, 2, 3]);

diff --git a/...mit/avoidable_slice_indexing_limit.stderr → ...gth/avoidable_slice_indexing_limit.stderr b/...mit/avoidable_slice_indexing_limit.stderr → ...gth/avoidable_slice_indexing_limit.stderr
@@ -7,8 +7,8 @@ LL |     if let Some(slice) = slice {
 note: the lint level is defined here
   --> $DIR/avoidable_slice_indexing_limit.rs:1:9
    |
-LL | #![deny(clippy::avoidable_slice_indexing)]
-   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+LL | #![deny(clippy::index_refutable_slice)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 help: try using a slice pattern here
    |
 LL |     if let Some([_, _, _, _, _, _, _, slice_7, ..]) = slice {

diff --git a/tests/ui-toml/max_suggested_slice_pattern_length/clippy.toml b/tests/ui-toml/max_suggested_slice_pattern_length/clippy.toml
@@ -0,0 +1 @@
+max-suggested-slice-pattern-length = 8
diff --git a/tests/ui-toml/toml_unknown_key/conf_unknown_key.stderr b/tests/ui-toml/toml_unknown_key/conf_unknown_key.stderr
@@ -1,4 +1,4 @@
-error: error reading Clippy's configuration file `$DIR/clippy.toml`: unknown field `foobar`, expected one of `avoid-breaking-exported-api`, `msrv`, `blacklisted-names`, `cognitive-complexity-threshold`, `cyclomatic-complexity-threshold`, `doc-valid-idents`, `too-many-arguments-threshold`, `type-complexity-threshold`, `single-char-binding-names-threshold`, `too-large-for-stack`, `enum-variant-name-threshold`, `enum-variant-size-threshold`, `verbose-bit-mask-threshold`, `literal-representation-threshold`, `trivial-copy-size-limit`, `pass-by-value-size-limit`, `too-many-lines-threshold`, `array-size-threshold`, `vec-box-size-threshold`, `max-trait-bounds`, `max-struct-bools`, `max-fn-params-bools`, `warn-on-all-wildcard-imports`, `disallowed-methods`, `disallowed-types`, `unreadable-literal-lint-fractions`, `upper-case-acronyms-aggressive`, `cargo-ignore-publish`, `standard-macro-braces`, `enforced-import-renames`, `allowed-scripts`, `avoidable-slice-indexing-limit`, `third-party` at line 5 column 1
+error: error reading Clippy's configuration file `$DIR/clippy.toml`: unknown field `foobar`, expected one of `avoid-breaking-exported-api`, `msrv`, `blacklisted-names`, `cognitive-complexity-threshold`, `cyclomatic-complexity-threshold`, `doc-valid-idents`, `too-many-arguments-threshold`, `type-complexity-threshold`, `single-char-binding-names-threshold`, `too-large-for-stack`, `enum-variant-name-threshold`, `enum-variant-size-threshold`, `verbose-bit-mask-threshold`, `literal-representation-threshold`, `trivial-copy-size-limit`, `pass-by-value-size-limit`, `too-many-lines-threshold`, `array-size-threshold`, `vec-box-size-threshold`, `max-trait-bounds`, `max-struct-bools`, `max-fn-params-bools`, `warn-on-all-wildcard-imports`, `disallowed-methods`, `disallowed-types`, `unreadable-literal-lint-fractions`, `upper-case-acronyms-aggressive`, `cargo-ignore-publish`, `standard-macro-braces`, `enforced-import-renames`, `allowed-scripts`, `max-suggested-slice-pattern-length`, `third-party` at line 5 column 1
 
 error: aborting due to previous error
 
diff --git a/...lice_indexing/if_let_slice_destruction.rs → ...x_refutable_slice/if_let_slice_binding.rs b/...lice_indexing/if_let_slice_destruction.rs → ...x_refutable_slice/if_let_slice_binding.rs
@@ -1,4 +1,4 @@
-#![deny(clippy::avoidable_slice_indexing)]
+#![deny(clippy::index_refutable_slice)]
 
 enum SomeEnum<T> {
     One(T),

diff --git a/..._indexing/if_let_slice_destruction.stderr → ...futable_slice/if_let_slice_binding.stderr b/..._indexing/if_let_slice_destruction.stderr → ...futable_slice/if_let_slice_binding.stderr
@@ -1,14 +1,14 @@
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:13:17
+  --> $DIR/if_let_slice_binding.rs:13:17
    |
 LL |     if let Some(slice) = slice {
    |                 ^^^^^
    |
 note: the lint level is defined here
-  --> $DIR/if_let_slice_destruction.rs:1:9
+  --> $DIR/if_let_slice_binding.rs:1:9
    |
-LL | #![deny(clippy::avoidable_slice_indexing)]
-   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+LL | #![deny(clippy::index_refutable_slice)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 help: try using a slice pattern here
    |
 LL |     if let Some([slice_0, ..]) = slice {
@@ -19,7 +19,7 @@ LL |         println!("{}", slice_0);
    |                        ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:19:17
+  --> $DIR/if_let_slice_binding.rs:19:17
    |
 LL |     if let Some(slice) = slice {
    |                 ^^^^^
@@ -34,7 +34,7 @@ LL |         println!("{}", slice_0);
    |                        ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:25:17
+  --> $DIR/if_let_slice_binding.rs:25:17
    |
 LL |     if let Some(slice) = slice {
    |                 ^^^^^
@@ -50,7 +50,7 @@ LL ~         println!("{}", slice_0);
    |
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:32:26
+  --> $DIR/if_let_slice_binding.rs:32:26
    |
 LL |     if let SomeEnum::One(slice) | SomeEnum::Three(slice) = slice_wrapped {
    |                          ^^^^^
@@ -65,7 +65,7 @@ LL |         println!("{}", slice_0);
    |                        ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:39:29
+  --> $DIR/if_let_slice_binding.rs:39:29
    |
 LL |     if let (SomeEnum::Three(a), Some(b)) = (a_wrapped, b_wrapped) {
    |                             ^
@@ -80,7 +80,7 @@ LL |         println!("{} -> {}", a_2, b[1]);
    |                              ~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:39:38
+  --> $DIR/if_let_slice_binding.rs:39:38
    |
 LL |     if let (SomeEnum::Three(a), Some(b)) = (a_wrapped, b_wrapped) {
    |                                      ^
@@ -95,7 +95,7 @@ LL |         println!("{} -> {}", a[2], b_1);
    |                                    ~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:46:21
+  --> $DIR/if_let_slice_binding.rs:46:21
    |
 LL |     if let Some(ref slice) = slice {
    |                     ^^^^^
@@ -110,7 +110,7 @@ LL |         println!("{:?}", slice_1);
    |                          ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:54:17
+  --> $DIR/if_let_slice_binding.rs:54:17
    |
 LL |     if let Some(slice) = &slice {
    |                 ^^^^^
@@ -125,7 +125,7 @@ LL |         println!("{:?}", slice_0);
    |                          ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:123:17
+  --> $DIR/if_let_slice_binding.rs:123:17
    |
 LL |     if let Some(slice) = wrap.inner {
    |                 ^^^^^
@@ -140,7 +140,7 @@ LL |             println!("This is awesome! {}", slice_0);
    |                                             ~~~~~~~
 
 error: this binding can be a slice pattern to avoid indexing
-  --> $DIR/if_let_slice_destruction.rs:130:17
+  --> $DIR/if_let_slice_binding.rs:130:17
    |
 LL |     if let Some(slice) = wrap.inner {
    |                 ^^^^^

diff --git a/...slice_indexing/slice_indexing_in_macro.rs → ...efutable_slice/slice_indexing_in_macro.rs b/...slice_indexing/slice_indexing_in_macro.rs → ...efutable_slice/slice_indexing_in_macro.rs
@@ -1,4 +1,4 @@
-#![deny(clippy::avoidable_slice_indexing)]
+#![deny(clippy::index_refutable_slice)]
 
 extern crate if_chain;
 use if_chain::if_chain;

diff --git a/...e_indexing/slice_indexing_in_macro.stderr → ...able_slice/slice_indexing_in_macro.stderr b/...e_indexing/slice_indexing_in_macro.stderr → ...able_slice/slice_indexing_in_macro.stderr
@@ -7,8 +7,8 @@ LL |         if let Some(slice) = slice;
 note: the lint level is defined here
   --> $DIR/slice_indexing_in_macro.rs:1:9
    |
-LL | #![deny(clippy::avoidable_slice_indexing)]
-   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+LL | #![deny(clippy::index_refutable_slice)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 help: try using a slice pattern here
    |
 LL |         if let Some([slice_0, ..]) = slice;