@learnpack/learnpack 5.0.43 → 5.0.44

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.43 win32-x64 node-v22.14.0
+@learnpack/learnpack/5.0.44 win32-x64 node-v22.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -79,7 +79,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.43/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\audit.ts)_
 
 ## `learnpack breakToken`
 
@@ -94,7 +94,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.43/src\commands\breakToken.ts)_
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -109,7 +109,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -127,7 +127,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -159,7 +159,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.43/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -177,7 +177,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -195,7 +195,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -327,7 +327,7 @@ OPTIONS
   -s, --strict  strict mode
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.43/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -349,7 +349,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.43/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -366,7 +366,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.43/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -380,7 +380,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.43/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.44/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/init.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = require("@oclif/command");
 const BaseCommand_1 = require("../utils/BaseCommand");
+const ora_1 = require("ora");
 // eslint-disable-next-line
 const fs = require("fs-extra");
 const prompts = require("prompts");
@@ -102,6 +103,7 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
     let currentDescription = "";
     let currentDifficulty = "";
     while (!isReady) {
+        const spinner = (0, ora_1.default)("Thinking...").start();
         let wholeInfo = courseInfo;
         wholeInfo += `
     Current title: ${currentTitle}
@@ -112,6 +114,7 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
             courseInfo: wholeInfo,
             prevInteractions: prevInteractions,
         });
+        spinner.succeed("Done!");
         currentSteps = res.parsed.listOfSteps;
         isReady = res.parsed.ready;
         if (res.parsed.title && currentTitle !== res.parsed.title) {
@@ -152,60 +155,6 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
 process.emitWarning = (warning) => {
     console_1.default.debug("A Warning was emitted by Node.js: ", warning);
 };
-const appendContentIndex = async () => {
-    const choices = await prompts([
-        {
-            type: "confirm",
-            name: "contentIndex",
-            message: "Do you have a content index for this tutorial?",
-        },
-    ]);
-    if (choices.contentIndex) {
-        await (0, creatorUtilities_1.createFileOnDesktop)("content_index.txt");
-        console_1.default.info("Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready.");
-        const isReady = await prompts([
-            {
-                type: "confirm",
-                name: "isReady",
-                message: "Are you ready to continue?",
-            },
-        ]);
-        if (!isReady.isReady) {
-            console_1.default.error("Please make the necessary changes and try again.");
-            process.exit(1);
-        }
-        const contentIndex = (0, creatorUtilities_1.getDesktopFile)("content_index.txt");
-        return contentIndex;
-    }
-    return null;
-};
-const appendAIRules = async () => {
-    const choices = await prompts([
-        {
-            type: "confirm",
-            name: "airules",
-            message: "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
-        },
-    ]);
-    if (choices.airules) {
-        await (0, creatorUtilities_1.createFileOnDesktop)("airules.txt");
-        console_1.default.info("Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready.");
-        const isReady = await prompts([
-            {
-                type: "confirm",
-                name: "isReady",
-                message: "Are you ready to continue?",
-            },
-        ]);
-        if (!isReady.isReady) {
-            console_1.default.error("Please make the necessary changes and try again.");
-            process.exit(1);
-        }
-        const airules = (0, creatorUtilities_1.getDesktopFile)("airules.txt");
-        return airules;
-    }
-    return null;
-};
 const handleAILogic = async (tutorialDir, packageInfo) => {
     fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"));
     let sessionPayload = await session_1.default.getPayload();
@@ -239,8 +188,8 @@ const handleAILogic = async (tutorialDir, packageInfo) => {
     }
     console_1.default.success("🎉 Let's begin this learning journey!");
     const { targetAudience, estimatedDuration } = await whichTargetAudienceAndEstimatedDuration();
-    const contentIndex = await appendContentIndex();
-    const airules = await appendAIRules();
+    const contentIndex = await (0, creatorUtilities_1.appendContentIndex)();
+    const airules = await (0, creatorUtilities_1.appendAIRules)();
     let packageContext = `
   \n
   Title: "${packageInfo.title.us}"

package/lib/utils/creatorUtilities.d.ts

@@ -49,7 +49,7 @@ export declare const makePackageInfo: (choices: any) => {
     slug: any;
 };
 export declare function estimateDuration(listOfSteps: string[]): number;
-export declare function createFileOnDesktop(fileName: string): Promise<void>;
+export declare function createFileOnDesktop(fileName: string, content: string): Promise<void>;
 export declare function getDesktopFile(fileName: string): string;
 export declare function extractTextFromMarkdown(mdContent: string): string;
 export declare const saveTranslatedReadme: (exercise: string, languageCode: string, readme: string) => Promise<void>;
@@ -90,4 +90,6 @@ export declare function fleschKincaidGrade(text: string): TFKGLResult;
  */
 export declare function countSentences(text: string): number;
 export declare function howManyDifficultParagraphs(paragraphs: TFKGLResult[], maxFKGL: number): number;
+export declare const appendContentIndex: () => Promise<string | null>;
+export declare const appendAIRules: () => Promise<string | null>;
 export {};

package/lib/utils/creatorUtilities.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
+exports.appendAIRules = exports.appendContentIndex = exports.saveTranslatedReadme = exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void 0;
 exports.checkReadability = checkReadability;
 exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
@@ -26,6 +26,7 @@ const path_1 = require("path");
 const child_process_1 = require("child_process");
 const util_1 = require("util");
 const yaml = require("js-yaml");
+const prompts = require("prompts");
 const estimateReadingTime = (text, wordsPerMinute = 150) => {
     const words = text.trim().split(/\s+/).length;
     const minutes = words / wordsPerMinute;
@@ -161,19 +162,10 @@ function estimateDuration(listOfSteps) {
 }
 const writeFilePromise = (0, util_1.promisify)(fs.writeFile);
 const execPromise = (0, util_1.promisify)(child_process_1.exec);
-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(fileName) {
+async function createFileOnDesktop(fileName, content) {
     try {
         const desktopPath = (0, path_1.join)((0, os_1.homedir)(), "Desktop");
         const filePath = (0, path_1.join)(desktopPath, fileName);
-        const content = example_content.trim();
         await writeFilePromise(filePath, content);
         console.log(`File created successfully at: ${filePath}`);
         await openFile(filePath);
@@ -333,3 +325,75 @@ function countSentences(text) {
 function howManyDifficultParagraphs(paragraphs, maxFKGL) {
     return paragraphs.filter(paragraph => paragraph.fkgl > maxFKGL).length;
 }
+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.
+`;
+const appendContentIndex = async () => {
+    const choices = await prompts([
+        {
+            type: "confirm",
+            name: "contentIndex",
+            message: "Do you have a content index for this tutorial?",
+        },
+    ]);
+    if (choices.contentIndex) {
+        await createFileOnDesktop("content_index.txt", example_content);
+        console_1.default.info("Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready.");
+        const isReady = await prompts([
+            {
+                type: "confirm",
+                name: "isReady",
+                message: "Are you ready to continue?",
+            },
+        ]);
+        if (!isReady.isReady) {
+            console_1.default.error("Please make the necessary changes and try again.");
+            process.exit(1);
+        }
+        const contentIndex = getDesktopFile("content_index.txt");
+        return contentIndex;
+    }
+    return null;
+};
+exports.appendContentIndex = appendContentIndex;
+const example_airules = `
+Write with an engaging tone, use simple words and avoid complex sentences.
+Write in first person, as if you are talking to the reader.
+Add mental maps to help the reader understand the content.
+Add diagrams to help the reader understand the content.
+No code exercises required
+
+`;
+const appendAIRules = async () => {
+    const choices = await prompts([
+        {
+            type: "confirm",
+            name: "airules",
+            message: "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
+        },
+    ]);
+    if (choices.airules) {
+        await createFileOnDesktop("airules.txt", example_airules);
+        console_1.default.info("Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready.");
+        const isReady = await prompts([
+            {
+                type: "confirm",
+                name: "isReady",
+                message: "Are you ready to continue?",
+            },
+        ]);
+        if (!isReady.isReady) {
+            console_1.default.error("Please make the necessary changes and try again.");
+            process.exit(1);
+        }
+        const airules = getDesktopFile("airules.txt");
+        return airules;
+    }
+    return null;
+};
+exports.appendAIRules = appendAIRules;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.43","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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false}},"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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false},"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.44","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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false}},"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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false},"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.43",
+  "version": "5.0.44",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -47,6 +47,7 @@
     "node-emoji": "^1.10.0",
     "node-fetch": "^2.7.0",
     "node-persist": "^3.1.0",
+    "ora": "^8.2.0",
     "prompts": "^2.3.2",
     "shelljs": "^0.8.4",
     "socket.io": "^4.4.1",

package/src/commands/init.ts

@@ -1,5 +1,7 @@
 import { flags } from "@oclif/command"
 import BaseCommand from "../utils/BaseCommand"
+import ora from "ora"
+
 // eslint-disable-next-line
 import * as fs from "fs-extra"
 import * as prompts from "prompts"
@@ -31,8 +33,8 @@ import {
   getFilenameFromUrl,
   makePackageInfo,
   estimateDuration,
-  createFileOnDesktop,
-  getDesktopFile,
+  appendContentIndex,
+  appendAIRules,
 } from "../utils/creatorUtilities"
 import SessionManager from "../managers/session"
 
@@ -186,6 +188,7 @@ const initializeInteractiveCreation = async (
   let currentDifficulty = ""
 
   while (!isReady) {
+    const spinner = ora("Thinking...").start()
     let wholeInfo = courseInfo
     wholeInfo += `
     Current title: ${currentTitle}
@@ -196,6 +199,7 @@ const initializeInteractiveCreation = async (
       courseInfo: wholeInfo,
       prevInteractions: prevInteractions,
     })
+    spinner.succeed("Done!")
     currentSteps = res.parsed.listOfSteps
     isReady = res.parsed.ready
     if (res.parsed.title && currentTitle !== res.parsed.title) {
@@ -244,71 +248,6 @@ process.emitWarning = (warning: string) => {
   Console.debug("A Warning was emitted by Node.js: ", warning)
 }
 
-const appendContentIndex = async () => {
-  const choices = await prompts([
-    {
-      type: "confirm",
-      name: "contentIndex",
-      message: "Do you have a content index for this tutorial?",
-    },
-  ])
-  if (choices.contentIndex) {
-    await createFileOnDesktop("content_index.txt")
-    Console.info(
-      "Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready."
-    )
-    const isReady = await prompts([
-      {
-        type: "confirm",
-        name: "isReady",
-        message: "Are you ready to continue?",
-      },
-    ])
-    if (!isReady.isReady) {
-      Console.error("Please make the necessary changes and try again.")
-      process.exit(1)
-    }
-
-    const contentIndex = getDesktopFile("content_index.txt")
-    return contentIndex
-  }
-
-  return null
-}
-
-const appendAIRules = async () => {
-  const choices = await prompts([
-    {
-      type: "confirm",
-      name: "airules",
-      message:
-        "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
-    },
-  ])
-  if (choices.airules) {
-    await createFileOnDesktop("airules.txt")
-    Console.info(
-      "Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready."
-    )
-    const isReady = await prompts([
-      {
-        type: "confirm",
-        name: "isReady",
-        message: "Are you ready to continue?",
-      },
-    ])
-    if (!isReady.isReady) {
-      Console.error("Please make the necessary changes and try again.")
-      process.exit(1)
-    }
-
-    const airules = getDesktopFile("airules.txt")
-    return airules
-  }
-
-  return null
-}
-
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"))
 

package/src/utils/creatorUtilities.ts

@@ -12,6 +12,7 @@ import { exec } from "child_process"
 import { promisify } from "util"
 
 import * as yaml from "js-yaml"
+import * as prompts from "prompts"
 
 type TEstimateReadingTimeReturns = {
   minutes: number
@@ -207,22 +208,11 @@ export function estimateDuration(listOfSteps: string[]): number {
 const writeFilePromise = promisify(fs.writeFile)
 const execPromise = promisify(exec)
 
-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.
-`
-
-export async function createFileOnDesktop(fileName: string) {
+export async function createFileOnDesktop(fileName: string, content: string) {
   try {
     const desktopPath = join(homedir(), "Desktop")
     const filePath = join(desktopPath, fileName)
 
-    const content = example_content.trim()
-
     await writeFilePromise(filePath, content)
     console.log(`File created successfully at: ${filePath}`)
 
@@ -419,3 +409,86 @@ export function howManyDifficultParagraphs(
 ): number {
   return paragraphs.filter(paragraph => paragraph.fkgl > maxFKGL).length
 }
+
+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.
+`
+
+export const appendContentIndex = async () => {
+  const choices = await prompts([
+    {
+      type: "confirm",
+      name: "contentIndex",
+      message: "Do you have a content index for this tutorial?",
+    },
+  ])
+  if (choices.contentIndex) {
+    await createFileOnDesktop("content_index.txt", example_content)
+    Console.info(
+      "Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready."
+    )
+    const isReady = await prompts([
+      {
+        type: "confirm",
+        name: "isReady",
+        message: "Are you ready to continue?",
+      },
+    ])
+    if (!isReady.isReady) {
+      Console.error("Please make the necessary changes and try again.")
+      process.exit(1)
+    }
+
+    const contentIndex = getDesktopFile("content_index.txt")
+    return contentIndex
+  }
+
+  return null
+}
+
+const example_airules = `
+Write with an engaging tone, use simple words and avoid complex sentences.
+Write in first person, as if you are talking to the reader.
+Add mental maps to help the reader understand the content.
+Add diagrams to help the reader understand the content.
+No code exercises required
+
+`
+
+export const appendAIRules = async () => {
+  const choices = await prompts([
+    {
+      type: "confirm",
+      name: "airules",
+      message:
+        "Do you want to add any specific rules for the AI? (e.g. no code exercises, no quizzes, etc, a particular writting style, etc)",
+    },
+  ])
+  if (choices.airules) {
+    await createFileOnDesktop("airules.txt", example_airules)
+    Console.info(
+      "Please make the necessary in the recently created file in your desktop, it should automatically open. Edit the file to match your expectations and save it. Keep the same name and structure as the example file. Continue when ready."
+    )
+    const isReady = await prompts([
+      {
+        type: "confirm",
+        name: "isReady",
+        message: "Are you ready to continue?",
+      },
+    ])
+    if (!isReady.isReady) {
+      Console.error("Please make the necessary changes and try again.")
+      process.exit(1)
+    }
+
+    const airules = getDesktopFile("airules.txt")
+    return airules
+  }
+
+  return null
+}