Use workspace lint settings (#1224)

This change shifts from having common lints described at the top of each
crate's lib.rs to having them in a single top-level lints section of the
workspace Cargo.toml. This feature was new as of Rust 1.74, but we
hadn't switched to it ahead of the initial release.
Of note, a few crates were missing the top-level lints, so had lots of
fixup to do to get them up to the bar of the rest of code.

Author: swernli

Cargo.toml

@@ -65,6 +65,14 @@ quantum-sparse-sim = { git = "https://github.com/qir-alliance/qir-runner", rev =
 async-trait = "0.1"
 tokio = { version = "1.35", features = ["macros", "rt"] }
 
+[workspace.lints.clippy]
+mod_module_files = "warn"
+pedantic = "warn"
+unwrap_used = "warn"
+missing_errors_doc = "allow"
+missing_panics_doc = "allow"
+module_name_repetitions = "allow"
+
 [profile.release]
 debug = 1
 strip = true

compiler/qsc/Cargo.toml

@@ -34,6 +34,9 @@ criterion = { workspace = true, features = ["cargo_bench_support"] }
 expect-test = { workspace = true }
 indoc = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 bench = false
 doctest = false

compiler/qsc/benches/eval.rs

@@ -28,7 +28,7 @@ pub fn teleport(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -47,7 +47,7 @@ pub fn deutsch_jozsa(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -66,7 +66,7 @@ pub fn large_file(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -97,7 +97,7 @@ pub fn array_append(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -128,7 +128,7 @@ pub fn array_update(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -147,7 +147,7 @@ pub fn array_literal(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 
@@ -183,7 +183,7 @@ pub fn large_nested_iteration(c: &mut Criterion) {
             let mut out = Vec::new();
             let mut rec = GenericReceiver::new(&mut out);
             assert!(evaluator.eval_entry(&mut rec).is_ok());
-        })
+        });
     });
 }
 

compiler/qsc/benches/large.rs

@@ -24,7 +24,7 @@ pub fn large_file(c: &mut Criterion) {
                 LanguageFeatures::default(),
             );
             assert!(reports.is_empty());
-        })
+        });
     });
 }
 

compiler/qsc/benches/library.rs

@@ -8,7 +8,7 @@ use qsc_frontend::compile::{PackageStore, RuntimeCapabilityFlags};
 pub fn library(c: &mut Criterion) {
     let store = PackageStore::new(compile::core());
     c.bench_function("Standard library", |b| {
-        b.iter(|| compile::std(&store, RuntimeCapabilityFlags::all()))
+        b.iter(|| compile::std(&store, RuntimeCapabilityFlags::all()));
     });
 }
 

