Add arguments and return type

https://youtrack.weseek.co.jp/issue/GW-7856
- Define type of ItemListData and NestedItemListData
- Add type for arguments and return value
- Improve buildList method
- Add regex test url in comments
- Improve regex pattern to match ordered list
- Change type of ordered list number from string to number

packages/app/src/services/renderer/PreProcessor/OrderedList.ts

@@ -1,17 +1,31 @@
+type ItemListDataType = {
+  number: number,
+  content: string,
+  level: number
+}
+
+type NestedItemListDataType = ItemListDataType & {
+  children?: NestedItemListDataType[] | null
+}
 export default class OrderedList {
 
   process(markdown) {
-    const orderedListRE = /^(\s*)(\d+\.)(\s)(.*)+?/gm;
+    // Pattern to match ordered list
+    // https://regex101.com/r/JnvoLK/1
+    const orderedListRE = /^(\s*)(\d+[.)])(\s)(.*)+?/gm;
+
+    // Regex to grouping markdown by new line
+    // https://regex101.com/r/KJDb1J/1
     const markdownTextGroupRE = /((?:[^\n][\n]?)+)/gm;
 
-    const getItemListData = (itemList) => {
+    const getItemListData = (itemList: string[]): ItemListDataType[] | null => {
       const isValidList = itemList[0].split(/[\d]/)[0].length === 0;
       if (!isValidList) {
-        return;
+        return null;
       }
       return itemList.map((item) => {
         const indent = item.split(/[\d]/)[0].length;
-        const itemNumber = item.trim().split('.')[0];
+        const itemNumber = Number(item.trim().split(/[.)]/)[0]);
         const content = item.split(/\d.\s/)[1];
         const level = Math.round(indent / 4) + 1;
         return {
@@ -22,9 +36,9 @@ export default class OrderedList {
       });
     };
 
-    const getNestedOrderedListData = (itemListData) => {
-      const result:any[] = [];
-      const listItemNode:any[] = [result];
+    const getNestedOrderedListData = (itemListData: ItemListDataType[]): NestedItemListDataType[] => {
+      const result:NestedItemListDataType[] = [];
+      const listItemNode: NestedItemListDataType[][] = [result];
       if (itemListData?.length > 0) {
         itemListData.forEach((item) => {
           if (listItemNode[item.level - 1] != null) {
@@ -36,20 +50,22 @@ export default class OrderedList {
       return result;
     };
 
-    const buildList = (itemListData) => {
-      if (itemListData == null || itemListData.length === 0) {
+    const buildList = (nestedItemListData: NestedItemListDataType[]): string => {
+      if (nestedItemListData == null || nestedItemListData.length === 0) {
         return '';
       }
-      let element = `<ol start=${itemListData[0].number}>`;
-      element += itemListData.map((item) => {
-        return `<li class="code-line"> ${item.content}</li> ${buildList(item.children)}`;
+      let element = `<ol start=${nestedItemListData[0].number}>`;
+      element += nestedItemListData.map((item) => {
+        if (item.children != null) {
+          return `<li class="code-line"> ${item.content}</li> ${buildList(item.children)}`;
+        }
+        return `<li class="code-line"> ${item.content}</li>`;
       }).join('');
       element += '</ol>';
       return element;
-
     };
 
-    const replaceMarkdownWithHtml = (nestedItemListData) => {
+    const replaceMarkdownWithHtml = (nestedItemListData: NestedItemListDataType[]): string => {
       let occurrence = 0;
       occurrence++;
       if (occurrence === 1) {
@@ -60,10 +76,10 @@ export default class OrderedList {
     };
 
 
-    return markdown.replace(markdownTextGroupRE, (group) => {
+    return markdown.replace(markdownTextGroupRE, (group: string) => {
       const itemList = group.match(orderedListRE);
-      if (itemList != null) {
-        const itemListData = getItemListData(itemList);
+      const itemListData = itemList != null ? getItemListData(itemList) : null;
+      if (itemListData != null) {
         const nestedItemListData = getNestedOrderedListData(itemListData);
         return nestedItemListData.length > 0 ? replaceMarkdownWithHtml(nestedItemListData) : group;
       }