Improved CI and check script.

Author: orium

.github/workflows/ci.yml

@@ -28,12 +28,15 @@ jobs:
       - name: Install cargo plugins
         run: |
           cargo install cargo-rdme
+          cargo install cargo-machete
+          cargo install taplo-cli
+          cargo install cargo-deadlinks
 
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Check everything
-        run: bash ./tools/check.sh
+        run: bash ./tools/check.sh basic doc_url_links unused_deps packaging fmt toml_fmt readme
 
   msrv:
     runs-on: ubuntu-latest
@@ -49,4 +52,17 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Check the minimum supported rust version
-        run: cargo msrv verify
+        run: bash ./tools/check.sh msrv
+
+  clippy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run clippy
+        run: bash ./tools/check.sh clippy

.taplo.toml

@@ -0,0 +1,17 @@
+include = ["**/*.toml"]
+exclude = ["target/**", "testdata/**"]
+
+[formatting]
+column_width = 100
+indent_string = '    '
+allowed_blank_lines = 1
+
+[[rule]]
+formatting = { reorder_keys = true }
+keys = [
+    "workspace.dependencies",
+    "dependencies",
+    "dev-dependencies",
+    "build-dependencies",
+    "lints.clippy",
+]

Cargo.toml

@@ -12,15 +12,9 @@ repository = "https://github.com/cloudflare/wildcard"
 documentation = "https://docs.rs/wildcard"
 readme = "README.md"
 
-keywords = [
-    "wildcard",
-    "matching",
-]
+keywords = ["wildcard", "matching"]
 
-categories = [
-    "text-processing",
-    "algorithms",
-]
+categories = ["text-processing", "algorithms"]
 
 license = "Apache-2.0"
 
@@ -40,12 +34,12 @@ thiserror = "2.0.3"
 
 [dev-dependencies]
 criterion = "0.5.1"
-regex = "1.10.5"
-wildmatch = "2.3.4"
-toml = "0.8.14"
-serde = "1.0.203"
 quickcheck = "1.0.3"
 quickcheck_macros = "1.0.0"
+regex = "1.10.5"
+serde = "1.0.203"
+toml = "0.8.14"
+wildmatch = "2.3.4"
 
 [features]
 fatal-warnings = []
@@ -65,8 +59,8 @@ missing-docs = "warn"
 
 [lints.clippy]
 all = { level = "warn", priority = -1 }
-pedantic = { level = "warn", priority = -1 }
 correctness = { level = "deny", priority = 1 }
+pedantic = { level = "warn", priority = -1 }
 
 explicit-deref-methods = "allow"
 if-not-else = "allow"

benches/benchmark.rs

@@ -15,6 +15,7 @@
 #![allow(missing_docs)]
 #![allow(clippy::must_use_candidate)]
 #![allow(clippy::missing_panics_doc)]
+#![allow(clippy::too_many_lines)]
 
 use criterion::{criterion_group, criterion_main, Criterion, Throughput};
 use std::time::Duration;