compiler/qsc/build.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 use std::process::Command;
 
 fn main() {

compiler/qsc/src/bin/memtest.rs

@@ -45,6 +45,7 @@ impl<A: GlobalAlloc> AllocationCounter<A> {
 #[global_allocator]
 static ALLOCATOR: AllocationCounter<System> = AllocationCounter::new(System);
 
+#[must_use]
 pub fn compile_stdlib() -> CompileUnit {
     let store = PackageStore::new(compile::core());
     compile::std(&store, RuntimeCapabilityFlags::all())

compiler/qsc/src/bin/qsc.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 use clap::{crate_version, ArgGroup, Parser, ValueEnum};
 use log::info;
 use miette::{Context, IntoDiagnostic, Report};

compiler/qsc/src/bin/qsi.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 use clap::{crate_version, Parser};
 use miette::{Context, IntoDiagnostic, Report, Result};
 use num_bigint::BigUint;

compiler/qsc/src/interpret.rs

@@ -113,7 +113,6 @@ pub struct Interpreter {
     env: Env,
 }
 
-#[allow(clippy::module_name_repetitions)]
 pub type InterpretResult = std::result::Result<Value, Vec<Error>>;
 
 impl Interpreter {

compiler/qsc/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 pub mod compile;
 pub mod error;
 pub mod incremental;

compiler/qsc_ast/Cargo.toml

@@ -14,5 +14,8 @@ miette = { workspace = true }
 num-bigint = { workspace = true }
 qsc_data_structures = { path = "../qsc_data_structures" }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_ast/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 pub mod assigner;
 pub mod ast;
 pub mod mut_visit;

compiler/qsc_codegen/Cargo.toml

@@ -23,5 +23,8 @@ expect-test = { workspace = true }
 indoc = { workspace = true }
 qsc_passes = { path = "../qsc_passes" }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_codegen/src/lib.rs

@@ -1,7 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 pub mod qir_base;

compiler/qsc_data_structures/Cargo.toml

@@ -16,5 +16,8 @@ bitflags = { workspace = true }
 [dev-dependencies]
 expect-test = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_data_structures/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 pub mod display;
 pub mod functors;
 pub mod index_map;

compiler/qsc_data_structures/src/span.rs

@@ -75,7 +75,6 @@ impl From<Span> for SourceSpan {
     }
 }
 
-#[allow(clippy::module_name_repetitions)]
 pub trait WithSpan {
     #[must_use]
     fn with_span(self, span: Span) -> Self;

compiler/qsc_doc_gen/Cargo.toml

@@ -18,5 +18,8 @@ qsc_ast = { path = "../qsc_ast" }
 qsc_hir = { path = "../qsc_hir" }
 rustc-hash = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_doc_gen/src/display.rs

@@ -56,17 +56,20 @@ pub struct CodeDisplay<'a> {
 
 #[allow(clippy::unused_self)]
 impl<'a> CodeDisplay<'a> {
+    #[must_use]
     pub fn hir_callable_decl(&self, decl: &'a hir::CallableDecl) -> impl Display + '_ {
         HirCallableDecl { decl }
     }
 
+    #[must_use]
     pub fn ast_callable_decl(&self, decl: &'a ast::CallableDecl) -> impl Display + '_ {
         AstCallableDecl {
             lookup: self.compilation,
             decl,
         }
     }
 
+    #[must_use]
     pub fn name_ty_id(&self, name: &'a str, ty_id: ast::NodeId) -> impl Display + '_ {
         NameTyId {
             lookup: self.compilation,
@@ -75,22 +78,27 @@ impl<'a> CodeDisplay<'a> {
         }
     }
 
+    #[must_use]
     pub fn ident_ty(&self, ident: &'a ast::Ident, ty: &'a ast::Ty) -> impl Display + '_ {
         IdentTy { ident, ty }
     }
 
+    #[must_use]
     pub fn ident_ty_def(&self, ident: &'a ast::Ident, def: &'a ast::TyDef) -> impl Display + 'a {
         IdentTyDef { ident, def }
     }
 
+    #[must_use]
     pub fn hir_udt(&self, udt: &'a ty::Udt) -> impl Display + '_ {
         HirUdt { udt }
     }
 
+    #[must_use]
     pub fn hir_pat(&self, pat: &'a hir::Pat) -> impl Display + '_ {
         HirPat { pat }
     }
 
+    #[must_use]
     pub fn get_param_offset(&self, decl: &hir::CallableDecl) -> u32 {
         HirCallableDecl { decl }.get_param_offset()
     }
@@ -601,13 +609,15 @@ fn eval_functor_expr(expr: &ast::FunctorExpr) -> ty::FunctorSetValue {
 
 /// Takes a doc string from Q# and increases all of the markdown header levels by one level.
 /// i.e. `# Summary` becomes `## Summary`
+#[must_use]
 pub fn increase_header_level(doc: &str) -> String {
     let re = Regex::new(r"(?mi)^(#+)( [\s\S]+?)$").expect("Invalid regex");
     re.replace_all(doc, "$1#$2").to_string()
 }
 
 /// Takes a doc string from Q# and returns the contents of the `# Summary` section. If no
 /// such section can be found, returns the original doc string.
+#[must_use]
 pub fn parse_doc_for_summary(doc: &str) -> String {
     let re = Regex::new(r"(?mi)(?:^# Summary$)([\s\S]*?)(?:(^# .*)|\z)").expect("Invalid regex");
     match re.captures(doc) {
@@ -626,6 +636,7 @@ pub fn parse_doc_for_summary(doc: &str) -> String {
 /// Takes a doc string from a Q# callable and the name of a parameter of
 /// that callable. Returns the description of that parameter found in the
 /// doc string. If no description is found, returns the empty string.
+#[must_use]
 pub fn parse_doc_for_param(doc: &str, param: &str) -> String {
     let re = Regex::new(r"(?mi)(?:^# Input$)([\s\S]*?)(?:(^# .*)|\z)").expect("Invalid regex");
     let input = match re.captures(doc) {

compiler/qsc_doc_gen/src/generate_docs.rs

@@ -102,6 +102,7 @@ impl Lookup for Compilation {
     }
 }
 
+#[must_use]
 pub fn generate_docs() -> Files {
     let compilation = Compilation::new();
     let mut files: Files = vec![];

compiler/qsc_eval/Cargo.toml

@@ -27,5 +27,8 @@ indoc = { workspace = true }
 qsc_frontend = { path = "../qsc_frontend" }
 qsc_passes = { path = "../qsc_passes" }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_eval/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 #[cfg(test)]
 mod tests;
 

compiler/qsc_eval/src/lower.rs

@@ -683,7 +683,6 @@ fn lower_functor_set_value(value: qsc_hir::ty::FunctorSetValue) -> qsc_fir::ty::
 }
 
 #[must_use]
-#[allow(clippy::module_name_repetitions)]
 fn lower_local_item_id(id: qsc_hir::hir::LocalItemId) -> LocalItemId {
     LocalItemId::from(usize::from(id))
 }

compiler/qsc_fir/Cargo.toml

@@ -14,5 +14,8 @@ num-bigint = { workspace = true }
 qsc_data_structures = { path = "../qsc_data_structures" }
 rustc-hash = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_fir/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 pub mod assigner;
 pub mod fir;
 pub mod global;

compiler/qsc_frontend/Cargo.toml

@@ -23,5 +23,8 @@ thiserror = { workspace = true }
 expect-test = { workspace = true }
 indoc = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false

compiler/qsc_frontend/src/compile.rs

@@ -90,7 +90,6 @@ impl From<ConfigAttr> for RuntimeCapabilityFlags {
     }
 }
 
-#[allow(clippy::module_name_repetitions)]
 #[derive(Debug, Default)]
 pub struct CompileUnit {
     pub package: hir::Package,

compiler/qsc_frontend/src/lib.rs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![warn(clippy::mod_module_files, clippy::pedantic, clippy::unwrap_used)]
-#![allow(clippy::missing_errors_doc, clippy::missing_panics_doc)]
-
 mod closure;
 pub mod compile;
 pub mod error;

compiler/qsc_hir/Cargo.toml

@@ -14,5 +14,8 @@ num-bigint = { workspace = true }
 qsc_data_structures = { path = "../qsc_data_structures" }
 rustc-hash = { workspace = true }
 
+[lints]
+workspace = true
+
 [lib]
 doctest = false