@learnpack/learnpack 2.1.25 → 2.1.27

package/lib/utils/audit.js

@@ -1,302 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("./console");
-const fs = require("fs");
-const path = require("path");
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-// eslint-disable-next-line
-const fm = require("front-matter");
-// This function checks if a url is valid.
-const isUrl = async (url, errors, counter) => {
-    const regexUrl = /(https?:\/\/[\w./-]+)/gm;
-    counter.links.total++;
-    if (!regexUrl.test(url)) {
-        counter.links.error++;
-        errors.push({
-            exercise: undefined,
-            msg: `The repository value of the configuration file is not a link: ${url}`,
-        });
-        return false;
-    }
-    const res = await fetch(url, { method: "HEAD" });
-    if (!res.ok) {
-        counter.links.error++;
-        errors.push({
-            exercise: undefined,
-            msg: `The link of the repository is broken: ${url}`,
-        });
-    }
-    return true;
-};
-const checkForEmptySpaces = (str) => {
-    const isEmpty = true;
-    for (const letter of str) {
-        if (letter !== " ") {
-            return false;
-        }
-    }
-    return isEmpty;
-};
-const checkLearnpackClean = (configObj, errors) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    if ((((_a = configObj.config) === null || _a === void 0 ? void 0 : _a.outputPath) &&
-        fs.existsSync((_b = configObj.config) === null || _b === void 0 ? void 0 : _b.outputPath)) ||
-        fs.existsSync(`${(_c = configObj.config) === null || _c === void 0 ? void 0 : _c.dirPath}/_app`) ||
-        fs.existsSync(`${(_d = configObj.config) === null || _d === void 0 ? void 0 : _d.dirPath}/reports`) ||
-        fs.existsSync(`${(_e = configObj.config) === null || _e === void 0 ? void 0 : _e.dirPath}/resets`) ||
-        fs.existsSync(`${(_f = configObj.config) === null || _f === void 0 ? void 0 : _f.dirPath}/app.tar.gz`) ||
-        fs.existsSync(`${(_g = configObj.config) === null || _g === void 0 ? void 0 : _g.dirPath}/config.json`) ||
-        fs.existsSync(`${(_h = configObj.config) === null || _h === void 0 ? void 0 : _h.dirPath}/vscode_queue.json`)) {
-        errors.push({
-            exercise: undefined,
-            msg: "You have to run learnpack clean command",
-        });
-    }
-};
-const findInFile = (types, content) => {
-    const regex = {
-        relativeImages: /!\[.*]\s*\((((\.\/)?(\.{2}\/){1,5})(.*\/)*(.[^\s/]*\.[A-Za-z]{2,4})\S*)\)/gm,
-        externalImages: /!\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
-        markdownLinks: /(\s)+\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
-        url: /(https?:\/\/[\w./-]+)/gm,
-        uploadcare: /https:\/\/ucarecdn.com\/(?:.*\/)*([\w./-]+)/gm,
-    };
-    const validTypes = Object.keys(regex);
-    if (!Array.isArray(types))
-        types = [types];
-    const findings = {};
-    for (const type of types) {
-        if (!validTypes.includes(type))
-            throw new Error("Invalid type: " + type);
-        else
-            findings[type] = {};
-    }
-    for (const type of types) {
-        let m;
-        while ((m = regex[type].exec(content)) !== null) {
-            // This is necessary to avoid infinite loops with zero-width matches
-            if (m.index === regex.lastIndex) {
-                regex.lastIndex++;
-            }
-            // The result can be accessed through the `m`-variable.
-            // m.forEach((match, groupIndex) => values.push(match));
-            findings[type][m[0]] = {
-                content: m[0],
-                absUrl: m[1],
-                mdUrl: m[2],
-                relUrl: m[6],
-            };
-        }
-    }
-    return findings;
-};
-// This function checks that each of the url's are working.
-const checkUrl = async (config, filePath, fileName, exercise, errors, warnings, counter) => {
-    var _a, _b, _c, _d;
-    if (!fs.existsSync(filePath))
-        return false;
-    const content = fs.readFileSync(filePath).toString();
-    const isEmpty = checkForEmptySpaces(content);
-    if (isEmpty || !content)
-        errors.push({
-            exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-            msg: `This file (${fileName}) 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 && counter.links.total++;
-            try {
-                // eslint-disable-next-line
-                let res = await fetch(frontmatter.attributes[attribute], {
-                    method: "HEAD",
-                });
-                if (!res.ok) {
-                    counter && counter.links.error++;
-                    errors.push({
-                        exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                        msg: `This link is broken (${res.ok}): ${frontmatter.attributes[attribute]}`,
-                    });
-                }
-            }
-            catch (_e) {
-                counter && counter.links.error++;
-                errors.push({
-                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                    msg: `This link is broken: ${frontmatter.attributes[attribute]}`,
-                });
-            }
-        }
-    }
-    // Check url's of each README file.
-    const findings = 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 && counter.images.total++;
-                        const relativePath = path
-                            .relative(exercise ? 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 && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : 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 && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : 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 && 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 ? 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 === null || exercise === void 0 ? void 0 : 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 && counter.images.error++;
-                                errors.push({
-                                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                    msg: `This link is broken: ${obj[img].absUrl}`,
-                                });
-                            }
-                        }
-                        catch (_f) {
-                            counter && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : 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 && counter.links.total++;
-                        if (!obj[link].mdUrl.includes("twitter")) {
-                            try {
-                                // eslint-disable-next-line
-                                let res = await fetch(obj[link].mdUrl, {
-                                    method: "HEAD",
-                                });
-                                if (res.status > 399 && res.status < 500) {
-                                    counter && counter.links.error++;
-                                    errors.push({
-                                        exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                        msg: `This link is broken: ${obj[link].mdUrl}`,
-                                    });
-                                }
-                            }
-                            catch (_g) {
-                                counter && counter.links.error++;
-                                errors.push({
-                                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                    msg: `This link is broken: ${obj[link].mdUrl}`,
-                                });
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-    return true;
-};
-// This function writes a given file with the given content.
-const writeFile = async (content, filePath) => {
-    try {
-        await fs.promises.writeFile(filePath, content);
-    }
-    catch (error) {
-        if (error)
-            console_1.default.error(`We weren't able to write the file in this path "${filePath}".`, error);
-    }
-};
-// This function checks if there are errors, and show them in the console at the end.
-const showErrors = (errors, counter) => {
-    return new Promise((resolve, reject) => {
-        if (errors) {
-            if (errors.length > 0) {
-                console_1.default.log("Checking for errors...");
-                for (const [i, error] of errors.entries())
-                    console_1.default.error(`${i + 1}) ${error.msg} ${error.exercise ? `(Exercise: ${error.exercise})` : ""}`);
-                if (counter) {
-                    console_1.default.error(` We found ${errors.length} error${errors.length > 1 ? "s" : ""} among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
-                }
-                else {
-                    console_1.default.error(` We found ${errors.length} error${errors.length > 1 ? "s" : ""} related with the project integrity.`);
-                }
-                process.exit(1);
-            }
-            else {
-                if (counter) {
-                    console_1.default.success(`We didn't find any errors in this repository among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
-                }
-                else {
-                    console_1.default.success(`We didn't find any errors in this repository.`);
-                }
-                process.exit(0);
-            }
-        }
-        else {
-            reject("Failed");
-        }
-    });
-};
-// This function checks if there are warnings, and show them in the console at the end.
-const showWarnings = (warnings) => {
-    return new Promise((resolve, reject) => {
-        if (warnings) {
-            if (warnings.length > 0) {
-                console_1.default.log("Checking for warnings...");
-                for (const [i, warning] of warnings.entries())
-                    console_1.default.warning(`${i + 1}) ${warning.msg} ${warning.exercise ? `File: ${warning.exercise}` : ""}`);
-            }
-            resolve("SUCCESS");
-        }
-        else {
-            reject("Failed");
-        }
-    });
-};
-exports.default = {
-    isUrl,
-    checkForEmptySpaces,
-    checkLearnpackClean,
-    findInFile,
-    checkUrl,
-    writeFile,
-    showErrors,
-    showWarnings,
-};

package/lib/utils/console.d.ts

@@ -1,12 +0,0 @@
-declare const _default: {
-    _debug: boolean;
-    startDebug: () => void;
-    log: (msg: string | Array<string>, ...args: Array<any>) => void;
-    error: (msg: string, ...args: Array<any>) => void;
-    success: (msg: string, ...args: Array<any>) => void;
-    info: (msg: string, ...args: Array<any>) => void;
-    help: (msg: string) => void;
-    debug(...args: Array<any>): void;
-    warning: (msg: string) => void;
-};
-export default _default;

package/lib/utils/console.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-exports.default = {
-    // _debug: true,
-    _debug: process.env.DEBUG === 'true',
-    startDebug: function () {
-        this._debug = true;
-    },
-    log: (msg, ...args) => console.log(chalk.gray(msg), ...args),
-    error: (msg, ...args) => console.log(chalk.red('⨉ ' + msg), ...args),
-    success: (msg, ...args) => console.log(chalk.green('✓ ' + msg), ...args),
-    info: (msg, ...args) => console.log(chalk.blue('ⓘ ' + msg), ...args),
-    help: (msg) => console.log(`${chalk.white.bold('⚠ help:')} ${chalk.white(msg)}`),
-    debug(...args) {
-        this._debug && console.log(chalk.magentaBright('⚠ debug: '), args);
-    },
-    warning: (msg) => console.log(`${chalk.yellow('⚠ warning:')} ${chalk.yellow(msg)}`),
-};

package/lib/utils/errors.d.ts

@@ -1,17 +0,0 @@
-import { ISolution, IError } from '../models/errors';
-export declare const getSolution: (slug?: string | undefined) => ISolution;
-export declare const ValidationError: (error: IError | string) => IError;
-export declare const NotFoundError: (error: IError | string) => IError;
-export declare const CompilerError: (error: IError | string) => IError;
-export declare const TestingError: (error: IError | string) => IError;
-export declare const AuthError: (error: IError | string) => IError;
-export declare const InternalError: (error: IError | string) => IError;
-declare const _default: {
-    ValidationError: (error: string | IError) => IError;
-    CompilerError: (error: string | IError) => IError;
-    TestingError: (error: string | IError) => IError;
-    NotFoundError: (error: string | IError) => IError;
-    InternalError: (error: string | IError) => IError;
-    AuthError: (error: string | IError) => IError;
-};
-export default _default;

package/lib/utils/errors.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalError = exports.AuthError = exports.TestingError = exports.CompilerError = exports.NotFoundError = exports.ValidationError = exports.getSolution = void 0;
-const console_1 = require("./console");
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-let solutions = null;
-const uknown = {
-    video: 'https://www.youtube.com/watch?v=gD1Sa99GiE4',
-    message: 'Uknown internal error',
-    slug: 'uknown',
-    gif: 'https://github.com/breatheco-de/breathecode-cli/blob/master/docs/errors/uknown.gif?raw=true',
-};
-exports.getSolution = (slug) => {
-    if (!slug) {
-        console_1.default.debug('Getting solution templates from the learnpack repository');
-    }
-    else {
-        console_1.default.debug(`Getting solution for ${slug}`, solutions);
-    }
-    if (!solutions) {
-        console_1.default.debug('Fetching for errors.json on github');
-        fetch('https://raw.githubusercontent.com/breatheco-de/breathecode-cli/master/docs/errors/errors.json')
-            .then((r) => r.json())
-            .then(function (_s) {
-            solutions = _s;
-        });
-        return uknown;
-    }
-    return typeof solutions[slug || ''] === 'undefined' || !slug ?
-        uknown :
-        solutions[slug];
-};
-exports.ValidationError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 400;
-    _err.type = 'validation-error';
-    const sol = exports.getSolution(error.slug);
-    _err.video = sol.video;
-    _err.gif = sol.gif;
-    _err.message = typeof message === 'string' ? message : sol.message;
-    return _err;
-};
-exports.NotFoundError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 400;
-    _err.type = 'not-found-error';
-    const sol = exports.getSolution(error.slug);
-    _err.video = sol.video;
-    _err.gif = sol.gif;
-    _err.message = typeof message === 'string' ? message : sol.message;
-    return _err;
-};
-exports.CompilerError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 400;
-    _err.type = 'compiler-error';
-    const sol = exports.getSolution(error.slug);
-    _err.video = sol.video;
-    _err.gif = sol.gif;
-    _err.message = typeof message === 'string' ? message : sol.message;
-    return _err;
-};
-exports.TestingError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 400;
-    _err.type = 'testing-error';
-    return _err;
-};
-exports.AuthError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 403;
-    _err.type = 'auth-error';
-    return _err;
-};
-exports.InternalError = (error) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = 500;
-    _err.type = 'internal-error';
-    const sol = exports.getSolution(error.slug);
-    _err.video = sol.video;
-    _err.gif = sol.gif;
-    _err.message = typeof message === 'string' ? message : sol.message;
-    return _err;
-};
-exports.getSolution();
-exports.default = {
-    ValidationError: exports.ValidationError,
-    CompilerError: exports.CompilerError,
-    TestingError: exports.TestingError,
-    NotFoundError: exports.NotFoundError,
-    InternalError: exports.InternalError,
-    AuthError: exports.AuthError,
-};

