Define cargo features

fix #19

Author: KSXGitHub

.github/workflows/deploy.yaml

@@ -29,29 +29,47 @@ jobs:
           override: 'true'
           default: 'true'
 
-      - name: Build (dev)
-        run: cargo build --locked
-
-      - name: Test (dev)
-        run: cargo test
-
-      - name: Build (release)
-        run: cargo build --locked --release
-
-      - name: Test (release)
-        run: cargo test --release
-
-      - name: Check formatting
-        if: runner.os == 'Linux'
-        run: cargo fmt -- --check
-
-      - name: Clippy check (dev)
+      - name: Build and Test (dev)
+        env:
+          FMT: 'false'
+          LINT: 'false'
+          BUILD: 'true'
+          TEST: 'true'
+          BUILD_FLAGS: '--locked'
+          TEST_FLAGS: ''
+        run: ./test.sh
+
+      - name: Build and Test (release)
+        env:
+          FMT: 'false'
+          LINT: 'false'
+          BUILD: 'true'
+          TEST: 'true'
+          BUILD_FLAGS: '--locked'
+          TEST_FLAGS: ''
+        run: ./test.sh --release
+
+      - name: Fmt and Clippy (dev)
         if: runner.os == 'Linux'
-        run: cargo clippy -- -D warnings
-
-      - name: Clippy check (release)
+        env:
+          FMT: 'true'
+          LINT: 'true'
+          BUILD: 'false'
+          TEST: 'false'
+          BUILD_FLAGS: ''
+          TEST_FLAGS: ''
+        run: ./test.sh
+
+      - name: Clippy (release)
         if: runner.os == 'Linux'
-        run: cargo clippy --release -- -D warnings
+        env:
+          FMT: 'false'
+          LINT: 'true'
+          BUILD: 'false'
+          TEST: 'false'
+          BUILD_FLAGS: ''
+          TEST_FLAGS: ''
+        run: ./test.sh --release
 
   build_linux:
     name: Build
@@ -76,7 +94,7 @@ jobs:
           default: 'true'
 
       - name: Build
-        run: cargo build --target ${{ matrix.target }} --release
+        run: cargo build --target ${{ matrix.target }} --release --all-features
 
       - name: Strip all debug symbols
         run: strip --strip-all target/${{ matrix.target }}/release/pdu
@@ -109,7 +127,7 @@ jobs:
           default: 'true'
 
       - name: Build
-        run: cargo build --target ${{ matrix.target }} --release
+        run: cargo build --target ${{ matrix.target }} --release --all-features
 
       - name: Strip all debug symbols
         run: strip target/${{ matrix.target }}/release/pdu
@@ -143,7 +161,7 @@ jobs:
           default: 'true'
 
       - name: Build
-        run: cargo build --target ${{ matrix.target }} --release
+        run: cargo build --target ${{ matrix.target }} --release --all-features
 
       - name: Upload build artifact
         uses: actions/upload-artifact@v2

.github/workflows/test.yaml

@@ -42,14 +42,22 @@ jobs:
           override: 'true'
           default: 'true'
 
-      - name: Build (dev)
-        run: cargo build --locked
-
       - name: Test (dev)
-        run: cargo test --no-fail-fast
-
-      - name: Build (release)
-        run: cargo build --locked --release
+        env:
+          FMT: 'false'
+          LINT: 'true'
+          BUILD: 'true'
+          TEST: 'true'
+          BUILD_FLAGS: '--locked'
+          TEST_FLAGS: '--no-fail-fast'
+        run: ./test.sh
 
       - name: Test (release)
-        run: cargo test --no-fail-fast --release
+        env:
+          FMT: 'false'
+          LINT: 'true'
+          BUILD: 'true'
+          TEST: 'true'
+          BUILD_FLAGS: '--locked'
+          TEST_FLAGS: '--no-fail-fast'
+        run: ./test.sh --release

Cargo.toml

@@ -34,15 +34,20 @@ path = "src/lib.rs"
 [[bin]]
 name = "pdu"
 path = "cli/main.rs"
+required-features = ["cli"]
 
 [[bin]]
 name = "pdu-completions"
 path = "cli/completions.rs"
+required-features = ["cli-completions"]
+
+[features]
+default = ["cli"]
+cli = ["structopt", "structopt-utilities"]
+cli-completions = ["cli"]
 
 [dependencies]
 pipe-trait = "^0.3.2"
-structopt = "^0.3.21"
-structopt-utilities = "^0.0.8"
 smart-default = "^0.6.0"
 derive_more = "^0.99.14"
 rayon = "^1.5.1"
@@ -54,6 +59,14 @@ assert-cmp = "^0.2.0"
 zero-copy-pads = "^0.2.0"
 terminal_size = "^0.1.17"
 
+[dependencies.structopt]
+version = "^0.3.21"
+optional = true
+
+[dependencies.structopt-utilities]
+version = "^0.0.8"
+optional = true
+
 [dependencies.strum]
 version = "^0.20.0"
 features = ["derive"]

README.md

