@learnpack/learnpack 5.0.33 → 5.0.35

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.33 win32-x64 node-v22.14.0
+@learnpack/learnpack/5.0.35 win32-x64 node-v22.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -76,7 +76,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.33/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\audit.ts)_
 
 ## `learnpack breakToken`
 
@@ -91,7 +91,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\breakToken.ts)_
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -106,7 +106,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -124,7 +124,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -156,7 +156,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.33/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -192,7 +192,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -323,7 +323,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.33/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -345,7 +345,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.33/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -362,7 +362,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.33/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -376,7 +376,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.33/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.35/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/breakToken.js

@@ -4,18 +4,46 @@ const command_1 = require("@oclif/command");
 const BaseCommand_1 = require("../utils/BaseCommand");
 const console_1 = require("../utils/console");
 const creatorUtilities_1 = require("../utils/creatorUtilities");
+const exampleMd = `# How to Install Node.js
+
+Node.js lets you run JavaScript outside a web browser.
+
+## Step 1: Download Node.js
+
+Get the Node.js installer from the [official site](https://nodejs.org/en/download/).
+
+## Step 2: Install Node.js
+
+Open the installer and follow the steps to finish.
+
+## Step 3: Verify the Installation
+
+Open a terminal and type:
+
+\`\`\`bash
+node -v
+\`\`\`
+`;
 class BreakTokenCommand extends BaseCommand_1.default {
     async run() {
         const { flags } = this.parse(BreakTokenCommand);
         // await SessionManager.breakToken()
-        await (0, creatorUtilities_1.createFileOnDesktop)();
-        console_1.default.info("File created on desktop, please make the necessary changes and continue when ready");
-        // Wait for user to press enter
-        process.stdin.once("data", () => {
-            console_1.default.info("File content:");
-            console_1.default.info((0, creatorUtilities_1.getContentIndex)());
-            process.exit(0);
-        });
+        const paragraphs = (0, creatorUtilities_1.extractParagraphs)(exampleMd);
+        for (const paragraph of paragraphs) {
+            const syllables = (0, creatorUtilities_1.splitIntoSyllables)(paragraph);
+            const words = (0, creatorUtilities_1.extractWords)(paragraph);
+            const sentences = (0, creatorUtilities_1.countSentences)(paragraph);
+            const fkgl = (0, creatorUtilities_1.fleschKincaidGrade)(paragraph);
+            console_1.default.info(paragraph);
+            console_1.default.info(`Number of syllables: ${syllables.length}`);
+            console_1.default.info(syllables);
+            console_1.default.info(`Number of words: ${words.length}`);
+            console_1.default.info(words);
+            console_1.default.info(`Number of sentences: ${sentences}`);
+            console_1.default.info(`FKGL: ${fkgl}`);
+            console_1.default.info("---");
+        }
+        process.exit(0);
     }
 }
 BreakTokenCommand.description = "Break the token";

package/lib/commands/init.js

@@ -20,6 +20,12 @@ const durationByKind = {
     quiz: 2,
     read: 1,
 };
