Skip to content

Feature/subtasks #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 5, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
support parsing subtasks
Signed-off-by: shmck <[email protected]>
ShMcK committed Jul 5, 2020
commit 72430c62e1d13258b9ed6f30d5e725c9ceea17c7
43 changes: 31 additions & 12 deletions src/utils/parse.ts
Original file line number Diff line number Diff line change
@@ -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`);
}
}
}
15 changes: 8 additions & 7 deletions tests/parse.test.ts
Original file line number Diff line number Diff line change
@@ -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]);
});
});
});
4 changes: 2 additions & 2 deletions typings/tutorial.d.ts
Original file line number Diff line number Diff line change
@@ -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 {