@learnpack/learnpack 5.0.26 → 5.0.27

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.26 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.27 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -140,7 +140,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -158,7 +158,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -176,7 +176,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -307,7 +307,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -329,7 +329,7 @@ OPTIONS
   -y, --yes                           Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -346,7 +346,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -360,7 +360,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.26/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.27/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/init.js

@@ -7,92 +7,39 @@ const fs = require("fs-extra");
 const prompts = require("prompts");
 const cli_ux_1 = require("cli-ux");
 const eta = require("eta");
-const api_1 = require("../utils/api");
 const console_1 = require("../utils/console");
 const errors_1 = require("../utils/errors");
 const path = require("path");
 const rigoActions_1 = require("../utils/rigoActions");
-const api_2 = require("../utils/api");
-const slugify = (text) => {
-    return text
-        .toString()
-        .normalize("NFD")
-        .replace(/[\u0300-\u036F]/g, "")
-        .toLowerCase()
-        .trim()
-        .replace(/\s+/g, "-")
-        .replace(/[^\w-]+/g, "");
-};
-const getExInfo = (title) => {
-    // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
-    let [exNumber, exTitle] = title.split(" - ");
-    // Extract kind and description
-    const kindMatch = exTitle.match(/\[(.*?):(.*?)]/);
-    const kind = kindMatch ? kindMatch[1].trim().toLowerCase() : "read";
-    const description = kindMatch ? kindMatch[2].trim() : "";
-    exNumber = exNumber.trim();
-    // Clean title
-    exTitle = exTitle.replace((kindMatch === null || kindMatch === void 0 ? void 0 : kindMatch[0]) || "", "").trim();
-    exTitle = slugify(exTitle);
-    return {
-        exNumber,
-        kind,
-        description,
-        exTitle,
-    };
-};
-function extractImagesFromMarkdown(markdown) {
-    const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g;
-    const images = [];
-    let match;
-    while ((match = imageRegex.exec(markdown)) !== null) {
-        const altText = match[1];
-        const url = match[2];
-        images.push({ alt: altText, url: url });
-    }
-    return images;
-}
-function getFilenameFromUrl(url) {
-    return path.basename(url);
-}
-const makePackageInfo = (choices) => {
-    const packageInfo = {
-        grading: choices.grading,
-        difficulty: choices.difficulty,
-        duration: parseInt(choices.duration),
-        description: {
-            us: choices.description,
-        },
-        title: {
-            us: choices.title,
-        },
-        slug: choices.title
-            .toLowerCase()
-            .replace(/ /g, "-")
-            .replace(/[^\w-]+/g, ""),
-    };
-    return packageInfo;
-};
-async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents) {
-    const readmeFilename = `README.md`;
-    const readmeContent = await (0, rigoActions_1.generateCourseIntroduction)(rigoToken, {
-        course_title: packageInfo.title.us,
-        lessons_context: readmeContents.join("\n"),
-    });
-    fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer);
-}
+const api_1 = require("../utils/api");
+const creatorUtilities_1 = require("../utils/creatorUtilities");
+const session_1 = require("../managers/session");
 const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
     let prevInteractions = "";
     let isReady = false;
     let currentSteps = [];
