parse hints

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

src/utils/parse.ts

@@ -49,6 +49,7 @@ export function parseMdContent(md: string): TutorialFrame | never {
     mdContent.summary.description = summaryMatch.groups.tutorialDescription.trim();
   }
 
+  let current = { level: "0", step: "0" };
   // Identify each part of the content
   parts.forEach((section: string) => {
     // match level
@@ -71,24 +72,33 @@ export function parseMdContent(md: string): TutorialFrame | never {
           : truncate(levelContent.trim(), { length: 80, omission: "..." }),
         content: levelContent.trim(),
       };
+      current = { level: levelId, step: "0" };
     } else {
       // match step
       const stepRegex = /^(#{3}\s(?<stepId>(?<levelId>L\d+)S\d+)\s(?<stepTitle>.*)[\n\r]+(?<stepContent>[^]*))/;
       const stepMatch: RegExpMatchArray | null = section.match(stepRegex);
       if (stepMatch && stepMatch.groups) {
         const { stepId, stepContent } = stepMatch.groups;
 
-        // parse hints from stepContent
-        // const hintRegex = /^(#{4}\sHINTS[\n\r]+(?<hintContent>[^]*))/g;
-
-        // if (!!stepContent.match(hintRegex)) {
-        //   console.log("HAS HINT");
-        // }
-
         mdContent.steps[stepId] = {
           id: stepId,
           content: stepContent.trim(),
         };
+        current = { ...current, step: stepId };
+      } else {
+        // parse hints from stepContent
+        const hintDetectRegex = /^(#{4}\sHINTS[\n\r]+(\*\s(?<hintContent>[^]*))[\n\r]+)+/;
+        const hintMatch = section.match(hintDetectRegex);
+        if (!!hintMatch) {
+          const hintItemRegex = /[\n\r]+\*\s/;
+          const hints = section
+            .split(hintItemRegex)
+            .slice(1) // remove #### HINTS
+            .map((h) => h.trim());
+          if (hints.length) {
+            mdContent.steps[current.step].hints = hints;
+          }
+        }
       }
     }
   });

tests/parse.test.ts

@@ -869,7 +869,7 @@ Description.
     });
   });
 
-  xdescribe("hints", () => {
+  describe("hints", () => {
     it("should parse hints for a step", () => {
       const md = `# Title
     
@@ -947,7 +947,7 @@ First level content.
 
 The first step
 
-#### Hints
+#### HINTS
 
 * First Hint with \`markdown\`. See **bold**
 * Second Hint has a codeblock
@@ -1019,7 +1019,7 @@ First level content.
 
 The first step
 
-#### Hints
+#### HINTS
 
 * First Hint with \`markdown\`. See **bold**
 * Second Hint has a codeblock
@@ -1030,7 +1030,7 @@ var a = 1;
 
 And spans multiple lines.
 
-### L1S2A
+### L1S2
 
 The second uninterrupted step
 `;
@@ -1073,7 +1073,7 @@ The second uninterrupted step
                 id: "L1S1",
                 content: "The first step",
                 setup: {
-                  commits: ["abcdef1", "123456789"],
+                  commits: ["abcdef1"],
                 },
                 solution: {
                   commits: ["123456789"],
@@ -1095,7 +1095,7 @@ The second uninterrupted step
           {},
         ],
       };
-      expect(result.levels).toEqual(expected.levels);
+      expect(result.levels[0]).toEqual(expected.levels[0]);
     });
   });
 });

typings/tutorial.d.ts

@@ -28,6 +28,7 @@ export type Step = {
   setup: StepActions;
   solution: Maybe<StepActions>;
   subtasks?: { [testName: string]: boolean };
+  hints?: string[];
 };
 
 /** A tutorial for use in VSCode CodeRoad */