Lint 配置选项

以下列表显示了每个配置选项，以及描述、默认值、示例和受影响的 lint。

`absolute-paths-allowed-crates`

允许从中获取绝对路径的 crate

默认值： []

受影响的 lint

absolute_paths

`absolute-paths-max-segments`

路径在被 lint 之前的最大段数，任何高于此值的路径都将被 lint。

默认值： 2

受影响的 lint

absolute_paths

`accept-comment-above-attributes`

是否接受放置在 unsafe 块的属性之上的安全注释

默认值： true

受影响的 lint

undocumented_unsafe_blocks

`accept-comment-above-statement`

是否接受放置在包含 unsafe 块的语句之上的安全注释

默认值： true

受影响的 lint

undocumented_unsafe_blocks

`allow-comparison-to-zero`

当比较模运算的结果是否为零时，不进行 lint。

默认值： true

受影响的 lint

modulo_arithmetic

`allow-dbg-in-tests`

是否允许在测试函数或 #[cfg(test)] 中使用 dbg!

默认值： false

受影响的 lint

dbg_macro

`allow-expect-in-tests`

是否允许在测试函数或 #[cfg(test)] 中使用 expect

默认值： false

受影响的 lint

expect_used

`allow-mixed-uninlined-format-args`

是否允许混合的未内联格式化参数，例如 format!("{} {}", a, foo.bar)

默认值： true

受影响的 lint

uninlined_format_args

`allow-one-hash-in-raw-strings`

当可以使用 r"" 时，是否允许使用 r#""#

默认值： false

受影响的 lint

unnecessary_raw_string_hashes

`allow-panic-in-tests`

是否允许在测试函数或 #[cfg(test)] 中使用 panic

默认值： false

受影响的 lint

panic

`allow-print-in-tests`

是否允许在测试函数或 #[cfg(test)] 中使用打印宏 (例如 println!)

默认值： false

受影响的 lint

`allow-private-module-inception`

是否允许私有模块嵌套。

默认值： false

受影响的 lint

module_inception

`allow-renamed-params-for`

在检查重命名函数参数时要忽略的 trait 路径列表。

示例

allow-renamed-params-for = [ "std::convert::From" ]

值得注意

默认情况下，将忽略以下 trait：From、TryFrom、FromStr
".." 可以用作列表的一部分，以指示应将配置的值附加到 Clippy 的默认配置。默认情况下，任何配置都将替换默认值。

默认值： ["core::convert::From", "core::convert::TryFrom", "core::str::FromStr"]

受影响的 lint

renamed_function_params

`allow-unwrap-in-tests`

是否允许在测试函数或 #[cfg(test)] 中使用 unwrap

默认值： false

受影响的 lint

unwrap_used

`allow-useless-vec-in-tests`

useless_vec 是否应忽略测试函数或 #[cfg(test)]

默认值： false

受影响的 lint

useless_vec

`allowed-dotfiles`

要允许的其他点文件（以点开头的文件或目录）

默认值： []

受影响的 lint

path_ends_with_ext

`allowed-duplicate-crates`

允许重复的 crate 名称列表

默认值： []

受影响的 lint

multiple_crate_versions

`allowed-idents-below-min-chars`

允许的低于最小允许字符数的名称。值 ".." 可以用作列表的一部分，以指示应将配置的值附加到 Clippy 的默认配置。默认情况下，任何配置都将替换默认值。

默认值： ["i", "j", "x", "y", "z", "w", "n"]

受影响的 lint

min_ident_chars

`allowed-prefixes`

在确定项目的名称是否以模块的名称结尾时，允许使用的前缀列表。如果项目名称的其余部分是允许的前缀（例如，模块 foo 中的项目 ToFoo 或 to_foo），则不发出警告。

示例

allowed-prefixes = [ "to", "from" ]

值得注意

默认情况下，允许以下前缀：to、as、into、from、try_into 和 try_from
每个 snake_case 变体都会自动包含 PascalCase 变体（例如，如果包含 try_into，则也会包含 TryInto）
使用 ".." 作为列表的一部分，以指示应将配置的值附加到 Clippy 的默认配置。默认情况下，任何配置都将替换默认值

默认值： ["to", "as", "into", "from", "try_into", "try_from"]