+    let currentTitle = "";
+    let currentDescription = "";
     while (!isReady) {
+        let wholeInfo = courseInfo;
+        wholeInfo += `
+    Current title: ${currentTitle}
+    Current description: ${currentDescription}
+    `;
         // eslint-disable-next-line
         const res = await (0, rigoActions_1.interactiveCreation)(rigoToken, {
-            courseInfo: courseInfo,
+            courseInfo: wholeInfo,
             prevInteractions: prevInteractions,
         });
         currentSteps = res.parsed.listOfSteps;
         isReady = res.parsed.ready;
+        if (res.parsed.title && currentTitle !== res.parsed.title) {
+            currentTitle = res.parsed.title;
+        }
+        if (res.parsed.description &&
+            currentDescription !== res.parsed.description) {
+            currentDescription = res.parsed.description;
+        }
         if (!isReady) {
             console.log(currentSteps);
             console_1.default.info(`AI: ${res.parsed.aiMessage}`);
@@ -109,42 +56,27 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
         }
     }
     return {
-        currentSteps,
-        prevInteractions,
+        steps: currentSteps,
+        title: currentTitle,
+        description: currentDescription,
+        interactions: prevInteractions,
     };
 };
 const handleAILogic = async (tutorialDir, packageInfo) => {
-    console_1.default.info("Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators");
     fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"));
-    const loginPrompts = await prompts([
-        {
-            type: "text",
-            name: "email",
-            message: "What's your email?",
-            validate: (value) => {
-                return value.length > 0 && value.includes("@");
-            },
-        },
-        {
-            type: "password",
-            name: "password",
-            message: "What's your password?",
-            validate: (value) => {
-                return value.length > 0;
-            },
-        },
-    ]);
-    let sessionPayload;
-    try {
-        sessionPayload = await api_1.default.login(loginPrompts.email, loginPrompts.password);
-    }
-    catch (error) {
-        console_1.default.error("Error trying to authenticate");
-        console_1.default.error(error.message || error);
-        return;
+    let sessionPayload = await session_1.default.getPayload();
+    if (!sessionPayload || !sessionPayload.rigobot) {
+        console_1.default.info("Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators");
+        try {
+            sessionPayload = await session_1.default.login();
+        }
+        catch (error) {
+            console_1.default.error("Error trying to authenticate");
+            console_1.default.error(error.message || error);
+        }
     }
     const rigoToken = sessionPayload.rigobot.key;
-    const consumables = await (0, api_2.getConsumables)(sessionPayload.token, "ai-generation");
+    const consumables = await (0, api_1.getConsumables)(sessionPayload.token, "ai-generation");
     if (consumables.ai_generation === 0) {
         console_1.default.error("It seems you cannot generate tutorials with AI. Make sure you creator subscription is up to date here: https://4geeks.com/profile/subscriptions? . If you believe there is an issue you can always contact support@4geeks.com");
         process.exit(1);
@@ -155,42 +87,53 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
         process.exit(1);
     }
     console_1.default.success("🎉 Let's begin this learning journey!");
-    const packageContext = `
+    let packageContext = `
   \n
-  The following information comes from user inputs 
   Title: ${packageInfo.title.us}
   Description: ${packageInfo.description.us}
-  Grading: ${packageInfo.grading}
   Difficulty: ${packageInfo.difficulty}
   Duration: ${packageInfo.duration}
-
-  Use it to generate more relevant exercises
   `;
-    const { currentSteps } = await initializeInteractiveCreation(rigoToken, packageContext);
+    const { steps, title, description } = await initializeInteractiveCreation(rigoToken, packageContext);
+    packageInfo.title.us = title;
+    packageInfo.description.us = description;
+    packageContext = `
+  Title: ${title}
+  Description: ${description}
+  Difficulty: ${packageInfo.difficulty}
+  Estimated duration: ${packageInfo.duration}
+  List of exercises: ${steps.join(", ")}
+  `;
     const exercisesDir = path.join(tutorialDir, "exercises");
     fs.ensureDirSync(exercisesDir);
     console_1.default.info("Creating lessons...");
-    for (const [index, exercise] of currentSteps.entries()) {
-        const { exNumber, exTitle } = getExInfo(exercise);
+    for (const [index, exercise] of steps.entries()) {
+        const { exNumber, exTitle } = (0, creatorUtilities_1.getExInfo)(exercise);
         const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`);
         fs.ensureDirSync(exerciseDir);
     }
