feat!: Rename serde1 cargo feature to serde and use the weak-deps cargo capability. (#814)

With it it's possible to not automatically declare all optional dependencies externally visible
features, and thus re-use feature names that oterwise are also a crate name.

Previously I thought that `serde1` is for future-proofing and supporting multiple serde versions
at the same time. However, it's most definitely a burden I wouldn't want anyway, so using
`serde` seems to be the way to go into the future.

Author: Byron

Cargo.toml

@@ -33,7 +33,7 @@ fast = ["gix/max-performance", "gix/comfort"]
 ## Use `clap` 3.0 to build the prettiest, best documented and most user-friendly CLI at the expense of binary size.
 ## Provides a terminal user interface for detailed and exhaustive progress.
 ## Provides a line renderer for leaner progress display, without the need for a full-blown TUI.
-pretty-cli = [ "gitoxide-core/serde1", "prodash/progress-tree", "prodash/progress-tree-log", "prodash/local-time", "env_logger/humantime", "env_logger/color", "env_logger/auto-color" ]
+pretty-cli = [ "gitoxide-core/serde", "prodash/progress-tree", "prodash/progress-tree-log", "prodash/local-time", "env_logger/humantime", "env_logger/color", "env_logger/auto-color" ]
 
 ## The `--verbose` flag will be powered by an interactive progress mechanism that doubles as log as well as interactive progress
 ## that appears after a short duration.

Makefile

@@ -77,17 +77,17 @@ check: ## Build all code in suitable configurations
 					&& cargo check
 	cd gix-object && cargo check --all-features \
                   && cargo check --features verbose-object-parsing-errors
-	cd gix-index && cargo check --features serde1
-	cd gix-credentials && cargo check --features serde1
-	cd gix-sec && cargo check --features serde1
-	cd gix-revision && cargo check --features serde1
-	cd gix-attributes && cargo check --features serde1
-	cd gix-glob && cargo check --features serde1
-	cd gix-mailmap && cargo check --features serde1
-	cd gix-worktree && cargo check --features serde1
-	cd gix-actor && cargo check --features serde1
-	cd gix-date && cargo check --features serde1
-	cd gix-pack && cargo check --features serde1 \
+	cd gix-index && cargo check --features serde
+	cd gix-credentials && cargo check --features serde
+	cd gix-sec && cargo check --features serde
+	cd gix-revision && cargo check --features serde
+	cd gix-attributes && cargo check --features serde
+	cd gix-glob && cargo check --features serde
+	cd gix-mailmap && cargo check --features serde
+	cd gix-worktree && cargo check --features serde
+	cd gix-actor && cargo check --features serde
+	cd gix-date && cargo check --features serde
+	cd gix-pack && cargo check --features serde \
 			   && cargo check --features pack-cache-lru-static \
 			   && cargo check --features pack-cache-lru-dynamic \
 			   && cargo check --features object-cache-dynamic \
@@ -138,7 +138,7 @@ check: ## Build all code in suitable configurations
 					  && cargo check --no-default-features --features max-performance-safe \
 					  && cargo check --no-default-features --features progress-tree \
 					  && cargo check --no-default-features
-	cd gix-odb && cargo check --features serde1
+	cd gix-odb && cargo check --features serde
 	cd cargo-smart-release && cargo check --all
 
 unit-tests: ## run all unit tests

gitoxide-core/Cargo.toml

@@ -33,7 +33,7 @@ async-client = ["gix/async-network-client-async-std", "gix-transport-configurati
 
 #! ### Other
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
-serde1 = ["gix-commitgraph/serde1", "gix/serde1", "serde_json", "serde", "bytesize/serde"]
+serde = ["gix-commitgraph/serde", "gix/serde", "serde_json", "dep:serde", "bytesize/serde"]
 
 
 [dependencies]
@@ -73,5 +73,5 @@ rusqlite = { version = "0.29.0", optional = true, features = ["bundled"] }
 document-features = { version = "0.2.0", optional = true }
 
 [package.metadata.docs.rs]
-features = ["document-features", "blocking-client", "organize", "estimate-hours", "serde1"]
+features = ["document-features", "blocking-client", "organize", "estimate-hours", "serde"]
 rustdoc-args = ["--cfg", "docsrs"]

gitoxide-core/src/commitgraph/verify.rs

@@ -46,10 +46,10 @@ where
         .verify_integrity(noop_processor)
         .with_context(|| "Verification failure")?;
 
-    #[cfg_attr(not(feature = "serde1"), allow(clippy::single_match))]
+    #[cfg_attr(not(feature = "serde"), allow(clippy::single_match))]
     match output_statistics {
         Some(OutputFormat::Human) => drop(print_human_output(&mut out, &stats)),
-        #[cfg(feature = "serde1")]
+        #[cfg(feature = "serde")]
         Some(OutputFormat::Json) => serde_json::to_writer_pretty(out, &stats)?,
         _ => {}
     }

gitoxide-core/src/index/entries.rs

@@ -10,7 +10,7 @@ pub fn entries(
     use crate::OutputFormat::*;
     let file = parse_file(index_path, object_hash)?;
 
-    #[cfg(feature = "serde1")]
+    #[cfg(feature = "serde")]
     if let Json = format {
         out.write_all(b"[\n")?;
     }
@@ -19,19 +19,19 @@ pub fn entries(
     while let Some(entry) = entries.next() {
         match format {
             Human => to_human(&mut out, &file, entry)?,
-            #[cfg(feature = "serde1")]
+            #[cfg(feature = "serde")]
             Json => to_json(&mut out, &file, entry, entries.peek().is_none())?,
         }
     }
 
-    #[cfg(feature = "serde1")]
+    #[cfg(feature = "serde")]
     if let Json = format {
         out.write_all(b"]\n")?;
     }
     Ok(())
 }
 
-#[cfg(feature = "serde1")]
+#[cfg(feature = "serde")]
 pub(crate) fn to_json(
     mut out: &mut impl std::io::Write,
     file: &gix::index::File,
@@ -40,7 +40,7 @@ pub(crate) fn to_json(
 ) -> anyhow::Result<()> {
     use gix::bstr::ByteSlice;
 
-    #[cfg_attr(feature = "serde1", derive(serde::Serialize))]
+    #[cfg_attr(feature = "serde", derive(serde::Serialize))]
     struct Entry<'a> {
         stat: &'a gix::index::entry::Stat,
         hex_id: String,

gitoxide-core/src/index/information.rs

@@ -4,7 +4,7 @@ pub struct Options {
     pub extension_details: bool,
 }
 
-#[cfg(feature = "serde1")]
+#[cfg(feature = "serde")]
 mod serde_only {
 
     mod ext {
@@ -153,5 +153,5 @@ mod serde_only {
         }
     }
 }
-#[cfg(feature = "serde1")]
+#[cfg(feature = "serde")]
 pub(crate) use serde_only::Collection;

gitoxide-core/src/index/mod.rs

@@ -39,14 +39,14 @@ pub fn verify(
     file.verify_integrity()?;
     file.verify_entries()?;
     file.verify_extensions(false, gix::index::verify::extensions::no_find)?;
-    #[cfg_attr(not(feature = "serde1"), allow(irrefutable_let_patterns))]
+    #[cfg_attr(not(feature = "serde"), allow(irrefutable_let_patterns))]
     if let crate::OutputFormat::Human = format {
         writeln!(out, "OK").ok();
     }
     Ok(())
 }
 
-#[cfg_attr(not(feature = "serde1"), allow(unused_variables, unused_mut))]
+#[cfg_attr(not(feature = "serde"), allow(unused_variables, unused_mut))]
 pub fn information(
     index_path: impl AsRef<Path>,
     out: impl std::io::Write,
@@ -60,7 +60,7 @@ pub fn information(
     }: information::Options,
 ) -> anyhow::Result<()> {
     use crate::OutputFormat::*;
-    #[cfg(feature = "serde1")]
+    #[cfg(feature = "serde")]
     if let Human = format {
         writeln!(err, "Defaulting to JSON printing as nothing else will be implemented.").ok();
         format = Json;
@@ -69,7 +69,7 @@ pub fn information(
         Human => {
             anyhow::bail!("Cannot print information using 'human' format.")
         }
-        #[cfg(feature = "serde1")]
+        #[cfg(feature = "serde")]
         Json => {
             let info = information::Collection::try_from_file(parse_file(index_path, object_hash)?, extension_details)?;
             serde_json::to_writer_pretty(out, &info)?;

gitoxide-core/src/lib.rs

@@ -35,15 +35,15 @@ use std::str::FromStr;
 #[derive(Debug, Eq, PartialEq, Hash, Clone, Copy)]
 pub enum OutputFormat {
     Human,
-    #[cfg(feature = "serde1")]
+    #[cfg(feature = "serde")]
     Json,
 }
 
 impl OutputFormat {
     pub fn variants() -> &'static [&'static str] {
         &[
             "human",
-            #[cfg(feature = "serde1")]
+            #[cfg(feature = "serde")]
             "json",
         ]
     }
@@ -56,7 +56,7 @@ impl FromStr for OutputFormat {
         let s_lc = s.to_ascii_lowercase();
         Ok(match s_lc.as_str() {
             "human" => OutputFormat::Human,
-            #[cfg(feature = "serde1")]
+            #[cfg(feature = "serde")]
             "json" => OutputFormat::Json,
             _ => return Err(format!("Invalid output format: '{}'", s)),
         })

gitoxide-core/src/pack/create.rs

@@ -314,7 +314,7 @@ where
 fn print(stats: Statistics, format: OutputFormat, out: impl std::io::Write) -> anyhow::Result<()> {
     match format {
         OutputFormat::Human => human_output(stats, out).map_err(Into::into),
-        #[cfg(feature = "serde1")]
+        #[cfg(feature = "serde")]
         OutputFormat::Json => serde_json::to_writer_pretty(out, &stats).map_err(Into::into),
     }
 }
@@ -365,7 +365,7 @@ fn human_output(
 }
 
 #[derive(Default)]
-#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 struct Statistics {
     counts: pack::data::output::count::objects::Outcome,
     entries: pack::data::output::entry::iter_from_counts::Outcome,

gitoxide-core/src/pack/index.rs

@@ -121,7 +121,7 @@ where
     .with_context(|| "Failed to write pack and index")?;
     match format {
         OutputFormat::Human => drop(human_output(out, res)),
-        #[cfg(feature = "serde1")]
+        #[cfg(feature = "serde")]
         OutputFormat::Json => serde_json::to_writer_pretty(out, &res)?,
     };
     Ok(())