package/lib/utils/exercisesQueue.d.ts

@@ -1,9 +0,0 @@
-import { IExercise } from "../models/exercise-obj";
-declare class ExercisesQueue {
-    exercises: IExercise[];
-    constructor(exercises: any);
-    pop(): IExercise | undefined;
-    isEmpty(): boolean;
-    size(): number;
-}
-export default ExercisesQueue;

package/lib/utils/exercisesQueue.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Exercise {
-    constructor(exercise) {
-        this.exercise = exercise;
-    }
-    test(sessionConfig, config, socket) {
-        if (this.exercise.language) {
-            socket.log("testing", `Testing exercise ${this.exercise.slug} using ${this.exercise.language} engine`);
-            sessionConfig.runHook("action", {
-                action: "test",
-                socket,
-                configuration: config,
-                exercise: this.exercise,
-            });
-        }
-        else {
-            socket.onTestingFinished({ result: "success" });
-        }
-    }
-}
-class ExercisesQueue {
-    constructor(exercises) {
-        this.exercises = exercises.map((exercise) => {
-            return new Exercise(exercise);
-        });
-    }
-    pop() {
-        return this.exercises.shift();
-    }
-    isEmpty() {
-        return this.size() === 0;
-    }
-    size() {
-        return this.exercises.length;
-    }
-}
-exports.default = ExercisesQueue;