-    const exercisePromises = currentSteps.map(async (exercise, index) => {
-        const { exNumber, exTitle, kind, description } = getExInfo(exercise);
+    const exercisePromises = steps.map(async (exercise, index) => {
+        const { exNumber, exTitle, kind, description } = (0, creatorUtilities_1.getExInfo)(exercise);
         const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`);
         const readme = await (0, rigoActions_1.readmeCreator)(rigoToken, {
             title: `${exNumber} - ${exTitle}`,
             output_lang: "en",
-            list_of_exercises: currentSteps.join(","),
+            list_of_exercises: steps.join(","),
             tutorial_description: packageContext,
             lesson_description: description,
             kind: kind.toLowerCase(),
         });
+        const { exceedsThreshold, newMarkdown } = (0, creatorUtilities_1.checkReadingTime)(readme.parsed.content, 200);
+        if (exceedsThreshold) {
+            console_1.default.error("The reading time exceeds the threshold");
+            console_1.default.info(`Please reduce the reading time of the lesson, current reading time is ${exceedsThreshold} minutes`);
+        }
         const readmeFilename = "README.md";
-        fs.writeFileSync(path.join(exerciseDir, readmeFilename), readme.parsed.content);
+        fs.writeFileSync(path.join(exerciseDir, readmeFilename), newMarkdown);
         if (kind.toLowerCase() === "code") {
             const codeFile = await (0, rigoActions_1.createCodeFile)(rigoToken, {
                 readme: readme.parsed.content,
+                tutorial_info: packageContext,
             });
             fs.writeFileSync(path.join(exerciseDir, `app.${codeFile.parsed.extension.replace(".", "")}`), codeFile.parsed.content);
         }
@@ -201,11 +144,11 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
     console_1.default.success("Lessons created! 🎉");
     console_1.default.info("Generating images for the lessons...");
     for (const content of readmeContents) {
-        imagesArray = [...imagesArray, ...extractImagesFromMarkdown(content)];
+        imagesArray = [...imagesArray, ...(0, creatorUtilities_1.extractImagesFromMarkdown)(content)];
     }
     const imagePromises = imagesArray.map(async (image) => {
         try {
-            const filename = getFilenameFromUrl(image.url);
+            const filename = (0, creatorUtilities_1.getFilenameFromUrl)(image.url);
             const imagePath = path.join(tutorialDir, ".learn", "assets", filename);
             const res = await (0, rigoActions_1.generateImage)(rigoToken, { prompt: image.alt });
             await (0, rigoActions_1.downloadImage)(res.image_url, imagePath);
@@ -219,7 +162,7 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
     await Promise.all(imagePromises);
     console_1.default.info("Images generated successfully! 🎉 Your tutorial will be ready soon!");
     console_1.default.info("Creating preview readme...");
-    await createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents);
+    await (0, rigoActions_1.createPreviewReadme)(tutorialDir, packageInfo, rigoToken, readmeContents);
     return true;
 };
 const getChoices = async (empty) => {
@@ -307,7 +250,7 @@ class InitComand extends BaseCommand_1.default {
         const { flags } = this.parse(InitComand);
         await alreadyInitialized();
         const choices = await getChoices(flags.yes);
-        const packageInfo = makePackageInfo(choices);
+        const packageInfo = (0, creatorUtilities_1.makePackageInfo)(choices);
         const tutorialDir = `./${packageInfo.slug}`;
         fs.ensureDirSync(tutorialDir);
         const templatesDir = path.resolve(__dirname, "../../src/utils/templates/" + (choices.grading || "no-grading"));

package/lib/utils/creatorUtilities.d.ts

@@ -0,0 +1,44 @@
+type TEstimateReadingTimeReturns = {
+    minutes: number;
+    words: number;
+};
+export declare const estimateReadingTime: (text: string, wordsPerMinute?: number) => TEstimateReadingTimeReturns;
+export type PackageInfo = {
+    grading: string;
+    difficulty: string;
+    duration: number;
+    description: {
+        us: string;
+    };
+    title: {
+        us: string;
+    };
+};
+export declare function checkReadingTime(markdown: string, wordsPerMinute?: number): {
+    newMarkdown: string;
+    exceedsThreshold: boolean;
+};
+export declare const getExInfo: (title: string) => {
+    exNumber: string;
+    kind: string;
+    description: string;
+    exTitle: string;
+};
+export declare function extractImagesFromMarkdown(markdown: string): {
+    alt: string;
+    url: string;
+}[];
+export declare function getFilenameFromUrl(url: string): string;
+export declare const makePackageInfo: (choices: any) => {
+    grading: any;
+    difficulty: any;
+    duration: number;
+    description: {
+        us: any;
+    };
+    title: {
+        us: any;
+    };
+    slug: any;
+};
+export {};

package/lib/utils/creatorUtilities.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
+exports.checkReadingTime = checkReadingTime;
+exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
+exports.getFilenameFromUrl = getFilenameFromUrl;
+// eslint-disable-next-line
+const frontMatter = require("front-matter");
+const path = require("path");
+const yaml = require("js-yaml");
+const estimateReadingTime = (text, wordsPerMinute = 150) => {
+    const words = text.trim().split(/\s+/).length;
+    const minutes = words / wordsPerMinute;
+    if (minutes < 1) {
+        if (words === 0)
+            return {
+                minutes: 1,
+                words,
+            };
+    }
+    else {
+        return {
+            minutes,
+            words,
+        };
+    }
+    return {
+        minutes: 1,
+        words,
+    };
+};
+exports.estimateReadingTime = estimateReadingTime;
+function checkReadingTime(markdown, wordsPerMinute = 150) {
+    const parsed = frontMatter(markdown);
+    const readingTime = (0, exports.estimateReadingTime)(parsed.body, wordsPerMinute);
+    let attributes = parsed.attributes ? parsed.attributes : {};
+    if (typeof parsed.attributes !== "object") {
+        attributes = {};
+    }
+    const updatedAttributes = Object.assign(Object.assign({}, attributes), { readingTime });
+    // Convert the front matter back to a proper YAML string
+    const yamlFrontMatter = yaml.dump(updatedAttributes).trim();
+    // Reconstruct the markdown with the front matter
+    const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`;
+    return {
+        newMarkdown,
+        exceedsThreshold: readingTime.minutes > wordsPerMinute,
+    };
+}
+const slugify = (text) => {
+    return text
+        .toString()
+        .normalize("NFD")
+        .replace(/[\u0300-\u036F]/g, "")
+        .toLowerCase()
+        .trim()
+        .replace(/\s+/g, "-")
+        .replace(/[^\w-]+/g, "");
+};
+const getExInfo = (title) => {
+    // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
+    let [exNumber, exTitle] = title.split(" - ");
+    // Extract kind and description
+    const kindMatch = exTitle.match(/\[(.*?):(.*?)]/);
+    const kind = kindMatch ? kindMatch[1].trim().toLowerCase() : "read";
+    const description = kindMatch ? kindMatch[2].trim() : "";
+    exNumber = exNumber.trim();
+    // Clean title
+    exTitle = exTitle.replace((kindMatch === null || kindMatch === void 0 ? void 0 : kindMatch[0]) || "", "").trim();
+    exTitle = slugify(exTitle);
+    return {
+        exNumber,
+        kind,
+        description,
+        exTitle,
+    };
+};
+exports.getExInfo = getExInfo;
+function extractImagesFromMarkdown(markdown) {
+    const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g;
+    const images = [];
+    let match;
+    while ((match = imageRegex.exec(markdown)) !== null) {
+        const altText = match[1];
+        const url = match[2];
+        images.push({ alt: altText, url: url });
+    }
+    return images;
+}
+function getFilenameFromUrl(url) {
+    return path.basename(url);
+}
+const makePackageInfo = (choices) => {
+    const packageInfo = {
+        grading: choices.grading,
+        difficulty: choices.difficulty,
+        duration: parseInt(choices.duration),
+        description: {
+            us: choices.description,
+        },
+        title: {
+            us: choices.title,
+        },
+        slug: choices.title
+            .toLowerCase()
+            .replace(/ /g, "-")
+            .replace(/[^\w-]+/g, ""),
+    };
+    return packageInfo;
+};
+exports.makePackageInfo = makePackageInfo;

package/lib/utils/rigoActions.d.ts

@@ -1,3 +1,4 @@
+import { PackageInfo } from "./creatorUtilities";
 type TCreateReadmeInputs = {
     title: string;
     output_lang: string;
@@ -30,6 +31,7 @@ type TInteractiveCreationInputs = {
 export declare const interactiveCreation: (token: string, inputs: TInteractiveCreationInputs) => Promise<any>;
 type TCreateCodeFileInputs = {
     readme: string;
+    tutorial_info: string;
 };
 export declare const createCodeFile: (token: string, inputs: TCreateCodeFileInputs) => Promise<any>;
 type TCreateCodingReadmeInputs = {
@@ -49,4 +51,5 @@ type TReadmeCreatorInputs = {
     kind: string;
 };
 export declare const readmeCreator: (token: string, inputs: TReadmeCreatorInputs) => Promise<any>;
+export declare function createPreviewReadme(tutorialDir: string, packageInfo: PackageInfo, rigoToken: string, readmeContents: string[]): Promise<void>;
 export {};

package/lib/utils/rigoActions.js

@@ -2,9 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readmeCreator = exports.createCodingReadme = exports.createCodeFile = exports.interactiveCreation = exports.generateCourseIntroduction = exports.translateExercise = exports.generateImage = exports.hasCreatorPermission = exports.createReadme = void 0;
 exports.downloadImage = downloadImage;
+exports.createPreviewReadme = createPreviewReadme;
 const axios_1 = require("axios");
 const fs_1 = require("fs");
 const console_1 = require("../utils/console");
+const fs = require("fs");
+const path = require("path");
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 const createReadme = async (token, inputs) => {
     try {
@@ -164,3 +167,11 @@ const readmeCreator = async (token, inputs) => {
     throw new Error("Invalid kind of lesson");
 };
 exports.readmeCreator = readmeCreator;
+async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents) {
+    const readmeFilename = `README.md`;
+    const readmeContent = await (0, exports.generateCourseIntroduction)(rigoToken, {
+        course_title: packageInfo.title.us,
+        lessons_context: readmeContents.join("\n"),
+    });
+    fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer);
+}

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.26","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}
+{"version":"5.0.27","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.26",
+  "version": "5.0.27",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -41,6 +41,7 @@
     "eta": "^1.2.0",
     "express": "^4.17.1",
     "front-matter": "^4.0.2",
+    "js-yaml": "^4.1.0",
     "moment": "^2.27.0",
     "node-emoji": "^1.10.0",
     "node-fetch": "^2.7.0",
@@ -60,6 +61,7 @@
     "@types/debounce": "^1.2.1",
     "@types/express": "^4.17.13",
     "@types/fs-extra": "^8.1.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/mocha": "^5",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^10.17.60",

package/src/commands/init.ts

@@ -15,128 +15,59 @@ import {
   hasCreatorPermission,
   generateImage,
   downloadImage,
-  generateCourseIntroduction,
   interactiveCreation,
   createCodeFile,
   readmeCreator,
+  createPreviewReadme,
 } from "../utils/rigoActions"
 import { getConsumables } from "../utils/api"
-
-const slugify = (text: string) => {
-  return text
-    .toString()
-    .normalize("NFD")
-    .replace(/[\u0300-\u036F]/g, "")
-    .toLowerCase()
-    .trim()
-    .replace(/\s+/g, "-")
-    .replace(/[^\w-]+/g, "")
-}
-
-const getExInfo = (title: string) => {
-  // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
-  let [exNumber, exTitle] = title.split(" - ")
-
-  // Extract kind and description
-  const kindMatch = exTitle.match(/\[(.*?):(.*?)]/)
-  const kind = kindMatch ? kindMatch[1].trim().toLowerCase() : "read"
-  const description = kindMatch ? kindMatch[2].trim() : ""
-
-  exNumber = exNumber.trim()
-  // Clean title
-  exTitle = exTitle.replace(kindMatch?.[0] || "", "").trim()
-  exTitle = slugify(exTitle)
-
-  return {
-    exNumber,
-    kind,
-    description,
-    exTitle,
-  }
-}
-
-function extractImagesFromMarkdown(markdown: string) {
-  const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g
-  const images = []
-  let match
-
-  while ((match = imageRegex.exec(markdown)) !== null) {
-    const altText = match[1]
-    const url = match[2]
-    images.push({ alt: altText, url: url })
-  }
-
-  return images
-}
-
-function getFilenameFromUrl(url: string) {
-  return path.basename(url)
-}
-
-const makePackageInfo = (choices: any) => {
-  const packageInfo = {
-    grading: choices.grading,
-    difficulty: choices.difficulty,
-    duration: parseInt(choices.duration),
-    description: {
-      us: choices.description,
-    },
-    title: {
-      us: choices.title,
-    },
-    slug: choices.title
-      .toLowerCase()
-      .replace(/ /g, "-")
-      .replace(/[^\w-]+/g, ""),
-  }
-  return packageInfo
-}
-
-async function createPreviewReadme(
-  tutorialDir: string,
-  packageInfo: PackageInfo,
-  rigoToken: string,
-  readmeContents: string[]
-) {
-  const readmeFilename = `README.md`
-
-  const readmeContent = await generateCourseIntroduction(rigoToken, {
-    course_title: packageInfo.title.us,
-    lessons_context: readmeContents.join("\n"),
-  })
-  fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer)
-}
-
-type PackageInfo = {
-  grading: string
-  difficulty: string
-  duration: number
-  description: {
-    us: string
-  }
-  title: {
-    us: string
-  }
-}
+import {
+  checkReadingTime,
+  PackageInfo,
+  getExInfo,
+  extractImagesFromMarkdown,
+  getFilenameFromUrl,
+  makePackageInfo,
+} from "../utils/creatorUtilities"
+import SessionManager from "../managers/session"
 
 const initializeInteractiveCreation = async (
   rigoToken: string,
   courseInfo: string
 ): Promise<{
-  currentSteps: string[]
-  prevInteractions: string
+  steps: string[]
+  title: string
+  description: string
+  interactions: string
 }> => {
   let prevInteractions = ""
   let isReady = false
   let currentSteps = []
+  let currentTitle = ""
+  let currentDescription = ""
   while (!isReady) {
+    let wholeInfo = courseInfo
+    wholeInfo += `
+    Current title: ${currentTitle}
+    Current description: ${currentDescription}
+    `
     // eslint-disable-next-line
     const res = await interactiveCreation(rigoToken, {
-      courseInfo: courseInfo,
+      courseInfo: wholeInfo,
       prevInteractions: prevInteractions,
     })
     currentSteps = res.parsed.listOfSteps
     isReady = res.parsed.ready
+    if (res.parsed.title && currentTitle !== res.parsed.title) {
+      currentTitle = res.parsed.title
+    }
+
+    if (
+      res.parsed.description &&
+      currentDescription !== res.parsed.description
+    ) {
+      currentDescription = res.parsed.description
+    }
 
     if (!isReady) {
       console.log(currentSteps)
@@ -155,44 +86,28 @@ const initializeInteractiveCreation = async (
   }
 
   return {
-    currentSteps,
-    prevInteractions,
+    steps: currentSteps,
+    title: currentTitle,
+    description: currentDescription,
+    interactions: prevInteractions,
   }
 }
 
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
-  Console.info(
-    "Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators"
-  )
-
   fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"))
 
-  const loginPrompts = await prompts([
-    {
-      type: "text",
-      name: "email",
-      message: "What's your email?",
-      validate: (value: string) => {
-        return value.length > 0 && value.includes("@")
-      },
-    },
-    {
-      type: "password",
-      name: "password",
-      message: "What's your password?",
-      validate: (value: string) => {
-        return value.length > 0
-      },
-    },
-  ])
+  let sessionPayload = await SessionManager.getPayload()
 
-  let sessionPayload
-  try {
-    sessionPayload = await api.login(loginPrompts.email, loginPrompts.password)
-  } catch (error) {
-    Console.error("Error trying to authenticate")
-    Console.error((error as TypeError).message || (error as string))
-    return
+  if (!sessionPayload || !sessionPayload.rigobot) {
+    Console.info(
+      "Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators"
+    )
+    try {
+      sessionPayload = await SessionManager.login()
+    } catch (error) {
+      Console.error("Error trying to authenticate")
+      Console.error((error as TypeError).message || (error as string))
+    }
   }
 
   const rigoToken = sessionPayload.rigobot.key
@@ -219,71 +134,84 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   Console.success("🎉 Let's begin this learning journey!")
 
-  const packageContext = `
+  let packageContext = `
   \n
-  The following information comes from user inputs 
   Title: ${packageInfo.title.us}
   Description: ${packageInfo.description.us}
-  Grading: ${packageInfo.grading}
   Difficulty: ${packageInfo.difficulty}
   Duration: ${packageInfo.duration}
-
-  Use it to generate more relevant exercises
   `
 
-  const { currentSteps } = await initializeInteractiveCreation(
+  const { steps, title, description } = await initializeInteractiveCreation(
     rigoToken,
     packageContext
   )
+  packageInfo.title.us = title
+  packageInfo.description.us = description
 
+  packageContext = `
+  Title: ${title}
+  Description: ${description}
+  Difficulty: ${packageInfo.difficulty}
+  Estimated duration: ${packageInfo.duration}
+  List of exercises: ${steps.join(", ")}
+  `
   const exercisesDir = path.join(tutorialDir, "exercises")
   fs.ensureDirSync(exercisesDir)
 
   Console.info("Creating lessons...")
-  for (const [index, exercise] of currentSteps.entries()) {
+  for (const [index, exercise] of steps.entries()) {
     const { exNumber, exTitle } = getExInfo(exercise)
     const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`)
     fs.ensureDirSync(exerciseDir)
   }
 
-  const exercisePromises = currentSteps.map(
-    async (exercise: any, index: number) => {
-      const { exNumber, exTitle, kind, description } = getExInfo(exercise)
-      const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`)
-
-      const readme = await readmeCreator(rigoToken, {
-        title: `${exNumber} - ${exTitle}`,
-        output_lang: "en",
-        list_of_exercises: currentSteps.join(","),
-        tutorial_description: packageContext,
-        lesson_description: description,
-        kind: kind.toLowerCase(),
-      })
+  const exercisePromises = steps.map(async (exercise: any, index: number) => {
+    const { exNumber, exTitle, kind, description } = getExInfo(exercise)
+    const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`)
 
-      const readmeFilename = "README.md"
+    const readme = await readmeCreator(rigoToken, {
+      title: `${exNumber} - ${exTitle}`,
+      output_lang: "en",
+      list_of_exercises: steps.join(","),
+      tutorial_description: packageContext,
+      lesson_description: description,
+      kind: kind.toLowerCase(),
+    })
 
-      fs.writeFileSync(
-        path.join(exerciseDir, readmeFilename),
-        readme.parsed.content
+    const { exceedsThreshold, newMarkdown } = checkReadingTime(
+      readme.parsed.content,
+      200
+    )
+
+    if (exceedsThreshold) {
+      Console.error("The reading time exceeds the threshold")
+      Console.info(
+        `Please reduce the reading time of the lesson, current reading time is ${exceedsThreshold} minutes`
       )
+    }
 
-      if (kind.toLowerCase() === "code") {
-        const codeFile = await createCodeFile(rigoToken, {
-          readme: readme.parsed.content,
-        })
-
-        fs.writeFileSync(
-          path.join(
-            exerciseDir,
-            `app.${codeFile.parsed.extension.replace(".", "")}`
-          ),
-          codeFile.parsed.content
-        )
-      }
+    const readmeFilename = "README.md"
 
-      return readme.parsed.content
+    fs.writeFileSync(path.join(exerciseDir, readmeFilename), newMarkdown)
+
+    if (kind.toLowerCase() === "code") {
+      const codeFile = await createCodeFile(rigoToken, {
+        readme: readme.parsed.content,
+        tutorial_info: packageContext,
+      })
+
+      fs.writeFileSync(
+        path.join(
+          exerciseDir,
+          `app.${codeFile.parsed.extension.replace(".", "")}`
+        ),
+        codeFile.parsed.content
+      )
     }
-  )
+
+    return readme.parsed.content
+  })
 
   let imagesArray: any[] = []
 

package/src/utils/creatorUtilities.ts

@@ -0,0 +1,147 @@
+// eslint-disable-next-line
+const frontMatter = require("front-matter")
+import * as path from "path"
+
+import * as yaml from "js-yaml"
+
+type TEstimateReadingTimeReturns = {
+  minutes: number
+  words: number
+}
+
+export const estimateReadingTime = (
+  text: string,
+  wordsPerMinute = 150
+): TEstimateReadingTimeReturns => {
+  const words = text.trim().split(/\s+/).length
+  const minutes = words / wordsPerMinute
+
+  if (minutes < 1) {
+    if (words === 0)
+      return {
+        minutes: 1,
+        words,
+      }
+  } else {
+    return {
+      minutes,
+      words,
+    }
+  }
+
+  return {
+    minutes: 1,
+    words,
+  }
+}
+
+export type PackageInfo = {
+  grading: string
+  difficulty: string
+  duration: number
+  description: {
+    us: string
+  }
+  title: {
+    us: string
+  }
+}
+
+export function checkReadingTime(
+  markdown: string,
+  wordsPerMinute = 150
+): { newMarkdown: string; exceedsThreshold: boolean } {
+  const parsed = frontMatter(markdown)
+  const readingTime = estimateReadingTime(parsed.body, wordsPerMinute)
+  let attributes = parsed.attributes ? parsed.attributes : {}
+
+  if (typeof parsed.attributes !== "object") {
+    attributes = {}
+  }
+
+  const updatedAttributes = {
+    ...attributes,
+    readingTime,
+  }
+
+  // Convert the front matter back to a proper YAML string
+  const yamlFrontMatter = yaml.dump(updatedAttributes).trim()
+
+  // Reconstruct the markdown with the front matter
+  const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`
+
+  return {
+    newMarkdown,
+    exceedsThreshold: readingTime.minutes > wordsPerMinute,
+  }
+}
+
+const slugify = (text: string) => {
+  return text
+    .toString()
+    .normalize("NFD")
+    .replace(/[\u0300-\u036F]/g, "")
+    .toLowerCase()
+    .trim()
+    .replace(/\s+/g, "-")
+    .replace(/[^\w-]+/g, "")
+}
+
+export const getExInfo = (title: string) => {
+  // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
+  let [exNumber, exTitle] = title.split(" - ")
+
+  // Extract kind and description
+  const kindMatch = exTitle.match(/\[(.*?):(.*?)]/)
+  const kind = kindMatch ? kindMatch[1].trim().toLowerCase() : "read"
+  const description = kindMatch ? kindMatch[2].trim() : ""
+
+  exNumber = exNumber.trim()
+  // Clean title
+  exTitle = exTitle.replace(kindMatch?.[0] || "", "").trim()
+  exTitle = slugify(exTitle)
+
+  return {
+    exNumber,
+    kind,
+    description,
+    exTitle,
+  }
+}
+
+export function extractImagesFromMarkdown(markdown: string) {
+  const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g
+  const images = []
+  let match
+
+  while ((match = imageRegex.exec(markdown)) !== null) {
+    const altText = match[1]
+    const url = match[2]
+    images.push({ alt: altText, url: url })
+  }
+
+  return images
+}
+
+export function getFilenameFromUrl(url: string) {
+  return path.basename(url)
+}
+
+export const makePackageInfo = (choices: any) => {
+  const packageInfo = {
+    grading: choices.grading,
+    difficulty: choices.difficulty,
+    duration: parseInt(choices.duration),
+    description: {
+      us: choices.description,
+    },
+    title: {
+      us: choices.title,
+    },
+    slug: choices.title
+      .toLowerCase()
+      .replace(/ /g, "-")
+      .replace(/[^\w-]+/g, ""),
+  }
+  return packageInfo
+}

package/src/utils/rigoActions.ts

@@ -1,6 +1,9 @@
 import axios from "axios"
 import { writeFile } from "fs"
 import Console from "../utils/console"
+import { PackageInfo } from "./creatorUtilities"
+import * as fs from "fs"
+import * as path from "path"
 
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 
@@ -188,6 +191,7 @@ export const interactiveCreation = async (
 
 type TCreateCodeFileInputs = {
   readme: string
+  tutorial_info: string
 }
 
 export const createCodeFile = async (
@@ -262,7 +266,7 @@ export const readmeCreator = async (
     return createReadme(token, createReadmeInputs)
   }
 
- if (inputs.kind === "code") {
+  if (inputs.kind === "code") {
     return createCodingReadme(token, {
       title: inputs.title,
       output_lang: inputs.output_lang,
@@ -271,7 +275,21 @@ export const readmeCreator = async (
       lesson_description: inputs.lesson_description,
     })
   }
- 
-    throw new Error("Invalid kind of lesson")
-  
+
+  throw new Error("Invalid kind of lesson")
+}
+
+export async function createPreviewReadme(
+  tutorialDir: string,
+  packageInfo: PackageInfo,
+  rigoToken: string,
+  readmeContents: string[]
+) {
+  const readmeFilename = `README.md`
+
+  const readmeContent = await generateCourseIntroduction(rigoToken, {
+    course_title: packageInfo.title.us,
+    lessons_context: readmeContents.join("\n"),
+  })
+  fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer)
 }