@learnpack/learnpack 2.1.39 → 2.1.41

package/src/commands/logout.ts

@@ -1,43 +1,43 @@
-// import  {Command, flags} from '@oclif/command'
-// import { prompt } from "enquirer"
-// import fetch from 'node-fetch'
-import SessionCommand from "../utils/SessionCommand"
-import SessionManager from "../managers/session"
-// import Console from '../utils/console'
-// import { replace } from 'node-emoji'
-// import { validURL } from "../utils/validators"
-// const BaseCommand from '../utils/BaseCommand');
-
-class LogoutCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(LogoutCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    // const {flags, args} = this.parse(LogoutCommand)
-
-    SessionManager.destroy()
-  }
-}
-
-export default LogoutCommand
+// import  {Command, flags} from '@oclif/command'
+// import { prompt } from "enquirer"
+// import fetch from 'node-fetch'
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+// import Console from '../utils/console'
+// import { replace } from 'node-emoji'
+// import { validURL } from "../utils/validators"
+// const BaseCommand from '../utils/BaseCommand');
+
+class LogoutCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(LogoutCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    // const {flags, args} = this.parse(LogoutCommand)
+
+    SessionManager.destroy()
+  }
+}
+
+export default LogoutCommand

package/src/commands/publish.ts

@@ -1,107 +1,107 @@
-import { prompt } from "enquirer"
-import SessionCommand from "../utils/SessionCommand"
-import Console from "../utils/console"
-import api from "../utils/api"
-import { validURL } from "../utils/validators"
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-
-class PublishCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(PublishCommand)
-    await this.initSession(flags, true)
-  }
-
-  async run() {
-    const { flags, args } = this.parse(PublishCommand)
-
-    // avoid annonymus sessions
-    // eslint-disable-next-line
-    if (!this.session) return;
-
-    Console.info(
-      `Session found for ${this.session.payload.email}, publishing the package...`
-    )
-
-    const configObject = this.configManager?.get()
-    if (
-      configObject?.config?.slug === undefined ||
-      !configObject.config?.slug
-    ) {
-      throw new Error(
-        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
-      )
-    }
-
-    if (!validURL(configObject?.config?.repository ?? "")) {
-      throw new Error(
-        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
-      )
-    } else {
-      const validateResp = await fetch(configObject.config?.repository, {
-        method: "HEAD",
-      })
-      if (!validateResp.ok || validateResp.status !== 200) {
-        throw new Error(
-          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
-        )
-      }
-    }
-
-    // start watching for file changes
-    try {
-      await api.publish({
-        ...configObject,
-        author: this.session.payload.user_id,
-      })
-      Console.success(
-        `Package updated and published successfully: ${configObject.config?.slug}`
-      )
-    } catch (error) {
-      if ((error as any).status === 404) {
-        const answer = await prompt([
-          {
-            type: "confirm",
-            name: "create",
-            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
-          },
-        ])
-        if (answer) {
-          await api.update({
-            ...configObject,
-            author: this.session.payload.user_id,
-          })
-          Console.success(
-            `Package created and published successfully: ${configObject.config?.slug}`
-          )
-        } else {
-          Console.error("No answer from server")
-        }
-      } else {
-        Console.error((error as TypeError).message)
-      }
-    }
-  }
-}
-
-export default PublishCommand
+import { prompt } from "enquirer"
+import SessionCommand from "../utils/SessionCommand"
+import Console from "../utils/console"
+import api from "../utils/api"
+import { validURL } from "../utils/validators"
+
+// eslint-disable-next-line
+const fetch = require("node-fetch");
+
+class PublishCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(PublishCommand)
+    await this.initSession(flags, true)
+  }
+
+  async run() {
+    const { flags, args } = this.parse(PublishCommand)
+
+    // avoid annonymus sessions
+    // eslint-disable-next-line
+    if (!this.session) return;
+
+    Console.info(
+      `Session found for ${this.session.payload.email}, publishing the package...`
+    )
+
+    const configObject = this.configManager?.get()
+    if (
+      configObject?.config?.slug === undefined ||
+      !configObject.config?.slug
+    ) {
+      throw new Error(
+        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
+      )
+    }
+
+    if (!validURL(configObject?.config?.repository ?? "")) {
+      throw new Error(
+        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
+      )
+    } else {
+      const validateResp = await fetch(configObject.config?.repository, {
+        method: "HEAD",
+      })
+      if (!validateResp.ok || validateResp.status !== 200) {
+        throw new Error(
+          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
+        )
+      }
+    }
+
+    // start watching for file changes
+    try {
+      await api.publish({
+        ...configObject,
+        author: this.session.payload.user_id,
+      })
+      Console.success(
+        `Package updated and published successfully: ${configObject.config?.slug}`
+      )
+    } catch (error) {
+      if ((error as any).status === 404) {
+        const answer = await prompt([
+          {
+            type: "confirm",
+            name: "create",
+            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
+          },
+        ])
+        if (answer) {
+          await api.update({
+            ...configObject,
+            author: this.session.payload.user_id,
+          })
+          Console.success(
+            `Package created and published successfully: ${configObject.config?.slug}`
+          )
+        } else {
+          Console.error("No answer from server")
+        }
+      } else {
+        Console.error((error as TypeError).message)
+      }
+    }
+  }
+}
+
+export default PublishCommand

