Better linting

jwodder · Oct 30, 2023 · 3889422 · 3889422
1 parent 91d93cb
commit 3889422
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+v0.2.0 (in development)
+-----------------------
+
+v0.1.0 (2023-10-30)
+-------------------
+Initial release
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cfgfifo"
-version = "0.1.0"
+version = "0.2.0-dev"
 edition = "2021"
 rust-version = "1.67"
 description = "(De)serialize common configuration file formats based on file extension"

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.67-orange)](https://www.rust-lang.org)
 [![MIT License](https://img.shields.io/github/license/jwodder/cfgfifo.svg)](https://opensource.org/licenses/MIT)
 
-[GitHub](https://github.com/jwodder/cfgfifo) | [crates.io](https://crates.io/crates/cfgfifo) | [Documentation](https://docs.rs/cfgfifo) | [Issues](https://github.com/jwodder/cfgfifo/issues)
+[GitHub](https://github.com/jwodder/cfgfifo) | [crates.io](https://crates.io/crates/cfgfifo) | [Documentation](https://docs.rs/cfgfifo) | [Issues](https://github.com/jwodder/cfgfifo/issues) | [Changelog](https://github.com/jwodder/cfgfifo/blob/master/CHANGELOG.md)
 
 `cfgfifo` is a Rust library for serializing & deserializing various common
 configuration file formats ([JSON][], [JSON5][], [RON][], [TOML][], and

diff --git a/src/lib.rs b/src/lib.rs
@@ -100,7 +100,7 @@
 //! ```
 
 use serde::{de::DeserializeOwned, Serialize};
-#[allow(unused)]
+#[allow(unused_imports)]
 use serde_path_to_error::{deserialize as depath, serialize as serpath, Error as PathError};
 use std::fs::File;
 use std::io;
@@ -307,7 +307,7 @@ impl Format {
     /// # Errors
     ///
     /// Returns an error if the underlying serializer returns an error.
-    #[allow(unused)]
+    #[allow(unused_variables)]
     pub fn dump_to_string<T: Serialize>(&self, value: &T) -> Result<String, SerializeError> {
         match self {
             #[cfg(feature = "json")]
@@ -319,8 +319,7 @@ impl Format {
             }
             #[cfg(feature = "json5")]
             Format::Json5 => {
-                /// json5::to_string() just serializes as JSON, but
-                /// non-prettily.
+                // json5::to_string() just serializes as JSON, but non-prettily
                 let mut buffer = Vec::new();
                 let mut ser = serde_json::Serializer::pretty(&mut buffer);
                 serpath(value, &mut ser)?;
@@ -347,6 +346,7 @@ impl Format {
                 self.dump_to_writer(&mut buffer, value)?;
                 Ok(String::from_utf8(buffer).expect("serialized YAML should be valid UTF-8"))
             }
+            #[allow(unreachable_patterns)]
             _ => unreachable!(),
         }
     }
@@ -387,7 +387,7 @@ impl Format {
     /// # Errors
     ///
     /// Returns an error if the underlying deserializer returns an error.
-    #[allow(unused)]
+    #[allow(unused_variables)]
     pub fn load_from_str<T: DeserializeOwned>(&self, s: &str) -> Result<T, DeserializeError> {
         match self {
             #[cfg(feature = "json")]
@@ -429,6 +429,7 @@ impl Format {
                 let de = serde_yaml::Deserializer::from_str(s);
                 depath(de).map_err(Into::into)
             }
+            #[allow(unreachable_patterns)]
             _ => unreachable!(),
         }
     }
@@ -443,7 +444,7 @@ impl Format {
     ///
     /// Returns an error if an I/O error occurs or if the underlying serializer
     /// returns an error.
-    #[allow(unused)]
+    #[allow(unused_mut, unused_variables)]
     pub fn dump_to_writer<W: io::Write, T: Serialize>(
         &self,
         mut writer: W,
@@ -485,6 +486,7 @@ impl Format {
                 let mut ser = serde_yaml::Serializer::new(writer);
                 serpath(value, &mut ser).map_err(Into::into)
             }
+            #[allow(unreachable_patterns)]
             _ => unreachable!(),
         }
     }
@@ -495,10 +497,10 @@ impl Format {
     ///
     /// Returns an error if an I/O error occurs or if the underlying
     /// deserializer returns an error.
-    #[allow(unused)]
+    #[allow(unused_variables)]
     pub fn load_from_reader<R: io::Read, T: DeserializeOwned>(
         &self,
-        mut reader: R,
+        reader: R,
     ) -> Result<T, DeserializeError> {
         match self {
             #[cfg(feature = "json")]
@@ -528,6 +530,7 @@ impl Format {
                 let de = serde_yaml::Deserializer::from_reader(reader);
                 depath(de).map_err(Into::into)
             }
+            #[allow(unreachable_patterns)]
             _ => unreachable!(),
         }
     }

diff --git a/tests/deser.rs b/tests/deser.rs
@@ -134,7 +134,7 @@ struct RonConfig {
 }
 
 impl RonConfig {
-    #[allow(unused)]
+    #[allow(dead_code)]
     fn get() -> RonConfig {
         RonConfig {
             primitives: Primitives::get(),
@@ -152,7 +152,7 @@ struct RonEnums {
 }
 
 impl RonEnums {
-    #[allow(unused)]
+    #[allow(dead_code)]
     fn get() -> RonEnums {
         RonEnums {
             color: Color::Green,