@learnpack/learnpack 2.1.57 → 4.0.1

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.57 win32-x64 node-v20.10.0
+@learnpack/learnpack/4.0.1 win32-x64 node-v20.10.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/v2.1.57/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/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/v2.1.57/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v4.0.1/src\commands\test.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

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

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

package/lib/managers/config/defaults.js

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

package/lib/managers/config/index.js

@@ -145,12 +145,12 @@ 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 || "3.1.23";
+        configObj.config.editor.version = packageJSON.version || "4.0.0";
     }
     configObj.config.dirPath = "./" + confPath.base;
     configObj.config.exercisesPath = getExercisesPath(confPath.base) || "./";
-    const allowedCommands = new Set(["ls", "pwd", "echo", "node", "python"]);
     if (configObj.config.variables) {
+        const allowedCommands = new Set(["ls", "pwd", "echo", "node", "python"]);
         const variableKeys = Object.keys(configObj.config.variables);
         const promises = [];
         for (const v of variableKeys) {

package/lib/managers/file.js

@@ -28,22 +28,32 @@ exports.decompress = (sourcePath, destinationPath) => new Promise((resolve, reje
     });
 });
 exports.downloadEditor = async (version, destination) => {
-    // https://raw.githubusercontent.com/learnpack/coding-ide/master/dist/app.tar.gz
-    // if(versions[version] === undefined) throw new Error(`Invalid editor version ${version}`)
     if (!version) {
         const res = await fetch("https://raw.githubusercontent.com/learnpack/ide/master/package.json");
         const json = await res.json();
-        version = json.version;
+        version = json.version || "4.0.0";
         if (!version)
             throw errors_1.InternalError(`Coding Editor version was not found on learnpack repository, check the config.editor.version property on learn.json`);
     }
-    const versionNumber = parseInt(version.split(".")[0]);
-    let url = `https://github.com/learnpack/coding-ide/blob/${version}/dist`;
+    const [major, minor] = version.split(".");
+    const versionPrefix = `${major}.${minor}`;
+    const tagsRes = await fetch("https://api.github.com/repos/learnpack/ide/contents/bin");
+    const tags = await tagsRes.json();
+    const matchingTags = tags
+        .filter((tag) => tag.name.includes(versionPrefix))
+        .sort((a, b) => b.name.localeCompare(a.name, undefined, { numeric: true }));
+    if (matchingTags.length === 0)
+        throw errors_1.InternalError(`No matching version found for prefix ${versionPrefix} in the learnpack repository`);
+    const latestVersion = matchingTags[0].name
+        .replace("learnpack-", "")
+        .replace(".tar.gz", "");
+    const versionNumber = parseInt(latestVersion.split(".")[0]);
+    let url = `https://github.com/learnpack/coding-ide/blob/${latestVersion}/dist`;
     if (versionNumber > 2)
-        url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${version}.tar.gz`;
+        url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${latestVersion}.tar.gz`;
     const resp2 = await fetch(url, { method: "HEAD" });
     if (!resp2.ok)
-        throw errors_1.InternalError(`Coding Editor ${version} was not found on learnpack repository, check the config.editor.version property on learn.json`);
+        throw errors_1.InternalError(`Coding Editor ${latestVersion} was not found on learnpack repository, check the config.editor.version property on learn.json`);
     console_1.default.info("Downloading the LearnPack coding UI, this may take a minute...");
     url += versionNumber > 2 ? `?raw=true` : `/app.tar.gz?raw=true`;
     return exports.download(url, destination);

package/oclif.manifest.json

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

package/src/managers/config/defaults.ts

@@ -39,4 +39,5 @@ export default {
   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
 }

package/src/managers/config/index.ts

@@ -28,9 +28,9 @@ import { IFile } from "../../models/file"
 /* exercise folder name standard */
 
 // eslint-disable-next-line
-const fetch = require("node-fetch");
+const fetch = require("node-fetch")
 // eslint-disable-next-line
-const chalk = require("chalk");
+const chalk = require("chalk")
 
 /* exercise folder name standard */
 
@@ -206,15 +206,15 @@ 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 || "3.1.23"
+    configObj.config.editor.version = packageJSON.version || "4.0.0"
   }
 
   configObj.config.dirPath = "./" + confPath.base
   configObj.config.exercisesPath = getExercisesPath(confPath.base) || "./"
 
