Inline verbatim (#15)

* add inline verbatim * tests: add markup inside verbatim * rename snapshot file
nvim-neorg · Nov 9, 2024 · 055d113 · 055d113
1 parent 21f83af
commit 055d113
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -706,4 +706,21 @@ mod tests {
 
         assert_yaml_snapshot!(examples);
     }
+
+    #[test]
+    fn inline_verbatim() {
+        let examples: Vec<_> = [
+            "some text `inline verbatim`",
+            "`verbatim at start`",
+            "{/ some_link.txt}[with `inline verbatim` in anchor]",
+            "`*markup* /inside/ /-verbatim-/`",
+        ]
+        .into_iter()
+        .map(|example| example.to_string() + "\n")
+        .map(|str| parse(&str))
+        .try_collect()
+        .unwrap();
+
+        assert_yaml_snapshot!(examples);
+    }
 }
diff --git a/src/snapshots/rust_norg__tests__inline_verbatim.snap b/src/snapshots/rust_norg__tests__inline_verbatim.snap
@@ -0,0 +1,57 @@
+---
+source: src/lib.rs
+assertion_line: 588
+expression: examples
+---
+- - Paragraph:
+      - Token:
+          Text: some
+      - Token: Whitespace
+      - Token:
+          Text: text
+      - Token: Whitespace
+      - InlineVerbatim:
+          - Text: inline
+          - Whitespace
+          - Text: verbatim
+- - Paragraph:
+      - InlineVerbatim:
+          - Text: verbatim
+          - Whitespace
+          - Text: at
+          - Whitespace
+          - Text: start
+- - Paragraph:
+      - Link:
+          filepath: ~
+          targets:
+            - Path: some_link.txt
+          description:
+            - Token:
+                Text: with
+            - Token: Whitespace
+            - InlineVerbatim:
+                - Text: inline
+                - Whitespace
+                - Text: verbatim
+            - Token: Whitespace
+            - Token:
+                Text: in
+            - Token: Whitespace
+            - Token:
+                Text: anchor
+- - Paragraph:
+      - InlineVerbatim:
+          - Special: "*"
+          - Text: markup
+          - Special: "*"
+          - Whitespace
+          - Special: /
+          - Text: inside
+          - Special: /
+          - Whitespace
+          - Special: /
+          - Special: "-"
+          - Text: verbatim
+          - Special: "-"
+          - Special: /
diff --git a/src/stage_1.rs b/src/stage_1.rs
@@ -44,7 +44,7 @@ impl From<NorgToken> for String {
 }
 
 /// A list of characters which are considered "special", i.e. for parsing of attached modifiers.
-const SPECIAL_CHARS: &str = "*-~/_!%^,\"'$:@|=.#+<>()[]{}\\";
+const SPECIAL_CHARS: &str = "*-~/_!%^,\"'`$:@|=.#+<>()[]{}\\";
 
 /// Parses a `.norg` document and breaks it up into tokens.
 pub fn stage_1() -> impl Parser<char, Vec<NorgToken>, Error = chumsky::error::Simple<char>> {

diff --git a/src/stage_3.rs b/src/stage_3.rs
@@ -133,6 +133,16 @@ fn paragraph_parser_opener_candidates_and_links() -> impl Parser<
             ParagraphSegment::AttachedModifierOpener((None, modifiers, right))
         });
 
+    let inline_verbatim = just(ParagraphSegmentToken::Special('`'))
+        .ignore_then(
+            just(ParagraphSegmentToken::Special('`'))
+                .not()
+                .repeated()
+                .at_least(1),
+        )
+        .then_ignore(just(ParagraphSegmentToken::Special('`')))
+        .map(|content| ParagraphSegment::InlineVerbatim(content));
+
     let anchor = just(ParagraphSegmentToken::Special('['))
         .ignore_then(
             just(ParagraphSegmentToken::Special(']'))
@@ -230,6 +240,7 @@ fn paragraph_parser_opener_candidates_and_links() -> impl Parser<
                     content: parse_paragraph(content).unwrap(),
                     target: Box::new(link),
                 }),
+            inline_verbatim,
             anchor
                 .clone()
                 .then(anchor.clone().or_not())
@@ -472,6 +483,7 @@ pub enum ParagraphSegment {
         description: Option<Vec<ParagraphSegment>>,
     },
     InlineLinkTarget(Vec<ParagraphSegment>),
+    InlineVerbatim(Vec<ParagraphSegmentToken>),
 }
 
 fn parse_paragraph(