move off of plain map type for properties, add todo for generalizing …

…snippet parsing
microsoft · Aug 16, 2023 · 7aa279f · 7aa279f
1 parent c25719c
commit 7aa279f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/localtypings/pxtarget.d.ts b/localtypings/pxtarget.d.ts
@@ -1178,9 +1178,13 @@ declare namespace pxt.tutorial {
         execute(options: CodeValidationExecuteOptions): Promise<CodeValidationResult>;
     }
 
+    interface CodeValidatorBaseProperties {
+        enabled?: string;
+    }
+
     interface CodeValidatorMetadata {
         validatorType: string;
-        properties: pxt.Map<string>;
+        properties: CodeValidatorBaseProperties;
     }
 
     interface CodeValidationConfig {

diff --git a/pxtlib/tutorial.ts b/pxtlib/tutorial.ts
@@ -541,6 +541,11 @@ ${code}
         return pxt.BrowserUtils.getTutorialCodeHash(codeSnippets);
     }
 
+    /** TODO: if this gets exported, we probably want to consider generalizing to 'parseMarkdownSnippets'
+     * that returns { snippetName: string[] }; e.g.
+     * { "blocks": ["block snippet 1", "block snippet 2"], "package": ["deplist 1"] }
+     * need to cover getMetadataRegex + stripHiddenSnippets types, maybe more if any happen to be around.
+     **/
     function getBlockSnippetCode(mdSnippet: string): string[] {
         let hintCode: string[] = [];
 

diff --git a/webapp/src/components/tutorialValidators.tsx b/webapp/src/components/tutorialValidators.tsx
@@ -24,8 +24,8 @@ abstract class CodeValidatorBase implements CodeValidator {
     enabled: boolean;
     abstract name: string;
 
-    constructor(properties: {[index: string]: string}) {
-        this.enabled = properties["enabled"]?.toLowerCase() != "false"; // Default to true
+    constructor(properties: pxt.tutorial.CodeValidatorBaseProperties) {
+        this.enabled = properties.enabled?.toLowerCase() != "false"; // Default to true
     }
 
     async execute(options: CodeValidationExecuteOptions): Promise<CodeValidationResult> {