@learnpack/learnpack 5.0.280 → 5.0.282

package/lib/commands/serve.js

@@ -139,7 +139,7 @@ async function startExerciseGeneration(rigoToken, steps, packageContext, exercis
     console.log("Starting generation of", exSlug);
     const webhookUrl = `${process.env.HOST}/webhooks/${courseSlug}/exercise-processor/${exercise.id}/${rigoToken}`;
     console.log("WEBHOOK URL", webhookUrl);
-    const res = await (0, rigoActions_1.readmeCreator)(rigoToken, {
+    const res = await (0, rigoActions_1.readmeCreator)(rigoToken.trim(), {
         title: `${exercise.id} - ${exercise.title}`,
         output_lang: packageContext.language || "en",
         list_of_exercises: JSON.stringify(steps.map(step => step.id + "-" + step.title)),
@@ -406,7 +406,7 @@ class ServeCommand extends SessionCommand_1.default {
         });
         app.post("/actions/continue-generating/:courseSlug/:position", async (req, res) => {
             const { courseSlug, position } = req.params;
-            const { feedback } = req.body;
+            const { feedback, mode } = req.body;
             const rigoToken = req.header("x-rigo-token");
             if (!rigoToken) {
                 return res.status(400).json({
@@ -454,6 +454,7 @@ class ServeCommand extends SessionCommand_1.default {
             else {
                 syllabusJson.feedback = feedback;
             }
+            syllabusJson.generationMode = mode;
             await uploadFileToBucket(bucket, JSON.stringify(syllabusJson), `courses/${courseSlug}/.learn/initialSyllabus.json`);
             res.json({ status: "SUCCESS" });
         });
@@ -528,7 +529,9 @@ class ServeCommand extends SessionCommand_1.default {
             }
             let nextCompletionId = null;
             if (nextExercise &&
-                (exerciseIndex === 0 || !(exerciseIndex % 3 === 0))) {
+                (exerciseIndex === 0 ||
+                    !(exerciseIndex % 3 === 0) ||
+                    syllabusJson.generationMode === "continue-with-all")) {
                 let feedback = "";
                 if (syllabusJson.feedback) {
                     feedback = `\n\nThe user added the following feedback with relation to the previous generations: ${syllabusJson.feedback}`;

package/lib/models/creator.d.ts

@@ -39,4 +39,5 @@ export type Syllabus = {
     lessons: Lesson[];
     courseInfo: FormState;
     feedback?: string;
+    generationMode?: "next-three" | "continue-with-all";
 };

package/lib/utils/rigoActions.js

@@ -21,7 +21,7 @@ const createReadme = async (token, inputs, purpose, webhookUrl) => {
         }, {
             headers: {
                 "Content-Type": "application/json",
-                Authorization: "Token " + token,
+                Authorization: "Token " + token.trim(),
             },
         });
         return response.data;
@@ -186,7 +186,7 @@ const createStructuredPreviewReadme = async (token, inputs, webhookUrl) => {
     }, {
         headers: {
             "Content-Type": "application/json",
-            Authorization: "Token " + token,
+            Authorization: "Token " + token.trim(),
         },
     });
     return response.data;

package/lib/utils/templates/epub/epub.css

@@ -0,0 +1,133 @@
+/* Basic EPUB styling */
+body {
+  font-family: "Georgia", serif;
+  line-height: 1.6;
+  margin: 2em;
+  color: #333;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  color: #2c3e50;
+  margin-top: 1.5em;
+  margin-bottom: 0.5em;
+}
+
+h1 {
+  font-size: 2em;
+  border-bottom: 2px solid #3498db;
+  padding-bottom: 0.3em;
+}
+
+h2 {
+  font-size: 1.5em;
+  border-bottom: 1px solid #bdc3c7;
+  padding-bottom: 0.2em;
+}
+
+p {
+  margin-bottom: 1em;
+  text-align: justify;
+}
+
+code {
+  background-color: #f8f9fa;
+  padding: 0.2em 0.4em;
+  border-radius: 3px;
+  font-family: "Courier New", monospace;
+  font-size: 0.9em;
+}
+
+pre {
+  background-color: #f8f9fa;
+  padding: 1em;
+  border-radius: 5px;
+  overflow-x: auto;
+  border-left: 4px solid #3498db;
+}
+
+pre code {
+  background-color: transparent;
+  padding: 0;
+}
+
+blockquote {
+  border-left: 4px solid #bdc3c7;
+  margin: 1em 0;
+  padding-left: 1em;
+  font-style: italic;
+  color: #7f8c8d;
+}
+
+ul,
+ol {
+  margin-bottom: 1em;
+  padding-left: 2em;
+}
+
+li {
+  margin-bottom: 0.5em;
+}
+
+a {
+  color: #3498db;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+img {
+  max-width: 100%;
+  height: auto;
+  display: block;
+  margin: 1em auto;
+}
+
+table {
+  border-collapse: collapse;
+  width: 100%;
+  margin: 1em 0;
+}
+
+th,
+td {
+  border: 1px solid #ddd;
+  padding: 8px;
+  text-align: left;
+}
+
+th {
+  background-color: #f2f2f2;
+  font-weight: bold;
+}
+
+#toc {
+  background-color: #f8f9fa;
+  padding: 1em;
+  border-radius: 5px;
+  margin-bottom: 2em;
+}
+
+#toc h2 {
+  border-bottom: none;
+  margin-top: 0;
+}
+
+#toc ol {
+  padding-left: 1em;
+}
+
+#toc li {
+  margin-bottom: 0.3em;
+}
+
+#toc a {
+  color: #2c3e50;
+  font-weight: 500;
+}

package/lib/utils/templates/gitignore.txt

@@ -0,0 +1,20 @@
+# configuration and readme
+!.gitignore
+!.gitpod.yml
+!.gitpod.Dockerfile
+!learn.json
+!README.md
+
+# exercises
+!.learn/
+!.learn/*
+.learn/_app
+.learn/.session
+.learn/dist
+.learn/app.tar.gz
+.learn/config.json
+
+# python compiled files
+*.pyc
+__pycache__/
+.pytest_cache/

package/lib/utils/templates/incremental/.github/workflows/learnpack-audit.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Learnpack audit
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install @learnpack/learnpack@latest -g
+    - run: learnpack audit --strict

package/lib/utils/templates/incremental/.learn/exercises/01-hello-world/README.es.md

@@ -0,0 +1,24 @@
+# `01` Hello World
+
+Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
+
+También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
+
+## Inserta videos
+
+Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```

package/lib/utils/templates/incremental/.learn/exercises/01-hello-world/README.md

@@ -0,0 +1,24 @@
+# `01` Hello World
+
+You can have just a README file and it will be like a page in a book, no code files.
+
+You can also add a `README.[lang].md` file for translations, for example: `README.es.md` for spanish.
+
+## Video compatibility
+
+If you want to include some video introduction for each exercise, add a `intro` property in the markdown frontmatter of the README.md for that particular exercise:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+You can also add a video solution for each exercise by adding a `tutorial` property on the markdown frontmatter of it's README.md:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```

package/lib/utils/templates/incremental/.vscode/schema.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "language": {
+      "type": "string",
+      "enum": ["react", "auto", "html", "python", "node", "dom"]
+    },
+    "slug": {
+      "type": "string"
+    },
+    "title": {
+      "type": "object",
+      "properties": {
+        "en": {
+          "type": "string"
+        },
+        "es": {
+          "type": "string"
+        }
+      },
+      "required": ["en"]
+    },
+    "repository": {
+      "type": "string",
+      "format": "uri"
+    },
+    "preview": {
+      "type": "string",
+      "format": "uri"
+    },
+    "description": {
+      "type": "object",
+      "properties": {
+        "en": {
+          "type": "string"
+        },
+        "es": {
+          "type": "string"
+        }
+      },
+      "required": ["en"]
+    },
+    "duration": {
+      "type": "integer"
+    },
+    "projectType": {
+      "type": "string",
+      "enum": ["tutorial", "project"]
+    },
+    "difficulty": {
+      "type": "string",
+      "enum": ["easy","beginner", "medium", "hard"]
+    },
+    "videoSolutions": {
+      "type": "boolean"
+    },
+    "bugsLink": {
+      "type": "string",
+      "format": "uri"
+    },
+    "grading": {
+      "type": ["string", "null"],
+      "enum": ["isolated", "incremental", null]
+    },
+    "editor": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "enum": ["extension", "preview"]
+        },
+        "agent": {
+          "type": "string",
+          "enum": ["vscode", "os"]
+        }
+      },
+      "required": ["version"]
+    },
+    "telemetry": {
+      "type": "object",
+      "properties": {
+        "batch": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": ["batch"]
+    },
+    "video": {
+      "type": "object",
+      "properties": {
+        "intro": {
+          "type": "object",
+          "properties": {
+            "en": {
+              "type": "string",
+              "format": "uri"
+            },
+            "es": {
+              "type": "string",
+              "format": "uri"
+            }
+          }
+        }
+      },
+      "required": ["intro"]
+    }
+  },
+  "required": [
+    "slug",
+    "title",
+    "description",
+    "duration",
+    "difficulty",
+    "grading"
+  ]
+}

package/lib/utils/templates/incremental/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "files.autoSave": "afterDelay",
+    "files.autoSaveDelay": 700,
+    "editor.minimap.enabled": false,
+    "workbench.editorAssociations": {   
+        "*.md": "vscode.markdown.preview.editor"
+    },
+    "json.schemas": [
+        {
+          "fileMatch": ["learn.json"],
+          "url": "./.vscode/schema.json"
+        }
+      ]
+}

package/lib/utils/templates/incremental/README.ejs

@@ -0,0 +1,5 @@
+# Welcome to <%= it.title %>
+
+You have initialized the exercises with grading=`incremental`; meaning that your students will complete one single tutorial with clear and autograded steps from beginning to end.
+
+Type `$ learnpack start` in your terminal to start the exercises.

package/lib/utils/templates/incremental/README.es.ejs

@@ -0,0 +1,5 @@
+# Bienvenido a <%= it.title %>
+
+Has inicializado los ejercicios con grading=`incremental`; esto signigica que tus estudiantes completarán un solo tutorial con pasos claros e incrementales, desde el comienzo hasta el final.
+
+Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

package/lib/utils/templates/isolated/.github/workflows/learnpack-audit.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Learnpack audit
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install @learnpack/learnpack@latest -g
+    - run: learnpack audit --strict

package/lib/utils/templates/isolated/.vscode/schema.json

@@ -0,0 +1,122 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+      "language": {
+        "type": "string",
+        "enum": ["react", "auto", "html", "python", "node", "dom"]
+      },
+      "slug": {
+        "type": "string"
+      },
+      "title": {
+        "type": "object",
+        "properties": {
+          "en": {
+            "type": "string"
+          },
+          "es": {
+            "type": "string"
+          }
+        },
+        "required": ["en"]
+      },
+      "repository": {
+        "type": "string",
+        "format": "uri"
+      },
+      "preview": {
+        "type": "string",
+        "format": "uri"
+      },
+      "description": {
+        "type": "object",
+        "properties": {
+          "en": {
+            "type": "string"
+          },
+          "es": {
+            "type": "string"
+          }
+        },
+        "required": ["en"]
+      },
+      "duration": {
+        "type": "integer"
+      },
+      "projectType": {
+        "type": "string",
+        "enum": ["tutorial", "project"]
+      },
+      "difficulty": {
+        "type": "string",
+        "enum": ["easy","beginner", "medium", "hard"]
+      },
+      "videoSolutions": {
+        "type": "boolean"
+      },
+      "bugsLink": {
+        "type": "string",
+        "format": "uri"
+      },
+      "grading": {
+        "type": ["string", "null"],
+        "enum": ["isolated", "incremental", null]
+      },
+      "editor": {
+        "type": "object",
+        "properties": {
+          "version": {
+            "type": "string"
+          },
+          "mode": {
+            "type": "string",
+            "enum": ["extension", "preview"]
+          },
+          "agent": {
+            "type": "string",
+            "enum": ["vscode", "os"]
+          }
+        },
+        "required": ["version"]
+      },
+      "telemetry": {
+        "type": "object",
+        "properties": {
+          "batch": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "required": ["batch"]
+      },
+      "video": {
+        "type": "object",
+        "properties": {
+          "intro": {
+            "type": "object",
+            "properties": {
+              "en": {
+                "type": "string",
+                "format": "uri"
+              },
+              "es": {
+                "type": "string",
+                "format": "uri"
+              }
+            }
+          }
+        },
+        "required": ["intro"]
+      }
+    },
+    "required": [
+      "slug",
+      "title",
+      "description",
+      "duration",
+      "difficulty",
+      "grading"
+    ]
+  }
+  

package/lib/utils/templates/isolated/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "files.autoSave": "afterDelay",
+    "files.autoSaveDelay": 700,
+    "editor.minimap.enabled": false,
+    "workbench.editorAssociations": {   
+        "*.md": "vscode.markdown.preview.editor"
+    },
+    "json.schemas": [
+        {
+          "fileMatch": ["learn.json"],
+          "url": "./.vscode/schema.json"
+        }
+      ]
+}

package/lib/utils/templates/isolated/README.ejs

@@ -0,0 +1,5 @@
+# Welcome to <%= it.title %>
+
+You have initialized the exercises with grading=`incremental`; meaning that your students will complete one single tutorial with clear and autograded steps from beginning to end.
+
+Type `$ learnpack start` in your terminal to start the exercises.

package/lib/utils/templates/isolated/README.es.ejs

@@ -0,0 +1,5 @@
+# Bienvenido a <%= it.title %>
+
+Has inicializado los ejercicios con grading=`incremental`; esto signigica que tus estudiantes completarán un solo tutorial con pasos claros e incrementales, desde el comienzo hasta el final.
+
+Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

package/lib/utils/templates/isolated/exercises/01-hello-world/README.es.md

@@ -0,0 +1,26 @@
+# `01` Primer Ejercicio
+
+Hemos creado este primer ejercicio como ejemplo. Lo puedes ubicar en la carpeta `./01-hello-world`.
+
+1. Cada ejercicio debe estar ubicado en carpetas separadas y debe tener un archivo README.md con las instrucciones del ejercicio escrito en markdown.
+2. Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
+3. También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
+
+## Inserta videos
+
+Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```

package/lib/utils/templates/isolated/exercises/01-hello-world/README.md

@@ -0,0 +1,26 @@
+# `01` First Exercise
+
+We created this first exercise as an example, you can find it located in the folder `./01-hello-world`.
+
+1. Every exercise must be located on a separate folder and it must have a README.md file inside with the exercise instructions written in markdown.
+2. You can have just a README file and it will be like a page in a book, no code files.
+3. You can also add a `README.[lang].md` file for translations, for example: `README.es.md` for spanish.
+
+## Video compatibility
+
+If you want to include some video introduction for each exercise, add a `intro` property in the markdown frontmatter of the README.md for that particular exercise:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+You can also add a video solution for each exercise by adding a `tutorial` property on the markdown frontmatter of it's README.md:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```