-  const allowedCommands = new Set(["ls", "pwd", "echo", "node", "python"])
-
   if (configObj.config.variables) {
+    const allowedCommands = new Set(["ls", "pwd", "echo", "node", "python"])
+
     const variableKeys = Object.keys(configObj.config.variables)
     const promises = []
 
@@ -384,9 +384,7 @@ fs.unlinkSync(_path)
         ex => ex.slug === slug
       )
       if (!exercise)
-        throw ValidationError(
-          `Exercise ${slug} not found on the configuration`
-        )
+        throw ValidationError(`Exercise ${slug} not found on the configuration`)
 
       if (configObj.config) {
         for (const fileName of fs.readdirSync(

package/src/managers/file.ts

@@ -8,7 +8,7 @@ import * as https from "https"
 import { InternalError } from "../utils/errors"
 
 // eslint-disable-next-line
-const fetch = require("node-fetch");
+const fetch = require("node-fetch")
 
 export const decompress = (sourcePath: string, destinationPath: string) =>
   new Promise((resolve, reject) => {
@@ -34,15 +34,12 @@ export const downloadEditor = async (
   version: string | undefined,
   destination: string
 ) => {
-  // https://raw.githubusercontent.com/learnpack/coding-ide/master/dist/app.tar.gz
-  // if(versions[version] === undefined) throw new Error(`Invalid editor version ${version}`)
-
   if (!version) {
     const res = await fetch(
       "https://raw.githubusercontent.com/learnpack/ide/master/package.json"
     )
     const json = await res.json()
-    version = json.version
+    version = json.version || "4.0.0"
 
     if (!version)
       throw InternalError(
@@ -50,22 +47,41 @@ export const downloadEditor = async (
       )
   }
 
-  const versionNumber = parseInt(version.split(".")[0])
+  const [major, minor] = version.split(".")
+  const versionPrefix = `${major}.${minor}`
 
-  let url = `https://github.com/learnpack/coding-ide/blob/${version}/dist`
+  const tagsRes = await fetch(
+    "https://api.github.com/repos/learnpack/ide/contents/bin"
+  )
+  const tags = await tagsRes.json()
+  const matchingTags = tags
+    .filter((tag: any) => tag.name.includes(versionPrefix))
+    .sort((a: any, b: any) =>
+      b.name.localeCompare(a.name, undefined, { numeric: true })
+    )
+
+  if (matchingTags.length === 0)
+    throw InternalError(
+      `No matching version found for prefix ${versionPrefix} in the learnpack repository`
+    )
+
+  const latestVersion = matchingTags[0].name
+    .replace("learnpack-", "")
+    .replace(".tar.gz", "")
+  const versionNumber = parseInt(latestVersion.split(".")[0])
+
+  let url = `https://github.com/learnpack/coding-ide/blob/${latestVersion}/dist`
 
   if (versionNumber > 2)
-    url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${version}.tar.gz`
+    url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${latestVersion}.tar.gz`
 
   const resp2 = await fetch(url, { method: "HEAD" })
   if (!resp2.ok)
     throw InternalError(
-      `Coding Editor ${version} was not found on learnpack repository, check the config.editor.version property on learn.json`
+      `Coding Editor ${latestVersion} was not found on learnpack repository, check the config.editor.version property on learn.json`
     )
 
-  Console.info(
-    "Downloading the LearnPack coding UI, this may take a minute..."
-  )
+  Console.info("Downloading the LearnPack coding UI, this may take a minute...")
 
   url += versionNumber > 2 ? `?raw=true` : `/app.tar.gz?raw=true`