@learnpack/learnpack 2.1.19 → 2.1.24

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.19 win32-x64 node-v16.14.0
+@learnpack/learnpack/2.1.24 win32-x64 node-v16.14.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.19/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/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.19/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,5 +344,5 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.19/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.24/src\commands\test.ts)_
 <!-- commandsstop -->

package/lib/commands/audit.js

@@ -8,8 +8,6 @@ const SessionCommand_1 = require("../utils/SessionCommand");
 const path = require("path");
 // eslint-disable-next-line
 const fetch = require("node-fetch");
-// eslint-disable-next-line
-const fm = require("front-matter");
 class AuditCommand extends SessionCommand_1.default {
     async init() {
         const { flags } = this.parse(AuditCommand);
@@ -58,154 +56,10 @@ class AuditCommand extends SessionCommand_1.default {
                             });
                     }
                 });
-                // This function checks that each of the url's are working.
-                const checkUrl = async (file, exercise) => {
-                    var _a, _b, _c, _d;
-                    if (!fs.existsSync(file.path))
-                        return false;
-                    const content = fs.readFileSync(file.path).toString();
-                    const isEmpty = audit_1.default.checkForEmptySpaces(content);
-                    if (isEmpty || !content)
-                        errors.push({
-                            exercise: exercise.title,
-                            msg: `This file (${file.name}) doesn't have any content inside.`,
-                        });
-                    const frontmatter = fm(content);
-                    for (const attribute in frontmatter.attributes) {
-                        if (Object.prototype.hasOwnProperty.call(frontmatter.attributes, attribute) &&
-                            (attribute === "intro" || attribute === "tutorial")) {
-                            counter.links.total++;
-                            try {
-                                // eslint-disable-next-line
-                                let res = await fetch(frontmatter.attributes[attribute], {
-                                    method: "HEAD",
-                                });
-                                if (!res.ok) {
-                                    counter.links.error++;
-                                    errors.push({
-                                        exercise: exercise.title,
-                                        msg: `This link is broken (${res.ok}): ${frontmatter.attributes[attribute]}`,
-                                    });
-                                }
-                            }
-                            catch (_e) {
-                                counter.links.error++;
-                                errors.push({
-                                    exercise: exercise.title,
-                                    msg: `This link is broken: ${frontmatter.attributes[attribute]}`,
-                                });
-                            }
-                        }
-                    }
-                    // Check url's of each README file.
-                    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) {
-                                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()) {
-                                            counter.images.error++;
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `This relative path (${obj[img].relUrl}) is not pointing to the assets folder.`,
-                                            });
-                                        }
-                                        if (!fs.existsSync(`${(_b = config.config) === null || _b === void 0 ? void 0 : _b.dirPath}/assets/${obj[img].relUrl}`)) {
-                                            counter.images.error++;
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `The file ${obj[img].relUrl} doesn't exist in the assets folder.`,
-                                            });
-                                        }
-                                    }
-                                }
-                            }
-                            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("?")
-                                            .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, "/");
-                                            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}".`,
-                                            });
-                                        }
-                                        try {
-                                            // eslint-disable-next-line
-                                            let res = await fetch(obj[img].absUrl, {
-                                                method: "HEAD",
-                                            });
-                                            if (!res.ok) {
-                                                counter.images.error++;
-                                                errors.push({
-                                                    exercise: exercise.title,
-                                                    msg: `This link is broken: ${obj[img].absUrl}`,
-                                                });
-                                            }
-                                        }
-                                        catch (_f) {
-                                            counter.images.error++;
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `This link is broken: ${obj[img].absUrl}`,
-                                            });
-                                        }
-                                    }
-                                }
-                            }
-                            else if (finding === "markdownLinks" &&
-                                Object.keys(obj).length > 0) {
-                                for (const link in obj) {
-                                    if (Object.prototype.hasOwnProperty.call(obj, link)) {
-                                        counter.links.total++;
-                                        try {
-                                            // eslint-disable-next-line
-                                            let res = await fetch(obj[link].mdUrl, {
-                                                method: "HEAD",
-                                            });
-                                            if (res.status > 399 && res.status < 500) {
-                                                console_1.default.log("Response links:", res.status, obj[link].mdUrl, res);
-                                                counter.links.error++;
-                                                errors.push({
-                                                    exercise: exercise.title,
-                                                    msg: `This link is broken: ${obj[link].mdUrl}`,
-                                                });
-                                            }
-                                        }
-                                        catch (_g) {
-                                            counter.links.error++;
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `This link is broken: ${obj[link].mdUrl}`,
-                                            });
-                                        }
-                                    }
-                                }
-                            }
-                        }
-                    }
-                    return true;
-                };
                 // This function is being created because the find method doesn't work with promises.
                 const find = async (file, lang, exercise) => {
                     if (file.name === lang) {
-                        await checkUrl(file, exercise);
+                        await audit_1.default.checkUrl(config, file.path, file.name, exercise, errors, warnings, counter);
                         return true;
                     }
                     return false;
@@ -349,11 +203,9 @@ class AuditCommand extends SessionCommand_1.default {
                 for (const readme of readmeFiles) {
                     counter.readmeFiles += readme.count;
                 }
-                await audit_1.default.showWarnings(warnings);
-                await audit_1.default.showErrors(errors, counter);
             }
             else {
-                // This is the audit for Projects
+                // This is the audit code for Projects
                 // Getting the learn.json schema
                 const schemaResponse = await fetch("https://raw.githubusercontent.com/tommygonzaleza/project-template/main/.github/learn-schema.json");
                 const schema = await schemaResponse.json();
@@ -363,18 +215,53 @@ class AuditCommand extends SessionCommand_1.default {
                     console_1.default.error("There is no learn.json file located in the root of the project.");
                     process.exit(1);
                 }
-                // Checkimg the README.md file
-                const readme = fs.readFileSync("./README.md").toString();
-                if (!readme)
-                    errors.push({
-                        exercise: undefined,
-                        msg: 'There is no "README.md" located in the root of the project.',
-                    });
-                if (readme.length < 800)
-                    errors.push({
-                        exercise: undefined,
-                        msg: `The "README.md" file should have at least 800 characters (It currently have: ${readme.length}).`,
-                    });
+                // Checking the README.md files and possible translations.
+                let readmeFiles = [];
+                const translations = [];
+                const translationRegex = /README\.([a-z]{2,3})\.md/;
+                try {
+                    const data = await fs.promises.readdir("./");
+                    readmeFiles = data.filter(file => file.includes("README"));
+                    if (readmeFiles.length === 0)
+                        errors.push({
+                            exercise: undefined,
+                            msg: `There is no README file in the repository.`,
+                        });
+                }
+                catch (error) {
+                    if (error)
+                        console_1.default.error("There was an error getting the directory files", error);
+                }
+                for (const readmeFile of readmeFiles) {
+                    // Checking the language of each README file.
+                    if (readmeFile === "README.md")
+                        translations.push("us");
+                    else {
+                        const regexGroups = translationRegex.exec(readmeFile);
+                        if (regexGroups)
+                            translations.push(regexGroups[1]);
+                    }
+                    const readme = fs.readFileSync(path.resolve(readmeFile)).toString();
+                    const isEmpty = audit_1.default.checkForEmptySpaces(readme);
+                    if (isEmpty || !readme) {
+                        errors.push({
+                            exercise: undefined,
+                            msg: `This file "${readmeFile}" doesn't have any content inside.`,
+                        });
+                        continue;
+                    }
+                    if (readme.length < 800)
+                        errors.push({
+                            exercise: undefined,
+                            msg: `The "${readmeFile}" file should have at least 800 characters (It currently have: ${readme.length}).`,
+                        });
+                    // eslint-disable-next-line
+                    await audit_1.default.checkUrl(config, path.resolve(readmeFile), readmeFile, undefined, errors, warnings, 
+                    // eslint-disable-next-line
+                    undefined);
+                }
+                // Adding the translations to the learn.json
+                learnjson.translations = translations;
                 // Checking if the preview image (from the learn.json) is OK.
                 try {
                     const res = await fetch(learnjson.preview, { method: "HEAD" });
@@ -391,83 +278,38 @@ class AuditCommand extends SessionCommand_1.default {
                         msg: `The link of the "preview" is broken: ${learnjson.preview}`,
                     });
                 }
-                // Checking each of the schema rules that are mandatory.
-                for (const schemaItem of schema) {
-                    const learnItem = learnjson[schemaItem.key];
-                    if (schemaItem.mandatory) {
-                        console_1.default.info(`Checking for the "${schemaItem.key}" property...`);
-                        if (!learnItem) {
-                            errors.push({
-                                exercise: undefined,
-                                msg: `learn.json missing "${schemaItem.key}" mandatory property.`,
-                            });
-                            return;
-                        }
-                        if (schemaItem.max_size && learnItem.length > schemaItem.max_size)
-                            errors.push({
-                                exercise: undefined,
-                                msg: `The "${schemaItem.key}" property should have a maximum size of ${schemaItem.max_size}`,
-                            });
-                        if (schemaItem.enum) {
-                            if (typeof learnItem === "object") {
-                                let valid = true;
-                                for (const ele of learnItem) {
-                                    if (!schemaItem.enum.includes(ele))
-                                        valid = false;
-                                }
-                                if (!valid)
-                                    errors.push({
-                                        exercise: undefined,
-                                        msg: `The "${schemaItem.key}" property (current: ${learnItem}) should be one of the following values: ${schemaItem.enum.join(", ")}.`,
-                                    });
-                            }
-                            else if (!schemaItem.enum.includes(learnItem.toLowerCase()))
-                                errors.push({
-                                    exercise: undefined,
-                                    msg: `The "${schemaItem.key}" property (current: ${learnItem}) should be one of the following values: ${schemaItem.enum.join(", ")}.`,
-                                });
-                        }
-                        if (schemaItem.type === "url" && schemaItem.allowed_extensions) {
-                            let valid = false;
-                            for (const ele of schemaItem.allowed_extensions) {
-                                if (learnItem.split(".").includes(ele))
-                                    valid = true;
-                            }
-                            if (!valid)
-                                errors.push({
-                                    exercise: undefined,
-                                    msg: `The "${schemaItem.key}" property should have one of the allowed extensions: ${schemaItem.allowed_extensions.join(", ")}.`,
-                                });
-                        }
-                        if (schemaItem.max_item_size &&
-                            learnItem.length > schemaItem.max_item_size)
-                            errors.push({
-                                exercise: undefined,
-                                msg: `The "${schemaItem.key}" property has more items than allowed (${schemaItem.max_item_size}).`,
-                            });
-                    }
-                }
-                /* eslint-disable-next-line */
-                await audit_1.default.showErrors(errors, undefined);
+                const date = new Date();
+                learnjson.validationAt = date.getTime();
+                if (errors.length > 0)
+                    learnjson.validationStatus = "error";
+                else if (warnings.length > 0)
+                    learnjson.validationStatus = "warning";
+                else
+                    learnjson.validationStatus = "success";
+                // Writes the "learn.json" file with all the new properties
+                await fs.promises.writeFile("./learn.json", JSON.stringify(learnjson));
             }
