ci: Add clippy and fmt lints (#132)

* CI: Add clippy and fmt lints

Run cargo clippy, and cargo fmt with import sorting.

* Format imports

* Move lints from test.yml and test-python.yml to lint.yml

* Format imports in python/ folder

* Apply suggestions from code review

* Update .github/workflows/lint.yml

* remove rustfmt component installation

---------

Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Kyle Barron <[email protected]>

Author: weiji14

.github/workflows/lint.yml

@@ -0,0 +1,44 @@
+name: Lint
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    types: [opened, reopened, synchronize]
+    branches: ["main"]
+
+permissions: {}
+
+# Make sure CI fails on all warnings, including Clippy lints
+env:
+  CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  clippy_check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Run Clippy
+        run: |
+          cargo clippy --all-targets --all-features
+          cargo clippy --all-targets --all-features --manifest-path python/Cargo.toml
+
+  format_check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Run Rustfmt
+        run: |
+          cargo fmt --all --check -- --config imports_granularity=Module,group_imports=StdExternalCrate
+          cargo fmt --all --check --manifest-path python/Cargo.toml -- --config imports_granularity=Module,group_imports=StdExternalCrate

.github/workflows/test-python.yml

@@ -7,8 +7,8 @@ on:
   pull_request:
 
 jobs:
-  lint-test:
-    name: Lint and Test
+  test:
+    name: Test
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -18,17 +18,9 @@ jobs:
 
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
-        with:
-          components: rustfmt, clippy
 
       - uses: Swatinem/rust-cache@v2
 
-      - name: Cargo fmt
-        run: cargo fmt --all -- --check
-
-      - name: "clippy --all"
-        run: cargo clippy --all --all-features --tests -- -D warnings
-
       - name: "cargo check"
         run: cargo check --all --all-features
 
@@ -47,8 +39,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
-        with:
-          components: rustfmt
 
       - uses: Swatinem/rust-cache@v2
       - uses: actions/setup-python@v5

.github/workflows/test.yml

@@ -7,25 +7,17 @@ on:
   pull_request:
 
 jobs:
-  lint-test:
-    name: Lint and Test
+  test:
+    name: Test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
-        with:
-          components: rustfmt, clippy
 
       - uses: Swatinem/rust-cache@v2
 
-      - name: Cargo fmt
-        run: cargo fmt --all -- --check
-
-      - name: "clippy --all"
-        run: cargo clippy --all --all-features --tests -- -D warnings
-
       - run: cargo install cargo-all-features
 
       - name: Check all combinations of features can build

python/src/thread_pool.rs

@@ -2,7 +2,6 @@ use std::sync::Arc;
 
 use pyo3::exceptions::PyValueError;
 use pyo3::prelude::*;
-
 use pyo3::sync::PyOnceLock;
 use rayon::{ThreadPool, ThreadPoolBuilder};
 

src/cog.rs

@@ -23,13 +23,13 @@ mod test {
     use std::io::BufReader;
     use std::sync::Arc;
 
-    use crate::metadata::{PrefetchBuffer, TiffMetadataReader};
-    use crate::reader::{AsyncFileReader, ObjectReader};
-
-    use super::*;
     use object_store::local::LocalFileSystem;
     use tiff::decoder::{DecodingResult, Limits};
 
+    use super::*;
+    use crate::metadata::{PrefetchBuffer, TiffMetadataReader};
+    use crate::reader::{AsyncFileReader, ObjectReader};
+
     #[ignore = "local file"]
     #[tokio::test]
     async fn tmp() {

src/error.rs

@@ -1,6 +1,7 @@
 //! Error handling.
 
 use std::fmt::Debug;
+
 use thiserror::Error;
 
 /// Enum with all errors in this crate.

src/geo/geo_key_directory.rs

@@ -5,8 +5,7 @@ use std::collections::HashMap;
 
 use num_enum::{IntoPrimitive, TryFromPrimitive};
 
-use crate::tiff::Value;
-use crate::tiff::{TiffError, TiffResult};
+use crate::tiff::{TiffError, TiffResult, Value};
 
 /// Geospatial TIFF tag variants
 #[derive(Clone, Copy, Debug, PartialEq, TryFromPrimitive, IntoPrimitive, Eq, Hash)]

src/metadata/reader.rs

@@ -623,14 +623,15 @@ async fn read_tag_value<F: MetadataFetch>(
 
 #[cfg(test)]
 mod test {
-    use crate::{
-        metadata::{reader::read_tag, MetadataFetch},
-        reader::Endianness,
-        tiff::{tags::Tag, Value},
-    };
     use bytes::Bytes;
     use futures::FutureExt;
 
+    use crate::metadata::reader::read_tag;
+    use crate::metadata::MetadataFetch;
+    use crate::reader::Endianness;
+    use crate::tiff::tags::Tag;
+    use crate::tiff::Value;
+
     impl MetadataFetch for Bytes {
         fn fetch(
             &self,

src/predictor.rs

@@ -3,10 +3,10 @@ use std::fmt::Debug;
 
 use bytes::{Bytes, BytesMut};
 
-use crate::error::AsyncTiffError;
+use crate::error::{AsyncTiffError, AsyncTiffResult};
+use crate::reader::Endianness;
 use crate::tiff::tags::PlanarConfiguration;
 use crate::ImageFileDirectory;
-use crate::{error::AsyncTiffResult, reader::Endianness};
 
 /// All info that may be used by a predictor
 ///
@@ -397,12 +397,9 @@ mod test {
 
     use bytes::Bytes;
 
-    use crate::{
-        predictor::{unpredict_float, unpredict_hdiff},
-        reader::Endianness,
-    };
-
     use super::*;
+    use crate::predictor::{unpredict_float, unpredict_hdiff};
+    use crate::reader::Endianness;
 
     const PRED_INFO: PredictorInfo = PredictorInfo {
         endianness: Endianness::LittleEndian,

src/reader.rs

@@ -108,6 +108,7 @@ impl<T: tokio::io::AsyncRead + tokio::io::AsyncSeek + Unpin + Send + Debug> Toki
 
     async fn make_range_request(&self, range: Range<u64>) -> AsyncTiffResult<Bytes> {
         use std::io::SeekFrom;
+
         use tokio::io::{AsyncReadExt, AsyncSeekExt};
 
         use crate::error::AsyncTiffError;