ci: Split lints into more jobs

.github/workflows/lint.yml → .github/workflows/clippy.yml

@@ -1,4 +1,4 @@
-name: Lint the code
+name: Lint the code with clippy
 
 on:
   push:
@@ -20,7 +20,7 @@ on:
 
 jobs:
   linting:
-    name: Lint on ${{ matrix.os }} for ${{ matrix.target }}
+    name: Lint with clippy on ${{ matrix.os }} for ${{ matrix.target }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -56,7 +56,6 @@ jobs:
       - name: Setup Rust toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
-          components: llvm-tools-preview
           targets: ${{ matrix.target }}
 
       - uses: actions/cache@v4
@@ -74,18 +73,5 @@ jobs:
 
       # ----- Actual linting logic ------
       # These lines should mirror the `just lint` command.
-      - name: cargo fmt
-        run: cargo fmt --all -- --check
-
       - name: cargo clippy
-        run: cargo clippy --tests --workspace -- -D warnings
-
-      # Only run taplo on linux to save some time.
-      # Also, taplo is broken on windows for some reason.
-      - name: Install taplo-cli
-        run: cargo install taplo-cli || exit 0
-        if: matrix.target == 'x86_64-unknown-linux-gnu'
-
-      - name: cargo sort
-        run: ~/.cargo/bin/taplo format --check
-        if: matrix.target == 'x86_64-unknown-linux-gnu'
+        run: cargo clippy --tests --workspace --all -- -D warnings

.github/workflows/format.yml

@@ -0,0 +1,51 @@
+name: Check code formatting
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+
+jobs:
+  format:
+    name: Format code
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: format-${{ runner.os }}-cargo-${{ matrix.target }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            format-${{ runner.os }}-cargo-${{ matrix.target }}-
+            ${{ runner.os }}-cargo-${{ matrix.target }}-
+
+      # ----- Actual linting logic ------
+      # These lines should mirror the `just lint` command.
+      - name: cargo fmt
+        run: cargo fmt --all -- --check

.github/workflows/lint_docs.yml

@@ -0,0 +1,67 @@
+name: Lint the code docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+
+jobs:
+  linting:
+    name: Lint code docs on ${{ matrix.os }} for ${{ matrix.target }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        target:
+          - x86_64-unknown-linux-gnu
+          - aarch64-unknown-linux-musl
+          - armv7-unknown-linux-musleabihf
+          - arm-unknown-linux-musleabihf
+          - x86_64-pc-windows-msvc
+          - x86_64-apple-darwin
+          - aarch64-apple-darwin
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+          - os: macos-latest
+            target: x86_64-apple-darwin
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: lint-docs-${{ runner.os }}-cargo-${{ matrix.target }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            lint-docs-${{ runner.os }}-cargo-${{ matrix.target }}-
+            ${{ runner.os }}-cargo-${{ matrix.target }}-
+
+      # ----- Actual linting logic ------
+      # These lines should mirror the `just lint` command.
+      - name: cargo doc lints
+        run: RUSTDOCFLAGS='-D warnings' cargo doc --document-private-items --no-deps

.github/workflows/lint_toml.yml

@@ -0,0 +1,51 @@
+name: Lint toml files
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/**/*"
+      - "**.rs"
+      - "**/Cargo.toml"
+      - "**/Cargo.lock"
+
+jobs:
+  linting:
+    name: Toml lints
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: lint-toml-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: lint-toml-
+
+      # Only run taplo on linux to save some time.
+      - name: Install taplo-cli
+        run: cargo install taplo-cli || exit 0
+        if: matrix.target == 'x86_64-unknown-linux-gnu'
+
+      - name: cargo sort
+        run: ~/.cargo/bin/taplo format --check
+        if: matrix.target == 'x86_64-unknown-linux-gnu'

Justfile

@@ -16,6 +16,7 @@ lint:
     cargo fmt --all -- --check
     taplo format --check
     cargo clippy --tests --workspace --all -- -D warnings
+    RUSTDOCFLAGS='-D warnings' cargo doc --document-private-items --no-deps
 
 format:
     just ensure-command taplo

pueue/src/client/mod.rs

@@ -2,8 +2,8 @@ pub mod cli;
 /// All subcommands have their dedicated file and functions in here.
 mod commands;
 pub(crate) mod display_helper;
-/// The [`OutputStyle`] helper, responsible for formatting and styling output based on the current
-/// settings.
+/// The [`OutputStyle`](style::OutputStyle) helper, responsible for formatting and styling output
+/// based on the current settings.
 pub mod style;
 
 pub use commands::handle_command;