fix: code review

Author: AriPerkkio

packages/astro/src/default/utils/content.ts

@@ -1,7 +1,7 @@
 import type { ChapterSchema, Lesson, LessonSchema, PartSchema, Tutorial, TutorialSchema } from '@tutorialkit/types';
 import { interpolateString } from '@tutorialkit/types';
 import { getCollection } from 'astro:content';
-import mm from 'micromatch';
+import micromatch from 'micromatch';
 import path from 'node:path';
 import { DEFAULT_LOCALIZATION } from './content/default-localization';
 import { squash } from './content/squash.js';
@@ -257,14 +257,14 @@ export async function getTutorial(): Promise<Tutorial> {
     };
 
     if (lesson.data.template && typeof lesson.data.template !== 'string' && lesson.data.template.visibleFiles?.length) {
-      const templateFilesRef = await getFilesRefList(lesson.data.template.name, TEMPLATES_DIR);
+      const [, tempalteFiles] = await getFilesRefList(lesson.data.template.name, TEMPLATES_DIR);
 
-      for (const filename of templateFilesRef[1]) {
+      for (const filename of tempalteFiles) {
         if (lesson.files[1].includes(filename)) {
           continue;
         }
 
-        if (mm.isMatch(filename, lesson.data.template.visibleFiles, { format: formatTemplateFile })) {
+        if (micromatch.isMatch(filename, lesson.data.template.visibleFiles, { format: formatTemplateFile })) {
           lesson.files[1].push(filename);
         }
       }

packages/runtime/src/store/index.ts

@@ -176,7 +176,7 @@ export class TutorialStore {
         this._lessonFiles = files;
         this._lessonSolution = solution;
         this._lessonTemplate = template;
-        this._visibleTemplateFiles = filterEntries(template, lesson.files[1]);
+        this._visibleTemplateFiles = pick(template, lesson.files[1]);
 
         const editorFiles = { ...this._visibleTemplateFiles, ...this._lessonFiles };
         this._editorStore.setDocuments(editorFiles);
@@ -374,6 +374,14 @@ export class TutorialStore {
   }
 }
 
-function filterEntries<T extends object>(obj: T, filter: string[]) {
-  return Object.fromEntries(Object.entries(obj).filter(([entry]) => filter.includes(entry)));
+function pick<T>(obj: Record<string, T>, entries: string[]) {
+  const result: Record<string, T> = {};
+
+  for (const entry of entries) {
+    if (entry in obj) {
+      result[entry] = obj[entry];
+    }
+  }
+
+  return result;
 }

packages/types/src/schemas/common.ts

@@ -177,16 +177,17 @@ export const webcontainerSchema = commandsSchema.extend({
   template: z
     .union([
       // name of the template
-      z.string().optional(),
+      z.string(),
 
       z.strictObject({
         // name of the template
         name: z.string(),
 
         // list of globs of files that should be visible
-        visibleFiles: z.array(z.string()).optional(),
+        visibleFiles: z.array(z.string()).optional().describe('Specifies which files from template should be visible'),
       }),
     ])
+    .optional()
     .describe(
       'Specifies which folder from the `src/templates/` directory should be used as the basis for the code. See the "Code templates" guide for a detailed explainer.',
     ),