refactor: put serde functionality behind a feature flag (#36)

* refactor: put `serde` functionality behind a feature flag

* ci: check code without default features enabled

* docs: instructions for installing without serialization support, and `rgd` example

Author: Rolv-Apneseth

.github/workflows/check.yml

@@ -34,6 +34,9 @@ jobs:
             - name: Check
               run: cargo check
 
+            - name: Check without default features
+              run: cargo check --no-default-features
+
             - name: Build
               run: cargo build --verbose
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lib_game_detector"
-version = "0.0.24"
+version = "0.0.25"
 edition = "2021"
 description = "A Rust library for detecting and parsing data about games installed on the system"
 readme = "README.md"
@@ -17,7 +17,7 @@ itertools = "0.14"
 thiserror = "2.0"
 steam_shortcuts_util = "1.1"
 walkdir = "2.5"
-serde = { version = "1.0", features = ["derive"] }
+serde = { version = "1.0", features = ["derive"], optional = true }
 
 [dev-dependencies]
 criterion = { version = "0.7", features = ["html_reports"] }
@@ -26,6 +26,7 @@ is-terminal = "0.4"
 test-case = "3.3"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 serde_json = { version = "1.0" }
+lib_game_detector = { path = ".", features = ["serde"] }
 
 [[bench]]
 name = "criterion"
@@ -36,3 +37,7 @@ harness = false
 name = "divan"
 path = "benches/divan.rs"
 harness = false
+
+[features]
+default = ["serde"]
+serde = ["dep:serde"]

README.md

@@ -26,6 +26,13 @@ Install with:
 cargo add lib_game_detector
 ```
 
+Support for serialization via `serde`, which is enabled by default, can be disabled
+by installing with:
+
+```sh
+cargo add lib_game_detector --no-default-features
+```
+
 ## Usage
 
 ```rust
@@ -40,7 +47,8 @@ let all_games_from_steam = detector.get_all_detected_games_from_specific_launche
 
 ## Examples
 
-- See [rofi-games](https://github.com/Rolv-Apneseth/rofi-games) for an example which uses this library to find games and their box art to use for displaying in a launcher
+- Checkout [rofi-games](https://github.com/Rolv-Apneseth/rofi-games) or [rgd](https://github.com/Rolv-Apneseth/rgd)
+  to see this library being used to find games and their box art for displaying in a launcher
 - Check the [examples folder](https://github.com/Rolv-Apneseth/lib_game_detector/tree/main/examples)
 
 ## Currently supported game sources

src/data.rs

@@ -7,11 +7,13 @@ use std::{
     sync::Arc,
 };
 
+#[cfg(feature = "serde")]
 use serde::{Serialize, Serializer};
 
 use crate::error::GamesParsingError;
 
 /// Serialize a type into a string using the debug output
+#[cfg(feature = "serde")]
 fn serialize_debug<S, T>(x: &T, s: S) -> Result<S::Ok, S::Error>
 where
     T: Debug,
@@ -21,7 +23,8 @@ where
 }
 
 /// Data structure which defines all relevant data about any particular game
-#[derive(Debug, Serialize)]
+#[derive(Debug)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub struct Game {
     /// Game title / name.
     pub title: String,
@@ -31,12 +34,14 @@ pub struct Game {
     pub path_box_art: Option<PathBuf>,
     /// Path to the game's root directory (if one was found).
     pub path_game_dir: Option<PathBuf>,
+
     /// Command to launch the game.
     // NOTE: serialized output can be `sh -c "$launch_command"`
-    #[serde(serialize_with = "serialize_debug")]
+    #[cfg_attr(feature = "serde", serde(serialize_with = "serialize_debug"))]
     pub launch_command: Command,
+
     /// Game detection source.
-    #[serde(serialize_with = "serialize_debug")]
+    #[cfg_attr(feature = "serde", serde(serialize_with = "serialize_debug"))]
     pub source: SupportedLaunchers,
 }
 

src/lib.rs

@@ -22,6 +22,13 @@
 //! cargo add lib_game_detector
 //! ```
 //!
+//! Support for serialization via `serde`, which is enabled by default, can be disabled
+//! by installing with:
+//!
+//! ```sh
+//! cargo add lib_game_detector --no-default-features
+//! ```
+//!
 //! # Usage
 //!
 //! ```rust
@@ -36,7 +43,8 @@
 //!
 //! # Examples
 //!
-//! - See [rofi-games](https://github.com/Rolv-Apneseth/rofi-games) for an example which uses this library to find games and their box art to use for displaying in a launcher
+//! - Checkout [rofi-games](https://github.com/Rolv-Apneseth/rofi-games) or [rgd](https://github.com/Rolv-Apneseth/rgd)
+//!   to see this library being used to find games and their box art for displaying in a launcher
 //! - Check the [examples folder](https://github.com/Rolv-Apneseth/lib_game_detector/tree/main/examples)
 //!
 //! # Currently supported game sources