@learnpack/learnpack 5.0.29 → 5.0.31

package/lib/utils/creatorUtilities.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
+exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
 exports.checkReadingTime = checkReadingTime;
 exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
 exports.estimateDuration = estimateDuration;
 exports.createFileOnDesktop = createFileOnDesktop;
 exports.getContentIndex = getContentIndex;
-// eslint-disable-next-line
+exports.extractTextFromMarkdown = extractTextFromMarkdown;
 const frontMatter = require("front-matter");
 const path = require("path");
 const fs = require("fs");
@@ -41,6 +41,7 @@ exports.estimateReadingTime = estimateReadingTime;
 function checkReadingTime(markdown, wordsPerMinute = 200, maxMinutes = 1) {
     const parsed = frontMatter(markdown);
     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 = {};
@@ -56,6 +57,7 @@ function checkReadingTime(markdown, wordsPerMinute = 200, maxMinutes = 1) {
             exceedsThreshold: false,
             minutes: 0,
             body: "",
+            // readingEase: 0,
         };
     }
     // Reconstruct the markdown with the front matter
@@ -65,6 +67,7 @@ function checkReadingTime(markdown, wordsPerMinute = 200, maxMinutes = 1) {
         exceedsThreshold: readingTime.minutes > maxMinutes,
         minutes: readingTime.minutes,
         body: parsed.body,
+        // readingEase: 0,
     };
 }
 const slugify = (text) => {
@@ -146,11 +149,13 @@ function estimateDuration(listOfSteps) {
 }
 const writeFilePromise = (0, util_1.promisify)(fs.writeFile);
 const execPromise = (0, util_1.promisify)(child_process_1.exec);
-const example_content = `
-00.1 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]
-01.1 - Introduction to Machine Learning [READ: Small introduction to important concepts such as AI, machine learning, and their applications]
-01.2 - Introduction to Deep Learning [QUIZ: Small introduction to important concepts such as AI, machine learning, and their applications]
-02.1 - Test your knowledge [CODE: Code problem to solve]
+const example_content = `Write or paste your table of content below this line, each topic should be defined on a new line, here is an example:
+
+Introduction to AI: Explain what is AI and its applications
+Introduction to Machine Learning: Explain what is machine learning and its applications
+What is an AI Model: Explain what is an AI model and its applications
+How to use an AI Model: Different APIs, local models, etc.
+How to build an AI Model: Fine-tuning, data collection, cleaning and more.
 `;
 async function createFileOnDesktop() {
     try {
@@ -191,3 +196,39 @@ function getContentIndex() {
     const content = fs.readFileSync(filePath, "utf8");
     return content;
 }
+// export function fleschKincaidReadingEase(text: string): number {
+//   const sentences = text.split(/[.!?]/).filter((s) => s.trim().length > 0)
+//   const words = text.split(/\s+/).filter((w) => w.trim().length > 0)
+//   const totalSyllables = words.reduce((sum, word) => sum + syllable(word), 0)
+//   const ASL = words.length / sentences.length // Average Sentence Length
+//   const ASW = totalSyllables / words.length // Average Syllables per Word
+//   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();
+}
+// 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, "");
+};
+const saveTranslatedReadme = async (exercise, languageCode, readme) => {
+    const readmePath = path.join(process.cwd(), "exercises", exercise, `README.${languageCode}.md`);
+    fs.writeFileSync(readmePath, cleanReadme(readme));
+};
+exports.saveTranslatedReadme = saveTranslatedReadme;

package/lib/utils/rigoActions.d.ts

@@ -58,4 +58,5 @@ type TReduceReadmeInputs = {
     expected_number_words: string;
 };
 export declare function reduceReadme(rigoToken: string, inputs: TReduceReadmeInputs): Promise<any>;
+export declare const isValidRigoToken: (rigobotToken: string) => Promise<boolean>;
 export {};

package/lib/utils/rigoActions.js

@@ -1,6 +1,6 @@
 "use strict";
 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.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;
@@ -46,7 +46,7 @@ const hasCreatorPermission = async (token) => {
         return true;
     }
     catch (error) {
-        console_1.default.debug(error);
+        console_1.default.error(error);
         return false;
     }
 };
@@ -191,3 +191,14 @@ async function reduceReadme(rigoToken, inputs) {
         return null;
     }
 }
+const isValidRigoToken = async (rigobotToken) => {
+    const rigoUrl = `${RIGOBOT_HOST}/v1/auth/token/${rigobotToken}`;
+    const rigoResp = await fetch(rigoUrl);
+    if (!rigoResp.ok) {
+        console_1.default.debug("Invalid Rigobot token", rigoResp.status);
+        console_1.default.debug(rigoResp.statusText);
+        return false;
+    }
+    return true;
+};
+exports.isValidRigoToken = isValidRigoToken;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.29","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.31","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":[]}}}

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.29",
+  "version": "5.0.31",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -50,6 +50,7 @@
     "shelljs": "^0.8.4",
     "socket.io": "^4.4.1",
     "targz": "^1.0.1",
+    "text-readability": "^1.1.0",
     "tslib": "^1",
     "validator": "^13.1.1",
     "xxhashjs": "^0.2.2"
@@ -64,7 +65,7 @@
     "@types/js-yaml": "^4.0.9",
     "@types/mocha": "^5",
     "@types/mock-fs": "^4.13.1",
-    "@types/node": "^10.17.60",
+    "@types/node": "^22.13.5",
     "@types/node-persist": "^3.1.2",
     "@types/prompts": "^2.0.14",
     "@types/shelljs": "^0.8.9",