@learnpack/learnpack 5.0.19 → 5.0.21

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.19 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.21 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -140,7 +140,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -158,7 +158,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -176,7 +176,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -307,7 +307,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -329,7 +329,7 @@ OPTIONS
   -y, --yes                           Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -346,7 +346,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -360,7 +360,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.19/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/publish.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable arrow-parens */
 /* eslint-disable unicorn/no-array-for-each */
+const child_process_1 = require("child_process");
 const command_1 = require("@oclif/command");
 const SessionCommand_1 = require("../utils/SessionCommand");
 const session_1 = require("../managers/session");
@@ -16,6 +17,26 @@ const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 // const RIGOBOT_HOST =
 //   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload";
+const runAudit = () => {
+    try {
+        console_1.default.info("Running learnpack audit before publishing...");
+        (0, child_process_1.execSync)("learnpack audit", { stdio: "inherit" });
+    }
+    catch (error) {
+        console_1.default.error("Failed to audit with learnpack");
+        // Si `execSync` lanza un error, capturamos el mensaje de error
+        if (error instanceof Error) {
+            console_1.default.error(error.message);
+        }
+        else {
+            console_1.default.error("Unknown error occurred");
+        }
+        // Detener la ejecución del comando si `learnpack publish` falla
+        process.exit(1);
+    }
+    // Continuar con el proceso de build solo si `learnpack publish` fue exitoso
+    console_1.default.info("Learnpack publish completed successfully. Proceeding with build...");
+};
 class BuildCommand extends SessionCommand_1.default {
     async init() {
         const { flags } = this.parse(BuildCommand);
@@ -42,6 +63,7 @@ class BuildCommand extends SessionCommand_1.default {
             console_1.default.info("Cleaning configuration files");
             (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.clean();
             // build exerises
+            runAudit();
             console_1.default.debug("Building exercises");
             (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
         }

package/lib/managers/socket.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const socket_io_1 = require("socket.io");
 const console_1 = require("../utils/console");
 const fileQueue_1 = require("../utils/fileQueue");
+const languageToMessage = {
+    python3: "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a print statement in your code?",
+    node: "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a console.log statement in your code?",
+};
 const SocketManager = {
     socket: null,
     config: null,
@@ -144,14 +148,20 @@ const SocketManager = {
     ready: function (message) {
         this.log("ready", [message]);
     },
-    success: function (type, stdout) {
+    success: function (type, stdout, lang) {
         const types = ["compiler", "testing"];
         if (!types.includes(type))
             this.fatal(`Invalid socket success type "${type}" on socket`);
-        else if (stdout === "")
+        else if (stdout === "" &&
+            lang &&
+            Object.keys(languageToMessage).includes(lang)) {
+            this.log((type + "-success"), [languageToMessage[lang]]);
+        }
+        else if (stdout === "") {
             this.log((type + "-success"), [
                 "No stdout to display on the console",
             ]);
+        }
         else
             this.log((type + "-success"), [stdout]);
     },

package/lib/models/socket.d.ts

@@ -29,7 +29,7 @@ export interface ISocket {
     error: (type: any, stdout: string) => void;
     fatal: (msg: string) => void;
     dialog: (message: string) => void;
-    success: (type: any, stdout: string) => void;
+    success: (type: any, stdout: string, lang?: string) => void;
     onTestingFinished: (obj: any) => void;
 }
 export type TOpenWindowData = {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.19","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.21","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":[]}}}

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

package/src/commands/publish.ts

@@ -1,5 +1,6 @@
 /* eslint-disable arrow-parens */
 /* eslint-disable unicorn/no-array-for-each */
+import { execSync } from "child_process"
 import { flags } from "@oclif/command"
 import SessionCommand from "../utils/SessionCommand"
 import SessionManager from "../managers/session"
@@ -20,6 +21,30 @@ const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 //   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
 
+const runAudit = () => {
+  try {
+    Console.info("Running learnpack audit before publishing...")
+    execSync("learnpack audit", { stdio: "inherit" })
+  } catch (error) {
+    Console.error("Failed to audit with learnpack")
+
+    // Si `execSync` lanza un error, capturamos el mensaje de error
+    if (error instanceof Error) {
+      Console.error(error.message)
+    } else {
+      Console.error("Unknown error occurred")
+    }
+
+    // Detener la ejecución del comando si `learnpack publish` falla
+    process.exit(1)
+  }
+
+  // Continuar con el proceso de build solo si `learnpack publish` fue exitoso
+  Console.info(
+    "Learnpack publish completed successfully. Proceeding with build..."
+  )
+}
+
 export default class BuildCommand extends SessionCommand {
   static description =
     "Builds the project by copying necessary files and directories into a zip file"
@@ -56,6 +81,8 @@ export default class BuildCommand extends SessionCommand {
       Console.info("Cleaning configuration files")
       this.configManager?.clean()
       // build exerises
+      runAudit()
+
       Console.debug("Building exercises")
       this.configManager?.buildIndex()
     }

package/src/managers/socket.ts

@@ -10,6 +10,12 @@ import { TStatus } from "../models/status"
 import { TSuccessType } from "../models/success-types"
 import * as http from "http"
 
+const languageToMessage: Record<string, string> = {
+  python3:
+    "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a print statement in your code?",
+  node: "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a console.log statement in your code?",
+}
+
 const SocketManager: ISocket = {
   socket: null,
   config: null,
@@ -211,16 +217,22 @@ actions = [actions]
   ready: function (message: string) {
     this.log("ready", [message])
   },
-  success: function (type: TSuccessType, stdout: string) {
+  success: function (type: TSuccessType, stdout: string, lang) {
     const types = ["compiler", "testing"]
 
     if (!types.includes(type))
       this.fatal(`Invalid socket success type "${type}" on socket`)
-    else if (stdout === "")
+    else if (
+      stdout === "" &&
+      lang &&
+      Object.keys(languageToMessage).includes(lang)
+    ) {
+      this.log((type + "-success") as TSuccessType, [languageToMessage[lang]])
+    } else if (stdout === "") {
       this.log((type + "-success") as TSuccessType, [
         "No stdout to display on the console",
       ])
-    else 
+    } else 
 this.log((type + "-success") as TSuccessType, [stdout])
   },
   error: function (type: TStatus, stdout: string) {

package/src/models/socket.ts

@@ -51,7 +51,7 @@ export interface ISocket {
   error: (type: any, stdout: string) => void
   fatal: (msg: string) => void
   dialog: (message: string) => void
-  success: (type: any, stdout: string) => void
+  success: (type: any, stdout: string, lang?: string) => void
   onTestingFinished: (obj: any) => void
 }