@@ -316,9 +317,8 @@ struct Benchmarks {
 const BENCHDATA_SIZES: &[usize] = &[1, 2, 4, 8, 16, 32, 64, 128];
 
 fn read_benchmark(size_kib: usize) -> Benchmarks {
-    let benches =
-        std::fs::read_to_string(format!("benches/benchdata/benchmarks_{}k.toml", size_kib))
-            .expect("failed to read benchmark data");
+    let benches = std::fs::read_to_string(format!("benches/benchdata/benchmarks_{size_kib}k.toml"))
+        .expect("failed to read benchmark data");
 
     toml::from_str(&benches).expect("failed to parse benchmark file")
 }
@@ -357,7 +357,7 @@ fn benchmark_benchdata_comparison_matches(c: &mut Criterion) {
 
                     for input in benchmark.inputs.match_.iter().chain(&benchmark.inputs.no_match) {
                         criterion::black_box(engine_regex_bytes::matches(
-                            &pattern,
+                            pattern,
                             input.as_bytes(),
                         ));
                     }
@@ -377,7 +377,7 @@ fn benchmark_benchdata_comparison_matches(c: &mut Criterion) {
                         benchmark.inputs.match_.iter().chain(benchmark.inputs.no_match.iter())
                     {
                         criterion::black_box(engine_regex_bytes::matches_compiled(
-                            &regex_compiled,
+                            regex_compiled,
                             input.as_bytes(),
                         ));
                     }
@@ -391,7 +391,7 @@ fn benchmark_benchdata_comparison_matches(c: &mut Criterion) {
                     let pattern = &benchmark.pattern;
 
                     for input in benchmark.inputs.match_.iter().chain(&benchmark.inputs.no_match) {
-                        criterion::black_box(engine_wildmatch::matches(&pattern, input));
+                        criterion::black_box(engine_wildmatch::matches(pattern, input));
                     }
                 }
             });
@@ -409,7 +409,7 @@ fn benchmark_benchdata_comparison_matches(c: &mut Criterion) {
                         benchmark.inputs.match_.iter().chain(benchmark.inputs.no_match.iter())
                     {
                         criterion::black_box(engine_wildmatch::matches_compiled(
-                            &wildmatch_compiled,
+                            wildmatch_compiled,
                             input,
                         ));
                     }
@@ -447,7 +447,7 @@ fn benchmark_benchdata_comparison_matches(c: &mut Criterion) {
                         benchmark.inputs.match_.iter().chain(benchmark.inputs.no_match.iter())
                     {
                         criterion::black_box(engine_wildcard::matches_compiled(
-                            &wildcard_compiled,
+                            wildcard_compiled,
                             input.as_bytes(),
                         ));
                     }
@@ -489,7 +489,7 @@ fn benchmark_benchdata_comparison_captures(c: &mut Criterion) {
 
                     for input in benchmark.inputs.match_.iter().chain(&benchmark.inputs.no_match) {
                         criterion::black_box(engine_regex_bytes::captures(
-                            &pattern,
+                            pattern,
                             input.as_bytes(),
                         ));
                     }
@@ -509,7 +509,7 @@ fn benchmark_benchdata_comparison_captures(c: &mut Criterion) {
                         benchmark.inputs.match_.iter().chain(benchmark.inputs.no_match.iter())
                     {
                         criterion::black_box(engine_regex_bytes::captures_compiled(
-                            &regex_compiled,
+                            regex_compiled,
                             input.as_bytes(),
                         ));
                     }
@@ -547,7 +547,7 @@ fn benchmark_benchdata_comparison_captures(c: &mut Criterion) {
                         benchmark.inputs.match_.iter().chain(benchmark.inputs.no_match.iter())
                     {
                         criterion::black_box(engine_wildcard::captures_compiled(
-                            &wildcard_compiled,
+                            wildcard_compiled,
                             input.as_bytes(),
                         ));
                     }

fuzz/Cargo.toml

@@ -9,8 +9,8 @@ cargo-fuzz = true
 
 [dependencies]
 libfuzzer-sys = "0.4.7"
-wildcard = { path = ".." }
 regex = "1.10.5"
+wildcard = { path = ".." }
 
 [profile.release]
 debug = true

tools/check.sh

@@ -16,39 +16,93 @@ function on_failure {
     echo -e "${RED}Whoopsie-daisy: something failed!$NC" >&2
 }
 
-assert_installed "cargo-fmt"
-assert_installed "cargo-clippy"
-assert_installed "cargo-rdme"
+assert_installed "cargo"
 
 trap on_failure ERR
 
-echo 'Building:'
-cargo build --all-features --all-targets
-echo 'Testing:'
-SHORT_BENCH=1 cargo test  --all-features --all-targets --benches
-
-# We test property-based tests will a much higher number of testcases. We need to compile this with the release profile,
-# otherwise this would be very slow.
-echo 'Testing property-based tests for longer:'
-QUICKCHECK_TESTS=200000 cargo test --all-features --release property_
-
-# Weirdly, the `cargo test ... --all-targets ...` above does not run the tests in the documentation, so we run the
-# doc tests like this.
-# See https://github.com/rust-lang/cargo/issues/6669.
-echo 'Testing doc:'
-cargo test  --all-features --doc
-echo 'Checking documentation:'
-cargo doc   --all-features --no-deps --document-private-items
-
-echo 'Checking clippy:'
-cargo clippy --all-features --all-targets
-
-echo 'Checking packaging:'
-cargo package --allow-dirty
-echo 'Checking code style:'
-cargo fmt -- --check
-echo 'Checking readme:'
-cargo rdme --check
+function check_basic {
+    echo 'Building:'
+    cargo build --features fatal-warnings --all-targets
+	echo 'Testing:'
+	SHORT_BENCH=1 cargo test  --all-features --all-targets --benches
+	# We test property-based tests will a much higher number of testcases. We need to compile this with the release profile,
+	# otherwise this would be very slow.
+	echo 'Testing property-based tests for longer:'
+	QUICKCHECK_TESTS=200000 cargo test --all-features --release property_
+    # Weirdly, the `cargo test ... --all-targets ...` above does not run the tests in the documentation, so we run the
+    # doc tests like this.
+    # See https://github.com/rust-lang/cargo/issues/6669.
+    echo 'Testing doc:'
+    cargo test  --features fatal-warnings --doc
+    echo 'Checking the benchmarks:'
+    cargo bench --features fatal-warnings -- --test
+    echo 'Checking documentation:'
+    cargo doc   --features fatal-warnings --no-deps
+}
+
+function check_doc_url_links {
+    assert_installed "cargo-deadlinks"
+
+    echo 'Checking doc url links:'
+    cargo deadlinks
+}
+
+function check_unused_deps {
+    assert_installed "cargo-machete"
+
+    echo 'Checking unused dependencies:'
+    cargo machete
+}
+
+function check_packaging {
+    echo 'Checking packaging:'
+    cargo package --allow-dirty
+}
+
+function check_fmt {
+    assert_installed "cargo-fmt"
+
+    echo 'Checking code format:'
+    cargo fmt -- --check
+}
+
+function check_toml_fmt {
+    assert_installed "taplo"
+
+    echo 'Checking toml format:'
+    taplo fmt --check
+}
+
+function check_readme {
+    assert_installed "cargo-rdme"
+
+    echo 'Checking readme:'
+	cargo rdme --check
+}
+
+function check_msrv {
+    assert_installed "cargo-msrv"
+
+    echo 'Checking the minimum supported rust version:'
+    cargo msrv verify
+}
+
+function check_clippy {
+    assert_installed "cargo-clippy"
+
+    echo 'Checking with clippy:'
+    cargo clippy --all-targets -- -D warnings
+}
+
+to_run=(basic doc_url_links unused_deps packaging fmt toml_fmt readme msrv clippy)
+
+if [ $# -ge 1 ]; then
+    to_run=("$@")
+fi
+
+for check in "${to_run[@]}"; do
+    check_$check
+done
 
 echo
 echo -e "${GREEN}Everything looks lovely!$NC"