refactor: enable more clippy rules

Author: sapphi-red

.github/workflows/ci.yml

@@ -12,9 +12,8 @@ env:
   RUST_BACKTRACE: 1
 
 jobs:
-  # Code quality checks
-  quality:
-    name: Quality Checks
+  common-quality:
+    name: Common Quality Checks
     runs-on: ubuntu-latest
     steps:
       - uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
@@ -23,15 +22,8 @@ jobs:
         with:
           save-cache: ${{ github.ref_name == 'main' }}
           cache-key: warm
-          components: clippy rustfmt
           tools: typos-cli,cargo-deny,cargo-shear
 
-      - name: Check formatting
-        run: cargo fmt --all -- --check
-
-      - name: Clippy
-        run: cargo clippy --all-targets --all-features -- -D warnings
-
       - name: Check for typos
         run: typos
 
@@ -41,6 +33,30 @@ jobs:
       - name: Run cargo-shear
         run: cargo shear
 
+  # Code quality checks
+  quality:
+    name: Quality Checks ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+      - uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
+
+      - uses: oxc-project/setup-rust@cd82e1efec7fef815e2c23d296756f31c7cdc03d # v1.0.0
+        with:
+          save-cache: ${{ github.ref_name == 'main' }}
+          cache-key: warm
+          components: clippy rustfmt
+          tools: typos-cli,cargo-deny,cargo-shear
+
+      - name: Check formatting
+        run: cargo fmt -- --check
+
+      - name: Clippy
+        run: cargo clippy --workspace --all-targets --all-features -- -D warnings
+
   # Test on multiple platforms with different Rust versions
   test:
     name: Test ${{ matrix.os }} ${{ matrix.features != '' && format('({0})', matrix.features) || '' }}

Cargo.toml

@@ -18,6 +18,64 @@ homepage = "https://github.com/notify-rs/notify"
 repository = "https://github.com/notify-rs/notify.git"
 edition = "2024"
 
+[workspace.lints.clippy]
+# Guidelines
+# - We should only disable rules globally if they are either false positives, chaotic, or does not make sense.
+# - Group are enabled with priority -1, so we could easily override some specific rules.
+#   - https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-lints-section
+
+# --- restriction https://doc.rust-lang.org/clippy/usage.html#clippyrestriction
+allow_attributes = "deny"
+dbg_macro = "deny"
+print_stdout = "deny"
+
+# I like the explicitness of this rule as it removes confusion around `clone`.
+# This increases readability, avoids `clone` mindlessly and heap allocating on accident.
+clone_on_ref_ptr = "deny"
+empty_drop = "deny"
+exit = "deny"
+filetype_is_file = "deny"
+get_unwrap = "deny"
+rc_buffer = "deny"
+rc_mutex = "deny"
+rest_pat_in_fully_bound_structs = "deny"
+unnecessary_safety_comment = "deny"
+
+# --- pedantic #https://doc.rust-lang.org/clippy/usage.html#clippypedantic
+# To write the best rust code, pedantic group is enabled by default.
+pedantic = { level = "deny", priority = -1 }
+case_sensitive_file_extension_comparisons = "allow"
+
+# Though the following are nursery rules, they’re still useful.
+debug_assert_with_mut_call = "warn"
+iter_on_single_items = "warn"
+needless_pass_by_ref_mut = "warn"
+redundant_clone = "warn"
+redundant_pub_crate = "warn"
+significant_drop_in_scrutinee = "warn"
+unused_peekable = "warn"
+
+# Wizards, naming is too hard.
+module_inception = "allow"
+module_name_repetitions = "allow"
+similar_names = "allow"
+struct_field_names = "allow"
+# Forwarding `Result` is a common pattern, this rule is too pedantic.
+missing_errors_doc = "allow"
+doc_markdown = "allow"
+inline_always = "allow"
+wildcard_imports = "allow"
+redundant_closure_for_method_calls = "allow"
+items_after_statements = "allow"
+redundant-pub-crate = "allow"
+# Order doesn't really matter https://rust-lang.github.io/rust-clippy/master/index.html#/inconsistent_struct_constructor
+inconsistent_struct_constructor = "allow"
+# Single match is equally readable as if/else. https://rust-lang.github.io/rust-clippy/master/index.html#/single_match
+single_match = "allow"
+single_match_else = "allow"
+# Rewriting `unwrap_or` to `map_or` requires to annotate type explicitly which is cumbersome
+map_unwrap_or = "allow"
+
 [workspace.dependencies]
 bitflags = "2.7.0"
 crossbeam-channel = "0.5.0"

