Add a restricted set of clippy lints, required to pass

This sets up CI to check clippy with a restricted set of clippy groups.
Some of the default groups have some excessive sets of lints that are
either wrong or style choices that I would prefer to not mess over at
this time. The lint groups can be adjusted later if it looks like
something that would be helpful.
This commit is contained in:
Eric Huss 2025-04-20 19:11:23 -07:00
parent 14aeb0cb83
commit 8181445d99
6 changed files with 20 additions and 4 deletions

View file

@ -88,6 +88,16 @@ jobs:
- name: Build and run tests (+ GUI) - name: Build and run tests (+ GUI)
run: cargo test --locked --target x86_64-unknown-linux-gnu --test gui run: cargo test --locked --target x86_64-unknown-linux-gnu --test gui
# Ensure there are no clippy warnings
clippy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
run: bash ci/install-rust.sh stable x86_64-unknown-linux-gnu
- run: rustup component add clippy
- run: cargo clippy --workspace --all-targets --no-deps -- -D warnings
# The success job is here to consolidate the total success/failure state of # The success job is here to consolidate the total success/failure state of
# all other jobs. This job is then included in the GitHub branch protection # all other jobs. This job is then included in the GitHub branch protection
# rule which prevents merges unless all other jobs are passing. This makes # rule which prevents merges unless all other jobs are passing. This makes
@ -101,6 +111,7 @@ jobs:
- rustfmt - rustfmt
- aarch64-cross-builds - aarch64-cross-builds
- gui - gui
- clippy
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}' - run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'

View file

@ -1,6 +1,12 @@
[workspace] [workspace]
members = [".", "examples/remove-emphasis/mdbook-remove-emphasis"] members = [".", "examples/remove-emphasis/mdbook-remove-emphasis"]
[workspace.lints.clippy]
all = { level = "allow", priority = -2 }
correctness = { level = "warn", priority = -1 }
complexity = { level = "warn", priority = -1 }
needless-lifetimes = "allow" # Remove once 1.87 is stable, https://github.com/rust-lang/rust-clippy/issues/13514
[package] [package]
name = "mdbook" name = "mdbook"
version = "0.4.48" version = "0.4.48"
@ -91,3 +97,6 @@ test = false
name = "gui" name = "gui"
path = "tests/gui/runner.rs" path = "tests/gui/runner.rs"
crate-type = ["bin"] crate-type = ["bin"]
[lints]
workspace = true

View file

@ -5,7 +5,6 @@
//! //!
//! [1]: ../index.html //! [1]: ../index.html
#[allow(clippy::module_inception)]
mod book; mod book;
mod init; mod init;
mod summary; mod summary;

View file

@ -148,7 +148,6 @@ enum RangeOrAnchor {
} }
// A range of lines specified with some include directive. // A range of lines specified with some include directive.
#[allow(clippy::enum_variant_names)] // The prefix can't be removed, and is meant to mirror the contained type
#[derive(PartialEq, Debug, Clone)] #[derive(PartialEq, Debug, Clone)]
enum LineRange { enum LineRange {
Range(Range<usize>), Range(Range<usize>),

View file

@ -207,7 +207,6 @@ impl HtmlHandlebars {
Ok(()) Ok(())
} }
#[allow(clippy::let_and_return)]
fn post_process( fn post_process(
&self, &self,
rendered: String, rendered: String,

View file

@ -780,7 +780,6 @@ mod search {
} }
#[test] #[test]
#[allow(clippy::float_cmp)]
fn book_creates_reasonable_search_index() { fn book_creates_reasonable_search_index() {
let temp = DummyBook::new().build().unwrap(); let temp = DummyBook::new().build().unwrap();
let md = MDBook::load(temp.path()).unwrap(); let md = MDBook::load(temp.path()).unwrap();