Put CLI deps behind a cli feature

Author: jwodder

.github/workflows/test.yml

@@ -6,6 +6,10 @@ on:
   schedule:
     - cron: '0 12 * * *'
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
@@ -63,7 +67,12 @@ jobs:
         run: cargo build --verbose
 
       - name: Test crate
-        run: cargo hack --optional-deps --feature-powerset test --verbose
+        run: |
+          cargo hack \
+            --optional-deps \
+            --feature-powerset \
+            --exclude-features default \
+            test --verbose
 
   coverage:
     # This is separate from the main tests because cargo-llvm-cov doesn't run
@@ -120,8 +129,13 @@ jobs:
       - name: Install cargo-hack
         uses: taiki-e/install-action@cargo-hack
 
-      - name: Check code
-        run: cargo hack --optional-deps --feature-powerset clippy --all-targets -- -Dwarnings
+      - name: Test crate
+        run: |
+          cargo hack \
+            --optional-deps \
+            --feature-powerset \
+            --exclude-features default \
+            clippy --all-targets -- -Dwarnings
 
       - name: Check formatting
         run: cargo fmt --check

CHANGELOG.md

@@ -2,6 +2,7 @@ v0.5.0 (in development)
 -----------------------
 - Increased MSRV to 1.65
 - Convert error Displays to lowercase per Rust conventions
+- The packages needed soley for the CLI are now behind a default `cli` feature
 
 v0.4.0 (2023-02-15)
 -------------------

Cargo.toml

@@ -12,7 +12,7 @@ categories = ["command-line-utilities"]
 exclude = ["/.*"]
 
 [dependencies]
-lexopt = "0.3.0"
+lexopt = { version = "0.3.0", optional = true }
 serde = { version = "1.0.160", optional = true }
 
 [dev-dependencies]
@@ -24,6 +24,14 @@ serde_json = "1.0.96"
 tempfile = "3.5.0"
 which = "4.4.0"
 
+[features]
+default = ["cli"]
+cli = ["dep:lexopt"]
+
+[[bin]]
+name = "ghrepo"
+required-features = ["cli"]
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]

README.md

@@ -23,14 +23,17 @@ in your Cargo project, add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-ghrepo = "0.4.0"
+# By default, ghrepo depends on some packages only needed for its command-line
+# interface; disable the default features so that these dependencies aren't
+# pulled in when using as a library.
+ghrepo = { version = "0.4.0", default-features = false }
 ```
 
 To use `ghrepo` with its `serde` feature, add the following instead:
 
 ```toml
 [dependencies]
-ghrepo = { version = "0.4.0", features = ["serde"] }
+ghrepo = { version = "0.4.0", default-features = false, features = ["serde"] }
 ```
 
 To install the `ghrepo` command on your system, use `cargo install`:

tests/cli.rs

@@ -1,3 +1,4 @@
+#![cfg(feature = "cli")]
 // Use "pub" to silence some "unused code" warnings
 pub mod repomaker;