受影响的 lint

module_name_repetitions

`allowed-scripts`

允许在作用域中使用的 Unicode 脚本列表。

默认值： ["Latin"]

受影响的 lint

disallowed_script_idents

`allowed-wildcard-imports`

允许具有通配符导入的路径段列表。

示例

allowed-wildcard-imports = [ "utils", "common" ]

值得注意

如果与 warn_on_all_wildcard_imports = true 一起使用，此配置将不起作用。
默认情况下，已允许任何包含单词“prelude”的段的路径。

默认值： []

受影响的 lint

wildcard_imports

`arithmetic-side-effects-allowed`

禁止检查所有类型操作中传递的类型名称。

如果需要特定的操作，请考虑使用 arithmetic_side_effects_allowed_binary 或 arithmetic_side_effects_allowed_unary。

示例

arithmetic-side-effects-allowed = ["SomeType", "AnotherType"]

值得注意

在此配置中列出的类型（例如 SomeType）具有与 arithmetic_side_effects_allowed_binary 中的 ["SomeType" , "*"], ["*", "SomeType"] 相同的行为。

默认值： []

受影响的 lint

arithmetic_side_effects

`arithmetic-side-effects-allowed-binary`

禁止检查二进制操作（例如加法或乘法）中传递的类型对名称。

支持 "*" 通配符，以指示无论涉及的对应项如何，某个类型都不会触发 lint。例如，["SomeType", "*"] 或 ["*", "AnotherType"]。

对是不对称的，这意味着 ["SomeType", "AnotherType"] 与 ["AnotherType", "SomeType"] 不同。

示例

arithmetic-side-effects-allowed-binary = [["SomeType" , "f32"], ["AnotherType", "*"]]

默认值： []

受影响的 lint

arithmetic_side_effects

`arithmetic-side-effects-allowed-unary`

禁止检查一元操作（如“取反” (-)）中传递的类型名称。

示例

arithmetic-side-effects-allowed-unary = ["SomeType", "AnotherType"]

默认值： []

受影响的 lint

arithmetic_side_effects

`array-size-threshold`

堆栈上数组的最大允许大小

默认值： 16384

受影响的 lint

`avoid-breaking-exported-api`

每当建议的更改会导致其他 crate 发生中断时，禁止 lint。

默认值： true

受影响的 lint

`await-holding-invalid-types`

可能无法在 await 点之间保留的类型列表。

默认值： []

受影响的 lint

await_holding_invalid_type

`cargo-ignore-publish`

仅用于内部测试，忽略 Cargo 清单中的当前 publish 设置。

默认值： false

受影响的 lint

cargo_common_metadata

`check-private-items`

是否还在私有项目上运行列出的 lint。

默认值： false

受影响的 lint

`cognitive-complexity-threshold`

函数可以具有的最大认知复杂度

默认值： 25

受影响的 lint

cognitive_complexity

`disallowed-macros`

不允许使用的宏列表，以完全限定路径的形式写入。

默认值： []

受影响的 lint

disallowed_macros

`disallowed-methods`

不允许使用的方法列表，以完全限定路径的形式写入。

默认值： []

受影响的 lint

disallowed_methods

`disallowed-names`

要 lint 的不允许使用的名称列表。注意：bar 不在此处，因为它具有合法用途。值 ".." 可以用作列表的一部分，以指示应将配置的值附加到 Clippy 的默认配置。默认情况下，任何配置都将替换默认值。

默认值： ["foo", "baz", "quux"]

受影响的 lint

disallowed_names

`disallowed-types`

不允许使用的类型列表，以完全限定路径的形式写入。

默认值： []

受影响的 lint

disallowed_types

`doc-valid-idents`

此 lint 不应视为需要使用反引号的标识符的单词列表。值 ".." 可以用作列表的一部分，以指示应将配置的值附加到 Clippy 的默认配置。默认情况下，任何配置都将替换默认值。例如

doc-valid-idents = ["ClipPy"] 将使用 ["ClipPy"] 替换默认列表。
doc-valid-idents = ["ClipPy", ".."] 会将 ClipPy 附加到默认列表。

