@learnpack/learnpack 2.1.1 → 2.1.2

package/lib/commands/audit.js

@@ -17,7 +17,7 @@ class AuditCommand extends SessionCommand_1.default {
     }
     async run() {
         var _a, _b, _c, _d, _e, _f, _g;
-        console_1.default.log('Running command audit...');
+        console_1.default.log("Running command audit...");
         // Get configuration object.
         let config = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         if (config) {
@@ -46,7 +46,7 @@ class AuditCommand extends SessionCommand_1.default {
             const exercisesPath = config.config.exercisesPath;
             fs.readdir(exercisesPath, (err, files) => {
                 if (err) {
-                    return console.log('Unable to scan directory: ' + err);
+                    return console.log("Unable to scan directory: " + err);
                 }
                 // listing all files using forEach
                 for (const file of files) {
@@ -55,7 +55,7 @@ class AuditCommand extends SessionCommand_1.default {
                     if (fs.statSync(filePath).isFile())
                         warnings.push({
                             exercise: file,
-                            msg: 'This file is not inside any exercise folder.',
+                            msg: "This file is not inside any exercise folder.",
                         });
                 }
             });
@@ -74,12 +74,12 @@ class AuditCommand extends SessionCommand_1.default {
                 const frontmatter = fm(content);
                 for (const attribute in frontmatter.attributes) {
                     if (Object.prototype.hasOwnProperty.call(frontmatter.attributes, attribute) &&
-                        (attribute === 'intro' || attribute === 'tutorial')) {
+                        (attribute === "intro" || attribute === "tutorial")) {
                         counter.links.total++;
                         try {
                             // eslint-disable-next-line
                             let res = await fetch(frontmatter.attributes[attribute], {
-                                method: 'HEAD',
+                                method: "HEAD",
                             });
                             if (!res.ok) {
                                 counter.links.error++;
@@ -99,20 +99,20 @@ class AuditCommand extends SessionCommand_1.default {
                     }
                 }
                 // Check url's of each README file.
-                const findings = audit_1.default.findInFile(['relativeImages', 'externalImages', 'markdownLinks'], content);
+                const findings = audit_1.default.findInFile(["relativeImages", "externalImages", "markdownLinks"], content);
                 for (const finding in findings) {
                     if (Object.prototype.hasOwnProperty.call(findings, finding)) {
                         const obj = findings[finding];
                         // Valdites all the relative path images.
-                        if (finding === 'relativeImages' && Object.keys(obj).length > 0) {
+                        if (finding === "relativeImages" && Object.keys(obj).length > 0) {
                             for (const img in obj) {
                                 if (Object.prototype.hasOwnProperty.call(obj, img)) {
                                     // Validates if the image is in the assets folder.
                                     counter.images.total++;
                                     const relativePath = path
-                                        .relative(exercise.path.replace(/\\/gm, '/'), `${(_a = config.config) === null || _a === void 0 ? void 0 : _a.dirPath}/assets/${obj[img].relUrl}`)
-                                        .replace(/\\/gm, '/');
-                                    if (relativePath !== obj[img].absUrl.split('?').shift()) {
+                                        .relative(exercise.path.replace(/\\/gm, "/"), `${(_a = config.config) === null || _a === void 0 ? void 0 : _a.dirPath}/assets/${obj[img].relUrl}`)
+                                        .replace(/\\/gm, "/");
+                                    if (relativePath !== obj[img].absUrl.split("?").shift()) {
                                         counter.images.error++;
                                         errors.push({
                                             exercise: exercise.title,
@@ -129,18 +129,18 @@ class AuditCommand extends SessionCommand_1.default {
                                 }
                             }
                         }
-                        else if (finding === 'externalImages' &&
+                        else if (finding === "externalImages" &&
                             Object.keys(obj).length > 0) {
                             // Valdites all the aboslute path images.
                             for (const img in obj) {
                                 if (Object.prototype.hasOwnProperty.call(obj, img)) {
                                     counter.images.total++;
                                     if (fs.existsSync(`${(_c = config.config) === null || _c === void 0 ? void 0 : _c.dirPath}/assets${obj[img].mdUrl
-                                        .split('?')
+                                        .split("?")
                                         .shift()}`)) {
                                         const relativePath = path
-                                            .relative(exercise.path.replace(/\\/gm, '/'), `${(_d = config.config) === null || _d === void 0 ? void 0 : _d.dirPath}/assets/${obj[img].mdUrl}`)
-                                            .replace(/\\/gm, '/');
+                                            .relative(exercise.path.replace(/\\/gm, "/"), `${(_d = config.config) === null || _d === void 0 ? void 0 : _d.dirPath}/assets/${obj[img].mdUrl}`)
+                                            .replace(/\\/gm, "/");
                                         warnings.push({
                                             exercise: exercise.title,
                                             msg: `On this exercise you have an image with an absolute path "${obj[img].absUrl}". We recommend you to replace it by the relative path: "${relativePath}".`,
@@ -167,7 +167,7 @@ class AuditCommand extends SessionCommand_1.default {
                                 }
                             }
                         }
-                        else if (finding === 'markdownLinks' &&
+                        else if (finding === "markdownLinks" &&
                             Object.keys(obj).length > 0) {
                             for (const link in obj) {
                                 if (Object.prototype.hasOwnProperty.call(obj, link)) {
@@ -175,6 +175,7 @@ class AuditCommand extends SessionCommand_1.default {
                                     try {
                                         // eslint-disable-next-line
                                         let res = await fetch(obj[link].mdUrl, { method: "HEAD" });
+                                        console_1.default.log("Response links:", obj[link].mdUrl, res);
                                         if (res.status > 399 && res.status < 500) {
                                             counter.links.error++;
                                             errors.push({
@@ -205,38 +206,38 @@ class AuditCommand extends SessionCommand_1.default {
                 }
                 return false;
             };
-            console_1.default.debug('config', config);
-            console_1.default.info(' Checking if the config file is fine...');
+            console_1.default.debug("config", config);
+            console_1.default.info(" Checking if the config file is fine...");
             // These two lines check if the 'slug' property is inside the configuration object.
-            console_1.default.debug('Checking if the slug property is inside the configuration object...');
+            console_1.default.debug("Checking if the slug property is inside the configuration object...");
             if (!((_d = config.config) === null || _d === void 0 ? void 0 : _d.slug))
                 errors.push({
                     exercise: undefined,
-                    msg: 'The slug property is not in the configuration object',
+                    msg: "The slug property is not in the configuration object",
                 });
             // These two lines check if the 'repository' property is inside the configuration object.
-            console_1.default.debug('Checking if the repository property is inside the configuration object...');
+            console_1.default.debug("Checking if the repository property is inside the configuration object...");
             if (!((_e = config.config) === null || _e === void 0 ? void 0 : _e.repository))
                 errors.push({
                     exercise: undefined,
-                    msg: 'The repository property is not in the configuration object',
+                    msg: "The repository property is not in the configuration object",
                 });
             else
                 audit_1.default.isUrl((_f = config.config) === null || _f === void 0 ? void 0 : _f.repository, errors, counter);
             // These two lines check if the 'description' property is inside the configuration object.
-            console_1.default.debug('Checking if the description property is inside the configuration object...');
+            console_1.default.debug("Checking if the description property is inside the configuration object...");
             if (!((_g = config.config) === null || _g === void 0 ? void 0 : _g.description))
                 errors.push({
                     exercise: undefined,
-                    msg: 'The description property is not in the configuration object',
+                    msg: "The description property is not in the configuration object",
                 });
             if (errors.length === 0)
-                console_1.default.log('The config file is ok');
+                console_1.default.log("The config file is ok");
             // Validates if images and links are working at every README file.
             const exercises = config.exercises;
             const readmeFiles = [];
             if (exercises && exercises.length > 0) {
-                console_1.default.info(' Checking if the images are working...');
+                console_1.default.info(" Checking if the images are working...");
                 for (const index in exercises) {
                     if (Object.prototype.hasOwnProperty.call(exercises, index)) {
                         const exercise = exercises[index];
@@ -251,10 +252,10 @@ class AuditCommand extends SessionCommand_1.default {
                                 exercise: exercise.title,
                                 msg: `The exercise ${exercise.title} doesn't have a README.md file.`,
                             });
-                        if (exercise.language === 'python3' ||
-                            exercise.language === 'python') {
+                        if (exercise.language === "python3" ||
+                            exercise.language === "python") {
                             for (const f of exercise.files.map(f => f)) {
-                                if (f.path.includes('test.py') || f.path.includes('tests.py')) {
+                                if (f.path.includes("test.py") || f.path.includes("tests.py")) {
                                     const content = fs.readFileSync(f.path).toString();
                                     const isEmpty = audit_1.default.checkForEmptySpaces(content);
                                     if (isEmpty || !content)
@@ -267,7 +268,7 @@ class AuditCommand extends SessionCommand_1.default {
                         }
                         else {
                             for (const f of exercise.files.map(f => f)) {
-                                if (f.path.includes('test.js') || f.path.includes('tests.js')) {
+                                if (f.path.includes("test.js") || f.path.includes("tests.js")) {
                                     const content = fs.readFileSync(f.path).toString();
                                     const isEmpty = audit_1.default.checkForEmptySpaces(content);
                                     if (isEmpty || !content)
@@ -308,7 +309,7 @@ class AuditCommand extends SessionCommand_1.default {
             else
                 errors.push({
                     exercise: undefined,
-                    msg: 'The exercises array is empty.',
+                    msg: "The exercises array is empty.",
                 });
             console_1.default.log(`${counter.images.total - counter.images.error} images ok from ${counter.images.total}`);
             console_1.default.info(" Checking if important files are missing... (README's, translations, gitignore...)");
@@ -324,7 +325,7 @@ class AuditCommand extends SessionCommand_1.default {
                     files.push(` ${item.exercise}`);
             }
             if (files.length > 0) {
-                const filesString = files.join(',');
+                const filesString = files.join(",");
                 warnings.push({
                     exercise: undefined,
                     msg: files.length === 1 ?
@@ -333,7 +334,7 @@ class AuditCommand extends SessionCommand_1.default {
                 });
             }
             // Checks if the .gitignore file exists.
-            if (!fs.existsSync('.gitignore'))
+            if (!fs.existsSync(".gitignore"))
                 warnings.push({
                     exercise: undefined,
                     msg: ".gitignore file doesn't exist",
@@ -347,21 +348,21 @@ class AuditCommand extends SessionCommand_1.default {
         }
     }
 }
-AuditCommand.description = `learnpack audit is the command in charge of creating an auditory of the repository
-...
-learnpack audit checks for the following information in a repository:
-    1. The configuration object has slug, repository and description. (Error)
-    2. The command learnpack clean has been run. (Error)
-    3. If a markdown or test file doesn't have any content. (Error)
-    4. The links are accessing to valid servers. (Error)
-    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)
-    6. The external images are working (If they are pointing to a valid server). (Error)
-    7. The exercises directory names are valid. (Error)
-    8. If an exercise doesn't have a README file. (Error)
-    9. The exercises array (Of the config file) has content. (Error)
-    10. The exercses have the same translations. (Warning)
-    11. The .gitignore file exists. (Warning)
-    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
+AuditCommand.description = `learnpack audit is the command in charge of creating an auditory of the repository
+...
+learnpack audit checks for the following information in a repository:
+    1. The configuration object has slug, repository and description. (Error)
+    2. The command learnpack clean has been run. (Error)
+    3. If a markdown or test file doesn't have any content. (Error)
+    4. The links are accessing to valid servers. (Error)
+    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)
+    6. The external images are working (If they are pointing to a valid server). (Error)
+    7. The exercises directory names are valid. (Error)
+    8. If an exercise doesn't have a README file. (Error)
+    9. The exercises array (Of the config file) has content. (Error)
+    10. The exercses have the same translations. (Warning)
+    11. The .gitignore file exists. (Warning)
+    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 `;
 AuditCommand.flags = {
 // name: flags.string({char: 'n', description: 'name to print'}),

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

@@ -12,6 +12,7 @@ declare const _default: {
         publicPath: string;
         publicUrl: null;
         language: string;
+        autoPlay: boolean;
         grading: string;
         exercisesPath: string;
         webpackTemplate: null;

package/lib/managers/config/defaults.js

@@ -8,28 +8,29 @@ exports.default = {
             agent: null,
             version: null,
         },
-        dirPath: './.learn',
-        configPath: './learn.json',
-        outputPath: './.learn/dist',
-        publicPath: '/preview',
+        dirPath: "./.learn",
+        configPath: "./learn.json",
+        outputPath: "./.learn/dist",
+        publicPath: "/preview",
         publicUrl: null,
-        language: 'auto',
-        grading: 'isolated',
-        exercisesPath: './',
+        language: "auto",
+        autoPlay: true,
+        grading: "isolated",
+        exercisesPath: "./",
         webpackTemplate: null,
         disableGrading: false,
         disabledActions: [],
         actions: [],
         entries: {
-            html: 'index.html',
-            vanillajs: 'index.js',
-            react: 'app.jsx',
-            node: 'app.js',
-            python3: 'app.py',
-            java: 'app.java',
+            html: "index.html",
+            vanillajs: "index.js",
+            react: "app.jsx",
+            node: "app.js",
+            python3: "app.py",
+            java: "app.java",
         },
     },
-    address: 'http://localhost',
+    address: "http://localhost",
     currentExercise: null,
     exercises: [],
 };

package/lib/managers/config/index.js

@@ -16,12 +16,7 @@ const fetch = require("node-fetch");
 const chalk = require("chalk");
 /* exercise folder name standard */
 const getConfigPath = () => {
-    const possibleFileNames = [
-        "learn.json",
-        ".learn/learn.json",
-        "bc.json",
-        ".breathecode/bc.json",
-    ];
+    const possibleFileNames = ["learn.json", ".learn/learn.json"];
     const config = possibleFileNames.find(file => fs.existsSync(file)) || null;
     if (config && fs.existsSync(".breathecode"))
         return { config, base: ".breathecode" };
@@ -101,8 +96,8 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
     if (configObj.config && !configObj.config.publicUrl)
         configObj.config.publicUrl = `${configObj.address}:${configObj.config.port}`;
     // Assign default editor mode if not set already
-    if (configObj.config && mode !== null) {
-        configObj.config.editor.mode = mode || "vscode";
+    if (configObj.config && !mode) {
+        configObj.config.editor.mode = mode;
     }
     if (configObj.config && !configObj.config.editor.mode)
         configObj.config.editor.mode =
@@ -113,7 +108,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/coding-ide/learnpack/package.json");
         const packageJSON = await resp.json();
-        configObj.config.editor.version = packageJSON.version || "1.0.72";
+        configObj.config.editor.version = packageJSON.version || "1.0.73";
     }
     if (configObj.config) {
         configObj.config.dirPath = "./" + confPath.base;

package/lib/models/config.d.ts

@@ -39,6 +39,7 @@ export interface IConfig {
     exercisesPath: string;
     disableGrading: boolean;
     actions: Array<string>;
+    autoPlay: boolean;
     disabledActions?: Array<TConfigAction>;
     compiler: TCompiler;
     publicPath: string;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.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":"[standalone, gitpod]","options":["standalone","gitpod"]},"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":"2.1.2","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":"[standalone, gitpod]","options":["standalone","gitpod"]},"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.1",
+  "version": "2.1.2",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"