@learnpack/learnpack 4.0.6 → 4.0.7

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/4.0.6 win32-x64 node-v20.10.0
+@learnpack/learnpack/4.0.7 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -74,7 +74,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/v4.0.6/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -89,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -107,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -138,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -156,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -309,7 +309,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -330,7 +330,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,7 +344,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.6/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.7/src\commands\test.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -22,10 +22,9 @@ class StartCommand extends SessionCommand_1.default {
         await this.initSession(flags);
     }
     async run() {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         // get configuration object
         const configObject = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
-        // TODO: console.log(this.config.platform); get the platfrom from Oclif
         const hasXDG = await osOperations_1.eventManager.checkXDGInstalled();
         const installedPlugins = this.config.plugins.map(plugin => {
             return `${plugin.pjson.name}`;
@@ -51,7 +50,7 @@ class StartCommand extends SessionCommand_1.default {
             // listen to socket commands
             if (config && this.configManager) {
                 const server = await server_1.default(configObject, this.configManager, process.env.NODE_ENV === "test");
-                server.setMaxListeners(25);
+                server.setMaxListeners(30);
                 // I should call a method to get the EventListener
                 const dispatcher = fileQueue_1.default.dispatcher({
                     create: true,
@@ -78,6 +77,18 @@ class StartCommand extends SessionCommand_1.default {
                     }
                 }
                 socket_1.default.start(config, server, false);
+                if ((_g = config === null || config === void 0 ? void 0 : config.warnings) === null || _g === void 0 ? void 0 : _g.agent) {
+                    const message = config.warnings.agent;
+                    setTimeout(() => {
+                        socket_1.default.dialog(message);
+                    }, 2000);
+                }
+                if ((_h = config === null || config === void 0 ? void 0 : config.warnings) === null || _h === void 0 ? void 0 : _h.extension) {
+                    const message = config.warnings.extension;
+                    setTimeout(() => {
+                        socket_1.default.dialog(message);
+                    }, 3000);
+                }
                 socket_1.default.on("open", (data) => {
                     console_1.default.debug("Opening these files: ", data);
                     const files = misc_1.prioritizeHTMLFile(data.files);

package/lib/managers/config/defaults.d.ts

@@ -37,6 +37,12 @@ declare const _default: {
     exercises: never[];
     bugsLink: null;
     videoSolutions: boolean;
+    suggestions: {
+        agent: null;
+    };
+    warnings: {
+        agent: null;
+    };
     localhostOnly: boolean;
 };
 export default _default;

package/lib/managers/config/defaults.js

@@ -41,5 +41,11 @@ exports.default = {
     exercises: [],
     bugsLink: null,
     videoSolutions: false,
+    suggestions: {
+        agent: null,
+    },
+    warnings: {
+        agent: null,
+    },
     localhostOnly: false,
 };

package/lib/managers/config/index.js

@@ -5,7 +5,6 @@ const fs = require("fs");
 const shell = require("shelljs");
 const child_process_1 = require("child_process");
 const util_1 = require("util");
-const execAsync = util_1.promisify(child_process_1.exec);
 const console_1 = require("../../utils/console");
 const watcher_1 = require("../../utils/watcher");
 const errors_1 = require("../../utils/errors");
@@ -13,6 +12,7 @@ const defaults_1 = require("./defaults");
 const exercise_1 = require("./exercise");
 const file_1 = require("../file");
 /* exercise folder name standard */
+const execAsync = util_1.promisify(child_process_1.exec);
 // eslint-disable-next-line
 const fetch = require("node-fetch");
 // eslint-disable-next-line
@@ -60,7 +60,7 @@ const getCodespacesNamespace = () => {
     return codespace_name;
 };
 exports.default = async ({ grading, mode, disableGrading, version, }) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     const confPath = getConfigPath();
     console_1.default.debug("This is the config path: ", confPath);
     let configObj = {};
@@ -108,11 +108,22 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
     // auto detect agent (if possible)
     const codespaces_workspace = getCodespacesNamespace();
     console_1.default.debug("This is the codespace namespace: ", codespaces_workspace);
+    if (!configObj.config.editor) {
+        configObj.config.editor = {};
+    }
     console_1.default.debug("This is the agent, and this should be null an the beginning: ", (_c = (_b = configObj.config) === null || _b === void 0 ? void 0 : _b.editor) === null || _c === void 0 ? void 0 : _c.agent);
+    if ((_e = (_d = configObj.config) === null || _d === void 0 ? void 0 : _d.editor) === null || _e === void 0 ? void 0 : _e.agent) {
+        if (configObj.config.suggestions) {
+            configObj.config.suggestions.agent = configObj.config.editor.agent;
+        }
+        else {
+            configObj.config.suggestions = { agent: configObj.config.editor.agent };
+        }
+    }
     if (shell.which("gp") && configObj && configObj.config) {
         console_1.default.debug("Gitpod detected");
         configObj.address = getGitpodAddress();
-        configObj.config.publicUrl = `https://${configObj.config.port}-${(_d = configObj.address) === null || _d === void 0 ? void 0 : _d.slice(8)}`;
+        configObj.config.publicUrl = `https://${configObj.config.port}-${(_f = configObj.address) === null || _f === void 0 ? void 0 : _f.slice(8)}`;
         configObj.config.editor.agent = "vscode";
     }
     else if (configObj.config && Boolean(codespaces_workspace)) {
@@ -125,11 +136,32 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
         console_1.default.debug("Neither Gitpod nor Codespaces detected, using localhost.");
         configObj.address = `http://localhost:${configObj.config.port}`;
         configObj.config.publicUrl = `http://localhost:${configObj.config.port}`;
-    }
-    if (!configObj.config.editor.agent) {
         configObj.config.editor.agent =
             process.env.TERM_PROGRAM === "vscode" ? "vscode" : "os";
     }
+    if (configObj.config.editor.agent === "vscode" && isCodeCommandAvailable()) {
+        const extensionName = "learn-pack.learnpack-vscode";
+        if (!isExtensionInstalled(extensionName)) {
+            console_1.default.info("The LearnPack extension is not installed, trying to install it automatically.");
+            if (!installExtension(extensionName)) {
+                configObj.config.warnings = {
+                    extension: EXTENSION_INSTALLATION_STEPS,
+                };
+                console_1.default.warning("The LearnPack extension is not installed and this tutorial is meant to be run inside VSCode. Please install the LearnPack extension.");
+            }
+        }
+    }
+    if (configObj.config.suggestions &&
+        configObj.config.editor &&
+        configObj.config.suggestions.agent !== configObj.config.editor.agent) {
+        console_1.default.warning(`The suggested agent "${configObj.config.suggestions.agent}" is different from the detected agent "${configObj.config.editor.agent}"`);
+        try {
+            configObj.config.warnings = Object.assign(Object.assign({}, configObj.config.warnings), { agent: buildAgentWarning(configObj.config.editor.agent, configObj.config.suggestions.agent) });
+        }
+        catch (_g) {
+            console_1.default.error("IMPOSSIBLE TO SET WARNING");
+        }
+    }
     if (configObj.config && !configObj.config.publicUrl)
         configObj.config.publicUrl = `${configObj.address}:${configObj.config.port}`;
     if (configObj.config && !configObj.config.editor.mode && mode) {
@@ -145,7 +177,7 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
         console_1.default.debug("Config version not found, downloading default.");
         const resp = await fetch("https://raw.githubusercontent.com/learnpack/ide/master/package.json");
         const packageJSON = await resp.json();
-        configObj.config.editor.version = packageJSON.version || "4.0.0";
+        configObj.config.editor.version = packageJSON.version || "4.0.2";
     }
     configObj.config.dirPath = "./" + confPath.base;
     configObj.config.exercisesPath = getExercisesPath(confPath.base) || "./";
@@ -188,7 +220,9 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
     }
     return {
         validLanguages: {},
-        get: () => configObj,
+        get: () => {
+            return configObj;
+        },
         validateEngine: function (language, server, socket) {
             // eslint-disable-next-line
             const alias = (_l) => {
@@ -374,3 +408,130 @@ 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)}
+       `;
+    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.
+    `;
+    }
+    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 "";
+};
+/**
+ * Checks if the 'code' command is available in the terminal.
+ *
+ * @returns {boolean} True if the 'code' command is available, false otherwise.
+ */
+const isCodeCommandAvailable = () => {
+    return shell.which("code") !== null;
+};
+/**
+ * Checks if a specific VSCode extension is installed.
+ *
+ * @param {string} extensionName - The name of the extension to check.
+ * @returns {boolean} True if the extension is installed, false otherwise.
+ */
+const isExtensionInstalled = (extensionName) => {
+    if (!isCodeCommandAvailable()) {
+        throw new Error("The 'code' command is not available in the terminal. Please ensure that VSCode is installed and the 'code' command is added to your PATH.");
+    }
+    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.
+`;
+/**
+ * Installs the LearnPack VSCode extension if the 'code' command is available.
+ *
+ * @param {string} extensionName - The name of the extension to install.
+ * @returns {boolean} True if the installation was successful, false otherwise.
+ */
+const installExtension = (extensionName) => {
+    if (!isCodeCommandAvailable()) {
+        throw new Error("The 'code' command is not available in the terminal. Please ensure that VSCode is installed and the 'code' command is added to your PATH.");
+    }
+    const result = shell.exec(`code --install-extension ${extensionName}`, {
+        silent: true,
+    });
+    return result.code === 0;
+};

package/lib/managers/socket.js

@@ -102,7 +102,7 @@ const SocketManager = {
         });
     },
     reload: function (files = null, exercises = null) {
-        this.emit("reload", (files === null || files === void 0 ? void 0 : files.join("")) || "" /* TODO: Check it out this */, exercises);
+        this.emit("reload", (files === null || files === void 0 ? void 0 : files.join("")) || "", exercises);
     },
     openWindow: function (url = "") {
         fileQueue_1.default.dispatcher().enqueue(fileQueue_1.default.events.OPEN_WINDOW, url);

package/lib/models/config.d.ts

@@ -8,10 +8,9 @@ export declare type TCompiler = "webpack" | "vanillajs" | "react" | "html" | "no
 export interface IConfigPath {
     base: string;
 }
-declare type TAgent = "vscode" | "os";
 export interface IEditor {
     mode?: TMode;
-    version: string;
+    version?: string;
     agent?: TAgent;
     hideTerminal?: boolean;
 }
@@ -56,9 +55,19 @@ export interface IConfig {
     skills: Array<string>;
     telemetry?: TTelemetryUrls;
     variables?: TVariables;
+    suggestions: TSuggestions;
+    warnings: TWarnings;
     runHook: (...agrs: Array<any>) => void;
     testingFinishedCallback: (arg: any | undefined) => void;
 }
+export declare type TAgent = "os" | "vscode" | null;
+declare type TSuggestions = {
+    agent: TAgent;
+};
+declare type TWarnings = {
+    agent?: string;
+    extension?: string;
+};
 declare type TVariable = {
     type: "command" | "string";
     source: string;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"4.0.6","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":{"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":"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}]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"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":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]}}}
+{"version":"4.0.7","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":{"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":"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}]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"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":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Create, sell or download and take learning amazing learning packages",
-  "version": "4.0.6",
+  "version": "4.0.7",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/start.ts

@@ -77,7 +77,6 @@ export default class StartCommand extends SessionCommand {
     // get configuration object
     const configObject = this.configManager?.get()
 
-    // TODO: console.log(this.config.platform); get the platfrom from Oclif
     const hasXDG = await eventManager.checkXDGInstalled()
 
     const installedPlugins = this.config.plugins.map(plugin => {
@@ -86,6 +85,7 @@ export default class StartCommand extends SessionCommand {
 
     if (configObject) {
       const { config } = configObject
+
       // build exerises
       this.configManager?.buildIndex()
 
@@ -112,9 +112,7 @@ export default class StartCommand extends SessionCommand {
         this.exit(1)
       }
 
-      const appAlreadyExists = checkIfDirectoryExists(
-        `${config?.dirPath}/_app`
-      )
+      const appAlreadyExists = checkIfDirectoryExists(`${config?.dirPath}/_app`)
 
       if (!appAlreadyExists) {
         // download app and decompress
@@ -137,7 +135,7 @@ export default class StartCommand extends SessionCommand {
           this.configManager,
           process.env.NODE_ENV === "test"
         )
-        server.setMaxListeners(25)
+        server.setMaxListeners(30)
 
         // I should call a method to get the EventListener
         const dispatcher = queue.dispatcher({
@@ -172,6 +170,20 @@ export default class StartCommand extends SessionCommand {
 
         socket.start(config, server, false)
 
+        if (config?.warnings?.agent) {
+          const message = config.warnings.agent
+          setTimeout(() => {
+            socket.dialog(message)
+          }, 2000)
+        }
+
+        if (config?.warnings?.extension) {
+          const message = config.warnings.extension
+          setTimeout(() => {
+            socket.dialog(message)
+          }, 3000)
+        }
+
         socket.on("open", (data: IGitpodData) => {
           Console.debug("Opening these files: ", data)
 

package/src/managers/config/defaults.ts

@@ -1,43 +1,49 @@
-import * as os from "os"
-export default {
-  config: {
-    port: 3000,
-    os: (function () {
-      return os.platform()
-    })(),
-    editor: {
-      mode: null, // [extension, preview]
-      agent: null, // ["vscode", "os"] ("os" is the agent when running outside a coding editor
-      version: null, // By default downloads the latest version
-    },
-    dirPath: "./.learn",
-    configPath: "./learn.json",
-    outputPath: "./.learn/dist",
-    publicPath: "/preview",
-    publicUrl: null,
-    contact: "https://github.com/learnpack/learnpack/issues/new",
-    language: "auto",
-    autoPlay: true,
-    projectType: "tutorial", // [tutorial, project]
-    grading: "isolated", // [isolated, incremental]
-    exercisesPath: "./", // path to the folder that contains the exercises
-    webpackTemplate: null, // if you want webpack to use an HTML template
-    disableGrading: false,
-    disabledActions: [], // Possible: 'build', 'test' or 'reset'
-    actions: [], // ⚠️ deprecated, leave empty )
-    entries: {
-      html: "index.html",
-      vanillajs: "index.js",
-      react: "app.jsx",
-      node: "app.js",
-      python3: "app.py",
-      java: "app.java",
-    },
-  },
-  address: "http://localhost",
-  currentExercise: null,
-  exercises: [],
-  bugsLink: null,
-  videoSolutions: false,
-  localhostOnly: false, // if true, the exercise should not run on gitpod or codespaces but show an error message encouraging the user to run locally
-}
+import * as os from "os"
+export default {
+  config: {
+    port: 3000,
+    os: (function () {
+      return os.platform()
+    })(),
+    editor: {
+      mode: null, // [extension, preview]
+      agent: null, // ["vscode", "os"] ("os" is the agent when running outside a coding editor
+      version: null, // By default downloads the latest version
+    },
+    dirPath: "./.learn",
+    configPath: "./learn.json",
+    outputPath: "./.learn/dist",
+    publicPath: "/preview",
+    publicUrl: null,
+    contact: "https://github.com/learnpack/learnpack/issues/new",
+    language: "auto",
+    autoPlay: true,
+    projectType: "tutorial", // [tutorial, project]
+    grading: "isolated", // [isolated, incremental]
+    exercisesPath: "./", // path to the folder that contains the exercises
+    webpackTemplate: null, // if you want webpack to use an HTML template
+    disableGrading: false,
+    disabledActions: [], // Possible: 'build', 'test' or 'reset'
+    actions: [], // ⚠️ deprecated, leave empty )
+    entries: {
+      html: "index.html",
+      vanillajs: "index.js",
+      react: "app.jsx",
+      node: "app.js",
+      python3: "app.py",
+      java: "app.java",
+    },
+  },
+  address: "http://localhost",
+  currentExercise: null,
+  exercises: [],
+  bugsLink: null,
+  videoSolutions: false,
+  suggestions: {
+    agent: null,
+  },
+  warnings: {
+    agent: null,
+  },
+  localhostOnly: false, // if true, the exercise should not run on gitpod or codespaces but show an error message encouraging the user to run locally
+}

package/src/managers/config/index.ts

@@ -4,8 +4,6 @@ import * as shell from "shelljs"
 import { exec } from "child_process"
 import { promisify } from "util"
 
-const execAsync = promisify(exec)
-
 import Console from "../../utils/console"
 import watch from "../../utils/watcher"
 import {
@@ -18,7 +16,12 @@ import defaults from "./defaults"
 import { exercise } from "./exercise"
 
 import { rmSync } from "../file"
-import { IConfigObj, TConfigObjAttributes, TMode } from "../../models/config"
+import {
+  IConfigObj,
+  TConfigObjAttributes,
+  TMode,
+  TAgent,
+} from "../../models/config"
 import {
   IConfigManagerAttributes,
   IConfigManager,
@@ -26,6 +29,7 @@ import {
 import { IFile } from "../../models/file"
 
 /* exercise folder name standard */
+const execAsync = promisify(exec)
 
 // eslint-disable-next-line
 const fetch = require("node-fetch")
@@ -158,11 +162,23 @@ throw InternalError("Config object not found")
   const codespaces_workspace = getCodespacesNamespace()
   Console.debug("This is the codespace namespace: ", codespaces_workspace)
 
+  if (!configObj.config.editor) {
+    configObj.config.editor = {}
+  }
+
   Console.debug(
     "This is the agent, and this should be null an the beginning: ",
     configObj.config?.editor?.agent
   )
 
+  if (configObj.config?.editor?.agent) {
+    if (configObj.config.suggestions) {
+      configObj.config.suggestions.agent = configObj.config.editor.agent
+    } else {
+      configObj.config.suggestions = { agent: configObj.config.editor.agent }
+    }
+  }
+
   if (shell.which("gp") && configObj && configObj.config) {
     Console.debug("Gitpod detected")
     configObj.address = getGitpodAddress()
@@ -179,13 +195,51 @@ throw InternalError("Config object not found")
     Console.debug("Neither Gitpod nor Codespaces detected, using localhost.")
     configObj.address = `http://localhost:${configObj.config.port}`
     configObj.config.publicUrl = `http://localhost:${configObj.config.port}`
-  }
-
-  if (!configObj.config.editor.agent) {
     configObj.config.editor.agent =
       process.env.TERM_PROGRAM === "vscode" ? "vscode" : "os"
   }
 
+  if (configObj.config.editor.agent === "vscode" && isCodeCommandAvailable()) {
+    const extensionName = "learn-pack.learnpack-vscode"
+
+    if (!isExtensionInstalled(extensionName)) {
+      Console.info(
+        "The LearnPack extension is not installed, trying to install it automatically."
+      )
+
+      if (!installExtension(extensionName)) {
+        configObj.config.warnings = {
+          extension: EXTENSION_INSTALLATION_STEPS,
+        }
+        Console.warning(
+          "The LearnPack extension is not installed and this tutorial is meant to be run inside VSCode. Please install the LearnPack extension."
+        )
+      }
+    }
+  }
+
+  if (
+    configObj.config.suggestions &&
+    configObj.config.editor &&
+    configObj.config.suggestions.agent !== configObj.config.editor.agent
+  ) {
+    Console.warning(
+      `The suggested agent "${configObj.config.suggestions.agent}" is different from the detected agent "${configObj.config.editor.agent}"`
+    )
+
+    try {
+      configObj.config.warnings = {
+        ...configObj.config.warnings, // Ensure we don't overwrite other warnings
+        agent: buildAgentWarning(
+          configObj.config.editor.agent,
+          configObj.config.suggestions.agent
+        ),
+      }
+    } catch {
+      Console.error("IMPOSSIBLE TO SET WARNING")
+    }
+  }
+
   if (configObj.config && !configObj.config.publicUrl)
     configObj.config.publicUrl = `${configObj.address}:${configObj.config.port}`
 
@@ -206,7 +260,7 @@ configObj.config.editor.version = version
       "https://raw.githubusercontent.com/learnpack/ide/master/package.json"
     )
     const packageJSON = await resp.json()
-    configObj.config.editor.version = packageJSON.version || "4.0.0"
+    configObj.config.editor.version = packageJSON.version || "4.0.2"
   }
 
   configObj.config.dirPath = "./" + confPath.base
@@ -258,7 +312,9 @@ return
 
   return {
     validLanguages: {},
-    get: () => configObj,
+    get: () => {
+      return configObj
+    },
     validateEngine: function (language: string, server: any, socket: any) {
       // eslint-disable-next-line
       const alias = (_l: string) => {
@@ -500,3 +556,145 @@ acc = { ...acc, [key]: value }
 
   return acc
 }
+
+const buildAgentWarning = (current: TAgent, suggested: TAgent): string => {
+  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: TAgent): string => {
+  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.
+    `
+  }
+
+ 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 ""
+}
+
+/**
+ * Checks if the 'code' command is available in the terminal.
+ *
+ * @returns {boolean} True if the 'code' command is available, false otherwise.
+ */
+const isCodeCommandAvailable = (): boolean => {
+  return shell.which("code") !== null
+}
+
+/**
+ * Checks if a specific VSCode extension is installed.
+ *
+ * @param {string} extensionName - The name of the extension to check.
+ * @returns {boolean} True if the extension is installed, false otherwise.
+ */
+const isExtensionInstalled = (extensionName: string): boolean => {
+  if (!isCodeCommandAvailable()) {
+    throw new Error(
+      "The 'code' command is not available in the terminal. Please ensure that VSCode is installed and the 'code' command is added to your PATH."
+    )
+  }
+
+  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.
+`
+
+/**
+ * Installs the LearnPack VSCode extension if the 'code' command is available.
+ *
+ * @param {string} extensionName - The name of the extension to install.
+ * @returns {boolean} True if the installation was successful, false otherwise.
+ */
+const installExtension = (extensionName: string): boolean => {
+  if (!isCodeCommandAvailable()) {
+    throw new Error(
+      "The 'code' command is not available in the terminal. Please ensure that VSCode is installed and the 'code' command is added to your PATH."
+    )
+  }
+
+  const result = shell.exec(`code --install-extension ${extensionName}`, {
+    silent: true,
+  })
+  return result.code === 0
+}

package/src/managers/socket.ts

@@ -144,11 +144,7 @@ actions = [actions]
     files: Array<string> | null = null,
     exercises: Array<string> | null = null
   ) {
-    this.emit(
-      "reload",
-      files?.join("") || "" /* TODO: Check it out this */,
-      exercises!
-    )
+    this.emit("reload", files?.join("") || "", exercises!)
   },
   openWindow: function (url = "") {
     queue.dispatcher().enqueue(queue.events.OPEN_WINDOW, url)
@@ -195,7 +191,7 @@ actions = [actions]
     }
 
     // eslint-disable-next-line
-    this.config?.disabledActions?.forEach((a) => this.removeAllowed(a));
+    this.config?.disabledActions?.forEach((a) => this.removeAllowed(a))
 
     this.socket?.emit("compiler", {
       action,

package/src/models/config.ts

@@ -1,18 +1,13 @@
 import { IExercise } from "./exercise-obj"
 import { TTelemetryUrls } from "../managers/telemetry"
 
-export type TGrading = "isolated" | "incremental" | "no-grading";
+export type TGrading = "isolated" | "incremental" | "no-grading"
 
-export type TMode = "preview" | "extension";
+export type TMode = "preview" | "extension"
 
-export type TConfigAction =
-  | "test"
-  | "build"
-  | "tutorial"
-  | "reset"
-  | "generate";
+export type TConfigAction = "test" | "build" | "tutorial" | "reset" | "generate"
 
-export type TConfigObjAttributes = "config" | "exercises" | "grading";
+export type TConfigObjAttributes = "config" | "exercises" | "grading"
 
 export type TCompiler =
   | "webpack"
@@ -21,82 +16,91 @@ export type TCompiler =
   | "html"
   | "node"
   | "python"
-  | "css";
+  | "css"
 
 export interface IConfigPath {
-  base: string;
+  base: string
 }
 
-type TAgent = "vscode" | "os";
-
 export interface IEditor {
-  mode?: TMode;
-  version: string;
-  agent?: TAgent;
-  hideTerminal?: boolean;
+  mode?: TMode
+  version?: string
+  agent?: TAgent
+  hideTerminal?: boolean
 }
 
 export interface TEntries {
-  python3?: string;
-  html?: string;
-  node?: string;
-  react?: string;
-  java?: string;
+  python3?: string
+  html?: string
+  node?: string
+  react?: string
+  java?: string
 }
 
 export interface IConfig {
-  os: string;
-  port?: string;
-  repository?: string;
-  description?: string;
-  slug?: string;
-  dirPath: string;
-  preview?: string; // Picture thumbnail
-  entries: TEntries;
-  grading: TGrading;
-  configPath: string;
-  translations: Array<string>;
-  outputPath?: string;
-  editor: IEditor;
-  language: string;
-  title: string;
-  duration: number;
-  difficulty?: string;
-  exercisesPath: string;
-  disableGrading: boolean; // TODO: Deprecate
-  actions: Array<string>; // TODO: Deprecate
-  autoPlay: boolean;
-  projectType?: string;
+  os: string
+  port?: string
+  repository?: string
+  description?: string
+  slug?: string
+  dirPath: string
+  preview?: string // Picture thumbnail
+  entries: TEntries
+  grading: TGrading
+  configPath: string
+  translations: Array<string>
+  outputPath?: string
+  editor: IEditor
+  language: string
+  title: string
+  duration: number
+  difficulty?: string
+  exercisesPath: string
+  disableGrading: boolean // TODO: Deprecate
+  actions: Array<string> // TODO: Deprecate
+  autoPlay: boolean
+  projectType?: string
   // TODO: nameExerciseValidation
-  contact?: string;
-  disabledActions?: Array<TConfigAction>;
-  compiler: TCompiler;
-  compilers: Array<TCompiler>;
-  publicPath: string;
-  publicUrl?: string;
-  bugsLink?: string;
-  videoSolutions?: boolean;
-  skills: Array<string>;
-  telemetry?: TTelemetryUrls;
-  variables?: TVariables;
+  contact?: string
+  disabledActions?: Array<TConfigAction>
+  compiler: TCompiler
+  compilers: Array<TCompiler>
+  publicPath: string
+  publicUrl?: string
+  bugsLink?: string
+  videoSolutions?: boolean
+  skills: Array<string>
+  telemetry?: TTelemetryUrls
+  variables?: TVariables
+  suggestions: TSuggestions
+  warnings: TWarnings
+  runHook: (...agrs: Array<any>) => void
+  testingFinishedCallback: (arg: any | undefined) => void
+}
+export type TAgent = "os" | "vscode" | null
+
+type TSuggestions = {
+  agent: TAgent
+}
 
-  runHook: (...agrs: Array<any>) => void;
-  testingFinishedCallback: (arg: any | undefined) => void;
+type TWarnings = {
+  agent?: string
+  extension?: string
 }
 
 type TVariable = {
-  type: "command" | "string";
-  source: string;
-};
+  type: "command" | "string"
+  source: string
+}
 type TVariables = {
-  [key: string]: TVariable | string;
-};
+  [key: string]: TVariable | string
+}
 
 export interface IConfigObj {
-  session?: number;
-  currentExercise?: any;
-  config?: IConfig;
-  exercises?: Array<IExercise>;
-  confPath?: IConfigPath;
-  address?: string; // Maybe
+  session?: number
+  currentExercise?: any
+  config?: IConfig
+  exercises?: Array<IExercise>
+  confPath?: IConfigPath
+  address?: string // Maybe
 }