✨ Gate querying behind a feature

Author: bash

.github/workflows/ci.yml

@@ -40,8 +40,8 @@ jobs:
       run: rustup override set '${{matrix.rust-version}}'
     - name: Build
       run: cargo build --workspace --all-features
-    - name: Check fallback implementation
-      run: just check-unsupported
+    - name: Check
+      run: just check
   docs:
     name: Docs
     runs-on: ubuntu-latest

Justfile

@@ -9,8 +9,16 @@ test-package name *args:
     cargo package -p "{{name}}" {{args}}
     (cd $CARGO_TARGET_DIR/package/{{name}}-*/ && cargo test)
 
+check: clippy check-no-default-features check-unsupported
+
+clippy:
+    cargo clippy --workspace --tests --all-features --all-targets
+
+check-no-default-features:
+    cargo clippy -p terminal-colorsaurus --no-default-features
+
 check-unsupported:
-    RUSTFLAGS='--cfg terminal_colorsaurus_test_unsupported -Dwarnings' cargo check --workspace
+    RUSTFLAGS='--cfg terminal_colorsaurus_test_unsupported -Dwarnings' cargo clippy --workspace
 
 doc:
     cargo +nightly docs-rs -p terminal-colorsaurus

crates/terminal-colorsaurus/Cargo.toml

@@ -11,23 +11,27 @@ edition = "2021"
 rust-version = "1.70.0" # Search for `FIXME(msrv)` when bumping.
 exclude = [".github", ".gitignore", "*.sh", "benchmark/**/*", "doc/issues.md", "deny.toml"]
 
+[features]
+default = ["query"]
+query = ["dep:memchr", "dep:mio", "dep:terminal-trx", "dep:libc", "dep:windows-sys"]
+
 [dependencies]
 rgb = { version = "0.8.37", optional = true }
 anstyle = { version = "1.0.7", optional = true }
 cfg-if = "1.0.0"
 
+[target.'cfg(any(unix, windows))'.dependencies]
+memchr = { version = "2.7.1", optional = true }
+terminal-trx = { version = "0.2.3", optional = true }
+
 [target.'cfg(unix)'.dependencies]
-memchr = "2.7.1"
-mio = { version = "1", features = ["os-ext"], default-features = false }
-terminal-trx = "0.2.3"
+mio = { version = "1", features = ["os-ext"], default-features = false, optional = true }
 
 [target.'cfg(target_os = "macos")'.dependencies]
-libc = "0.2.151"
+libc = { version = "0.2.151", optional = true }
 
 [target.'cfg(windows)'.dependencies]
-memchr = "2.7.1"
-terminal-trx = "0.2.3"
-windows-sys = { version = "0.59.0", features = ["Win32_System_Threading"] } # Keep this in sync with terminal-trx's version to avoid duplicate deps.
+windows-sys = { version = "0.59.0", features = ["Win32_System_Threading"], optional = true } # Keep this in sync with terminal-trx's version to avoid duplicate deps.
 
 [lints.rust]
 missing_debug_implementations = "warn"

crates/terminal-colorsaurus/src/lib.rs

@@ -40,7 +40,6 @@
 //! * [`anstyle`] — Enable this feature to convert [`Color`] to [`anstyle::RgbColor`].
 
 use cfg_if::cfg_if;
-use std::time::Duration;
 
 mod color;
 mod error;
@@ -51,11 +50,13 @@ pub mod parse {
     pub use crate::xparsecolor::xparsecolor;
 }
 
+mod xparsecolor;
+
+#[cfg(feature = "query")]
 cfg_if! {
     if #[cfg(all(any(unix, windows), not(terminal_colorsaurus_test_unsupported)))] {
         mod io;
         mod quirks;
-        mod xparsecolor;
         mod xterm;
         use xterm as imp;
     } else {
@@ -92,6 +93,7 @@ pub use color::*;
 
 /// The color palette i.e. foreground and background colors of the terminal.
 /// Retrieved by calling [`color_palette`].
+#[cfg(feature = "query")]
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[non_exhaustive]
 pub struct ColorPalette {
@@ -105,6 +107,7 @@ pub struct ColorPalette {
 ///
 /// The easiest way to retrieve the color scheme
 /// is by calling [`color_scheme`].
+#[cfg(feature = "query")]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
 #[allow(clippy::exhaustive_enums)]
 #[doc(alias = "Theme")]
@@ -116,8 +119,10 @@ pub enum ColorScheme {
     Light,
 }
 
+#[cfg(feature = "query")]
 const PERCEPTUAL_MIDDLE_GRAY: u8 = 50;
 
+#[cfg(feature = "query")]
 impl ColorPalette {
     /// Determines if the terminal uses a dark or light background.
     pub fn color_scheme(&self) -> ColorScheme {
@@ -139,6 +144,7 @@ pub use error::Error;
 
 /// Options to be used with [`foreground_color`] and [`background_color`].
 /// You should almost always use the unchanged [`QueryOptions::default`] value.
+#[cfg(feature = "query")]
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[non_exhaustive]
 pub struct QueryOptions {
@@ -151,32 +157,36 @@ pub struct QueryOptions {
     /// almost always be detected as such before this timeout elapses.
     ///
     /// See [Feature Detection](`feature_detection`) for details on how this works.
-    pub timeout: Duration,
+    pub timeout: std::time::Duration,
 }
 
+#[cfg(feature = "query")]
 impl Default for QueryOptions {
     fn default() -> Self {
         Self {
-            timeout: Duration::from_secs(1),
+            timeout: std::time::Duration::from_secs(1),
         }
     }
 }
 
 /// Detects if the terminal is dark or light.
+#[cfg(feature = "query")]
 #[doc = include_str!("../doc/caveats.md")]
 #[doc(alias = "theme")]
 pub fn color_scheme(options: QueryOptions) -> Result<ColorScheme> {
     color_palette(options).map(|p| p.color_scheme())
 }
 
 /// Queries the terminal for it's color scheme (foreground and background color).
+#[cfg(feature = "query")]
 #[doc = include_str!("../doc/caveats.md")]
 pub fn color_palette(options: QueryOptions) -> Result<ColorPalette> {
     imp::color_palette(options)
 }
 
 /// Queries the terminal for it's foreground color. \
 /// If you also need the foreground color it is more efficient to use [`color_palette`] instead.
+#[cfg(feature = "query")]
 #[doc = include_str!("../doc/caveats.md")]
 #[doc(alias = "fg")]
 pub fn foreground_color(options: QueryOptions) -> Result<Color> {
@@ -185,6 +195,7 @@ pub fn foreground_color(options: QueryOptions) -> Result<Color> {
 
 /// Queries the terminal for it's background color. \
 /// If you also need the foreground color it is more efficient to use [`color_palette`] instead.
+#[cfg(feature = "query")]
 #[doc = include_str!("../doc/caveats.md")]
 #[doc(alias = "bg")]
 pub fn background_color(options: QueryOptions) -> Result<Color> {