默认值： ["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "MHz", "GHz", "THz", "AccessKit", "CoAP", "CoreFoundation", "CoreGraphics", "CoreText", "DevOps", "Direct2D", "Direct3D", "DirectWrite", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenAL", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "OpenType", "WebGL", "WebGL2", "WebGPU", "WebRTC", "WebSocket", "WebTransport", "WebP", "OpenExr", "YCbCr", "sRGB", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "NetBSD", "OpenBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]

受影响的 lint

doc_markdown

`enable-raw-pointer-heuristic-for-send`

是否应用原始指针启发式方法来确定类型是否为 Send。

默认值： true

受影响的 lint

non_send_fields_in_send_ty

`enforce-iter-loop-reborrow`

是否建议对重新借用的值使用隐式 into iter。

示例

let mut vec = vec![1, 2, 3];
let rmvec = &mut vec;
for _ in rmvec.iter() {}
for _ in rmvec.iter_mut() {}

改用

let mut vec = vec![1, 2, 3];
let rmvec = &mut vec;
for _ in &*rmvec {}
for _ in &mut *rmvec {}

默认值： false

受影响的 lint

explicit_iter_loop

`enforced-import-renames`

要始终重命名的导入列表，一个完全限定的路径后跟重命名。

默认值： []

受影响的 lint

missing_enforced_import_renames

`enum-variant-name-threshold`

关于变量名称的 lint 触发的枚举变量的最小数量

默认值： 3

受影响的 lint

enum_variant_names

`enum-variant-size-threshold`

避免 box 建议的枚举变量的最大大小

默认值： 200

受影响的 lint

large_enum_variant

`excessive-nesting-threshold`

一个块可以驻留的最大嵌套量

默认值： 0

受影响的 lint

excessive_nesting

`future-size-threshold`

Future 可以拥有的最大字节大小，然后触发 clippy::large_futures lint

默认值： 16384

受影响的 lint

large_futures

`ignore-interior-mutability`

应被视为不包含内部可变性的类型路径列表

默认值： ["bytes::Bytes"]

受影响的 lint

`large-error-threshold`

从函数返回的 Result 中 Err 变体的最大大小

默认值： 128

受影响的 lint

result_large_err

`literal-representation-threshold`

lint 十进制文字的下限

默认值： 16384

受影响的 lint

decimal_literal_representation

`matches-for-let-else`

是否应将匹配项视为 lint，以及是否应过滤常用类型。

默认值： "WellKnownTypes"

受影响的 lint

manual_let_else

`max-fn-params-bools`

函数可以拥有的最大布尔参数数量

默认值： 3

受影响的 lint

fn_params_excessive_bools

`max-include-file-size`

通过 include_bytes!() 或 include_str!() 包含的文件的最大大小，以字节为单位

默认值： 1000000

受影响的 lint

large_include_file

`max-struct-bools`

一个结构体可以拥有的布尔字段的最大数量

默认值： 3

受影响的 lint

struct_excessive_bools

`max-suggested-slice-pattern-length`

当 Clippy 建议使用切片模式时，这是建议的切片模式中允许的最大元素数量。如果需要更多元素，则会抑制 lint。例如，[_, _, _, e, ..] 是一个包含 4 个元素的切片模式。

默认值： 3

受影响的 lint

index_refutable_slice

`max-trait-bounds`

一个 trait 可以拥有的最大边界数，超过此数量将会触发 lint

默认值： 3

受影响的 lint

type_repetition_in_bounds

`min-ident-chars-threshold`

标识符可以拥有的最小字符数，任何小于或等于此值的标识符都将被 lint。

默认值： 1

受影响的 lint

min_ident_chars

`missing-docs-in-crate-items`

是否仅检查当前 crate 中可见的项是否缺少文档。例如，pub(crate) 项。

默认值： false

受影响的 lint

missing_docs_in_private_items

`module-item-order-groupings`

模块中不同源项类型的命名分组。

默认值： [["modules", ["extern_crate", "mod", "foreign_mod"]], ["use", ["use"]], ["macros", ["macro"]], ["global_asm", ["global_asm"]], ["UPPER_SNAKE_CASE", ["static", "const"]], ["PascalCase", ["ty_alias", "enum", "struct", "union", "trait", "trait_alias", "impl"]], ["lower_snake_case", ["fn"]]]

受影响的 lint