@learnpack/learnpack 2.1.18 → 2.1.23

package/lib/commands/audit.js

@@ -8,341 +8,290 @@ 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);
         await this.initSession(flags);
     }
     async run() {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         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) {
             const errors = [];
             const warnings = [];
-            const counter = {
-                images: {
-                    error: 0,
-                    total: 0,
-                },
-                links: {
-                    error: 0,
-                    total: 0,
-                },
-                exercises: 0,
-                readmeFiles: 0,
-            };
-            // Checks if learnpack clean has been run
-            audit_1.default.checkLearnpackClean(config, errors);
-            // Build exercises if they are not built yet.
-            (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.buildIndex();
-            config = (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.get();
-            // Check if the exercises folder has some files within any ./exercise
-            const exercisesPath = config.config.exercisesPath;
-            fs.readdir(exercisesPath, (err, files) => {
-                if (err) {
-                    return console.log("Unable to scan directory: " + err);
-                }
-                // listing all files using forEach
-                for (const file of files) {
-                    // Do whatever you want to do with the file
-                    const filePath = path.join(exercisesPath, file);
-                    if (fs.statSync(filePath).isFile())
-                        warnings.push({
-                            exercise: file,
-                            msg: "This file is not inside any exercise folder.",
-                        });
-                }
-            });
-            // 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))
+            if (((_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.projectType) === "tutorial") {
+                const counter = {
+                    images: {
+                        error: 0,
+                        total: 0,
+                    },
+                    links: {
+                        error: 0,
+                        total: 0,
+                    },
+                    exercises: 0,
+                    readmeFiles: 0,
+                };
+                // Checks if learnpack clean has been run
+                audit_1.default.checkLearnpackClean(config, errors);
+                // Build exercises if they are not built yet.
+                (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
+                config = (_d = this.configManager) === null || _d === void 0 ? void 0 : _d.get();
+                // Check if the exercises folder has some files within any ./exercise
+                const exercisesPath = config.config.exercisesPath;
+                fs.readdir(exercisesPath, (err, files) => {
+                    if (err) {
+                        return console.log("Unable to scan directory: " + err);
+                    }
+                    // listing all files using forEach
+                    for (const file of files) {
+                        // Do whatever you want to do with the file
+                        const filePath = path.join(exercisesPath, file);
+                        if (fs.statSync(filePath).isFile())
+                            warnings.push({
+                                exercise: file,
+                                msg: "This file is not inside any exercise folder.",
+                            });
+                    }
+                });
+                // 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 audit_1.default.checkUrl(config, file.path, file.name, exercise, errors, warnings, counter);
+                        return true;
+                    }
                     return false;
-                const content = fs.readFileSync(file.path).toString();
-                const isEmpty = audit_1.default.checkForEmptySpaces(content);
-                if (isEmpty || !content)
+                };
+                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...");
+                if (!((_e = config.config) === null || _e === void 0 ? void 0 : _e.slug))
                     errors.push({
-                        exercise: exercise.title,
-                        msg: `This file (${file.name}) doesn't have any content inside.`,
+                        exercise: undefined,
+                        msg: "The slug property is not in the configuration object",
                     });
-                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++;
+                // 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...");
+                if (!((_f = config.config) === null || _f === void 0 ? void 0 : _f.repository))
+                    errors.push({
+                        exercise: undefined,
+                        msg: "The repository property is not in the configuration object",
+                    });
+                else
+                    audit_1.default.isUrl((_g = config.config) === null || _g === void 0 ? void 0 : _g.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...");
+                if (!((_h = config.config) === null || _h === void 0 ? void 0 : _h.description))
+                    errors.push({
+                        exercise: undefined,
+                        msg: "The description property is not in the configuration object",
+                    });
+                if (errors.length === 0)
+                    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...");
+                    for (const index in exercises) {
+                        if (Object.prototype.hasOwnProperty.call(exercises, index)) {
+                            const exercise = exercises[index];
+                            if (!exercise_1.validateExerciseDirectoryName(exercise.title))
                                 errors.push({
                                     exercise: exercise.title,
-                                    msg: `This link is broken (${res.ok}): ${frontmatter.attributes[attribute]}`,
+                                    msg: `The exercise ${exercise.title} has an invalid name.`,
                                 });
-                            }
-                        }
-                        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++;
+                            let readmeFilesCount = { exercise: exercise.title, count: 0 };
+                            if (Object.keys(exercise.translations).length === 0)
+                                errors.push({
+                                    exercise: exercise.title,
+                                    msg: `The exercise ${exercise.title} doesn't have a README.md file.`,
+                                });
+                            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")) {
+                                        const content = fs.readFileSync(f.path).toString();
+                                        const isEmpty = audit_1.default.checkForEmptySpaces(content);
+                                        if (isEmpty || !content)
                                             errors.push({
                                                 exercise: exercise.title,
-                                                msg: `This link is broken: ${obj[img].absUrl}`,
+                                                msg: `This file (${f.name}) doesn't have any content inside.`,
                                             });
-                                        }
-                                    }
-                                    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++;
+                            else {
+                                for (const f of exercise.files.map(f => f)) {
+                                    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)
                                             errors.push({
                                                 exercise: exercise.title,
-                                                msg: `This link is broken: ${obj[link].mdUrl}`,
+                                                msg: `This file (${f.name}) doesn't have any content inside.`,
                                             });
+                                    }
+                                }
+                            }
+                            for (const lang in exercise.translations) {
+                                if (Object.prototype.hasOwnProperty.call(exercise.translations, lang)) {
+                                    const files = [];
+                                    const findResultPromises = [];
+                                    for (const file of exercise.files) {
+                                        const found = find(file, exercise.translations[lang], exercise);
+                                        findResultPromises.push(found);
+                                    }
+                                    // eslint-disable-next-line
+                                    let findResults = await Promise.all(findResultPromises);
+                                    for (const found of findResults) {
+                                        if (found) {
+                                            readmeFilesCount = Object.assign(Object.assign({}, readmeFilesCount), { count: readmeFilesCount.count + 1 });
+                                            files.push(found);
                                         }
                                     }
-                                    catch (_g) {
-                                        counter.links.error++;
+                                    if (!files.includes(true))
                                         errors.push({
                                             exercise: exercise.title,
-                                            msg: `This link is broken: ${obj[link].mdUrl}`,
+                                            msg: "This exercise doesn't have a README.md file.",
                                         });
-                                    }
                                 }
                             }
+                            readmeFiles.push(readmeFilesCount);
                         }
                     }
                 }
