Move our paths over to diagnostic items #5393

Manishearth · 2020-03-30T18:02:34Z

Currently we have a ton of hardcoded paths for stdlib types.

Rustc has a way of tagging types for diagnostics via a "diagnostic item" API (rust-lang/rust#60966). We should go through rustc and tag most of these diagnostic items, and replace the hardcoded paths with hardcoded diagnostic item names instead. We can still keep the path framework around for rapid prototyping, but have a comment recommending people switch to diagnostic items whenever possible.

flip1995 · 2020-03-30T18:33:21Z

Marking it as tracking issue and pinning it, since this is probably done in multiple steps.

Make use of more diagnostic items This makes use of some (not all) already existing diagnostic items. Specifically: * 79982a2: `core::mem::uninitialized`, `core::mem::zeroed`, `alloc::sync::Arc`, `alloc::sync::Rc` * 83874d0: `Option` and `Result` cc #5393 changelog: none

@Manishearth

…nishearth More diagnostic items for Clippy usage This adds a couple of more diagnostic items to be used in Clippy. I chose these particular ones because they were the types which we seem to check for the most in Clippy. I'm not sure if the `cfg_attr(not(test))` is needed, but it was also used for `Vec` and a few other types. cc rust-lang/rust-clippy#5393 r? @Manishearth

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

…=matthiaskrgr Add derive_ord_xor_partial_ord lint Fix #1621 Some remarks: This PR follows the example of the analogous derive_hash_xor_partial_eq lint where possible. I initially tried using the `match_path` function to identify `Ord` implementation like the derive_hash_xor_partial_eq lint currently does, for `Hash` implementations but that didn't work. Specifically, the structs at the top level were getting paths that matched `&["$crate", "cmp", "Ord"]` instead of `&["std", "cmp", "Ord"]`. While trying to figure out what to do instead I saw the comment at the top of [clippy_lints/src/utils/paths.rs](https://github.com/rust-lang/rust-clippy/blob/f5d429cd762423901f946abd800dc2cd91366ccf/clippy_lints/src/utils/paths.rs#L5) that mentioned [this issue](#5393) and suggested to use diagnostic items instead of hardcoded paths whenever possible. I looked for a way to identify `Ord` implementations with diagnostic items, but (possibly because this was the first time I had heard of diagnostic items,) I was unable to find one. Eventually I tried using `get_trait_def_id` and comparing `DefId` values directly and that seems to work as expected. Maybe there's a better approach however? changelog: new lint: derive_ord_xor_partial_ord

…ord-lint, r=matthiaskrgr Add derive_ord_xor_partial_ord lint Fix rust-lang#1621 Some remarks: This PR follows the example of the analogous derive_hash_xor_partial_eq lint where possible. I initially tried using the `match_path` function to identify `Ord` implementation like the derive_hash_xor_partial_eq lint currently does, for `Hash` implementations but that didn't work. Specifically, the structs at the top level were getting paths that matched `&["$crate", "cmp", "Ord"]` instead of `&["std", "cmp", "Ord"]`. While trying to figure out what to do instead I saw the comment at the top of [clippy_lints/src/utils/paths.rs](https://github.com/rust-lang/rust-clippy/blob/f5d429cd762423901f946abd800dc2cd91366ccf/clippy_lints/src/utils/paths.rs#L5) that mentioned [this issue](rust-lang#5393) and suggested to use diagnostic items instead of hardcoded paths whenever possible. I looked for a way to identify `Ord` implementations with diagnostic items, but (possibly because this was the first time I had heard of diagnostic items,) I was unable to find one. Eventually I tried using `get_trait_def_id` and comparing `DefId` values directly and that seems to work as expected. Maybe there's a better approach however? changelog: new lint: derive_ord_xor_partial_ord

tesuji · 2020-09-15T10:19:26Z

Could we use lang_items if possible ?

For example: begin_panic has lang_items but no diagnostic item.
https://github.com/rust-lang/rust/blob/c1589cc819ba7cf289c3ccbab30c215f0a6ba7d7/library/std/src/panicking.rs#L491-L499

flip1995 · 2020-09-15T11:57:03Z

If there is a LangItem we should use it. But this issue is rather about adding #[rustc_diagnostic_item(..)] in rustc and then use it in Clippy. We can do this easier now that Clippy is a subtree in rustc.

migrate paths to newly-added diagnostic items This gets rid of the following paths: * OS_STRING * TO_OWNED * TO_STRING Removes some usages of: * PATH_BUF Per #5393 also removes unneeded `is_ty_param_path` from `clippy_lints::types` and relocates `is_ty_param_lang_item` and `is_ty_param_diagnostic_item` to `clippy_utils`. changelog: none

Related to: rust-lang#5393

xFrednet · 2021-07-14T22:27:39Z

Heyho, #7466 updates Clippy to use diagnostic items where currently possible. There are still a bunch of paths which don't have a corresponding diagnostic item yet. (See: paths.rs after the update).

I would be happy to go through rustc and add the missing diagnostic items. Is this still wanted as stated in the lint description? And is there any documentation regarding the diagnostic items? The compiler currently has a mixture of naming conventions, and it sometimes uses #[cfg_attr(not(test), rustc_diagnostic_item = "...")] instead of rustc_diagnostic_item which got me a little confused. Any guidance would be greatly appreciated 🙃

Manishearth · 2021-07-14T22:30:48Z

@xFrednet yes, please add them. I don't remember why the compiler does that though, perhaps ask on one of the compiler zulip channels

…-items, r=Manishearth,oli-obk Add diagnostic items for Clippy This adds a bunch of diagnostic items to `std`/`core`/`alloc` functions, structs and traits used in Clippy. The actual refactorings in Clippy to use these items will be done in a different PR in Clippy after the next sync. This PR doesn't include all paths Clippy uses, I've only gone through the first 85 lines of Clippy's [`paths.rs`](https://github.com/rust-lang/rust-clippy/blob/ecf85f4bdc319f9d9d853d1fff68a8a25e64c7a8/clippy_utils/src/paths.rs) (after rust-lang/rust-clippy#7466) to get some feedback early on. I've also decided against adding diagnostic items to methods, as it would be nicer and more scalable to access them in a nicer fashion, like adding a `is_diagnostic_assoc_item(did, sym::Iterator, sym::map)` function or something similar (Suggested by `@camsteffen` [on Zulip](https://rust-lang.zulipchat.com/#narrow/stream/147480-t-compiler.2Fwg-diagnostics/topic/Diagnostic.20Item.20Naming.20Convention.3F/near/225024603)) There seems to be some different naming conventions when it comes to diagnostic items, some use UpperCamelCase (`BinaryHeap`) and some snake_case (`hashmap_type`). This PR uses UpperCamelCase for structs and traits and snake_case with the module name as a prefix for functions. Any feedback on is this welcome. cc: rust-lang/rust-clippy#5393 r? `@Manishearth`

…1995 Use diagnostic items where possible Clippy still uses a bunch of paths in places that could easily use already defined diagnostic items. This PR updates all references to such paths and also removes a bunch of them that are no longer needed after this cleanup. Some paths are also used to construct new paths and can therefore not be removed that easily. I've added a doc comment to those instances that recommends the use of the diagnostic item where possible. And that's it, cleaning crew signing off 🧹 🗑️ --- changelog: none (only internal improvements) cc: #5393

Replace a few paths with diagnostic items A fairly small change towards #5393 changelog: none

Replace some more paths with diagnostic items cc #5393 Replaces the macro & mem paths, and catches a couple others that were unused changelog: none

…=Manishearth,oli-obk Add diagnostic items for Clippy This adds a bunch of diagnostic items to `std`/`core`/`alloc` functions, structs and traits used in Clippy. The actual refactorings in Clippy to use these items will be done in a different PR in Clippy after the next sync. This PR doesn't include all paths Clippy uses, I've only gone through the first 85 lines of Clippy's [`paths.rs`](https://github.com/rust-lang/rust-clippy/blob/ecf85f4bdc319f9d9d853d1fff68a8a25e64c7a8/clippy_utils/src/paths.rs) (after rust-lang/rust-clippy#7466) to get some feedback early on. I've also decided against adding diagnostic items to methods, as it would be nicer and more scalable to access them in a nicer fashion, like adding a `is_diagnostic_assoc_item(did, sym::Iterator, sym::map)` function or something similar (Suggested by `@camsteffen` [on Zulip](https://rust-lang.zulipchat.com/#narrow/stream/147480-t-compiler.2Fwg-diagnostics/topic/Diagnostic.20Item.20Naming.20Convention.3F/near/225024603)) There seems to be some different naming conventions when it comes to diagnostic items, some use UpperCamelCase (`BinaryHeap`) and some snake_case (`hashmap_type`). This PR uses UpperCamelCase for structs and traits and snake_case with the module name as a prefix for functions. Any feedback on is this welcome. cc: rust-lang/rust-clippy#5393 r? `@Manishearth`

… r=compiler-errors Add diagnostic item for `std::iter::Enumerate` This adds a diagnostic item for `std::iter::Enumerate`. The change will be used by the clippy `unused_enumerate_index` lint to move away from type paths to using diagnostic items. see: rust-lang/rust-clippy#5393

Rollup merge of rust-lang#124308 - CBSpeir:diagnostic-item-enumerate, r=compiler-errors Add diagnostic item for `std::iter::Enumerate` This adds a diagnostic item for `std::iter::Enumerate`. The change will be used by the clippy `unused_enumerate_index` lint to move away from type paths to using diagnostic items. see: rust-lang/rust-clippy#5393

…er-errors Add diagnostic item for `std::iter::Enumerate` This adds a diagnostic item for `std::iter::Enumerate`. The change will be used by the clippy `unused_enumerate_index` lint to move away from type paths to using diagnostic items. see: rust-lang/rust-clippy#5393

…method, r=scottmcm Add diagnostic item for `std::iter::Iterator::enumerate` Adds a diagnostic item for the `std::iter:Iterator::enumerate` trait method. This change, along with PR rust-lang#124308, will be used by the clippy `unused_enumerate_index` lint to move away from paths to using diagnostic items. see: rust-lang/rust-clippy#5393

Rollup merge of rust-lang#124542 - CBSpeir:diagnostic-item-enumerate-method, r=scottmcm Add diagnostic item for `std::iter::Iterator::enumerate` Adds a diagnostic item for the `std::iter:Iterator::enumerate` trait method. This change, along with PR rust-lang#124308, will be used by the clippy `unused_enumerate_index` lint to move away from paths to using diagnostic items. see: rust-lang/rust-clippy#5393

Remove `dead_code` paths The following paths are `dead_code` and can be removed: ### `clippy_utils::paths::VEC_RESIZE` * Introduced when `vec_resize_to_zero` lint added in PR #5637 * No longer used after commit 8acc4d2 ### `clippy_utils::paths::SLICE_GET` * Introduced when `get_first` lint added in PR #8882 * No longer used after commit a8d80d5 ### `clippy_utils::paths::STR_BYTES` * Introduced when `bytes_count_to_len` lint added in PR #8711 * No longer used after commit ba6a459 When the lints were moved into the `Methods` lint pass, they switched from using paths to diagnostic items. However, the paths were never removed. This occurred in PR #8957. This relates to issue #5393 changelog: none

Manishearth added E-medium Call for participation: Medium difficulty level problem and requires some initial experience. C-an-interesting-project Category: Interesting projects, that usually are more involved design/code wise. labels Mar 30, 2020

flip1995 added the C-tracking-issue Category: Tracking Issue label Mar 30, 2020

flip1995 pinned this issue Mar 30, 2020

phansch mentioned this issue Apr 10, 2020

Make use of more diagnostic items #5449

Merged

phansch mentioned this issue Apr 22, 2020

More diagnostic items for Clippy usage rust-lang/rust#71414

Merged

phansch added a commit to phansch/rust-clippy that referenced this issue Apr 23, 2020

More diagnostic items

c3acaf3

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

phansch mentioned this issue Apr 23, 2020

Use more diagnostic items #5509

Merged

bors added a commit that referenced this issue Apr 23, 2020

Auto merge of #5509 - phansch:more-diagnostic-items2, r=matthiaskrgr

855395b

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

bors added a commit that referenced this issue Apr 23, 2020

Auto merge of #5509 - phansch:more-diagnostic-items2, r=matthiaskrgr

1b7ed5c

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

phansch added a commit to phansch/rust-clippy that referenced this issue Apr 26, 2020

More diagnostic items

0480ff8

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

bors added a commit that referenced this issue Apr 26, 2020

Auto merge of #5509 - phansch:more-diagnostic-items2, r=<try>

ae0576a

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

bors added a commit that referenced this issue Apr 26, 2020

Auto merge of #5509 - phansch:more-diagnostic-items2, r=<try>

90a9e88

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

bors added a commit that referenced this issue Apr 26, 2020

Auto merge of #5509 - phansch:more-diagnostic-items2, r=matthiaskrgr

5c12f2b

Use more diagnostic items In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 #5393 --- changelog: none

ThibsG pushed a commit to ThibsG/rust-clippy that referenced this issue May 2, 2020

More diagnostic items

69dad2d

In particular for: * `VecDeque` * `String` * `Mutex` * `HashMap` * `HashSet` cc rust-lang/rust#71414 rust-lang#5393

esamudera mentioned this issue Jun 9, 2020

New lint: suggest ptr::read instead of mem::replace(..., uninitialized()) #5695

Merged

Ryan1729 mentioned this issue Jul 27, 2020

Add derive_ord_xor_partial_ord lint #5848

Merged

boxdot mentioned this issue Nov 23, 2020

Add invalid null pointer usage lint. #6192

Closed

anall mentioned this issue Feb 27, 2021

migrate paths to newly-added diagnostic items #6807

Merged

Y-Nak mentioned this issue Mar 12, 2021

Use sym::Iterator instead of paths::ITERATOR #6891

Merged

mgacek8 added a commit to mgacek8/rust-clippy that referenced this issue May 7, 2021

needless_collect: replace paths with diag items

59ccc1e

Related to: rust-lang#5393

DevinR528 mentioned this issue Jun 13, 2021

Remove requirement of fully qualified path for disallowed_method/type #7345

Merged

xFrednet mentioned this issue Jul 14, 2021

Use diagnostic items where possible #7466

Merged

xFrednet mentioned this issue Jul 15, 2021

Add diagnostic items for Clippy rust-lang/rust#87170

Merged

xFrednet mentioned this issue Aug 11, 2021

Document how/when to use diagnostic items rust-lang/rustc-dev-guide#1188

Closed

xFrednet mentioned this issue Aug 26, 2021

Documenting diagnostic items with their usage and naming conventions rust-lang/rustc-dev-guide#1192

Merged

camsteffen mentioned this issue Oct 7, 2021

Replace match_def_path and friends with is_item #7647

Closed

Alexendoo mentioned this issue Feb 12, 2022

Replace a few paths with diagnostic items #8421

Merged

bors added a commit that referenced this issue Feb 12, 2022

Auto merge of #8421 - Alexendoo:paths, r=llogiq

c37d6ee

Replace a few paths with diagnostic items A fairly small change towards #5393 changelog: none

Alexendoo mentioned this issue Feb 25, 2022

Replace some more paths with diagnostic items #8474

Merged

bors added a commit that referenced this issue Feb 25, 2022

Auto merge of #8474 - Alexendoo:paths, r=Manishearth

4417f78

Replace some more paths with diagnostic items cc #5393 Replaces the macro & mem paths, and catches a couple others that were unused changelog: none

xFrednet mentioned this issue Jan 14, 2023

Get the ItemId based on a given ast-path rust-marker/marker#93

Closed

CBSpeir mentioned this issue Apr 23, 2024

Add diagnostic item for std::iter::Enumerate rust-lang/rust#124308

Merged

This was referenced Apr 29, 2024

Add diagnostic item for std::iter::Iterator::enumerate rust-lang/rust#124542

Merged

Remove dead_code paths #12743

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move our paths over to diagnostic items #5393

Move our paths over to diagnostic items #5393

Manishearth commented Mar 30, 2020

flip1995 commented Mar 30, 2020

tesuji commented Sep 15, 2020 •

edited

flip1995 commented Sep 15, 2020

xFrednet commented Jul 14, 2021

Manishearth commented Jul 14, 2021

Move our paths over to diagnostic items #5393

Move our paths over to diagnostic items #5393

Comments

Manishearth commented Mar 30, 2020

flip1995 commented Mar 30, 2020

tesuji commented Sep 15, 2020 • edited

flip1995 commented Sep 15, 2020

xFrednet commented Jul 14, 2021

Manishearth commented Jul 14, 2021

tesuji commented Sep 15, 2020 •

edited