@learnpack/learnpack 5.0.27 → 5.0.29

package/lib/managers/config/index.js

@@ -423,66 +423,66 @@ function deepMerge(...sources) {
     return acc;
 }
 const buildAgentWarning = (current, suggested) => {
-    const message = `# Agent mismatch!\n
-        
-In LearnPack, the agent is in charge of running the LearnPack interface.
-
-You're currently using LearnPack through \`${current}\` but the suggested agent is \`${suggested}\`. 
-
-We recommend strongly recommend changing your agent.
-
-  ${stepsToChangeAgent(suggested)}
+    const message = `# Agent mismatch!\n
+        
+In LearnPack, the agent is in charge of running the LearnPack interface.
+
+You're currently using LearnPack through \`${current}\` but the suggested agent is \`${suggested}\`. 
+
+We recommend strongly recommend changing your agent.
+
+  ${stepsToChangeAgent(suggested)}
        `;
     return message;
 };
 const stepsToChangeAgent = (agent) => {
     if (agent === "vscode") {
-        return `
-# Steps to Change Agent to VSCode
-
-1. **Install VSCode**:
-   - Visit the [VSCode website](https://code.visualstudio.com/Download) and download the latest version.
-   - Follow the installation instructions for your operating system.
-
-2. **Install LearnPack VSCode Extension**:
-   - Open VSCode.
-   - Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing \`Ctrl+Shift+X\`.
-   - Search for "LearnPack" and click "Install".
-   - If the extension is already installed but disabled, enable it.
-
-3. **Run LearnPack in VSCode**:
-   - Open your terminal in VSCode.
-   - Navigate to your LearnPack project directory.
-   - Run the following command:
-     \`\`\`sh
-     learnpack start
-     \`\`\`
-
-We strongly recommend using VSCode for a better learning experience.
+        return `
+# Steps to Change Agent to VSCode
+
+1. **Install VSCode**:
+   - Visit the [VSCode website](https://code.visualstudio.com/Download) and download the latest version.
+   - Follow the installation instructions for your operating system.
+
+2. **Install LearnPack VSCode Extension**:
+   - Open VSCode.
+   - Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing \`Ctrl+Shift+X\`.
+   - Search for "LearnPack" and click "Install".
+   - If the extension is already installed but disabled, enable it.
+
+3. **Run LearnPack in VSCode**:
+   - Open your terminal in VSCode.
+   - Navigate to your LearnPack project directory.
+   - Run the following command:
+     \`\`\`sh
+     learnpack start
+     \`\`\`
+
+We strongly recommend using VSCode for a better learning experience.
     `;
     }
     if (agent === "os") {
-        return `
-# Steps to Change Agent to OS
-
-This learning package was designed to run outside of VSCode. We strongly recommend closing VSCode and running the package independently.
-
-1. **Close VSCode**:
-   - Save your work and close the VSCode application.
-
-2. **Open a New Terminal**:
-   - Open a terminal or command prompt on your operating system.
-
-3. **Navigate to Your LearnPack Project Directory**:
-   - Use the \`cd\` command to navigate to the directory where your LearnPack project is located.
-
-4. **Run LearnPack**:
-   - Run the following command to start LearnPack:
-     \`\`\`sh
-     learnpack start
-     \`\`\`
-
-We strongly recommend running the package independently for a better learning experience.
+        return `
+# Steps to Change Agent to OS
+
+This learning package was designed to run outside of VSCode. We strongly recommend closing VSCode and running the package independently.
+
+1. **Close VSCode**:
+   - Save your work and close the VSCode application.
+
+2. **Open a New Terminal**:
+   - Open a terminal or command prompt on your operating system.
+
+3. **Navigate to Your LearnPack Project Directory**:
+   - Use the \`cd\` command to navigate to the directory where your LearnPack project is located.
+
+4. **Run LearnPack**:
+   - Run the following command to start LearnPack:
+     \`\`\`sh
+     learnpack start
+     \`\`\`
+
+We strongly recommend running the package independently for a better learning experience.
     `;
     }
     return "";
@@ -508,31 +508,31 @@ const isExtensionInstalled = (extensionName) => {
     const result = shell.exec("code --list-extensions", { silent: true });
     return result.stdout.split("\n").includes(extensionName);
 };
-const EXTENSION_INSTALLATION_STEPS = `
-# Steps to Install LearnPack VSCode Extension
-
-1. **Open VSCode**:
-   - Launch the Visual Studio Code application on your computer.
-
-2. **Go to Extensions View**:
-   - Click on the Extensions icon in the Activity Bar on the side of the window.
-   - Alternatively, you can open the Extensions view by pressing \`Ctrl+Shift+X\`.
-
-3. **Search for LearnPack**:
-   - In the Extensions view, type "LearnPack" into the search bar.
-
-4. **Install the Extension**:
-   - Find the "LearnPack" extension in the search results and click the "Install" button.
-   - If the extension is already installed but disabled, click the "Enable" button.
-
-5. **Verify Installation**:
-   - Once installed, you can verify the installation by running the following command in the terminal:
-     \`\`\`sh
-     code --list-extensions | grep learn-pack.learnpack-vscode
-     \`\`\`
-   - If the extension is listed, it means the installation was successful.
-
-We strongly recommend using the LearnPack extension in VSCode for a better learning experience.
+const EXTENSION_INSTALLATION_STEPS = `
+# Steps to Install LearnPack VSCode Extension
+
+1. **Open VSCode**:
+   - Launch the Visual Studio Code application on your computer.
+
+2. **Go to Extensions View**:
+   - Click on the Extensions icon in the Activity Bar on the side of the window.
+   - Alternatively, you can open the Extensions view by pressing \`Ctrl+Shift+X\`.
+
+3. **Search for LearnPack**:
+   - In the Extensions view, type "LearnPack" into the search bar.
+
+4. **Install the Extension**:
+   - Find the "LearnPack" extension in the search results and click the "Install" button.
+   - If the extension is already installed but disabled, click the "Enable" button.
+
+5. **Verify Installation**:
+   - Once installed, you can verify the installation by running the following command in the terminal:
+     \`\`\`sh
+     code --list-extensions | grep learn-pack.learnpack-vscode
+     \`\`\`
+   - If the extension is listed, it means the installation was successful.
+
+We strongly recommend using the LearnPack extension in VSCode for a better learning experience.
 `;
 /**
  * Installs the LearnPack VSCode extension if the 'code' command is available.

package/lib/managers/server/routes.js

@@ -11,7 +11,6 @@ const fileQueue_1 = require("../../utils/fileQueue");
 const exercise_1 = require("../config/exercise");
 const session_1 = require("../../managers/session");
 const telemetry_1 = require("../telemetry");
-const osOperations_1 = require("../../utils/osOperations");
 const withHandler = (func) => (req, res) => {
     try {
         func(req, res);
@@ -200,10 +199,7 @@ async function default_1(app, configObject, configManager) {
         if (exercise.position) {
             telemetry_1.default.registerStepEvent(exercise.position, "open_step", {});
         }
-        if (((_a = configObject.config) === null || _a === void 0 ? void 0 : _a.editor.agent) === "os") {
-            osOperations_1.eventManager.enqueue(dispatcher.events.START_EXERCISE, exercise);
-        }
-        else {
+        if (((_a = configObject.config) === null || _a === void 0 ? void 0 : _a.editor.agent) !== "os") {
             dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug);
         }
         const entries = new Set(Object.keys(config === null || config === void 0 ? void 0 : config.entries).map(lang => config === null || config === void 0 ? void 0 : config.entries[lang]));

package/lib/managers/session.js

@@ -138,5 +138,13 @@ const Session = {
         this.token = null;
         console_1.default.success("You have logged out");
     },
+    breakToken: async function () {
+        const payload = await this.getPayload();
+        if (payload) {
+            this.token = "asdasdasdasd";
+            await storage.setItem("bc-payload", Object.assign(Object.assign({}, payload), { token: "asdasdsad" }));
+            console_1.default.success("Token broken successfully");
+        }
+    },
 };
 exports.default = Session;

package/lib/models/session.d.ts

@@ -31,5 +31,6 @@ export interface ISession {
     sync: () => Promise<void>;
     start: ({ token, payload }: IStartProps) => Promise<void>;
     destroy: () => Promise<void>;
+    breakToken: () => Promise<void>;
 }
 export {};

package/lib/utils/api.d.ts

@@ -1,6 +1,14 @@
 type TConsumableSlug = "ai-conversation-message" | "ai-compilation" | "ai-tutorial-generation" | "ai-generation";
 export declare const countConsumables: (consumables: any, consumableSlug?: TConsumableSlug) => any;
-export declare const getConsumables: (token: string, consumableSlug?: TConsumableSlug) => Promise<any>;
+export declare const getConsumable: (token: string, consumableSlug?: TConsumableSlug) => Promise<any>;
+export interface TAcademy {
+    id: number;
+    name: string;
+    slug: string;
+    timezone: string;
+}
+export declare const listUserAcademies: (breathecodeToken: string) => Promise<TAcademy[]>;
+export declare const validateToken: (token: string) => Promise<any>;
 declare const _default: {
     login: (identification: string, password: string) => Promise<any>;
     publish: (config: any) => Promise<any>;
@@ -13,5 +21,7 @@ declare const _default: {
     }) => Promise<any>;
     sendBatchTelemetry: (url: string, body: any) => Promise<void>;
     sendStreamTelemetry: (url: string, body: object) => Promise<void>;
+    listUserAcademies: (breathecodeToken: string) => Promise<TAcademy[]>;
+    validateToken: (token: string) => Promise<any>;
 };
 export default _default;

package/lib/utils/api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConsumables = exports.countConsumables = void 0;
+exports.validateToken = exports.listUserAcademies = exports.getConsumable = exports.countConsumables = void 0;
 const console_1 = require("../utils/console");
 const storage = require("node-persist");
 const cli_ux_1 = require("cli-ux");
@@ -63,13 +63,11 @@ const login = async (identification, password) => {
         cli_ux_1.default.action.start(`Looking for credentials with ${identification}`);
         await cli_ux_1.default.wait(1000);
         const url = `${HOST}/v1/auth/login/`;
-        const data = await fetch(url, {
-            body: JSON.stringify({
-                email: identification,
-                password: password,
-            }),
-            method: "post",
+        const res = await axios_1.default.post(url, {
+            email: identification,
+            password: password,
         });
+        const data = res.data;
         cli_ux_1.default.action.stop("ready");
         let rigoPayload = null;
         try {
@@ -258,22 +256,60 @@ const countConsumables = (consumables, consumableSlug = "ai-tutorial-generation"
     return consumable ? consumable.balance.unit : 0;
 };
 exports.countConsumables = countConsumables;
-const getConsumables = async (token, consumableSlug = "ai-generation") => {
+const getConsumable = async (token, consumableSlug = "ai-generation") => {
     const url = `${HOST}/v1/payments/me/service/consumable?virtual=true`;
     const headers = {
         Authorization: `Token ${token}`,
     };
     try {
         const response = await axios_1.default.get(url, { headers });
-        const ai_tutorial_generation = (0, exports.countConsumables)(response.data, consumableSlug);
-        return { ai_tutorial_generation };
+        const count = (0, exports.countConsumables)(response.data, consumableSlug);
+        return { count };
     }
     catch (error) {
         console.error("Error fetching consumables:", error);
         throw error;
     }
 };
-exports.getConsumables = getConsumables;
+exports.getConsumable = getConsumable;
+const listUserAcademies = async (breathecodeToken) => {
+    const url = "https://breathecode.herokuapp.com/v1/auth/user/me";
+    try {
+        const response = await axios_1.default.get(url, {
+            headers: {
+                Authorization: `Token ${breathecodeToken}`,
+            },
+        });
+        const data = response.data;
+        const academiesMap = new Map();
+        for (const role of data.roles) {
+            const academy = role.academy;
+            if (!academiesMap.has(academy.id)) {
+                academiesMap.set(academy.id, academy);
+            }
+        }
+        return [...academiesMap.values()];
+    }
+    catch (error) {
+        console.error("Failed to fetch user academies:", error);
+        return [];
+    }
+};
+exports.listUserAcademies = listUserAcademies;
+const validateToken = async (token) => {
+    const url = "https://breathecode.herokuapp.com/v1/auth/user/me";
+    const headers = {
+        Authorization: `Token ${token}`,
+    };
+    try {
+        const response = await axios_1.default.get(url, { headers });
+        return response.data;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.validateToken = validateToken;
 exports.default = {
     login,
     publish,
@@ -283,4 +319,6 @@ exports.default = {
     getAllPackages,
     sendBatchTelemetry,
     sendStreamTelemetry,
+    listUserAcademies: exports.listUserAcademies,
+    validateToken: exports.validateToken,
 };

package/lib/utils/creatorUtilities.d.ts

@@ -14,9 +14,11 @@ export type PackageInfo = {
         us: string;
     };
 };
-export declare function checkReadingTime(markdown: string, wordsPerMinute?: number): {
+export declare function checkReadingTime(markdown: string, wordsPerMinute?: number, maxMinutes?: number): {
     newMarkdown: string;
     exceedsThreshold: boolean;
+    minutes: number;
+    body: string;
 };
 export declare const getExInfo: (title: string) => {
     exNumber: string;
@@ -31,7 +33,7 @@ export declare function extractImagesFromMarkdown(markdown: string): {
 export declare function getFilenameFromUrl(url: string): string;
 export declare const makePackageInfo: (choices: any) => {
     grading: any;
-    difficulty: any;
+    difficulty: string;
     duration: number;
     description: {
         us: any;
@@ -41,4 +43,7 @@ export declare const makePackageInfo: (choices: any) => {
     };
     slug: any;
 };
+export declare function estimateDuration(listOfSteps: string[]): number;
+export declare function createFileOnDesktop(): Promise<void>;
+export declare function getContentIndex(): string;
 export {};

package/lib/utils/creatorUtilities.js

@@ -4,9 +4,17 @@ exports.makePackageInfo = exports.getExInfo = exports.estimateReadingTime = void
 exports.checkReadingTime = checkReadingTime;
 exports.extractImagesFromMarkdown = extractImagesFromMarkdown;
 exports.getFilenameFromUrl = getFilenameFromUrl;
+exports.estimateDuration = estimateDuration;
+exports.createFileOnDesktop = createFileOnDesktop;
+exports.getContentIndex = getContentIndex;
 // eslint-disable-next-line
 const frontMatter = require("front-matter");
 const path = require("path");
+const fs = require("fs");
+const os_1 = require("os");
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const util_1 = require("util");
 const yaml = require("js-yaml");
 const estimateReadingTime = (text, wordsPerMinute = 150) => {
     const words = text.trim().split(/\s+/).length;
@@ -30,7 +38,7 @@ const estimateReadingTime = (text, wordsPerMinute = 150) => {
     };
 };
 exports.estimateReadingTime = estimateReadingTime;
-function checkReadingTime(markdown, wordsPerMinute = 150) {
+function checkReadingTime(markdown, wordsPerMinute = 200, maxMinutes = 1) {
     const parsed = frontMatter(markdown);
     const readingTime = (0, exports.estimateReadingTime)(parsed.body, wordsPerMinute);
     let attributes = parsed.attributes ? parsed.attributes : {};
@@ -38,13 +46,25 @@ function checkReadingTime(markdown, wordsPerMinute = 150) {
         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();
+    let yamlFrontMatter = "";
+    try {
+        yamlFrontMatter = yaml.dump(updatedAttributes).trim();
+    }
+    catch (_a) {
+        return {
+            newMarkdown: "",
+            exceedsThreshold: false,
+            minutes: 0,
+            body: "",
+        };
+    }
     // Reconstruct the markdown with the front matter
     const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`;
     return {
         newMarkdown,
-        exceedsThreshold: readingTime.minutes > wordsPerMinute,
+        exceedsThreshold: readingTime.minutes > maxMinutes,
+        minutes: readingTime.minutes,
+        body: parsed.body,
     };
 }
 const slugify = (text) => {
@@ -93,8 +113,8 @@ function getFilenameFromUrl(url) {
 const makePackageInfo = (choices) => {
     const packageInfo = {
         grading: choices.grading,
-        difficulty: choices.difficulty,
-        duration: parseInt(choices.duration),
+        difficulty: "beginner",
+        duration: 5,
         description: {
             us: choices.description,
         },
@@ -109,3 +129,65 @@ const makePackageInfo = (choices) => {
     return packageInfo;
 };
 exports.makePackageInfo = makePackageInfo;
+function estimateDuration(listOfSteps) {
+    let duration = 0;
+    for (const step of listOfSteps) {
+        if (step.includes("[READ:")) {
+            duration += 1;
+        }
+        else if (step.includes("[QUIZ:")) {
+            duration += 2;
+        }
+        else if (step.includes("[CODE:")) {
+            duration += 3;
+        }
+    }
+    return duration;
+}
+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]
+`;
+async function createFileOnDesktop() {
+    try {
+        const desktopPath = (0, path_1.join)((0, os_1.homedir)(), "Desktop");
+        const filePath = (0, path_1.join)(desktopPath, "content_index.txt");
+        const content = example_content.trim();
+        await writeFilePromise(filePath, content);
+        console.log(`File created successfully at: ${filePath}`);
+        await openFile(filePath);
+    }
+    catch (error) {
+        console.error("Error:", error);
+    }
+}
+async function openFile(filePath) {
+    const platform = process.platform;
+    let command;
+    if (platform === "win32") {
+        command = `start "" "${filePath}"`;
+    }
+    else if (platform === "darwin") {
+        command = `open "${filePath}"`;
+    }
+    else {
+        command = `xdg-open "${filePath}"`;
+    }
+    try {
+        await execPromise(command);
+        console.log("File opened successfully.");
+    }
+    catch (error) {
+        console.error("Error opening the file:", error);
+    }
+}
+function getContentIndex() {
+    const desktopPath = (0, path_1.join)((0, os_1.homedir)(), "Desktop");
+    const filePath = (0, path_1.join)(desktopPath, "content_index.txt");
+    const content = fs.readFileSync(filePath, "utf8");
+    return content;
+}

package/lib/utils/rigoActions.d.ts

@@ -52,4 +52,10 @@ type TReadmeCreatorInputs = {
 };
 export declare const readmeCreator: (token: string, inputs: TReadmeCreatorInputs) => Promise<any>;
 export declare function createPreviewReadme(tutorialDir: string, packageInfo: PackageInfo, rigoToken: string, readmeContents: string[]): Promise<void>;
+type TReduceReadmeInputs = {
+    lesson: string;
+    number_of_words: string;
+    expected_number_words: string;
+};
+export declare function reduceReadme(rigoToken: string, inputs: TReduceReadmeInputs): Promise<any>;
 export {};

package/lib/utils/rigoActions.js

@@ -3,6 +3,7 @@ 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;
+exports.reduceReadme = reduceReadme;
 const axios_1 = require("axios");
 const fs_1 = require("fs");
 const console_1 = require("../utils/console");
@@ -175,3 +176,18 @@ async function createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeCo
     });
     fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer);
 }
+async function reduceReadme(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: {
+                "Content-Type": "application/json",
+                Authorization: "Token " + rigoToken,
+            },
+        });
+        return response.data;
+    }
+    catch (error) {
+        console_1.default.debug(error);
+        return null;
+    }
+}

package/oclif.manifest.json

@@ -1 +1 @@
-{"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":[]}}}
+{"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":[]}}}

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.27",
+  "version": "5.0.29",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/breakToken.ts

@@ -0,0 +1,36 @@
+import { flags } from "@oclif/command"
+import BaseCommand from "../utils/BaseCommand"
+// eslint-disable-next-line
+import * as fs from "fs-extra"
+import Console from "../utils/console"
+
+import SessionManager from "../managers/session"
+import { createFileOnDesktop, getContentIndex } from "../utils/creatorUtilities"
+
+class BreakTokenCommand extends BaseCommand {
+  static description = "Break the token"
+
+  static flags = {
+    ...BaseCommand.flags,
+    grading: flags.help({ char: "h" }),
+  }
+
+  async run() {
+    const { flags } = this.parse(BreakTokenCommand)
+
+    // await SessionManager.breakToken()
+    await createFileOnDesktop()
+    Console.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.info("File content:")
+      Console.info(getContentIndex())
+      process.exit(0)
+    })
+  }
+}
+
+export default BreakTokenCommand