package/lib/utils/fileQueue.d.ts

@@ -1,40 +0,0 @@
-declare const _default: {
-    events: {
-        START_EXERCISE: string;
-        INIT: string;
-        RUNNING: string;
-        END: string;
-        RESET_EXERCISE: string;
-        OPEN_FILES: string;
-        OPEN_WINDOW: string;
-        INSTRUCTIONS_CLOSED: string;
-    };
-    dispatcher: (opts?: any) => {
-        enqueue: (name: string, data?: any) => void;
-        events: {
-            START_EXERCISE: string;
-            INIT: string;
-            RUNNING: string;
-            END: string;
-            RESET_EXERCISE: string;
-            OPEN_FILES: string;
-            OPEN_WINDOW: string;
-            INSTRUCTIONS_CLOSED: string;
-        };
-    };
-    listener: (opts?: any) => {
-        onPull: (callback: (T?: any) => any) => boolean;
-        onReset: (callback: (T?: any) => any) => boolean;
-        events: {
-            START_EXERCISE: string;
-            INIT: string;
-            RUNNING: string;
-            END: string;
-            RESET_EXERCISE: string;
-            OPEN_FILES: string;
-            OPEN_WINDOW: string;
-            INSTRUCTIONS_CLOSED: string;
-        };
-    };
-};
-export default _default;