Add justfile

Author: SpriteOvO

.github/workflows/ci.yml

@@ -47,14 +47,17 @@ jobs:
       uses: actions/checkout@v4
     - name: Disable bench dependencies
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install Rust nightly
       run: |
         rustup toolchain install nightly
         rustup component add rustfmt --toolchain nightly
     - name: Restore cargo caches
       uses: Swatinem/rust-cache@v2
-    - name: Check formatting
-      run: cargo +nightly fmt --all --verbose -- --check
+    - name: Check Rust formatting
+      run: just fmt --verbose -- --check
+    - name: Check justfile formatting
+      run: just --unstable --fmt --check
 
   test:
     strategy:
@@ -75,13 +78,17 @@ jobs:
         timezoneWindows: "China Standard Time"
     - name: Disable bench dependencies
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install dependencies
       if: matrix.os == 'ubuntu-latest'
       run: sudo bash ./.github/workflows/install-deps.sh
     - name: Restore cargo caches
       uses: Swatinem/rust-cache@v2
-    - name: Run tests
+    - name: Run tests with selected features
       run: cargo test --features "${{ matrix.fn_features }} ${{ matrix.cfg_feature }}" --verbose
+    - name: Run tests with all features
+      if: matrix.fn_features == '' && matrix.cfg_feature == ''
+      run: just test
     - name: Run examples
       if: matrix.fn_features != ''
       run: |
@@ -102,6 +109,7 @@ jobs:
     - name: Disable bench dependencies
       if: matrix.target != fromJSON(needs.matrix.outputs.ci_targets)[0]
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install dependencies
       run: sudo bash ./.github/workflows/install-deps.sh
     - name: Install Rust nightly
@@ -116,7 +124,7 @@ jobs:
     - name: Restore cargo caches
       uses: Swatinem/rust-cache@v2
     - name: Run clippy 
-      run: cargo clippy --all-features --tests --examples -- -D warnings
+      run: just clippy -- -D warnings
     - name: Run clippy nightly
       run: |
         cargo +nightly clippy --all-features --tests --examples
@@ -148,6 +156,7 @@ jobs:
       uses: actions/checkout@v4
     - name: Disable bench dependencies
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install dependencies
       run: sudo bash ./.github/workflows/install-deps.sh
     - name: Install Rust target
@@ -157,7 +166,7 @@ jobs:
     - name: Restore cargo caches
       uses: Swatinem/rust-cache@v2
     - name: Run check
-      run: cargo check --all-features --verbose
+      run: just check --verbose
 
   check-doc:
     strategy:
@@ -168,6 +177,7 @@ jobs:
       uses: actions/checkout@v4
     - name: Disable bench dependencies
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install dependencies
       run: sudo bash ./.github/workflows/install-deps.sh
     - name: Install Rust nightly
@@ -177,10 +187,10 @@ jobs:
     - name: Run rustdoc nightly
       run: |
         RUSTDOCFLAGS='-D warnings -A rustdoc::broken-intra-doc-links'
-        cargo +nightly doc --verbose -Z unstable-options -Z rustdoc-scrape-examples
+        just _doc-default-features --verbose
 
         RUSTDOCFLAGS='-D warnings'
-        cargo +nightly doc --all-features --verbose -Z unstable-options -Z rustdoc-scrape-examples
+        just doc --verbose
 
   check-msrv:
     needs: [matrix]
@@ -347,13 +357,14 @@ jobs:
       uses: actions/checkout@v4
     - name: Disable bench dependencies
       run: ./.github/workflows/disable-bench-deps.sh
+    - uses: extractions/setup-just@v3
     - name: Install Rust nightly
       run: rustup toolchain install nightly
     - name: Restore cargo caches
       uses: Swatinem/rust-cache@v2
     - name: Run benchmark
       run: |
-        cargo +nightly bench --features "multi-thread,runtime-pattern,serde_json,log" \
+        just bench \
           --bench spdlog_rs \
           --bench spdlog_rs_pattern \
           --bench spdlog_rs_log_crate_proxy \

README.md

@@ -45,6 +45,8 @@ Unreleased commits are active on [`main-dev`] branch, and [`main`] branch is onl
 
 If you are going to contribute `spdlog-rs`, please make sure to check out the [`main-dev`] branch and select the [`main-dev`] branch as the base when opening PR.
 
+Due to the complexity of combining crate feature gates, this repository provides a [justfile] for tool [`just`] to easily interact with `cargo` during development. Run command `just --list` to check the available recipes specifically for this project.
+
 ## Supported Rust versions
 
 <!--
@@ -82,3 +84,5 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
 [open an issue]: https://github.com/SpriteOvO/spdlog-rs/issues/new/choose
 [`main-dev`]: https://github.com/SpriteOvO/spdlog-rs/tree/main-dev
 [`main`]: https://github.com/SpriteOvO/spdlog-rs/tree/main
+[justfile]: /justfile
+[`just`]: https://github.com/casey/just

justfile

@@ -0,0 +1,40 @@
+just := 'just' + ' --justfile=' + justfile()
+
+_:
+    @{{ just }} --list
+
+alias format := fmt
+
+fmt *ARGS:
+    cargo +nightly fmt --all {{ ARGS }}
+
+test *ARGS:
+    cargo test \
+      --features 'log native libsystemd multi-thread runtime-pattern serde serde_json sval' \
+      --features 'flexible-string source-location test' \
+      {{ ARGS }}
+
+clippy *ARGS:
+    cargo clippy --all-features --tests --examples {{ ARGS }}
+
+check *ARGS:
+    cargo check --all-features {{ ARGS }}
+
+_doc-default-features *ARGS:
+    cargo +nightly doc -Z unstable-options -Z rustdoc-scrape-examples {{ ARGS }}
+
+doc *ARGS:
+    @{{ just }} _doc-default-features --all-features {{ ARGS }}
+
+bench *ARGS:
+    cargo +nightly bench --features 'multi-thread runtime-pattern serde_json log' {{ ARGS }}
+
+[private]
+publish crate-name *ARGS:
+    cargo clean
+    cargo package --package {{ crate-name }}
+    @{{ just }} _publish-confirmed {{ crate-name }} {{ ARGS }}
+
+[confirm("Please check 'target/package' directory, keep going? (y/N)")]
+_publish-confirmed crate-name *ARGS:
+    cargo publish --package {{ crate-name }} {{ ARGS }}