@learnpack/learnpack 4.0.6 → 4.0.8

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,52 @@ 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 !== null &&
+    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}`
 
@@ -195,7 +250,7 @@ throw InternalError("Config object not found")
 
   if (!configObj.config.editor.mode) {
     configObj.config.editor.mode =
-      configObj.config.editor.agent === "vscode" ? "extension" : "preview"
+      process.env.TERM_PROGRAM === "vscode" ? "extension" : "preview"
   }
 
   if (version) 
@@ -206,7 +261,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 +313,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) => {
@@ -281,7 +338,7 @@ return true
 
       if (
         result.code === 0 &&
-        result.stdout.includes(`learnpack-${language}`)
+        result.stdout.includes(`@learnpack/${language}`)
       ) {
         this.validLanguages[language] = true
         return true
@@ -289,7 +346,7 @@ return true
 
       Console.info(`Language engine for ${language} not found, installing...`)
       // Install the compiler in their new versions
-      result = shell.exec(`learnpack plugins:install learnpack-${language}`, {
+      result = shell.exec(`learnpack plugins:install @learnpack/${language}`, {
         silent: true,
       })
       if (result.code === 0) {
@@ -459,8 +516,7 @@ fs.mkdirSync(confPath.base)
     },
 
     save: () => {
-      // Console.debug("Saving configuration with: ", configObj)
-
+      Console.debug("Saving configuration with: ", configObj)
       // remove the duplicates form the actions array
       // configObj.config.actions = [...new Set(configObj.config.actions)];
       if (configObj.config) {
@@ -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
+}