rename conf option to allowed_wildcard_imports

This commit is contained in:
J-ZhengLi 2024-02-02 09:22:42 +08:00
parent 314bddee95
commit 46dd8263a0
8 changed files with 41 additions and 17 deletions

View File

@ -5823,4 +5823,5 @@ Released 2018-09-13
[`check-private-items`]: https://doc.rust-lang.org/clippy/lint_configuration.html#check-private-items [`check-private-items`]: https://doc.rust-lang.org/clippy/lint_configuration.html#check-private-items
[`pub-underscore-fields-behavior`]: https://doc.rust-lang.org/clippy/lint_configuration.html#pub-underscore-fields-behavior [`pub-underscore-fields-behavior`]: https://doc.rust-lang.org/clippy/lint_configuration.html#pub-underscore-fields-behavior
[`allow-comparison-to-zero`]: https://doc.rust-lang.org/clippy/lint_configuration.html#allow-comparison-to-zero [`allow-comparison-to-zero`]: https://doc.rust-lang.org/clippy/lint_configuration.html#allow-comparison-to-zero
[`allowed-wildcard-imports`]: https://doc.rust-lang.org/clippy/lint_configuration.html#allowed-wildcard-imports
<!-- end autogenerated links to configuration documentation --> <!-- end autogenerated links to configuration documentation -->

View File

@ -838,3 +838,25 @@ Don't lint when comparing the result of a modulo operation to zero.
* [`modulo_arithmetic`](https://rust-lang.github.io/rust-clippy/master/index.html#modulo_arithmetic) * [`modulo_arithmetic`](https://rust-lang.github.io/rust-clippy/master/index.html#modulo_arithmetic)
## `allowed-wildcard-imports`
List of path segments allowed to have wildcard imports.
#### Example
```toml
allowed-wildcard-imports = [ "utils", "common" ]
```
#### Noteworthy
1. This configuration has no effects if used with `warn_on_all_wildcard_imports = true`.
2. Paths with any segment that containing the word 'prelude'
are already allowed by default.
**Default Value:** `[]`
---
**Affected lints:**
* [`wildcard_imports`](https://rust-lang.github.io/rust-clippy/master/index.html#wildcard_imports)

View File

@ -573,20 +573,20 @@ pub fn get_configuration_metadata() -> Vec<ClippyConfiguration> {
(allow_comparison_to_zero: bool = true), (allow_comparison_to_zero: bool = true),
/// Lint: WILDCARD_IMPORTS. /// Lint: WILDCARD_IMPORTS.
/// ///
/// List of path segments to ignore when checking wildcard imports. /// List of path segments allowed to have wildcard imports.
/// ///
/// #### Example /// #### Example
/// ///
/// ```toml /// ```toml
/// ignored-wildcard-imports = [ "utils", "common" ] /// allowed-wildcard-imports = [ "utils", "common" ]
/// ``` /// ```
/// ///
/// #### Noteworthy /// #### Noteworthy
/// ///
/// 1. This configuration has no effects if used with `warn_on_all_wildcard_imports = true`. /// 1. This configuration has no effects if used with `warn_on_all_wildcard_imports = true`.
/// 2. Paths with any segment that containing the word 'prelude' /// 2. Paths with any segment that containing the word 'prelude'
/// are already ignored by default. /// are already allowed by default.
(ignored_wildcard_imports: FxHashSet<String> = FxHashSet::default()), (allowed_wildcard_imports: FxHashSet<String> = FxHashSet::default()),
} }
/// Search for the configuration file. /// Search for the configuration file.

View File

@ -524,6 +524,7 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
ref allowed_dotfiles, ref allowed_dotfiles,
ref allowed_idents_below_min_chars, ref allowed_idents_below_min_chars,
ref allowed_scripts, ref allowed_scripts,
ref allowed_wildcard_imports,
ref arithmetic_side_effects_allowed_binary, ref arithmetic_side_effects_allowed_binary,
ref arithmetic_side_effects_allowed_unary, ref arithmetic_side_effects_allowed_unary,
ref arithmetic_side_effects_allowed, ref arithmetic_side_effects_allowed,
@ -545,7 +546,6 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
excessive_nesting_threshold, excessive_nesting_threshold,
future_size_threshold, future_size_threshold,
ref ignore_interior_mutability, ref ignore_interior_mutability,
ref ignored_wildcard_imports,
large_error_threshold, large_error_threshold,
literal_representation_threshold, literal_representation_threshold,
matches_for_let_else, matches_for_let_else,
@ -880,7 +880,7 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
store.register_late_pass(move |_| { store.register_late_pass(move |_| {
Box::new(wildcard_imports::WildcardImports::new( Box::new(wildcard_imports::WildcardImports::new(
warn_on_all_wildcard_imports, warn_on_all_wildcard_imports,
ignored_wildcard_imports.clone(), allowed_wildcard_imports.clone(),
)) ))
}); });
store.register_late_pass(|_| Box::<redundant_pub_crate::RedundantPubCrate>::default()); store.register_late_pass(|_| Box::<redundant_pub_crate::RedundantPubCrate>::default());

View File

@ -101,15 +101,15 @@
pub struct WildcardImports { pub struct WildcardImports {
warn_on_all: bool, warn_on_all: bool,
test_modules_deep: u32, test_modules_deep: u32,
ignored_segments: FxHashSet<String>, allowed_segments: FxHashSet<String>,
} }
impl WildcardImports { impl WildcardImports {
pub fn new(warn_on_all: bool, ignored_wildcard_imports: FxHashSet<String>) -> Self { pub fn new(warn_on_all: bool, allowed_wildcard_imports: FxHashSet<String>) -> Self {
Self { Self {
warn_on_all, warn_on_all,
test_modules_deep: 0, test_modules_deep: 0,
ignored_segments: ignored_wildcard_imports, allowed_segments: allowed_wildcard_imports,
} }
} }
} }
@ -193,7 +193,7 @@ fn check_exceptions(&self, item: &Item<'_>, segments: &[PathSegment<'_>]) -> boo
item.span.from_expansion() item.span.from_expansion()
|| is_prelude_import(segments) || is_prelude_import(segments)
|| (is_super_only_import(segments) && self.test_modules_deep > 0) || (is_super_only_import(segments) && self.test_modules_deep > 0)
|| is_ignored_via_config(segments, &self.ignored_segments) || is_allowed_via_config(segments, &self.allowed_segments)
} }
} }
@ -211,9 +211,9 @@ fn is_super_only_import(segments: &[PathSegment<'_>]) -> bool {
} }
// Allow skipping imports containing user configured segments, // Allow skipping imports containing user configured segments,
// i.e. "...::utils::...::*" if user put `ignored-wildcard-imports = ["utils"]` in `Clippy.toml` // i.e. "...::utils::...::*" if user put `allowed-wildcard-imports = ["utils"]` in `Clippy.toml`
fn is_ignored_via_config(segments: &[PathSegment<'_>], ignored_segments: &FxHashSet<String>) -> bool { fn is_allowed_via_config(segments: &[PathSegment<'_>], allowed_segments: &FxHashSet<String>) -> bool {
// segment matching need to be exact instead of using 'contains', in case user unintentionaly put // segment matching need to be exact instead of using 'contains', in case user unintentionaly put
// a single character in the config thus skipping most of the warnings. // a single character in the config thus skipping most of the warnings.
segments.iter().any(|seg| ignored_segments.contains(seg.ident.as_str())) segments.iter().any(|seg| allowed_segments.contains(seg.ident.as_str()))
} }