+const PARAMS = {
+    expected_grade_level: "6",
+    max_fkgl: 8,
+    max_words: 200,
+    max_rewrite_attempts: 3,
+};
 const whichTargetAudience = async () => {
     const res = await prompts([
         {
@@ -30,6 +36,48 @@ const whichTargetAudience = async () => {
     ]);
     return res.targetAudience;
 };
+async function processExercise(rigoToken, steps, packageContext, exercise, exercisesDir) {
+    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: steps.join(","),
+        tutorial_description: packageContext,
+        lesson_description: description,
+        kind: kind.toLowerCase(),
+    });
+    const duration = durationByKind[kind.toLowerCase()];
+    let attempts = 0;
+    let readability = (0, creatorUtilities_1.checkReadability)(readme.parsed.content, 200, duration || 1);
+    while (readability.fkglResult.fkgl > PARAMS.max_fkgl &&
+        attempts < PARAMS.max_rewrite_attempts) {
+        console_1.default.warning(`The lesson ${exTitle} has as readability score of  ${readability.fkglResult.fkgl} . It exceeds the maximum of words per minute. Rewriting it... (Attempt ${attempts + 1})`);
+        // eslint-disable-next-line
+        const reducedReadme = await (0, rigoActions_1.makeReadmeReadable)(rigoToken, {
+            lesson: readability.body,
+            number_of_words: readability.minutes.toString(),
+            expected_number_words: PARAMS.max_words.toString(),
+            fkgl_results: JSON.stringify(readability.fkglResult),
+            expected_grade_level: PARAMS.expected_grade_level,
+        });
+        if (!reducedReadme)
+            break;
+        readability = (0, creatorUtilities_1.checkReadability)(reducedReadme.parsed.content, PARAMS.max_words, duration || 1);
+        attempts++;
+    }
+    console_1.default.success(`After ${attempts} attempts, the lesson ${exTitle} has a readability score of ${readability.fkglResult.fkgl} using FKGL. And it has ${readability.minutes.toFixed(2)} minutes of reading time.`);
+    const readmeFilename = "README.md";
+    fs.writeFileSync(path.join(exerciseDir, readmeFilename), readability.newMarkdown);
+    if (kind.toLowerCase() === "code") {
+        const codeFile = await (0, rigoActions_1.createCodeFile)(rigoToken, {
+            readme: readability.newMarkdown,
+            tutorial_info: packageContext,
+        });
+        fs.writeFileSync(path.join(exerciseDir, `app.${codeFile.parsed.extension.replace(".", "")}`), codeFile.parsed.content);
+    }
+    return readability.newMarkdown;
+}
 const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
     let prevInteractions = "";
     let isReady = false;
