ci: tidy up pre commit to check docs

.github/workflows/rust.yml

@@ -49,12 +49,14 @@ jobs:
         run: |
           cargo build --verbose
           cargo test --verbose
+          cargo doc --verbose
 
       - name: Test on macOS
         if: matrix.os == 'macos'
         run: |
           cargo build --verbose
           cargo test --verbose
+          cargo doc --verbose
 
       - name: Test on FreeBSD
         if: matrix.os == 'freebsd'
@@ -70,6 +72,7 @@ jobs:
             . ~/.cargo/env
             cargo build --verbose
             cargo test --verbose
+            cargo doc --verbose
 
       - name: Test on OpenBSD
         if: matrix.os == 'openbsd'
@@ -85,6 +88,7 @@ jobs:
             . ~/.cargo/env
             cargo build --verbose
             cargo test --verbose
+            cargo doc --verbose
 
       - name: Test on Linux s390x (big-endian)
         if: matrix.os == 'linux' && matrix.arch == 's390x'
@@ -102,6 +106,7 @@ jobs:
             source ~/.cargo/env
             cargo build --verbose
             cargo test --verbose
+            cargo doc --verbose
 
       - name: Test on Linux RISC-V64
         if: matrix.os == 'linux' && matrix.arch == 'riscv64'
@@ -119,6 +124,7 @@ jobs:
             source ~/.cargo/env
             cargo build --verbose
             cargo test --verbose
+            cargo doc --verbose
 
       - name: Test on Linux aarch64
         if: matrix.os == 'linux' && matrix.arch == 'aarch64'
@@ -136,6 +142,7 @@ jobs:
             source ~/.cargo/env
             cargo build --verbose
             cargo test --verbose
+            cargo doc --verbose
 
       - name: Test on Alpine in Docker
         if: matrix.os == 'alpine' && matrix.arch == 'x86_64'
@@ -147,4 +154,5 @@ jobs:
             . /root/.cargo/env &&
             cargo build --verbose &&
             cargo test --verbose
+            cargo doc --verbose
           "

.pre-commit-config.yaml

@@ -30,6 +30,14 @@ repos:
         files: \.rs$
         pass_filenames: false
         always_run: true
+      - id: cargo-doc
+        name: Cargo Doc
+        description: Generate and check Rust documentation
+        entry: cargo doc --no-deps
+        language: system
+        files: \.rs$
+        pass_filenames: false
+        always_run: true
       - id: cargo-test
         name: Cargo Test
         description: Run Rust tests

fd_benchmarks/warm-cache-no-match.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+
+source "prelude.sh"
+source "new_prelude.sh"
+PATTERN="THISSHOULDNEVERMATCH"
+#i dont use gitignore so -HI is equivalent on both tools
+COMMAND_FD="fd $PATTERN '$SEARCH_ROOT' -HI"
+COMMAND_FIND="fdf $PATTERN '$SEARCH_ROOT' -HI"
+OUTPUT_DIR="./bench_results"
+mkdir -p "$OUTPUT_DIR"
+
+echo -e "\nRunning benchmarks..."
+hyperfine \
+  --warmup "$WARMUP_COUNT" \
+  --prepare 'sync; sleep 0.2' \
+  "$COMMAND_FD" \
+  "$COMMAND_FIND" \
+  --export-markdown "$OUTPUT_DIR/results-warm-cache-no-match.md"

fd_benchmarks/warm-cache-no-match_home_dir.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+
+source "prelude.sh"
+source "new_prelude.sh"
+PATTERN="THISSHOULDNEVERMATCH"
+#i dont use gitignore so -HI is equivalent on both tools
+COMMAND_FD="fd $PATTERN '$HOME' -HI"
+COMMAND_FIND="fdf $PATTERN '$HOME' -HI"
+OUTPUT_DIR="./bench_results"
+mkdir -p "$OUTPUT_DIR"
+
+echo -e "\nRunning benchmarks..."
+hyperfine \
+  --warmup "$WARMUP_COUNT" \
+  --prepare 'sync; sleep 0.2' \
+  "$COMMAND_FD" \
+  "$COMMAND_FIND" \
+  --export-markdown "$OUTPUT_DIR/results-warm-cache-no-match-home.md"