@learnpack/learnpack 2.0.16 → 2.0.19

package/lib/utils/audit.js

@@ -1,129 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("./console");
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-const fs = require("fs");
-exports.default = {
-    // This function checks if a url is valid.
-    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;
-    },
-    checkForEmptySpaces: (str) => {
-        const isEmpty = true;
-        for (const letter of str) {
-            if (letter !== ' ') {
-                return false;
-            }
-        }
-        return isEmpty;
-    },
-    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',
-            });
-        }
-    },
-    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 if there are errors, and show them in the console at the end.
-    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})` : ''}`);
-                    console_1.default.error(` We found ${errors.length} errors among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
-                    process.exit(1);
-                }
-                else {
-                    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.`);
-                    process.exit(0);
-                }
-            }
-            else {
-                reject('Failed');
-            }
-        });
-    },
-    // This function checks if there are warnings, and show them in the console at the end.
-    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');
-            }
-        });
-    },
-};

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;

package/lib/utils/fileQueue.js

@@ -1,168 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const fs = require("fs");
-// import em from "events"
-const XXH = require("xxhashjs");
-// possible events to dispatch
-const events = {
-    START_EXERCISE: "start_exercise",
-    INIT: "initializing",
-    RUNNING: "configuration_loaded",
-    END: "connection_ended",
-    RESET_EXERCISE: "reset_exercise",
-    OPEN_FILES: "open_files",
-    OPEN_WINDOW: "open_window",
-    INSTRUCTIONS_CLOSED: "instructions_closed",
-};
-let options = {
-    path: null,
-    create: false,
-};
-let lastHash = null;
-let watcher = null; // subscribe to file and listen to changes
-let actions = null; // action queue
-const loadDispatcher = (opts) => {
-    actions = [{ name: "initializing", time: now() }];
-    console_1.default.debug(`Loading from ${opts.path}`);
-    let exists = fs.existsSync(opts.path);
-    if (opts.create) {
-        if (exists)
-            actions.push({ name: "reset", time: now() });
-        fs.writeFileSync(opts.path, JSON.stringify(actions), { flag: "w" });
-        exists = true;
-    }
-    if (!exists)
-        throw new Error(`Invalid queue path, missing file at: ${opts.path}`);
-    let incomingActions = [];
-    try {
-        const content = fs.readFileSync(opts.path, "utf-8");
-        incomingActions = JSON.parse(content);
-        if (!Array.isArray(incomingActions))
-            incomingActions = [];
-    }
-    catch (_a) {
-        incomingActions = [];
-        console_1.default.debug("Error loading VSCode Actions file");
-    }
-    console_1.default.debug("Actions load ", incomingActions);
-    return incomingActions;
-};
-// eslint-disable-next-line
-const enqueue = (name, data = undefined) => {
-    if (!Object.values(events).includes(name)) {
-        console_1.default.debug(`Invalid event ${name}`);
-        throw new Error(`Invalid action ${name}`);
-    }
-    if (!actions)
-        actions = [];
-    actions.push({ name, time: now(), data: data });
-    console_1.default.debug(`EMIT -> ${name}:Exporting changes to ${options.path}`);
-    return fs.writeFileSync(options.path || "", JSON.stringify(actions));
-};
-const now = () => {
-    const hrTime = process.hrtime();
-    // eslint-disable-next-line
-    const htTime0 = hrTime[0] * 1000000;
-    return (htTime0 + hrTime[1]) / 1000;
-};
-const loadFile = (filePath) => {
-    if (!fs.existsSync(filePath))
-        throw new Error(`No queue.json file to load on ${filePath}`);
-    const content = fs.readFileSync(filePath, "utf8");
-    const newHash = XXH.h32(content, 43981).toString(16);
-    const isUpdated = lastHash !== newHash;
-    lastHash = newHash;
-    const incomingActions = JSON.parse(content);
-    return { isUpdated, incomingActions };
-};
-const dequeue = () => {
-    // first time dequeue loads
-    if (!actions)
-        actions = [];
-    const { isUpdated, incomingActions } = loadFile(options.path || "");
-    if (!isUpdated) {
-        /**
-         * make sure no tasks are executed from the queue by matching both
-         * queues (the incoming with current one)
-         */
-        actions = incomingActions;
-        console_1.default.debug(`No new actions to process: ${actions.length}/${incomingActions.length}`);
-        return null;
-    }
-    // do i need to reset actions to zero?
-    if (actions.length > 0 && actions[0].time !== incomingActions[0].time) {
-        actions = [];
-    }
-    const action = incomingActions[incomingActions.length - 1];
-    console_1.default.debug("Dequeing action ", action);
-    actions.push(action);
-    return action;
-};
-const pull = (callback) => {
-    console_1.default.debug("Pulling actions");
-    let incoming = dequeue();
-    while (incoming) {
-        callback(incoming);
-        incoming = dequeue();
-    }
-};
-const reset = (callback) => {
-    console_1.default.debug("Queue reseted");
-    actions = [];
-    if (fs.existsSync(options.path || "")) {
-        fs.writeFileSync(options.path || "", "[]");
-        callback();
-    }
-};
-const onPull = (callback) => {
-    // eslint-disable-next-line
-    const chokidar = require("chokidar");
-    console_1.default.debug("Starting to listen...");
-    try {
-        loadFile(options.path || "");
-    }
-    catch (_a) {
-        console_1.default.debug("No previeues queue file, waiting for it to be created...");
-    }
-    if (!watcher) {
-        console_1.default.debug(`Watching ${options.path}`);
-        watcher = chokidar.watch(`${options.path}`, {
-            persistent: true,
-        });
-    }
-    else
-        console_1.default.debug("Already watching queue path");
-    watcher.on("add", () => pull(callback)).on("change", () => pull(callback));
-    return true;
-};
-const onReset = (callback) => {
-    // eslint-disable-next-line
-    const chokidar = require("chokidar");
-    if (!watcher) {
-        console_1.default.debug(`Watching ${options.path}`);
-        watcher = chokidar.watch(`${options.path}`, {
-            persistent: true,
-        });
-    }
-    watcher.on("unlink", () => reset(callback));
-    return true;
-};
-exports.default = {
-    events,
-    dispatcher: (opts = {}) => {
-        if (!actions) {
-            options = Object.assign(Object.assign({}, options), opts);
-            console_1.default.debug("Initializing queue dispatcher", options);
-            actions = loadDispatcher(options);
-        }
-        return { enqueue, events };
-    },
-    listener: (opts = {}) => {
-        if (!actions) {
-            options = Object.assign(Object.assign({}, options), opts);
-            console_1.default.debug("Initializing queue listener", options);
-        }
-        return { onPull, onReset, events };
-    },
-};