-                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);
-                    return true;
+                else
+                    errors.push({
+                        exercise: undefined,
+                        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...)");
+                // Check if all the exercises has the same ammount of README's, this way we can check if they have the same ammount of translations.
+                const files = [];
+                let count = 0;
+                for (const item of readmeFiles) {
+                    if (count < item.count)
+                        count = item.count;
+                }
+                for (const item of readmeFiles) {
+                    if (item.count !== count)
+                        files.push(` ${item.exercise}`);
                 }
-                return false;
-            };
-            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...");
-            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",
-                });
-            // 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...");
-            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",
-                });
-            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...");
-            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",
-                });
-            if (errors.length === 0)
-                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...");
-                for (const index in exercises) {
-                    if (Object.prototype.hasOwnProperty.call(exercises, index)) {
-                        const exercise = exercises[index];
-                        if (!exercise_1.validateExerciseDirectoryName(exercise.title))
-                            errors.push({
-                                exercise: exercise.title,
-                                msg: `The exercise ${exercise.title} has an invalid name.`,
-                            });
-                        let readmeFilesCount = { exercise: exercise.title, count: 0 };
-                        if (Object.keys(exercise.translations).length === 0)
-                            errors.push({
-                                exercise: exercise.title,
-                                msg: `The exercise ${exercise.title} doesn't have a README.md file.`,
-                            });
-                        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")) {
-                                    const content = fs.readFileSync(f.path).toString();
-                                    const isEmpty = audit_1.default.checkForEmptySpaces(content);
-                                    if (isEmpty || !content)
-                                        errors.push({
-                                            exercise: exercise.title,
-                                            msg: `This file (${f.name}) doesn't have any content inside.`,
-                                        });
-                                }
-                            }
-                        }
-                        else {
-                            for (const f of exercise.files.map(f => f)) {
-                                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)
-                                        errors.push({
-                                            exercise: exercise.title,
-                                            msg: `This file (${f.name}) doesn't have any content inside.`,
-                                        });
-                                }
-                            }
-                        }
-                        for (const lang in exercise.translations) {
-                            if (Object.prototype.hasOwnProperty.call(exercise.translations, lang)) {
-                                const files = [];
-                                const findResultPromises = [];
-                                for (const file of exercise.files) {
-                                    const found = find(file, exercise.translations[lang], exercise);
-                                    findResultPromises.push(found);
-                                }
-                                // eslint-disable-next-line
-                                let findResults = await Promise.all(findResultPromises);
-                                for (const found of findResults) {
-                                    if (found) {
-                                        readmeFilesCount = Object.assign(Object.assign({}, readmeFilesCount), { count: readmeFilesCount.count + 1 });
-                                        files.push(found);
-                                    }
-                                }
-                                if (!files.includes(true))
-                                    errors.push({
-                                        exercise: exercise.title,
-                                        msg: "This exercise doesn't have a README.md file.",
-                                    });
-                            }
-                        }
-                        readmeFiles.push(readmeFilesCount);
-                    }
+                if (files.length > 0) {
+                    const filesString = files.join(",");
+                    warnings.push({
+                        exercise: undefined,
+                        msg: files.length === 1 ?
+                            `This exercise is missing translations:${filesString}` :
+                            `These exercises are missing translations:${filesString}`,
+                    });
+                }
+                // Checks if the .gitignore file exists.
+                if (!fs.existsSync(".gitignore"))
+                    warnings.push({
+                        exercise: undefined,
+                        msg: ".gitignore file doesn't exist",
+                    });
+                counter.exercises = exercises.length;
+                for (const readme of readmeFiles) {
+                    counter.readmeFiles += readme.count;
                 }
             }
