Added new option allowing for multiline cards with empty lines

package.json

@@ -48,7 +48,8 @@
     },
     "dependencies": {
         "chart.js": "^4.4.2",
-        "pagerank.js": "^1.0.2"
+        "pagerank.js": "^1.0.2",
+        "peggy": "^4.0.3"
     },
     "packageManager": "^[email protected]"
 }

src/NoteQuestionParser.ts

@@ -136,17 +136,7 @@ export class NoteQuestionParser {
 
     private parseQuestions(): ParsedQuestionInfo[] {
         // We pass contentText which has the frontmatter blanked out; see extractFrontmatter for reasoning
-        const settings: SRSettings = this.settings;
-        const result: ParsedQuestionInfo[] = parseEx(
-            this.contentText,
-            settings.singleLineCardSeparator,
-            settings.singleLineReversedCardSeparator,
-            settings.multilineCardSeparator,
-            settings.multilineReversedCardSeparator,
-            settings.convertHighlightsToClozes,
-            settings.convertBoldTextToClozes,
-            settings.convertCurlyBracketsToClozes,
-        );
+        const result: ParsedQuestionInfo[] = parseEx(this.contentText);
         return result;
     }
 

src/generateParser.ts

@@ -0,0 +1,226 @@
+// generateParser.ts
+
+import { SRSettings } from "./settings";
+import { generate, Parser } from "peggy";
+
+export function generateParser(settings: SRSettings): Parser {
+
+    const close_rules_list: string[] = [];
+
+    if(settings.convertHighlightsToClozes) close_rules_list.push("close_equal");
+    if(settings.convertBoldTextToClozes) close_rules_list.push("close_star");
+    if(settings.convertCurlyBracketsToClozes) close_rules_list.push("close_bracket");
+
+    const close_rules = close_rules_list.join(" / ");
+
+    const grammar = `
+{
+  // The fallback case is important if we want to test the rules with https://peggyjs.org/online.html
+  const CardTypeFallBack = {
+    SingleLineBasic: 0,
+    SingleLineReversed: 1,
+    MultiLineBasic: 2,
+    MultiLineReversed: 3,
+    Cloze: 4,
+  };
+
+  // The fallback case is important if we want to test the rules with https://peggyjs.org/online.html
+  const createParsedQuestionInfoFallBack = (cardType, text, firstLineNum, lastLineNum) => {
+    return {cardType, text, firstLineNum, lastLineNum};
+  };
+
+  const CardType = options.CardType ? options.CardType : CardTypeFallBack;
+  CardType.Ignore=null;
+  const createParsedQuestionInfo = options.createParsedQuestionInfo ? options.createParsedQuestionInfo : createParsedQuestionInfoFallBack;
+
+  function filterBlocks(b) {
+    return b.filter( (d) => d.cardType === CardType.Ignore ? false : true )
+  }
+}
+
+main
+  = blocks:block* { return filterBlocks(blocks); }
+
+block
+  = html_comment / inline_rev_card / inline_card / multiline_rev_card / multiline_card / close_card / loose_line
+
+html_comment
+  = $("<!--" (!"-->" (html_comment / .))* "-->" newline?) {
+    return createParsedQuestionInfo(CardType.Ignore,"",0,0);
+  }
+
+tag
+  = $("#" + name:([a-zA-Z/\\-_] { return 1; } / [0-9]{ return 0;})+ &{
+    // check if it is a valid Obsidian tag
+    return name.includes(1);
+  })
+
+tag_line
+  = tag:tag _* nl:newline { return tag + nl; }
+
+inline_card
+  = e:inline newline? { return e; }
+
+inline
+  = left:(!inline_mark [^\\n\\r])+ inline_mark right:not_newline (newline annotation)? {
+    return createParsedQuestionInfo(CardType.SingleLineBasic,text(),location().start.line-1,location().end.line-1);
+  }
+
+inline_rev_card
+  = e:inline_rev newline? { return e; }
+
+inline_rev
+  = left:(!inline_rev_mark [^\\n\\r])+ inline_rev_mark right:not_newline (newline annotation)? {
+      return createParsedQuestionInfo(CardType.SingleLineReversed,text(),location().start.line-1,location().end.line-1);
+    }
+
+multiline_card
+  = c:multiline separator_line {
+    return c;
+  }
+
+multiline
+  = tag:tag_line? arg1:multiline_before multiline_mark arg2:multiline_after {
+    return createParsedQuestionInfo(CardType.MultiLineBasic,((tag ?? "") + arg1+"${settings.multilineCardSeparator}"+"\\n"+arg2.trim()),location().start.line-1,location().end.line-2);
+  }
+
+multiline_before
+  = $(!multiline_mark nonempty_text_line)+
+
+multiline_after
+  = $(!separator_line (tilde_code / backprime_code / text_line))+
+
+tilde_code
+  = $(left:$tilde_marker text_line t:$(!(middle:$tilde_marker  &{ return left.length===middle.length;}) (tilde_code / text_line))* (right:$tilde_marker &{ return left.length===right.length; }) newline)  
+
+tilde_marker
+  = "~~~" "~"*
+
+backprime_code
+  = $(left:$backprime_marker text_line t:$(!(middle:$backprime_marker  &{ return left.length===middle.length;}) (backprime_code / text_line))* (right:$backprime_marker &{ return left.length===right.length; }) newline)  
+
+backprime_marker
+  = "\`\`\`" "\`"*
+
+multiline_rev_card
+  = @multiline_rev separator_line
+
+multiline_rev
+  = tag:tag_line? arg1:multiline_rev_before multiline_rev_mark arg2:multiline_rev_after {
+    return createParsedQuestionInfo(CardType.MultiLineReversed,((tag ?? "") + arg1+"${settings.multilineReversedCardSeparator}"+"\\n"+arg2.trim()),location().start.line-1,location().end.line-2);
+  }
+
+multiline_rev_before
+  = $(!multiline_rev_mark nonempty_text_line)+
+
+multiline_rev_after
+  = $(!separator_line text_line)+
+
+close_card
+  = $(multiline_before_close? f:close_line e:(multiline_after_close)? e1:(newline annotation)?) {
+    return createParsedQuestionInfo(CardType.Cloze,text().trim(),location().start.line-1,location().end.line-1);
+  }
+
+close_line
+  = ((!close_text [^\\n\\r])* close_text) text_line_nonterminated?
+
+multiline_before_close
+  = (!close_line nonempty_text_line)+
+
+multiline_after_close
+  = e:(!(newline separator_line) text_line1)+
+
+close_text
+  = ${close_rules}
+
+close_equal
+  = close_mark_equal (!close_mark_equal [^\\n\\r])+  close_mark_equal
+
+close_mark_equal
+  = "=="
+
+close_star
+  = close_mark_star (!close_mark_star [^\\n\\r])+  close_mark_star
+
+close_mark_star
+  = "**"
+
+close_bracket
+  = close_mark_bracket_open (!close_mark_bracket_close [^\\n\\r])+  close_mark_bracket_close
+
+close_mark_bracket_open
+  = "{{"
+
+close_mark_bracket_close
+  = "}}"
+
+inline_mark
+  = "${settings.singleLineCardSeparator}"
+
+inline_rev_mark
+  = "${settings.singleLineReversedCardSeparator}"
+
+multiline_mark
+  = "${settings.multilineCardSeparator}" _* newline
+
+multiline_rev_mark
+  = "${settings.multilineReversedCardSeparator}" _* newline
+
+end_card_mark
+  = "${settings.multilineCardEndMarker}"
+
+separator_line
+  = end_card_mark newline
+
+text_line_nonterminated
+  = $[^\\n\\r]+
+
+nonempty_text_line
+  = @$[^\\n\\r]+ newline
+
+text_line
+  = @$[^\\n\\r]* newline
+
+text_line1
+  = newline @$[^\\n\\r]*
+
+loose_line
+  = $(([^\\n\\r]* newline) / [^\\n\\r]+) {
+      return createParsedQuestionInfo(CardType.Ignore,"",0,0);
+    }
+
+annotation
+  = $("<!--SR:" (!"-->" .)+ "-->")
+
+not_newline
+  = $[^\\n\\r]*
+
+newline
+  = $[\\n\\r]
+
+empty_line
+  = $(_* [\\n\\r])
+
+empty_lines
+  = $empty_line+
+
+nonemptyspace
+  = [^ \\f\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]
+
+emptyspace
+  = _*
+
+_ = ([ \\f\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff])
+`;
+
+    if (settings.showDebugMessages) {
+        console.log(grammar);
+    }
+
+    // const t0 = Date.now();
+    const parser = generate(grammar);
+    // const t1 = Date.now();
+    // console.log("To generate the parser, it took " + (t1 - t0) + " milliseconds.")
+
+    return parser;
+}

src/lang/locale/ar.ts

@@ -119,6 +119,7 @@ Note that this setting is common to both Flashcards and Notes. : أدخل مسا
     INLINE_REVERSED_CARDS_SEPARATOR: "فاصل من أجل البطاقات العكسية المضمنة",
     MULTILINE_CARDS_SEPARATOR: "فاصل من أجل البطاقات المتعددة",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "فاصل من أجل البطاقات العكسية المتعددة",
+    MULTILINE_CARDS_END_MARKER: "الأحرف التي تدل على نهاية الكلوزات وبطاقات التعلم المتعددة الأسطر",
     NOTES: "ملاحظات",
     REVIEW_PANE_ON_STARTUP: "تمكين جزء مراجعة الملاحظات عند بدء التشغيل",
     TAGS_TO_REVIEW: "وسوم للمراجعة",

src/lang/locale/cz.ts

@@ -122,6 +122,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Oddělovač pro otočené inline kartičky",
     MULTILINE_CARDS_SEPARATOR: "Oddělovač pro víceřádkové kartičky",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Oddělovač pro víceřádkove otočené kartičky",
+    MULTILINE_CARDS_END_MARKER: "Znaky označující konec clozes a víceřádkových flash karet",
     NOTES: "Poznámky",
     REVIEW_PANE_ON_STARTUP: "Enable note review pane on startup",
     TAGS_TO_REVIEW: "Tag pro revizi",

src/lang/locale/de.ts

@@ -134,6 +134,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Trennzeichen für einzeilige beidseitige Lernkarten",
     MULTILINE_CARDS_SEPARATOR: "Trennzeichen für mehrzeilige Lernkarten",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Trennzeichen für mehrzeilige beidseitige Lernkarten",
+    MULTILINE_CARDS_END_MARKER: "Zeichen, die das Ende von Lückentexten und mehrzeiligen Flashcards kennzeichnen",
     NOTES: "Notizen",
     REVIEW_PANE_ON_STARTUP: "Öffne Überprüfungswarteschlage beim start",
     TAGS_TO_REVIEW: "Zu wiederholende Tags",

src/lang/locale/en.ts

@@ -122,6 +122,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Separator for inline reversed flashcards",
     MULTILINE_CARDS_SEPARATOR: "Separator for multiline flashcards",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Separator for multiline reversed flashcards",
+    MULTILINE_CARDS_END_MARKER: "Characters denoting the end of clozes and multiline flashcards",
     NOTES: "Notes",
     REVIEW_PANE_ON_STARTUP: "Enable note review pane on startup",
     TAGS_TO_REVIEW: "Tags to review",

src/lang/locale/es.ts

@@ -124,6 +124,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     MULTILINE_CARDS_SEPARATOR: "Separador para tarjetas de memorización multilínea",
     MULTILINE_REVERSED_CARDS_SEPARATOR:
         "Separador para tarjetas de memorización multilínea invertidas",
+    MULTILINE_CARDS_END_MARKER: "Caracteres que denotan el fin de los clozes y tarjetas didácticas de varias líneas",
     NOTES: "Notes",
     REVIEW_PANE_ON_STARTUP: "Activar panel de revisión de notas al arrancar",
     TAGS_TO_REVIEW: "Etiquetas a revisar",

src/lang/locale/it.ts

@@ -127,6 +127,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Separatore per schede all'incontrario sulla stessa riga",
     MULTILINE_CARDS_SEPARATOR: "Separatore per schede su più righe",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Separatore per schede all'incontrario su più righe",
+    MULTILINE_CARDS_END_MARKER: "Caratteri che denotano la fine di carte con spazi da riempiere e carte multilinea",
     NOTES: "Note",
     REVIEW_PANE_ON_STARTUP: "Abilita il pannello di revisione note all'avvio",
     TAGS_TO_REVIEW: "Etichette da rivedere",

src/lang/locale/ja.ts

@@ -125,6 +125,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "インラインの表裏反転フラッシュカードに使用するセパレーター",
     MULTILINE_CARDS_SEPARATOR: "複数行のフラッシュカードに使用するセパレーター",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "複数行の表裏反転フラッシュカードに使用するセパレーター",
+    MULTILINE_CARDS_END_MARKER: "クローズと複数行フラッシュカードの終わりを示す文字",
     NOTES: "ノート",
     REVIEW_PANE_ON_STARTUP: "Enable note review pane on startup",
     TAGS_TO_REVIEW: "レビューに使用するタグ",

src/lang/locale/ko.ts

@@ -123,6 +123,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "인라인 반전 플래시카드 구분자",
     MULTILINE_CARDS_SEPARATOR: "여러 줄 플래시카드 구분자",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "여러 줄 반전 플래시카드 구분자",
+    MULTILINE_CARDS_END_MARKER: "클로즈와 다중 행 플래시카드의 끝을 나타내는 문자",
     NOTES: "노트",
     REVIEW_PANE_ON_STARTUP: "Enable note review pane on startup",
     TAGS_TO_REVIEW: "리뷰에 사용할 태그",

src/lang/locale/pl.ts

@@ -126,6 +126,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     MULTILINE_CARDS_SEPARATOR: "Separator dla kart zamaskowanych wieloliniowych",
     MULTILINE_REVERSED_CARDS_SEPARATOR:
         "Separator dla kart zamaskowanych odwróconych wieloliniowych",
+    MULTILINE_CARDS_END_MARKER: "Caracteres que denotam o fim de clozes e flashcards multilineares",
     NOTES: "Notatki",
     REVIEW_PANE_ON_STARTUP: "Włączyć panel przeglądu notatek przy starcie",
     TAGS_TO_REVIEW: "Tagi do przeglądu",

src/lang/locale/pt-br.ts

@@ -125,6 +125,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Separador para flashcards inline reversos",
     MULTILINE_CARDS_SEPARATOR: "Separador para flashcards de múltiplas linhas",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Separador para flashcards de múltiplas linhas reversos",
+    MULTILINE_CARDS_END_MARKER: "Caracteres que denotam o fim de clozes e flashcards multilinha",
     NOTES: "Notas",
     REVIEW_PANE_ON_STARTUP: "Habilitar painel de revisão de notas na inicialização",
     TAGS_TO_REVIEW: "Etiquetas para revisar",

src/lang/locale/ru.ts

@@ -133,6 +133,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "Разделитель для обратных внутристрочных карточек",
     MULTILINE_CARDS_SEPARATOR: "Разделитель для многострочных карточек",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "Разделитель для обратных многострочных карточек",
+    MULTILINE_CARDS_END_MARKER: "Символы, обозначающие конец клозов и многострочных карточек",
     NOTES: "Заметки",
     REVIEW_PANE_ON_STARTUP: "Включить панель изучения карточек при запуске программы",
     TAGS_TO_REVIEW: "Теги для изучения",

src/lang/locale/zh-cn.ts

@@ -114,6 +114,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "单行翻转卡片的分隔符",
     MULTILINE_CARDS_SEPARATOR: "多行卡片的分隔符",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "多行翻转卡片的分隔符",
+    MULTILINE_CARDS_END_MARKER: "表示填空和多行闪卡结束的字符",
     NOTES: "笔记",
     REVIEW_PANE_ON_STARTUP: "启动时开启笔记复习窗格",
     TAGS_TO_REVIEW: "复习标签",

src/lang/locale/zh-tw.ts

@@ -114,6 +114,7 @@ Note that this setting is common to both Flashcards and Notes.`,
     INLINE_REVERSED_CARDS_SEPARATOR: "單行反轉卡片的分隔字元",
     MULTILINE_CARDS_SEPARATOR: "多行卡片的分隔字元",
     MULTILINE_REVERSED_CARDS_SEPARATOR: "多行翻轉卡片的分隔字元",
+    MULTILINE_CARDS_END_MARKER: "表示填空和多行闪卡结束的字符",
     NOTES: "筆記",
     REVIEW_PANE_ON_STARTUP: "啟動時開啟筆記復習窗格",
     TAGS_TO_REVIEW: "復習標籤",