Make serde an optional dependency

Author: benwebber

Cargo.toml

@@ -14,19 +14,20 @@ categories = ["command-line-utilities"]
 
 [dependencies]
 pulldown-cmark = "0.13.0"
-serde = { version = "1.0.219", features = ["derive"] }
+version-compare = "0.2.0"
 clap = { version = "4.5.45", features = ["cargo"], optional = true }
 owo-colors = { version = "4.2.2", features = ["supports-colors"], optional = true }
+serde = { version = "1.0.219", features = ["derive"], optional = true }
 serde_json = { version = "1.0.143", optional = true }
-version-compare = "0.2.0"
 toml = { version = "0.9.5", features = ["parse", "serde"], optional = true }
 
 [dev-dependencies]
 criterion = "0.3"
 insta = { version = "1.43.1", features = ["redactions", "yaml"] }
 
 [features]
-cli = ["dep:clap", "dep:serde_json", "dep:owo-colors", "dep:toml"]
+cli = ["serde", "dep:clap", "dep:serde_json", "dep:owo-colors", "dep:toml"]
+serde = ["dep:serde"]
 
 [lib]
 name = "notabene"

src/ast/block.rs

@@ -1,33 +1,38 @@
 //! AST block elements.
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 use crate::span::Span;
 
 /// A block element.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub enum Block {
     Heading(Heading),
     Paragraph(Literal),
     List(List),
 }
 
 /// An inline element.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub enum Inline {
     Link(Link),
     Literal(Literal),
 }
 
 /// A section heading.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Heading {
     pub span: Span,
     pub level: usize,
     pub inlines: Vec<Inline>,
 }
 
 /// A link.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Link {
     pub span: Span,
     pub content: Literal,
@@ -36,13 +41,15 @@ pub struct Link {
 }
 
 /// Literal markup.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Literal {
     pub span: Span,
 }
 
 /// An unordered list.
-#[derive(Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct List {
     pub span: Span,
     pub items: Vec<Literal>,

src/changelog/parsed.rs

@@ -1,6 +1,7 @@
 //! Borrowed versions of changelog types.
 //!
 //! These types also contain location information, used by the [`Linter`](crate::linter::Linter).
+#[cfg(feature = "serde")]
 use serde::Serialize;
 
 use crate::span::{Locator, Span, Spanned};
@@ -10,7 +11,8 @@ use super::{owned, traits};
 
 type SpannedStr<'a> = Spanned<&'a str>;
 
-#[derive(Debug, Default, PartialEq, Serialize)]
+#[derive(Debug, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub struct ParsedChangelog<'a> {
     pub(crate) source: &'a str,
     pub(crate) title: Option<SpannedStr<'a>>,
@@ -19,14 +21,16 @@ pub struct ParsedChangelog<'a> {
     pub(crate) invalid_spans: Vec<InvalidSpan>,
 }
 
-#[derive(Debug, Default, PartialEq, Serialize)]
+#[derive(Debug, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub struct ParsedUnreleased<'a> {
     pub(crate) heading_span: Span,
     pub(crate) url: Option<String>,
     pub(crate) changes: Vec<ParsedChanges<'a>>,
 }
 
-#[derive(Debug, Default, PartialEq, Serialize)]
+#[derive(Debug, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub struct ParsedRelease<'a> {
     pub(crate) heading_span: Span,
     pub(crate) version: SpannedStr<'a>,
@@ -36,14 +40,16 @@ pub struct ParsedRelease<'a> {
     pub(crate) changes: Vec<ParsedChanges<'a>>,
 }
 
-#[derive(Debug, Default, PartialEq, Serialize)]
+#[derive(Debug, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub struct ParsedChanges<'a> {
     pub(crate) heading_span: Span,
     pub(crate) kind: SpannedStr<'a>,
     pub(crate) items: Vec<SpannedStr<'a>>,
 }
 
-#[derive(Debug, PartialEq, Serialize)]
+#[derive(Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub enum InvalidSpan {
     InvalidTitle(Span),
     InvalidSectionHeading(Span),

src/diagnostic.rs

@@ -2,6 +2,7 @@
 use std::ops::Range;
 use std::path::PathBuf;
 
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 use crate::rule::Rule;
@@ -13,7 +14,8 @@ use crate::span::{Locator, Position, Ranged, Span};
 /// [`Diagnostic::new`] accepts a `Span`.
 ///
 /// Use [`Diagnostic::locate`] to convert a `Diagnostic<Span>` to a `Diagnostic<Position>`.
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[derive(Clone, Debug, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Diagnostic<L = Span> {
     /// The rule that was violated.
     pub rule: Rule,

src/rule.rs

@@ -2,7 +2,9 @@
 use std::collections::HashMap;
 use std::sync::LazyLock;
 
+#[cfg(feature = "serde")]
 use serde::de::{self, Visitor};
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Deserializer, Serialize};
 
 pub static RULES_BY_CODE: LazyLock<HashMap<String, Rule>> = LazyLock::new(|| {
@@ -15,7 +17,8 @@ pub static RULES_BY_CODE: LazyLock<HashMap<String, Rule>> = LazyLock::new(|| {
 macro_rules! rules {
     ($($rule:ident = ($doc:literal, $code:literal, $message:literal $(,)?)),* $(,)?) => {
         /// A linter rule.
-        #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, Serialize)]
+        #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+        #[cfg_attr(feature = "serde", derive(Serialize))]
         #[non_exhaustive]
         pub enum Rule {
             $(#[doc = concat!("`", $code, "`. ")] #[doc = $doc] $rule),*
@@ -162,6 +165,7 @@ impl TryFrom<&str> for Rule {
     }
 }
 
+#[cfg(feature = "serde")]
 impl<'de> Deserialize<'de> for Rule {
     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
     where

src/span.rs

@@ -1,6 +1,7 @@
 //! Work with spans within the source document.
 use std::ops::{Deref, Range};
 
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 mod iter;
@@ -16,17 +17,17 @@ pub use unist::{Point, Position};
 /// A span within the source document.
 ///
 /// Use [`Locator`] to convert a `Span` to a [`Position`].
-#[derive(
-    Copy, Clone, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord, Deserialize, Serialize,
-)]
+#[derive(Copy, Clone, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Span {
     /// The start offset of the span.
     pub start: usize,
     /// The end offset of the span.
     pub end: usize,
 }
 
-#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq, Serialize)]
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize))]
 pub(crate) struct Spanned<T> {
     pub span: Span,
     pub value: T,

src/span/unist.rs

@@ -1,5 +1,6 @@
 use std::ops::Range;
 
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 use crate::span::Ranged;
@@ -8,14 +9,16 @@ use crate::span::Ranged;
 ///
 /// Like [`Span`](crate::span::Span), `Position` represents a span within the source document.
 /// `Position` also includes line and column information.
-#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialEq, PartialOrd, Deserialize, Serialize)]
+#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Position {
     pub start: Point,
     pub end: Point,
 }
 
 /// A unist [Point](https://github.com/syntax-tree/unist/tree/3.0.0?tab=readme-ov-file#point).
-#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialEq, PartialOrd, Deserialize, Serialize)]
+#[derive(Copy, Clone, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 pub struct Point {
     pub line: usize,
     pub column: usize,