clippy: dissallow some methods and types #1411
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teh-cmc
requested changes
Feb 26, 2023
teh-cmc
approved these changes
Feb 26, 2023
Wumpf
approved these changes
Feb 27, 2023
| disallowed-macros = [ | ||
| 'dbg', | ||
|
|
||
| # TODO(emilk): consider forbidding these to encourage the use of proper log stream, and then explicitly allow legitimate uses |
There was a problem hiding this comment.
what's keeping us from that so far? Too widespread direct use?
There was a problem hiding this comment.
Yeah - it is used in a lot of build scripts and tests. We can add clippy exceptions to those files but I didn't want to make this PR too big or controversial in one go
| "std::env::temp_dir", # Use the tempdir crate instead | ||
|
|
||
| # Disabled because of https://github.com/rust-lang/rust-clippy/issues/10406 | ||
| # "std::time::Instant::now", # use `instant` crate instead for wasm/web compatability |
There was a problem hiding this comment.
I hit this before and would be thankful for the clippy warning. Why can't we enable this warning yet?
There was a problem hiding this comment.
Because instant::Instant is an alias of std::time::Instant on native: rust-lang/rust-clippy#10406 (comment)
Comment on lines
+45
to
+46
| # Allow-list of words for markdown in dosctrings https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown | ||
| doc-valid-idents = [ |
emilk
added a commit
that referenced
this pull request
Mar 2, 2023
* Allow-list some words in our markdown docstrings * Forbid a bunch of macros, functions and types * name the threads * Do not ignore errors * Replace use of std::sync::Mutex with parking_lot::Mutex * Warn on failure to spawn analytics threads instead of panicing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
clippyhas a very powerful feature where you can forbid certain macros, methods and types.Please take a look at the list - perhaps there are more things you'd like to forbid?
Checklist