support parsing subtasks

Signed-off-by: shmck <shawn.j.mckay@gmail.com>
coderoad · ShMcK · Jul 5, 2020 · Jul 5, 2020 · Jul 5, 2020 · Jul 5, 2020
commit 72430c62e1d13258b9ed6f30d5e725c9ceea17c7
diff --git a/src/utils/parse.ts b/src/utils/parse.ts
@@ -91,20 +91,39 @@ export function parseMdContent(md: string): TutorialFrame | never {
           content: stepContent.trim(),
         };
       } 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.levels[current.levelIndex].steps[
-              current.stepIndex
-            ].hints = hints;
-          }
+        const subtaskDetectRegex = /^(#{4}\sSUBTASKS[\n\r]+([\*|\-]\s(?<subtaskContent>[^]*))[\n\r]+)+/;
+        const subtaskMatch = section.match(subtaskDetectRegex);
+        const listItemregex = /[\n\r]+[\*|\-]\s/;
+
+        switch (true) {
+          // parse hints from stepContent
+          case !!hintMatch:
+            const hints = section
+              .split(listItemregex)
+              .slice(1) // remove #### HINTS
+              .map((h) => h.trim());
+            if (hints.length) {
+              mdContent.levels[current.levelIndex].steps[
+                current.stepIndex
+              ].hints = hints;
+            }
+            return;
+          // parse subtasks from stepContent
+          case !!subtaskMatch:
+            const subtasks = section
+              .split(listItemregex)
+              .slice(1) // remove #### SUBTASKS
+              .map((h) => h.trim());
+            if (subtasks.length) {
+              mdContent.levels[current.levelIndex].steps[
+                current.stepIndex
+              ].subtasks = subtasks;
+            }
+            return;
+          default:
+            console.warn(`No build parser match found for:\n${section}\n`);
         }
       }
     }

diff --git a/tests/parse.test.ts b/tests/parse.test.ts
@@ -1429,7 +1429,8 @@ Create a function \`add\` that can take a variety of params.
 
 - Add one number
 - Add two numbers
-- Add three numbers`;
+- Add three numbers
+`;
       const skeleton = {
         levels: [
           {
@@ -1453,18 +1454,18 @@ Create a function \`add\` that can take a variety of params.
               {
                 id: "1.1",
                 setup: {
-                  subtasks: [
-                    "Add one number",
-                    "Add two numbers",
-                    "Add three numbers",
-                  ],
                   commits: ["abcdef1"],
                 },
                 content:
                   "Create a function `add` that can take a variety of params.",
                 solution: {
                   commits: ["abcdef2"],
                 },
+                subtasks: [
+                  "Add one number",
+                  "Add two numbers",
+                  "Add three numbers",
+                ],
               },
             ],
           },
@@ -1478,7 +1479,7 @@ Create a function \`add\` that can take a variety of params.
           "1.1:S": ["abcdef2"],
         },
       });
-      expect(result.levels).toEqual(expected.levels);
+      expect(result.levels[0]).toEqual(expected.levels[0]);
     });
   });
 });
diff --git a/typings/tutorial.d.ts b/typings/tutorial.d.ts
@@ -27,7 +27,7 @@ export type Step = {
   content: string;
   setup?: StepActions;
   solution?: Maybe<StepActions>;
-  subtasks?: { [testName: string]: boolean };
+  subtasks?: string[];
   hints?: string[];
 };
 
@@ -52,7 +52,7 @@ export type StepActions = {
   files?: string[];
   watchers?: string[];
   filter?: string;
-  subtasks?: boolean;
+  subtasks?: string[];
 };
 
 export interface TestRunnerArgs {