package/lib/utils/misc.d.ts

@@ -1 +0,0 @@
-export declare const prioritizeHTMLFile: (entryFiles: string[]) => string[];

package/lib/utils/misc.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prioritizeHTMLFile = void 0;
-exports.prioritizeHTMLFile = (entryFiles) => {
-    let files = [];
-    // Find the html file and put it as latest in the files array
-    // in order to keep the html file opened in vscode plugin
-    const index = entryFiles.findIndex(file => {
-        return /.*\.html$/.test(file);
-    });
-    if (index !== -1) {
-        for (const [i, entryFile] of entryFiles.entries()) {
-            if (i !== index) {
-                files.push(entryFile);
-            }
-        }
-        files.push(entryFiles[index]);
-    }
-    else {
-        files = entryFiles;
-    }
-    return files;
-};

package/lib/utils/validators.d.ts

@@ -1,5 +0,0 @@
-export declare function validURL(str: string): boolean;
-declare const _default: {
-    validURL: typeof validURL;
-};
-export default _default;

package/lib/utils/validators.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validURL = void 0;
-function validURL(str) {
-    if (!str.includes('github.com')) {
-        return false;
-    }
-    const pattern = new RegExp('^(https?:\\/\\/)?' + // protocol
-        '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
-        '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
-        '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
-        '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
-        '(\\#[-a-z\\d_]*)?$', 'i'); // fragment locator
-    return !!pattern.test(str);
-}
-exports.validURL = validURL;
-exports.default = { validURL };

package/lib/utils/watcher.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (path: string) => Promise<unknown>;
-export default _default;

package/lib/utils/watcher.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chokidar = require("chokidar");
-const debounce = require("debounce");
-exports.default = (path) => new Promise((resolve /* , reject */) => {
-    const watcher = chokidar.watch(path, {
-        // TODO: This watcher is not ready yet
-        // ignored: (_path: string, _stats: any) => {
-        //   return new RegExp(_path)
-        // },
-        persistent: true,
-        depth: 1,
-        ignoreInitial: true,
-    });
-    const onChange = (eventname, _filename) => {
-        resolve(eventname /* , filename */);
-    };
-    watcher.on("all", debounce(onChange, 500, true));
-    // watcher.on('all', onChange)
-    process.on("SIGINT", function () {
-        watcher.close();
-        process.exit();
-    });
-});