@@ -180,43 +228,7 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
         const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`);
         fs.ensureDirSync(exerciseDir);
     }
-    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: steps.join(","),
-            tutorial_description: packageContext,
-            lesson_description: description,
-            kind: kind.toLowerCase(),
-        });
-        const duration = durationByKind[kind.toLowerCase()];
-        let readingTime = (0, creatorUtilities_1.checkReadingTime)(readme.parsed.content, 200, duration || 1);
-        if (readingTime.exceedsThreshold) {
-            // Console.info(
-            //   `The reading time for the lesson ${exTitle} exceeds the threshold, reducing it...`
-            // )
-            const reducedReadme = await (0, rigoActions_1.reduceReadme)(rigoToken, {
-                lesson: readingTime.body,
-                number_of_words: readingTime.minutes.toString(),
-                expected_number_words: "200",
-            });
-            if (reducedReadme) {
-                readingTime = (0, creatorUtilities_1.checkReadingTime)(reducedReadme.parsed.content, 200, duration || 1);
-            }
-        }
-        const readmeFilename = "README.md";
-        fs.writeFileSync(path.join(exerciseDir, readmeFilename), readingTime.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);
-        }
-        return readingTime.newMarkdown;
-    });
+    const exercisePromises = steps.map(exercise => processExercise(rigoToken, steps, packageContext, exercise, exercisesDir));
     const readmeContents = await Promise.all(exercisePromises);
     console_1.default.success("Lessons created! 🎉");
     console_1.default.info("Generating images for the lessons...");

package/lib/managers/config/exercise.js

@@ -94,6 +94,22 @@ const exercise = (path, position, configObject) => {
             }
             return content;
         },
+        renameFolder: function (newName) {
+            if (!(config === null || config === void 0 ? void 0 : config.dirPath)) {
+                throw new Error("No config directory found");
+            }
+            try {
+                const newPath = p.join(config === null || config === void 0 ? void 0 : config.exercisesPath, newName);
+                fs.renameSync(this.path, newPath);
+                this.path = newPath;
+                this.slug = newName;
+                this.title = newName;
+            }
+            catch (error) {
+                console.log(error);
+                throw new Error("Failed to rename exercise: " + error);
+            }
+        },
         saveFile: function (name, content) {
             const file = this.files.find((f) => f.name === name);
             if (file) {

package/lib/managers/server/routes.js

@@ -312,6 +312,27 @@ async function default_1(app, configObject, configManager) {
             return res.status(400).json({ error: error.message });
         }
     }));
+    app.put("/actions/rename", jsonBodyParser, withHandler(async (req, res) => {
+        const { slug, newSlug } = req.body;
+        const exercise = configManager.getExercise(slug);
+        if (!exercise) {
+            return res.status(400).json({ error: "Exercise not found" });
+        }
+        try {
+            if (exercise.renameFolder) {
+                exercise.renameFolder(newSlug);
+                res.json({ status: "ok" });
+            }
+            else {
+                res.status(500).json({
+                    error: "Failed to rename exercise because it's not supported by the exercise",
+                });
+            }
+        }
+        catch (_a) {
+            res.status(500).json({ error: "Failed to rename exercise" });
+        }
+    }));
     app.post("/exercise/:slug/create", jsonBodyParser, withHandler(async (req, res) => {
         const { title, readme, language } = req.body;
         const { slug } = req.params;

package/lib/models/exercise-obj.d.ts

@@ -17,6 +17,7 @@ export interface IExercise {
     getReadme?: (lang: string | null) => any;
     getFile?: (name: string) => string | Buffer;
     saveFile?: (name: string, content: string) => void;
+    renameFolder?: (newName: string) => void;
     getTestReport?: () => any;
     test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
 }

package/lib/utils/creatorUtilities.d.ts

@@ -14,11 +14,16 @@ export type PackageInfo = {
         us: string;
     };
 };
-export declare function checkReadingTime(markdown: string, wordsPerMinute?: number, maxMinutes?: number): {
+type TFKGLResult = {
+    text: string;
+    fkgl: number;
+};
+export declare function checkReadability(markdown: string, wordsPerMinute?: number, maxMinutes?: number): {
     newMarkdown: string;
     exceedsThreshold: boolean;
     minutes: number;
     body: string;
+    fkglResult: TFKGLResult;
 };
 export declare const getExInfo: (title: string) => {
     exNumber: string;
@@ -48,4 +53,41 @@ export declare function createFileOnDesktop(): Promise<void>;
 export declare function getContentIndex(): string;
 export declare function extractTextFromMarkdown(mdContent: string): string;
 export declare const saveTranslatedReadme: (exercise: string, languageCode: string, readme: string) => Promise<void>;
+/**
+ * Extracts paragraphs from a Markdown string.
+ * @param markdownText The input Markdown string.
+ * @returns An array of paragraph contents.
+ */
+export declare function extractParagraphs(markdownText: string): string[];
+/**
+ * Splits a paragraph into words and separates each word into syllables.
+ * @param paragraph The input paragraph.
+ * @returns An array of words, each split into syllables.
+ */
+export declare function splitIntoSyllables(paragraph: string): string[];
+/**
+ * Splits a word into its syllables using a basic estimation.
+ * @param word The word to split.
+ * @returns An array of syllables.
+ */
+export declare function splitWordIntoSyllables(word: string): string[];
+/**
+ * Extracts words from a given paragraph.
+ * @param paragraph The input text.
+ * @returns An array of words.
+ */
+export declare function extractWords(paragraph: string): string[];
+/**
+ * Calculates the Flesch-Kincaid Grade Level (FKGL) for a given text.
+ * @param text The input paragraph.
+ * @returns The FKGL score.
+ */
+export declare function fleschKincaidGrade(text: string): TFKGLResult;
+/**
+ * Counts the number of sentences in a given text.
+ * @param text The input paragraph.
+ * @returns The total number of sentences.
+ */
+export declare function countSentences(text: string): number;
+export declare function howManyDifficultParagraphs(paragraphs: TFKGLResult[], maxFKGL: number): number;
 export {};

package/lib/utils/creatorUtilities.js

@@ -1,14 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
-exports.checkReadingTime = checkReadingTime;
+exports.checkReadability = checkReadability;
 exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
 exports.estimateDuration = estimateDuration;
 exports.createFileOnDesktop = createFileOnDesktop;
 exports.getContentIndex = getContentIndex;
 exports.extractTextFromMarkdown = extractTextFromMarkdown;
+exports.extractParagraphs = extractParagraphs;
+exports.splitIntoSyllables = splitIntoSyllables;
+exports.splitWordIntoSyllables = splitWordIntoSyllables;
+exports.extractWords = extractWords;
+exports.fleschKincaidGrade = fleschKincaidGrade;
+exports.countSentences = countSentences;
+exports.howManyDifficultParagraphs = howManyDifficultParagraphs;
+const console_1 = require("./console");
 const frontMatter = require("front-matter");
+const MarkdownIt = require("markdown-it");
+const syllable_1 = require("syllable");
 const path = require("path");
 const fs = require("fs");
 const os_1 = require("os");
@@ -38,36 +48,38 @@ const estimateReadingTime = (text, wordsPerMinute = 150) => {
     };
 };
 exports.estimateReadingTime = estimateReadingTime;
-function checkReadingTime(markdown, wordsPerMinute = 200, maxMinutes = 1) {
+function checkReadability(markdown, wordsPerMinute = 200, maxMinutes = 1) {
     const parsed = frontMatter(markdown);
+    const fkglResult = fleschKincaidGrade(parsed.body);
     const readingTime = (0, exports.estimateReadingTime)(parsed.body, wordsPerMinute);
     // const readingEase = estimateReadingEase(parsed.body)
     let attributes = parsed.attributes ? parsed.attributes : {};
     if (typeof parsed.attributes !== "object") {
         attributes = {};
     }
-    const updatedAttributes = Object.assign(Object.assign({}, attributes), { readingTime });
+    const updatedAttributes = Object.assign(Object.assign({}, attributes), { readingTime, fkglResult: fkglResult.fkgl });
     let yamlFrontMatter = "";
     try {
         yamlFrontMatter = yaml.dump(updatedAttributes).trim();
     }
     catch (_a) {
+        console_1.default.error("Error dumping YAML front matter");
         return {
             newMarkdown: "",
             exceedsThreshold: false,
             minutes: 0,
             body: "",
+            fkglResult,
             // readingEase: 0,
         };
     }
-    // Reconstruct the markdown with the front matter
     const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`;
     return {
         newMarkdown,
         exceedsThreshold: readingTime.minutes > maxMinutes,
         minutes: readingTime.minutes,
         body: parsed.body,
-        // readingEase: 0,
+        fkglResult,
     };
 }
 const slugify = (text) => {
@@ -205,24 +217,16 @@ function getContentIndex() {
 //   return Math.round(206.835 - 1.015 * ASL - 84.6 * ASW)
 // }
 function extractTextFromMarkdown(mdContent) {
-    let content = mdContent.replace(/!\[.*?]\(.*?\)/g, "");
-    content = content.replace(/\[.*?]\(.*?\)/g, "");
-    content = content.replace(/`.*?`/g, "");
-    content = content.replace(/```[\S\s]*?```/g, "");
-    return content.trim();
+    return mdContent
+        .replace(/!\[.*?]\(.*?\)/g, "") // Remove images
+        .replace(/\[.*?]\(.*?\)/g, "") // Remove links
+        .replace(/(```[\S\s]*?```|`.*?`)/g, "") // Remove inline & block code
+        .replace(/^#.*$/gm, "") // Remove headings
+        .replace(/(\*{1,2}|_{1,2})/g, "") // Remove bold/italic markers
+        .replace(/>\s?/g, "") // Remove blockquotes
+        .replace(/[*-]\s+/g, "") // Remove bullets from lists
+        .trim();
 }
-// export const estimateReadingEase = async (text: string): Promise<number> => {
-//   const cleanedText = extractTextFromMarkdown(text)
-//   // @ts-ignore
-//   const rs = (await import("text-readability")).default;
-//   // return fleschKincaidReadingEase(cleanedText)
-//   // const score = readability(cleanedText)
-//   // console.log(score)
-//   // return score.fleschKincaid ?? 0
-//   const score = rs.fleschReadingEase(cleanedText)
-//   console.log(score, "SCORE FLESCH READING EASE")
-//   return score
-// }
 const cleanReadme = (readme) => {
     // Replace <text> and </text> with nothing
     return readme.replace(/<text>/g, "").replace(/<\/text>/g, "");
@@ -232,3 +236,100 @@ const saveTranslatedReadme = async (exercise, languageCode, readme) => {
     fs.writeFileSync(readmePath, cleanReadme(readme));
 };
 exports.saveTranslatedReadme = saveTranslatedReadme;
+/**
+ * Extracts paragraphs from a Markdown string.
+ * @param markdownText The input Markdown string.
+ * @returns An array of paragraph contents.
+ */
+function extractParagraphs(markdownText) {
+    var _a;
+    const md = new MarkdownIt();
+    const tokens = md.parse(markdownText, {});
+    const paragraphs = [];
+    for (let i = 0; i < tokens.length; i++) {
+        if (tokens[i].type === "paragraph_open" &&
+            ((_a = tokens[i + 1]) === null || _a === void 0 ? void 0 : _a.type) === "inline") {
+            paragraphs.push(tokens[i + 1].content);
+        }
+    }
+    return paragraphs;
+}
+/**
+ * Splits a paragraph into words and separates each word into syllables.
+ * @param paragraph The input paragraph.
+ * @returns An array of words, each split into syllables.
+ */
+function splitIntoSyllables(paragraph) {
+    const words = paragraph.split(/\s+/);
+    const syllables = [];
+    for (const word of words) {
+        syllables.push(...splitWordIntoSyllables(word));
+    }
+    return syllables;
+}
+/**
+ * Splits a word into its syllables using a basic estimation.
+ * @param word The word to split.
+ * @returns An array of syllables.
+ */
+function splitWordIntoSyllables(word) {
+    const syllableCount = (0, syllable_1.syllable)(word);
+    // Simple heuristic: Split word into equal parts (not perfect, better with a dictionary-based approach)
+    if (syllableCount <= 1)
+        return [word];
+    const approxLength = Math.ceil(word.length / syllableCount);
+    const syllables = [];
+    for (let i = 0; i < word.length; i += approxLength) {
+        // eslint-disable-next-line
+        syllables.push(word.substring(i, i + approxLength));
+    }
+    return syllables;
+}
+/**
+ * Extracts words from a given paragraph.
+ * @param paragraph The input text.
+ * @returns An array of words.
+ */
+function extractWords(paragraph) {
+    const words = paragraph.match(/\b\w+\b/g); // Match words using regex
+    return words ? words : []; // Return words or an empty array if none found
+}
+/**
+ * Calculates the Flesch-Kincaid Grade Level (FKGL) for a given text.
+ * @param text The input paragraph.
+ * @returns The FKGL score.
+ */
+function fleschKincaidGrade(text) {
+    const processableText = extractTextFromMarkdown(text);
+    const words = extractWords(processableText);
+    const numWords = words.length;
+    const numSentences = countSentences(processableText);
+    const numSyllables = words.reduce((total, word) => total + (0, syllable_1.syllable)(word), 0);
+    if (numWords === 0 || numSentences === 0) {
+        return {
+            text,
+            fkgl: 0,
+        };
+    }
+    const fkgl = 
+    // eslint-disable-next-line
+    0.39 * (numWords / numSentences) + 11.8 * (numSyllables / numWords) - 15.59;
+    return {
+        text,
+        fkgl: parseFloat(fkgl.toFixed(2)),
+    };
+}
+/**
+ * Counts the number of sentences in a given text.
+ * @param text The input paragraph.
+ * @returns The total number of sentences.
+ */
+function countSentences(text) {
+    const sentences = text
+        .split(/[!.?]+/)
+        .filter(sentence => sentence.trim().length > 0);
+    return sentences.length;
+}
+function howManyDifficultParagraphs(paragraphs, maxFKGL) {
+    return paragraphs.filter(paragraph => paragraph.fkgl > maxFKGL).length;
+}

package/lib/utils/rigoActions.d.ts

@@ -56,7 +56,9 @@ type TReduceReadmeInputs = {
     lesson: string;
     number_of_words: string;
     expected_number_words: string;
+    fkgl_results: string;
+    expected_grade_level: string;
 };
-export declare function reduceReadme(rigoToken: string, inputs: TReduceReadmeInputs): Promise<any>;
+export declare function makeReadmeReadable(rigoToken: string, inputs: TReduceReadmeInputs): Promise<any>;
 export declare const isValidRigoToken: (rigobotToken: string) => Promise<boolean>;
 export {};

package/lib/utils/rigoActions.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidRigoToken = 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;
-exports.reduceReadme = reduceReadme;
+exports.makeReadmeReadable = makeReadmeReadable;
 const axios_1 = require("axios");
 const fs_1 = require("fs");
 const console_1 = require("../utils/console");
@@ -176,7 +176,7 @@ async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeCo
     });
     fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer);
 }
-async function reduceReadme(rigoToken, inputs) {
+async function makeReadmeReadable(rigoToken, inputs) {
     try {
         const response = await axios_1.default.post(`${RIGOBOT_HOST}/v1/prompting/completion/588/`, { inputs, include_purpose_objective: false, execute_async: false }, {
             headers: {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.33","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":[]},"breakToken":{"id":"breakToken","description":"Break the token","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":[]},"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.35","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":[]},"breakToken":{"id":"breakToken","description":"Break the token","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":[]},"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":[]}}}