@@ -46,9 +46,24 @@ The benchmark was generated by [a GitHub Workflow](https://github.com/KSXGitHub/
 ### Test
 
 ```sh
-cargo clippy -- -D warnings && cargo fmt --check && cargo test
+./test.sh && ./test.sh --release
 ```
 
+<details><summary>
+Environment Variables
+</summary>
+
+| name          | type              | default value | description                                     |
+|---------------|-------------------|---------------|-------------------------------------------------|
+| `FMT`         | `true` or `false` | `true`        | Whether to run `cargo fmt`                      |
+| `LINT`        | `true` or `false` | `true`        | Whether to run `cargo clippy`                   |
+| `BUILD`       | `true` or `false` | `true`        | Whether to run `cargo build`                    |
+| `TEST`        | `true` or `false` | `true`        | Whether to run `cargo test`                     |
+| `BUILD_FLAGS` | string            | _(empty)_     | Space-separated list of flags for `cargo build` |
+| `TEST_FLAGS`  | string            | _(empty)_     | Space-separated list of flags for `cargo test`  |
+
+</details>
+
 ### Run
 
 ```sh

run.sh

@@ -1,3 +1,3 @@
 #! /bin/bash
 set -o errexit -o pipefail -o nounset
-exec cargo run --bin="$1" -- "${@:2}"
+exec cargo run --bin="$1" --features cli-completions -- "${@:2}"

src/bytes_format.rs

@@ -25,6 +25,7 @@ pub enum BytesFormat {
 }
 
 impl BytesFormat {
+    #[cfg(feature = "cli")]
     pub(crate) fn default_value() -> &'static str {
         BytesFormat::MetricUnits.as_ref()
     }

src/data_tree/retain.rs

@@ -22,6 +22,7 @@ where
     }
 
     /// Recursively cull all descendants whose data are too small relative to root.
+    #[cfg(feature = "cli")]
     pub(crate) fn par_cull_insignificant_data(&mut self, min_ratio: f32)
     where
         Data: Into<u64>,
@@ -32,6 +33,7 @@ where
 
     /// Process the tree via [`par_cull_insignificant_data`](Self::par_cull_insignificant_data) method.
     #[cfg(test)]
+    #[cfg(feature = "cli")]
     fn into_insignificant_data_par_culled(mut self, min_ratio: f32) -> Self
     where
         Data: Into<u64>,
@@ -42,4 +44,5 @@ where
 }
 
 #[cfg(test)]
+#[cfg(feature = "cli")]
 mod test;

src/lib.rs

@@ -2,8 +2,26 @@
 
 mod utils;
 
+#[cfg(feature = "cli")]
 pub mod app;
+#[cfg(feature = "cli")]
 pub mod args;
+
+/// The main program.
+#[cfg(feature = "cli")]
+pub fn main() {
+    if let Err(error) = app::App::from_env().run() {
+        eprintln!("[error] {}", error);
+    }
+}
+
+#[cfg(feature = "cli")]
+pub use structopt;
+#[cfg(feature = "cli")]
+pub use structopt::clap;
+#[cfg(feature = "cli")]
+pub use structopt_utilities;
+
 pub mod bytes_format;
 pub mod data_tree;
 pub mod fs_tree_builder;
@@ -16,15 +34,5 @@ pub mod status_board;
 pub mod tree_builder;
 pub mod visualizer;
 
-/// The main program.
-pub fn main() {
-    if let Err(error) = app::App::from_env().run() {
-        eprintln!("[error] {}", error);
-    }
-}
-
-pub use structopt;
-pub use structopt::clap;
-pub use structopt_utilities;
 pub use strum;
 pub use zero_copy_pads;

src/visualizer/direction.rs

@@ -8,6 +8,7 @@ pub enum Direction {
 }
 
 impl Direction {
+    #[cfg(feature = "cli")]
     pub(crate) const fn from_top_down(top_down: bool) -> Self {
         if top_down {
             Direction::TopDown

test.sh

@@ -0,0 +1,45 @@
+#! /bin/bash
+set -o errexit -o pipefail -o nounset
+
+run() {
+  echo >&2
+  echo "exec> $*" >&2
+  "$@"
+}
+
+skip() {
+  echo >&2
+  echo "skip> $*" >&2
+}
+
+run_if() {
+  condition="$1"
+  shift
+  case "$condition" in
+  true) run "$@" ;;
+  false) skip "$@" ;;
+  *)
+    echo "error: Invalid condition: $condition" >&2
+    exit 1
+    ;;
+  esac
+}
+
+flags=("$@")
+build_flags=()
+test_flags=()
+eval "build_flags+=(${BUILD_FLAGS:-})"
+eval "test_flags+=(${TEST_FLAGS:-})"
+unit() {
+  arguments=("$@" "${flags[@]}")
+  run_if "${LINT:-true}" cargo clippy "${arguments[@]}" -- -D warnings
+  run_if "${BUILD:-true}" cargo build "${build_flags[@]}" "${arguments[@]}"
+  run_if "${TEST:-true}" cargo test "${test_flags[@]}" "${arguments[@]}"
+}
+
+run_if "${FMT:-true}" cargo fmt
+unit
+unit --no-default-features
+unit --all-features
+unit --features cli
+unit --features cli-completions