-            else
-                errors.push({
-                    exercise: undefined,
-                    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...)");
-            // Check if all the exercises has the same ammount of README's, this way we can check if they have the same ammount of translations.
-            const files = [];
-            let count = 0;
-            for (const item of readmeFiles) {
-                if (count < item.count)
-                    count = item.count;
-            }
-            for (const item of readmeFiles) {
-                if (item.count !== count)
-                    files.push(` ${item.exercise}`);
-            }
-            if (files.length > 0) {
-                const filesString = files.join(",");
-                warnings.push({
-                    exercise: undefined,
-                    msg: files.length === 1 ?
-                        `This exercise is missing translations:${filesString}` :
-                        `These exercises are missing translations:${filesString}`,
-                });
-            }
-            // Checks if the .gitignore file exists.
-            if (!fs.existsSync(".gitignore"))
-                warnings.push({
-                    exercise: undefined,
-                    msg: ".gitignore file doesn't exist",
-                });
-            counter.exercises = exercises.length;
-            for (const readme of readmeFiles) {
-                counter.readmeFiles += readme.count;
+            else {
+                // 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();
+                // Checking the "learn.json" file:
+                const learnjson = JSON.parse(fs.readFileSync("./learn.json").toString());
+                if (!learnjson) {
+                    console_1.default.error("There is no learn.json file located in the root of the project.");
+                    process.exit(1);
+                }
+                // 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" });
+                    if (!res.ok) {
+                        errors.push({
+                            exercise: undefined,
+                            msg: `The link of the "preview" is broken: ${learnjson.preview}`,
+                        });
+                    }
+                }
+                catch (_j) {
+                    errors.push({
+                        exercise: undefined,
+                        msg: `The link of the "preview" is broken: ${learnjson.preview}`,
+                    });
+                }
+                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);
-            await audit_1.default.showErrors(errors, counter);
+            // eslint-disable-next-line
+            await audit_1.default.showErrors(errors, undefined);
         }
     }
 }

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

@@ -14,6 +14,7 @@ declare const _default: {
         contact: string;
         language: string;
         autoPlay: boolean;
+        projectType: string;
         grading: string;
         exercisesPath: string;
         webpackTemplate: null;

package/lib/managers/config/defaults.js

@@ -16,6 +16,7 @@ exports.default = {
         contact: "https://github.com/learnpack/learnpack/issues/new",
         language: "auto",
         autoPlay: true,
+        projectType: "tutorial",
         grading: "isolated",
         exercisesPath: "./",
         webpackTemplate: null,

package/lib/models/audit.d.ts

@@ -0,0 +1,15 @@
+export interface IAuditErrors {
+    exercise?: string;
+    msg: string;
+}
+declare type TType = "string" | "array" | "number" | "url" | "boolean";
+export interface ISchemaItem {
+    key: string;
+    mandatory: boolean;
+    type: TType;
+    max_size?: number;
+    allowed_extensions?: string[];
+    enum?: string[];
+    max_item_size?: number;
+}
+export {};

package/lib/models/config.d.ts

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