View File

@ -15,6 +15,7 @@ error: error reading Clippy's configuration file: unknown field `foobar`, expect
allowed-duplicate-crates allowed-duplicate-crates
allowed-idents-below-min-chars allowed-idents-below-min-chars
allowed-scripts allowed-scripts
allowed-wildcard-imports
arithmetic-side-effects-allowed arithmetic-side-effects-allowed
arithmetic-side-effects-allowed-binary arithmetic-side-effects-allowed-binary
arithmetic-side-effects-allowed-unary arithmetic-side-effects-allowed-unary
@ -39,7 +40,6 @@ error: error reading Clippy's configuration file: unknown field `foobar`, expect
excessive-nesting-threshold excessive-nesting-threshold
future-size-threshold future-size-threshold
ignore-interior-mutability ignore-interior-mutability
ignored-wildcard-imports
large-error-threshold large-error-threshold
literal-representation-threshold literal-representation-threshold
matches-for-let-else matches-for-let-else
@ -94,6 +94,7 @@ error: error reading Clippy's configuration file: unknown field `barfoo`, expect
allowed-duplicate-crates allowed-duplicate-crates
allowed-idents-below-min-chars allowed-idents-below-min-chars
allowed-scripts allowed-scripts
allowed-wildcard-imports
arithmetic-side-effects-allowed arithmetic-side-effects-allowed
arithmetic-side-effects-allowed-binary arithmetic-side-effects-allowed-binary
arithmetic-side-effects-allowed-unary arithmetic-side-effects-allowed-unary
@ -118,7 +119,6 @@ error: error reading Clippy's configuration file: unknown field `barfoo`, expect
excessive-nesting-threshold excessive-nesting-threshold
future-size-threshold future-size-threshold
ignore-interior-mutability ignore-interior-mutability
ignored-wildcard-imports
large-error-threshold large-error-threshold
literal-representation-threshold literal-representation-threshold
matches-for-let-else matches-for-let-else
@ -173,6 +173,7 @@ error: error reading Clippy's configuration file: unknown field `allow_mixed_uni
allowed-duplicate-crates allowed-duplicate-crates
allowed-idents-below-min-chars allowed-idents-below-min-chars
allowed-scripts allowed-scripts
allowed-wildcard-imports
arithmetic-side-effects-allowed arithmetic-side-effects-allowed
arithmetic-side-effects-allowed-binary arithmetic-side-effects-allowed-binary
arithmetic-side-effects-allowed-unary arithmetic-side-effects-allowed-unary

View File

@ -1,4 +1,4 @@
warn-on-all-wildcard-imports = true warn-on-all-wildcard-imports = true
# This should be ignored since `warn-on-all-wildcard-imports` has higher precedence # This should be ignored since `warn-on-all-wildcard-imports` has higher precedence
ignored-wildcard-imports = ["utils"] allowed-wildcard-imports = ["utils"]

View File

@ -1 +1 @@
ignored-wildcard-imports = ["utils"] allowed-wildcard-imports = ["utils"]