Merged PR 311: v1.31.0 - Add square bracket versions of default reade…

…r directives (#291) v1.31.0 - Add square bracket versions of default reader directives
alopezlago · Apr 19, 2024 · d91e137 · d91e137
1 parent bf7a245
commit d91e137
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "modaq",
-    "version": "1.30.1",
+    "version": "1.31.0",
     "description": "Quiz Bowl Reader using TypeScript, React, and MobX",
     "repository": {
         "type": "git",

diff --git a/src/parser/FormattedTextParser.ts b/src/parser/FormattedTextParser.ts
@@ -8,7 +8,14 @@ export const defaultPronunciationGuideMarkers: [string, string] = ["(", ")"];
 /**
  * Default reader directives used if none are passed into `IFormattingOptions`
  */
-export const defaultReaderDirectives: string[] = ["(emphasize)", "(pause)", "(read slowly)"];
+export const defaultReaderDirectives: string[] = [
+    "(emphasize)",
+    "(pause)",
+    "(read slowly)",
+    "[emphasize]",
+    "[pause]",
+    "[read slowly]",
+];
 
 /**
  * Options for how to parse and format text

diff --git a/tests/FormattedTextParserTests.ts b/tests/FormattedTextParserTests.ts
@@ -431,12 +431,11 @@ describe("FormattedTextParserTests", () => {
                 },
             ]);
         });
-        it("Default reader directives", () => {
+        it("Default reader directives (parentheses)", () => {
             const textToFormat =
                 "This (Emphasize) equation is proportional to (read slowly) a minus x, plus (pause) 1.";
             const result: IFormattedText[] = FormattedTextParser.parseFormattedText(textToFormat, {
                 pronunciationGuideMarkers: ["[", "]"],
-                // readerDirectives: ["(emphasize)", "(read slowly)", "(pause)"],
             });
             expect(result).to.deep.equal([
                 {
@@ -504,6 +503,78 @@ describe("FormattedTextParserTests", () => {
                 },
             ]);
         });
+        it("Default reader directives (square brackets)", () => {
+            const textToFormat =
+                "This [Emphasize] equation is proportional to [read Slowly] a minus x, plus [pause] 1.";
+            const result: IFormattedText[] = FormattedTextParser.parseFormattedText(textToFormat, {
+                pronunciationGuideMarkers: ["(", ")"],
+            });
+            expect(result).to.deep.equal([
+                {
+                    text: "This ",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: false,
+                },
+                {
+                    text: "[Emphasize]",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: true,
+                },
+                {
+                    text: " equation is proportional to ",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: false,
+                },
+                {
+                    text: "[read Slowly]",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: true,
+                },
+                {
+                    text: " a minus x, plus ",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: false,
+                },
+                {
+                    text: "[pause]",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: true,
+                },
+                {
+                    text: " 1.",
+                    bolded: false,
+                    emphasized: false,
+                    underlined: false,
+                    subscripted: false,
+                    superscripted: false,
+                    pronunciation: false,
+                },
+            ]);
+        });
         it("Explicit reader directives", () => {
             const textToFormat = "This (Emphasize) equation is proportional to (slowly) a minus x, plus (pause) 1.";
             const result: IFormattedText[] = FormattedTextParser.parseFormattedText(textToFormat, {