+            await audit_1.default.showWarnings(warnings);
+            // eslint-disable-next-line
+            await audit_1.default.showErrors(errors, undefined);
         }
     }
 }
-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/commands/init.js

@@ -9,7 +9,6 @@ const cli_ux_1 = require("cli-ux");
 const eta = require("eta");
 const console_1 = require("../utils/console");
 const errors_1 = require("../utils/errors");
-const defaults_1 = require("../managers/config/defaults");
 const path = require("path");
 class InitComand extends BaseCommand_1.default {
     async run() {
@@ -70,10 +69,17 @@ class InitComand extends BaseCommand_1.default {
                 },
             },
         ]);
-        const packageInfo = Object.assign(Object.assign({}, defaults_1.default.config), { grading: choices.grading, difficulty: choices.difficulty, duration: parseInt(choices.duration), description: choices.description, title: choices.title, slug: choices.title
+        const packageInfo = {
+            grading: choices.grading,
+            difficulty: choices.difficulty,
+            duration: parseInt(choices.duration),
+            description: choices.description,
+            title: choices.title,
+            slug: choices.title
                 .toLowerCase()
                 .replace(/ /g, "-")
-                .replace(/[^\w-]+/g, "") });
+                .replace(/[^\w-]+/g, ""),
+        };
         cli_ux_1.default.action.start("Initializing package");
         const languages = ["en", "es"];
         const templatesDir = path.resolve(__dirname, "../../src/utils/templates/" + choices.grading || "no-grading");

package/lib/utils/audit.d.ts

@@ -2,11 +2,14 @@ import { IAuditErrors } from "../models/audit";
 import { IConfigObj } from "../models/config";
 import { ICounter } from "../models/counter";
 import { IFindings } from "../models/findings";
+import { IExercise } from "../models/exercise-obj";
 declare const _default: {
     isUrl: (url: string, errors: IAuditErrors[], counter: ICounter) => Promise<boolean>;
     checkForEmptySpaces: (str: string) => boolean;
     checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
     findInFile: (types: string[], content: string) => IFindings;
+    checkUrl: (config: IConfigObj, filePath: string, fileName: string, exercise: IExercise | undefined, errors: IAuditErrors[], warnings: IAuditErrors[], counter: ICounter | undefined) => Promise<boolean>;
+    writeFile: (content: string, filePath: string) => Promise<void>;
     showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
     showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
 };