package/src/commands/start.ts

@@ -17,6 +17,9 @@ import { prioritizeHTMLFile } from "../utils/misc"
 import { IGitpodData } from "../models/gitpod-data"
 import { IExercise, IExerciseData } from "../models/exercise-obj"
 import { eventManager } from "../utils/osOperations"
+import { cli } from "cli-ux"
+import { TOpenWindowData } from "../models/socket"
+import { checkNotInstalledPlugins } from "../utils/checkNotInstalled"
 
 export default class StartCommand extends SessionCommand {
   static description = "Runs a small server with all the exercise instructions"
@@ -68,9 +71,51 @@ export default class StartCommand extends SessionCommand {
   async run() {
     // get configuration object
     const configObject = this.configManager?.get()
-    const config = configObject?.config
 
-    const hasXDG = await eventManager.checkXDGInstalled()
+    // TODO: console.log(this.config.platform); get the platfrom from Oclif
+
+    const installedPlugins = this.config.plugins.map(plugin => {
+      return `${plugin.pjson.name}`
+    })
+
+    const neededToInstallPlugins = checkNotInstalledPlugins(
+      configObject?.exercises || [],
+      installedPlugins
+    )
+    if (neededToInstallPlugins.length > 0) {
+      Console.error(
+        "These plugins are not installed but required: ",
+        neededToInstallPlugins
+      )
+      const confirmInstall = await cli.confirm(
+        "Do you want to install the needed plugins? (y/n)"
+      )
+      if (confirmInstall) {
+        Console.info("Installing the needed plugins...")
+        for await (const p of neededToInstallPlugins) {
+          await this.config.runCommand(`plugins:install`, [p])
+          Console.log(`Plugin ${p} installed`)
+        }
+
+        Console.log(
+          "All needed plugins installed, please restart LearnPack to load them."
+        )
+        Console.info("Run: $ learnpack start")
+        this.exit(0)
+      } else {
+        Console.error(
+          "You need to install the plugins to complete this exercise"
+        )
+        Console.info(
+          "To install the plugins run each of the following commands: "
+        )
+        for (const p of neededToInstallPlugins) {
+          Console.log(`learnpack plugins:install ${p}`)
+        }
+
+        this.exit(1)
+      }
+    }
 
     if (configObject) {
       const { config } = configObject
@@ -113,9 +158,7 @@ export default class StartCommand extends SessionCommand {
           this.configManager,
           process.env.NODE_ENV === "test"
         )
-        server.setMaxListeners(20)
-
-        // console.log(config, "this is the f*!shell.which("code")!shell.which("code")cking config");
+        server.setMaxListeners(25)
 
         // I should call a method to get the EventListener
         const dispatcher = queue.dispatcher({
@@ -164,28 +207,15 @@ export default class StartCommand extends SessionCommand {
           socket.ready("Ready to compile...")
         })
 
-        socket.on("open_window", (data: IGitpodData) => {
+        socket.on("open_window", (data: TOpenWindowData) => {
           Console.debug("Opening window: ", data)
-
-          if (
-            config.editor.agent === "os" &&
-            ((config.os === "linux" && hasXDG) || config.os !== "linux")
-          ) {
-            eventManager.enqueue(dispatcher.events.OPEN_WINDOW, data)
-          } else {
-            dispatcher.enqueue(dispatcher.events.OPEN_WINDOW, data)
-          }
-
-          socket.ready("Ready to compile...")
+          cli.open(data.url)
+          socket.log("open_window", `URL ${data.url} opened in the browser`)
         })
 
         socket.on("reset", (exercise: IExerciseData) => {
           try {
             this.configManager?.reset(exercise.exerciseSlug)
-            dispatcher.enqueue(
-              dispatcher.events.RESET_EXERCISE,
-              exercise.exerciseSlug
-            )
             socket.ready("Ready to compile...")
           } catch (error) {
             socket.error(
@@ -271,9 +301,9 @@ export default class StartCommand extends SessionCommand {
           return true
         })
 
-        const terminate = () => {
+        const terminate = async () => {
           Console.error("Terminating Learnpack...")
-          TelemetryManager.submit()
+          await TelemetryManager.submit()
           this.configManager?.noCurrentExercise()
           dispatcher.enqueue(dispatcher.events.END)
           process.exit()

package/src/commands/test.ts

@@ -1,85 +1,85 @@
-import Console from "../utils/console"
-import SessionCommand from "../utils/SessionCommand"
-import socket from "../managers/socket"
-
-import createServer from "../managers/server"
-import ExercisesQueue from "../utils/exercisesQueue"
-import { IExercise } from "../models/exercise-obj"
-
-class TestCommand extends SessionCommand {
-  async init() {
-    const { flags } = this.parse(TestCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    const {
-      args: { exerciseSlug },
-    } = this.parse(TestCommand)
-
-    // Build exercises index
-    this.configManager?.buildIndex()
-
-    let exercises: IExercise[] | undefined = []
-
-    // test all exercises
-    !exerciseSlug ?
-      (exercises = this.configManager?.getAllExercises()) :
-      (exercises = [this.configManager!.getExercise(exerciseSlug)])
-
-    const exercisesQueue = new ExercisesQueue(exercises)
-
-    const configObject = this.configManager?.get()
-
-    let hasFailed = false
-    let failedTestsCount = 0
-    let successTestsCount = 0
-    const testsToRunCount = exercisesQueue.size()
-
-    configObject!.config!.testingFinishedCallback = ({ result }) => {
-      if (result === "failed") {
-        hasFailed = true
-        failedTestsCount++
-      } else {
-        successTestsCount++
-      }
-
-      if (exercisesQueue.isEmpty()) {
-        Console.info(
-          `${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`
-        )
-        Console.success(
-          `${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`
-        )
-        Console.error(
-          `${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`
-        )
-
-        process.exit(hasFailed ? 1 : 0)
-      } else {
-        exercisesQueue.pop()!.test!(this.config, config!, socket)
-      }
-    }
-
-    const config = configObject?.config
-
-    const server = await createServer(configObject!, this.configManager!, true)
-
-    socket.start(config!, server, true)
-
-    exercisesQueue.pop()!.test!(this.config, config!, socket)
-  }
-}
-
-TestCommand.description = `Test exercises`
-
-TestCommand.args = [
-  {
-    name: "exerciseSlug",
-    required: false,
-    description: "The name of the exercise to test",
-    hidden: false,
-  },
-]
-
-export default TestCommand
+import Console from "../utils/console"
+import SessionCommand from "../utils/SessionCommand"
+import socket from "../managers/socket"
+
+import createServer from "../managers/server"
+import ExercisesQueue from "../utils/exercisesQueue"
+import { IExercise } from "../models/exercise-obj"
+
+class TestCommand extends SessionCommand {
+  async init() {
+    const { flags } = this.parse(TestCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const {
+      args: { exerciseSlug },
+    } = this.parse(TestCommand)
+
+    // Build exercises index
+    this.configManager?.buildIndex()
+
+    let exercises: IExercise[] | undefined = []
+
+    // test all exercises
+    !exerciseSlug ?
+      (exercises = this.configManager?.getAllExercises()) :
+      (exercises = [this.configManager!.getExercise(exerciseSlug)])
+
+    const exercisesQueue = new ExercisesQueue(exercises)
+
+    const configObject = this.configManager?.get()
+
+    let hasFailed = false
+    let failedTestsCount = 0
+    let successTestsCount = 0
+    const testsToRunCount = exercisesQueue.size()
+
+    configObject!.config!.testingFinishedCallback = ({ result }) => {
+      if (result === "failed") {
+        hasFailed = true
+        failedTestsCount++
+      } else {
+        successTestsCount++
+      }
+
+      if (exercisesQueue.isEmpty()) {
+        Console.info(
+          `${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`
+        )
+        Console.success(
+          `${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`
+        )
+        Console.error(
+          `${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`
+        )
+
+        process.exit(hasFailed ? 1 : 0)
+      } else {
+        exercisesQueue.pop()!.test!(this.config, config!, socket)
+      }
+    }
+
+    const config = configObject?.config
+
+    const server = await createServer(configObject!, this.configManager!, true)
+
+    socket.start(config!, server, true)
+
+    exercisesQueue.pop()!.test!(this.config, config!, socket)
+  }
+}
+
+TestCommand.description = `Test exercises`
+
+TestCommand.args = [
+  {
+    name: "exerciseSlug",
+    required: false,
+    description: "The name of the exercise to test",
+    hidden: false,
+  },
+]
+
+export default TestCommand

package/src/index.ts

@@ -1 +1 @@
-export * from '@oclif/command'
+export * from '@oclif/command'

package/src/managers/config/allowed_files.ts

@@ -1,29 +1,29 @@
-const extensions = {
-  extensions: [
-    "py",
-    "java",
-    "py",
-    "ruby",
-    "html",
-    "css",
-    "htm",
-    "php", // images
-    "js",
-    "jsx",
-    "ts", // images
-    "sh",
-    "bash", // images
-    "json",
-    "yml",
-    "yaml",
-    "csv",
-    "xml", // file storage extensions
-    "txt",
-    "text",
-    "markdown",
-    "readme", // compressed files
-  ],
-  names: ["package.json", "package-lock.json"],
-}
-
-export default extensions
+const extensions = {
+  extensions: [
+    "py",
+    "java",
+    "py",
+    "ruby",
+    "html",
+    "css",
+    "htm",
+    "php", // images
+    "js",
+    "jsx",
+    "ts", // images
+    "sh",
+    "bash", // images
+    "json",
+    "yml",
+    "yaml",
+    "csv",
+    "xml", // file storage extensions
+    "txt",
+    "text",
+    "markdown",
+    "readme", // compressed files
+  ],
+  names: ["package.json", "package-lock.json"],
+}
+
+export default extensions