feat: support object type in template schema

Author: AriPerkkio

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

@@ -232,6 +232,7 @@ export async function getTutorial(): Promise<Tutorial> {
     const partMetadata = _tutorial.parts[lesson.part.id].data;
     const chapterMetadata = _tutorial.parts[lesson.part.id].chapters[lesson.chapter.id].data;
 
+    // now we inherit options from upper levels
     lesson.data = {
       ...lesson.data,
       ...squash(

packages/astro/src/remark/import-file.ts

@@ -78,7 +78,7 @@ function getTemplateName(file: string) {
   );
 
   if (meta.attributes.template) {
-    return meta.attributes.template;
+    return typeof meta.attributes.template === 'string' ? meta.attributes.template : meta.attributes.template.name;
   }
 
   /**

packages/runtime/src/lesson-files.ts

@@ -42,7 +42,8 @@ export class LessonFilesFetcher {
   }
 
   async getLessonTemplate(lesson: Lesson): Promise<Files> {
-    const templatePathname = `template-${lesson.data.template}.json`;
+    const templateName = typeof lesson.data.template === 'string' ? lesson.data.template : lesson.data.template?.name;
+    const templatePathname = `template-${templateName}.json`;
 
     if (this._map.has(templatePathname)) {
       return this._map.get(templatePathname)!;

packages/template/src/content/tutorial/1-basics/1-introduction/1-welcome/content.md

@@ -11,6 +11,8 @@ prepareCommands:
   - ['node -e setTimeout(()=>{process.exit(1)},5000)', 'This is going to fail']
 terminal:
   panels: ['terminal', 'output']
+template:
+  name: default
 ---
 
 # Kitchen Sink [Heading 1]

packages/types/src/schemas/common.spec.ts

@@ -350,13 +350,22 @@ describe('webcontainerSchema', () => {
     }).not.toThrow();
   });
 
-  it('should allow specifying the template', () => {
+  it('should allow specifying the template by name', () => {
     expect(() => {
       webcontainerSchema.parse({
         template: 'default',
       });
     }).not.toThrow();
   });
+  it('should allow specifying the template by object type', () => {
+    expect(() => {
+      webcontainerSchema.parse({
+        template: {
+          name: 'default',
+        },
+      });
+    }).not.toThrow();
+  });
   it('should allow specifying the terminal', () => {
     expect(() => {
       webcontainerSchema.parse({

packages/types/src/schemas/common.ts

@@ -175,8 +175,15 @@ export const webcontainerSchema = commandsSchema.extend({
       'Navigating to a lesson that specifies autoReload will always reload the preview. This is typically only needed if your server does not support HMR.',
     ),
   template: z
-    .string()
-    .optional()
+    .union([
+      // name of the template
+      z.string().optional(),
+
+      z.strictObject({
+        // name of the template
+        name: z.string(),
+      }),
+    ])
     .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.',
     ),