clippy.toml

@@ -5,6 +5,9 @@ publish = false
 edition = "2024"
 license = "MIT OR Apache-2.0"
 
+[lints]
+workspace = true
+
 [dev-dependencies]
 rolldown-notify = { workspace = true }
 rolldown-notify-debouncer-mini = { workspace = true }

examples/Cargo.toml

@@ -1,3 +1,5 @@
+#![allow(clippy::print_stdout)]
+
 use futures::{
     SinkExt, StreamExt,
     channel::mpsc::{Receiver, channel},
@@ -10,11 +12,11 @@ fn main() {
     let path = std::env::args()
         .nth(1)
         .expect("Argument 1 needs to be a path");
-    println!("watching {}", path);
+    println!("watching {path}");
 
     futures::executor::block_on(async {
         if let Err(e) = async_watch(path).await {
-            println!("error: {:?}", e)
+            println!("error: {e:?}");
         }
     });
 }
@@ -28,7 +30,7 @@ fn async_watcher() -> notify::Result<(RecommendedWatcher, Receiver<notify::Resul
         move |res| {
             futures::executor::block_on(async {
                 tx.send(res).await.unwrap();
-            })
+            });
         },
         Config::default(),
     )?;
@@ -45,8 +47,8 @@ async fn async_watch<P: AsRef<Path>>(path: P) -> notify::Result<()> {
 
     while let Some(res) = rx.next().await {
         match res {
-            Ok(event) => println!("changed: {:?}", event),
-            Err(e) => println!("watch error: {:?}", e),
+            Ok(event) => println!("changed: {event:?}"),
+            Err(e) => println!("watch error: {e:?}"),
         }
     }
 

examples/async_monitor.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::print_stdout)]
+
 use std::{fs, thread, time::Duration};
 
 use notify::WatchMode;

examples/debouncer_full.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::print_stdout)]
+
 use std::{path::Path, time::Duration};
 
 use notify::{self, WatchMode};

examples/debouncer_mini_custom.rs

@@ -1,3 +1,6 @@
+#![allow(clippy::print_stdout)]
+#![cfg_attr(target_os = "windows", expect(clippy::unnecessary_wraps))]
+
 /// Example for watching kernel internal filesystems like `/sys` and `/proc`
 /// These can't be watched by the default backend or unconfigured pollwatcher
 /// This example can't be demonstrated under windows, it might be relevant for network shares
@@ -17,16 +20,17 @@ fn not_windows_main() -> notify::Result<()> {
             eprintln!(
                 "Must provide path to watch, default system path was not found (probably you're not running on Linux?)"
             );
+            #[expect(clippy::exit)]
             std::process::exit(1);
         }
         println!(
-            "Trying {:?}, use `ping localhost` to see changes!",
-            lo_stats
+            "Trying {}, use `ping localhost` to see changes!",
+            lo_stats.display()
         );
         paths.push(lo_stats);
     }
 
-    println!("watching {:?}...", paths);
+    println!("watching {paths:?}...");
     // configure pollwatcher backend
     let config = Config::default()
         .with_compare_contents(true) // crucial part for pseudo filesystems
@@ -43,8 +47,8 @@ fn not_windows_main() -> notify::Result<()> {
     // print all events, never returns
     for res in rx {
         match res {
-            Ok(event) => println!("changed: {:?}", event),
-            Err(e) => println!("watch error: {:?}", e),
+            Ok(event) => println!("changed: {event:?}"),
+            Err(e) => println!("watch error: {e:?}"),
         }
     }
 

examples/poll_sysfs.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::print_stdout)]
+
 use notify::{Config, PollWatcher, WatchMode, Watcher};
 use std::path::Path;
 use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};
@@ -34,8 +36,8 @@ fn watch<P: AsRef<Path>>(path: P) -> notify::Result<()> {
     std::thread::spawn(move || {
         for res in rx {
             match res {
-                Ok(event) => println!("changed: {:?}", event),
-                Err(e) => println!("watch error: {:?}", e),
+                Ok(event) => println!("changed: {event:?}"),
+                Err(e) => println!("watch error: {e:?}"),
             }
         }
     });

examples/pollwatcher_manual.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::print_stdout)]
+
 use notify::{Config, PollWatcher, WatchMode, Watcher, poll::ScanEvent};
 use std::path::Path;
 use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};