Add serde (de)serializing to configuration

Closes GH-70.

Co-authored-by: George Fischer <[email protected]>

Author: wooorm

src/configuration.rs

@@ -20,7 +20,7 @@
 //!   — enable logging (includes `dep:log`);
 //!   you can show logs with `RUST_LOG=debug`
 //! * **`serde`**
-//!   — enable serde to serialize the AST (includes `dep:serde`)
+//!   — enable serde to serialize ASTs and configuration (includes `dep:serde`)
 
 #![no_std]
 #![deny(clippy::pedantic)]

src/lib.rs

@@ -16,6 +16,7 @@ use alloc::{str::FromStr, string::String};
 /// # }
 /// ```
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum LineEnding {
     /// Both a carriage return (`\r`) and a line feed (`\n`).
     ///
@@ -25,6 +26,7 @@ pub enum LineEnding {
     /// a␍␊
     /// b
     /// ```
+    #[cfg_attr(feature = "serde", serde(rename = "\r\n"))]
     CarriageReturnLineFeed,
     /// Sole carriage return (`\r`).
     ///
@@ -34,6 +36,7 @@ pub enum LineEnding {
     /// a␍
     /// b
     /// ```
+    #[cfg_attr(feature = "serde", serde(rename = "\r"))]
     CarriageReturn,
     /// Sole line feed (`\n`).
     ///
@@ -44,6 +47,7 @@ pub enum LineEnding {
     /// b
     /// ```
     #[default]
+    #[cfg_attr(feature = "serde", serde(rename = "\n"))]
     LineFeed,
 }
 

src/util/line_ending.rs

@@ -240,8 +240,8 @@ fn image() -> Result<(), message::Message> {
             "![](javascript:alert(1))",
             &Options {
                 compile: CompileOptions {
-                    allow_dangerous_protocol: false,
                     allow_any_img_src: true,
+                    allow_dangerous_protocol: false,
                     ..Default::default()
                 },
                 ..Default::default()

tests/image.rs

@@ -9,6 +9,45 @@ enum Error {
     Serde(serde_json::Error),
 }
 
+#[test]
+#[cfg(feature = "serde")]
+fn serde_constructs() -> Result<(), Error> {
+    use pretty_assertions::assert_eq;
+
+    assert_eq!(
+        serde_json::to_string(&Constructs::default()).unwrap(),
+        r#"{"attention":true,"autolink":true,"blockQuote":true,"characterEscape":true,"characterReference":true,"codeIndented":true,"codeFenced":true,"codeText":true,"definition":true,"frontmatter":false,"gfmAutolinkLiteral":false,"gfmFootnoteDefinition":false,"gfmLabelStartFootnote":false,"gfmStrikethrough":false,"gfmTable":false,"gfmTaskListItem":false,"hardBreakEscape":true,"hardBreakTrailing":true,"headingAtx":true,"headingSetext":true,"htmlFlow":true,"htmlText":true,"labelStartImage":true,"labelStartLink":true,"labelEnd":true,"listItem":true,"mathFlow":false,"mathText":false,"mdxEsm":false,"mdxExpressionFlow":false,"mdxExpressionText":false,"mdxJsxFlow":false,"mdxJsxText":false,"thematicBreak":true}"#
+    );
+
+    Ok(())
+}
+
+#[test]
+#[cfg(feature = "serde")]
+fn serde_compile_options() -> Result<(), Error> {
+    use pretty_assertions::assert_eq;
+
+    assert_eq!(
+        serde_json::to_string(&markdown::CompileOptions::gfm()).unwrap(),
+        r#"{"allowAnyImgSrc":false,"allowDangerousHtml":false,"allowDangerousProtocol":false,"defaultLineEnding":"\n","gfmFootnoteBackLabel":null,"gfmFootnoteClobberPrefix":null,"gfmFootnoteLabelAttributes":null,"gfmFootnoteLabelTagName":null,"gfmFootnoteLabel":null,"gfmTaskListItemCheckable":false,"gfmTagfilter":true}"#
+    );
+
+    Ok(())
+}
+
+#[test]
+#[cfg(feature = "serde")]
+fn serde_parse_options() -> Result<(), Error> {
+    use pretty_assertions::assert_eq;
+
+    assert_eq!(
+        serde_json::to_string(&ParseOptions::gfm()).unwrap(),
+        r#"{"constructs":{"attention":true,"autolink":true,"blockQuote":true,"characterEscape":true,"characterReference":true,"codeIndented":true,"codeFenced":true,"codeText":true,"definition":true,"frontmatter":false,"gfmAutolinkLiteral":true,"gfmFootnoteDefinition":true,"gfmLabelStartFootnote":true,"gfmStrikethrough":true,"gfmTable":true,"gfmTaskListItem":true,"hardBreakEscape":true,"hardBreakTrailing":true,"headingAtx":true,"headingSetext":true,"htmlFlow":true,"htmlText":true,"labelStartImage":true,"labelStartLink":true,"labelEnd":true,"listItem":true,"mathFlow":false,"mathText":false,"mdxEsm":false,"mdxExpressionFlow":false,"mdxExpressionText":false,"mdxJsxFlow":false,"mdxJsxText":false,"thematicBreak":true},"gfmStrikethroughSingleTilde":true,"mathTextSingleDollar":true}"#
+    );
+
+    Ok(())
+}
+
 #[test]
 fn serde_blockquote() -> Result<(), Error> {
     assert_serde(
@@ -680,9 +719,9 @@ fn serde_paragraph() -> Result<(), Error> {
     )
 }
 
-/// Assert serde of Mdast constructs.
+/// Assert serde of mdast constructs.
 ///
-/// Refer below links for the MDAST JSON construct types.
+/// Refer below links for the mdast JSON construct types.
 /// * <https://github.com/syntax-tree/mdast#nodes>
 /// * <https://github.com/syntax-tree/mdast-util-mdx#syntax-tree>
 /// * <https://github.com/syntax-tree/mdast-util-frontmatter#syntax-tree>
@@ -705,6 +744,7 @@ fn assert_serde(input: &str, expected: &str, options: ParseOptions) -> Result<()
         source,
         serde_json::from_value(actual_value).map_err(Error::Serde)?
     );
+
     Ok(())
 }
 

tests/serde.rs

@@ -1,7 +1,5 @@
 //! Bridge between `markdown-rs` and SWC.
 
-extern crate markdown;
-
 use crate::test_utils::swc_utils::{create_span, RewritePrefixContext};
 use markdown::{MdxExpressionKind, MdxSignal};
 use std::rc::Rc;