feat(message-parser): LineBreak token and OrderedListItem digit (#720)

feat(message-parser): LineBreak token and OrderedListItem digit

Author: gabriellsh

packages/message-parser/src/definitions.ts

@@ -5,7 +5,7 @@ export type Blockquote = {
 
 export type OrderedList = {
   type: 'ORDERED_LIST';
-  value: ListItem[];
+  value: OrderedListItem[];
 };
 
 export type UnorderedList = {
@@ -18,6 +18,11 @@ export type ListItem = {
   value: Inlines[];
 };
 
+export type OrderedListItem = {
+  type: 'ORDERED_LIST_ITEM';
+  value: { digit: string; text: Inlines[] };
+};
+
 export type Tasks = {
   type: 'TASKS';
   value: Task[];
@@ -98,6 +103,11 @@ export type Plain = {
   value: string;
 };
 
+export type LineBreak = {
+  type: 'LINE_BREAK';
+  value: string;
+};
+
 export type Paragraph = {
   type: 'PARAGRAPH';
   value: Array<Exclude<Inlines, Paragraph>>;
@@ -150,8 +160,10 @@ export type Types = {
   TASK: Task;
   UNORDERED_LIST: UnorderedList;
   ORDERED_LIST: OrderedList;
+  ORDERED_LIST_ITEM: OrderedListItem;
   LIST_ITEM: ListItem;
   IMAGE: Image;
+  LINE_BREAK: LineBreak;
 };
 
 export type ASTNode =
@@ -195,6 +207,7 @@ export type Blocks =
   | ListItem
   | Tasks
   | OrderedList
-  | UnorderedList;
+  | UnorderedList
+  | LineBreak;
 
 export type MarkdownAST = Array<Paragraph | Blocks> | [BigEmoji];

packages/message-parser/src/grammar.pegjs

@@ -22,7 +22,9 @@
     task,
     orderedList,
     listItem,
+    orderedListItem,
     unorderedList,
+    lineBreak,
   } = require('./utils');
 }
 
@@ -32,6 +34,8 @@ start
 
 b = (EndOfLine / Space)*
 
+LineBreak = (Space* EndOfLine) { return lineBreak(''); }
+
 BigEmoji
   = b e1:Emoji b e2:Emoji? b e3:Emoji? b {
       return [bigEmoji([e1, e2, e3].filter(Boolean))];
@@ -44,6 +48,7 @@ Blocks
   / TaskList
   / OrderedList
   / UnorderedList
+  / LineBreak
 
 // / Section
 
@@ -96,13 +101,6 @@ line
 
 EOF = !.
 
-crlf
-  = "\r\n"
-  / "\r"
-  / "\n"
-
-EatLine = (!crlf !EOF .)*
-
 EndOfLine
   = "\r\n"
   / "\n"
@@ -303,7 +301,7 @@ UnorderedListItem__Inline
 OrderedList = lists:OrderedListItem+ { return orderedList(lists); }
 
 OrderedListItem
-  = (digit1_9+ "\x2E ") text:Inline { return listItem(text, true); }
+  = d:digits "\x2E " text:Inline { return orderedListItem(d, text); }
 
 Codetype = t:[a-zA-Z0-9 \_\-.]+ { return t.join(''); }
 

packages/message-parser/src/utils.ts

@@ -7,6 +7,7 @@ import type {
   Paragraph,
   Types,
   Task,
+  Inlines,
 } from './definitions';
 
 const generate =
@@ -86,7 +87,10 @@ export const unorderedList = generate('UNORDERED_LIST');
 
 export const listItem = generate('LIST_ITEM');
 
-export const list = generate('ORDERED_LIST');
+export const orderedListItem = (() => {
+  const fn = generate('ORDERED_LIST_ITEM');
+  return (digit: string, text: Inlines[]) => fn({ digit, text });
+})();
 
 export const mentionUser = (() => {
   const fn = generate('MENTION_USER');
@@ -112,3 +116,5 @@ export const reducePlainTexts = (
 
     return [...result, item];
   }, [] as Paragraph['value']);
+
+export const lineBreak = generate('LINE_BREAK');

packages/message-parser/tests/lineBreak.test.ts

@@ -0,0 +1,35 @@
+import { parser } from '../src';
+import { lineBreak, paragraph, plain } from '../src/utils';
+
+test.each([
+  [
+    `test
+
+test2`,
+    [paragraph([plain('test')]), lineBreak(''), paragraph([plain('test2')])],
+  ],
+  [
+    `test
+
+test2
+`,
+    [paragraph([plain('test')]), lineBreak(''), paragraph([plain('test2')])],
+  ],
+  [
+    `test
+
+
+
+test2
+`,
+    [
+      paragraph([plain('test')]),
+      lineBreak(''),
+      lineBreak(''),
+      lineBreak(''),
+      paragraph([plain('test2')]),
+    ],
+  ],
+])('parses %p', (input, output) => {
+  expect(parser(input)).toMatchObject(output);
+});

packages/message-parser/tests/orderedList.test.ts

@@ -1,42 +1,25 @@
 import { parser } from '../src';
-import { bold, plain, orderedList, listItem } from '../src/utils';
+import { bold, plain, orderedList, orderedListItem } from '../src/utils';
 
 test.each([
   [
     `
-1. First item
+7. First item
 2. Second item
-3. Third item
+8. Third item
 4. *Fourth item*
+15. *Fifteenth item*
 `.trim(),
     [
       orderedList([
-        listItem([plain('First item')]),
-        listItem([plain('Second item')]),
-        listItem([plain('Third item')]),
-        listItem([bold([plain('Fourth item')])]),
+        orderedListItem('7', [plain('First item')]),
+        orderedListItem('2', [plain('Second item')]),
+        orderedListItem('8', [plain('Third item')]),
+        orderedListItem('4', [bold([plain('Fourth item')])]),
+        orderedListItem('15', [bold([plain('Fifteenth item')])]),
       ]),
     ],
   ],
-
-  //   [
-  //     `
-  // 1. First item
-  // 2. Second item
-  // 3. Third item
-  //     1. First item
-  //     2. Second item
-  // 4. *Fourth item*
-  // `.trim(),
-  //     [
-  //       orderedList([
-  //         listItem([plain('First item')]),
-  //         listItem([plain('Second item')]),
-  //         listItem([plain('Third item')]),
-  //         listItem([bold([plain('Fourth item')])]),
-  //       ]),
-  //     ],
-  //   ],
 ])('parses %p', (input, output) => {
   expect(parser(input)).toMatchObject(output);
 });