Setup a clippy configuration file

This requires including the Minimum Supported Rust Version (MSRV). Additionally, document in Cargo.toml the different places where the MSRV needs to be kept in sync.
slog-rs · Sep 6, 2023 · 1e34879 · 1e34879
1 parent f45958a
commit 1e34879
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -25,6 +25,11 @@ edition = "2018"
 #
 # The first version of Cargo that supports this field was in Rust 1.56.0.
 # In older releases, the field will be ignored, and Cargo will display a warning.
+#
+# This must be kept in sync with the following places:
+# - .github/workflows/test.yml (Github Actions)
+# - README.md
+# - clippy.toml (Clippy config)
 rust-version = "1.49.0"
 
 [profile.release]

diff --git a/clippy.toml b/clippy.toml
@@ -0,0 +1,6 @@
+msrv = "1.49.0"
+# TODO: Consider adding this?
+#
+# I would much prefer supressing lints that break
+# API compatibility on a case-by-case basis.
+# avoid-breaking-exported-api = true