feat: add Display for detached modifiers, remove custom to_string…

… code for ParagraphSegmentTokens
nvim-neorg · Aug 15, 2024 · 7a34faf · 7a34faf
1 parent d89c701
commit 7a34faf
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 20 deletions.
diff --git a/src/snapshots/rust_norg__tests__carryover_tags.snap b/src/snapshots/rust_norg__tests__carryover_tags.snap
@@ -35,7 +35,7 @@ expression: examples
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
       next_object:
         Paragraph:
           - Token:
@@ -45,7 +45,7 @@ expression: examples
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
         - "&^@!"
         - third
         - parameter
@@ -98,7 +98,7 @@ expression: examples
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
       next_object:
         Paragraph:
           - Token:
@@ -108,7 +108,7 @@ expression: examples
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
         - "&^@!"
         - third
         - parameter

diff --git a/src/snapshots/rust_norg__tests__infirm_tags.snap b/src/snapshots/rust_norg__tests__infirm_tags.snap
@@ -1,5 +1,5 @@
 ---
-source: src/main.rs
+source: src/lib.rs
 expression: examples
 ---
 - - InfirmTag:
@@ -19,12 +19,12 @@ expression: examples
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
 - - InfirmTag:
       name:
         - tag-name_
       parameters:
-        - one large parameter
+        - "one\\ large\\ parameter"
         - "&^@!"
         - third
         - parameter

diff --git a/src/snapshots/rust_norg__tests__ranged_tags.snap b/src/snapshots/rust_norg__tests__ranged_tags.snap
@@ -21,7 +21,7 @@ expression: examples
         - some-text
         - here
       parameters:
-        - one parameter
+        - "one\\ parameter"
         - second-parameter
       content:
         - CarryoverTag:
@@ -109,7 +109,7 @@ expression: examples
         - some-text
         - here
       parameters:
-        - one parameter
+        - "one\\ parameter"
         - second-parameter
       content:
         - CarryoverTag:

diff --git a/src/snapshots/rust_norg__tests__ranged_verbatim_tags.snap b/src/snapshots/rust_norg__tests__ranged_verbatim_tags.snap
@@ -13,7 +13,7 @@ expression: examples
         - some-text
         - here
       parameters:
-        - lua language
+        - "lua\\ language"
         - second-parameter
       content: "print(\"Hello world!\")\n"
 - - VerbatimRangedTag:

diff --git a/src/stage_2.rs b/src/stage_2.rs
@@ -20,9 +20,7 @@ pub enum ParagraphSegmentToken {
 impl std::fmt::Display for ParagraphSegmentToken {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {
-            // Here, we purposefully strip the `\` backslash from the escape sequence to make
-            // output cleaner. This is unlikely to have any serious consequences.
-            Self::Escape(c) => f.write_char(*c),
+            Self::Escape(c) => write!(f, "\\{}", c),
             Self::Text(str) => f.write_str(str),
             Self::Special(c) => f.write_char(*c),
             Self::Whitespace => f.write_char(' '),

diff --git a/src/stage_3.rs b/src/stage_3.rs
@@ -1,3 +1,5 @@
+use std::fmt::Write;
+
 use chumsky::prelude::*;
 use itertools::Itertools;
 use serde::Serialize;
@@ -11,13 +13,33 @@ pub enum NestableDetachedModifier {
     OrderedList,
 }
 
+impl std::fmt::Display for NestableDetachedModifier {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            Self::Quote => f.write_char('>'),
+            Self::UnorderedList => f.write_char('-'),
+            Self::OrderedList => f.write_char('~'),
+        }
+    }
+}
+
 #[derive(Clone, Hash, Debug, PartialEq, Eq, Serialize)]
 pub enum RangeableDetachedModifier {
     Definition,
     Footnote,
     Table,
 }
 
+impl std::fmt::Display for RangeableDetachedModifier {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            Self::Definition => f.write_char('$'),
+            Self::Footnote => f.write_char('^'),
+            Self::Table => f.write_char(':'),
+        }
+    }
+}
+
 #[derive(Clone, Hash, Debug, PartialEq, Eq, Serialize)]
 pub enum TodoStatus {
     /// ` `
@@ -531,13 +553,8 @@ fn detached_modifier_extensions() -> impl Parser<
                 .map(|tokens| {
                     if let Some(tokens) = tokens {
                         tokens
-                            .iter()
-                            .map(|spec| match spec {
-                                Special(char) => char.to_string(),
-                                Text(str) => str.to_owned(),
-                                Escape(char) => format!(r"\{}", char),
-                                Whitespace => ' '.to_string(),
-                            })
+                            .into_iter()
+                            .map_into::<String>()
                             .collect()
                     } else {
                         String::from("")