add support for include_dir

.github/workflows/ci.yml

@@ -25,12 +25,14 @@ jobs:
         run: cargo clippy --all-features --all-targets
       - name: Lint (rustfmt)
         run: cargo xfmt --check
-      - name: Install cargo readme
+      - name: Install cargo-sync-rdme and just
         uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
         with:
-          tool: cargo-readme
-      - name: Run cargo readme
-        run: ./scripts/regenerate-readmes.sh
+          tool: cargo-sync-rdme,just
+      - name: Install nightly toolchain for cargo-sync-rdme
+        uses: dtolnay/rust-toolchain@nightly
+      - name: Generate readmes
+        run: just generate-readmes
       - name: Check for differences
         run: git diff --exit-code
 
@@ -68,24 +70,29 @@ jobs:
       - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
         with:
           key: ${{ matrix.rust-version }}
+      - name: Install tools
+        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        with:
+          tool: cargo-hack,just,nextest
       - name: Build
-        run: cargo build
-      - name: Install latest nextest release
-        uses: taiki-e/install-action@nextest
-      - name: Build datatest-stable
-        run: cargo build
+        run: just powerset build
+      - name: Build with all targets
+        run: just powerset build --all-targets
       - name: Run tests
-        run: cargo nextest run
+        run: just powerset nextest run
       - name: Run tests with cargo test
-        run: cargo test
+        run: just powerset test
 
       # Remove Cargo.lock to ensure that building with the latest versions works on stable.
       - name: Remove Cargo.lock and rebuild on stable
         if: matrix.rust-version == 'stable'
         run: rm Cargo.lock && cargo build
+      - name: Build with all targets
+        if: matrix.rust-version == 'stable'
+        run: just powerset build --all-targets
       - name: Run tests on stable
         if: matrix.rust-version == 'stable'
-        run: cargo nextest run
+        run: just powerset nextest run
       - name: Run tests with cargo test on stable
         if: matrix.rust-version == 'stable'
-        run: cargo test
+        run: just powerset test

.github/workflows/coverage.yml

@@ -25,17 +25,14 @@ jobs:
           components: llvm-tools-preview
       - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
 
-      - name: Install latest nextest release
-        uses: taiki-e/install-action@nextest
-      - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Install tools
+        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        with:
+          tool: cargo-llvm-cov,just,nextest
 
       - name: Collect coverage data
-        # Generate separate reports for nextest and doctests, and combine them.
         run: |
-          cargo llvm-cov --no-report nextest
-          cargo llvm-cov --no-report --doc
-          cargo llvm-cov report --doctests --lcov --output-path lcov.info
+          just coverage --lcov --output-path lcov.info
       - name: Upload coverage data to codecov
         uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5
         env:

.github/workflows/docs.yml

@@ -13,8 +13,9 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: dtolnay/rust-toolchain@stable
-      - name: Build rustdocs
-        run: ./scripts/build-docs.sh
+      - uses: taiki-e/install-action@just
+      - name: Build rustdoc
+        run: just rustdoc
       - name: Organize
         run: |
           rm -rf target/gh-pages

Cargo.toml

@@ -11,9 +11,27 @@ categories = ["development-tools::testing"]
 keywords = ["datatest", "data-driven-tests", "test-harness"]
 rust-version = "1.72"
 
+[badges]
+maintenance = { status = "passively-maintained" }
+
+[package.metadata.cargo-sync-rdme.badge.badges]
+maintenance = true
+license = true
+crates-io = true
+docs-rs = true
+rust-version = true
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg=doc_cfg"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(doc_cfg)'] }
+
 [dependencies]
 camino = "1.1.9"
 fancy-regex = "0.14.0"
+include_dir = { version = "0.7.4", optional = true }
 libtest-mimic = "0.8.1"
 walkdir = "2.5.0"
 
@@ -28,3 +46,6 @@ harness = false
 [[test]]
 name = "run_example"
 harness = true
+
+[features]
+include-dir = ["dep:include_dir"]

Justfile

@@ -0,0 +1,25 @@
+# Print a help message.
+help:
+    just --list
+
+
+# Run `cargo hack --feature-powerset` with the given arguments.
+powerset *args:
+    cargo hack --feature-powerset {{args}}
+
+# Build docs for crates and direct dependencies
+rustdoc:
+    @cargo tree --depth 1 -e normal --prefix none --workspace \
+        | gawk '{ gsub(" v", "@", $0); printf("%s\n", $1); }' \
+        | xargs printf -- '-p %s\n' \
+        | RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS='--cfg=doc_cfg' xargs cargo doc --no-deps --lib --all-features
+
+# Generate README.md files using `cargo-sync-rdme`.
+generate-readmes:
+    cargo sync-rdme --toolchain nightly --all-features
+
+# Collect coverage, pass in `--html` to get an HTML report
+coverage *args:
+    cargo +nightly llvm-cov --no-report nextest --all-features
+    cargo +nightly llvm-cov --no-report --doc --all-features
+    cargo +nightly llvm-cov report --doctests {{args}}