@learnpack/learnpack 4.0.9 → 4.0.12

package/lib/utils/checkNotInstalled.js

@@ -1,181 +1,185 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkNotInstalledDependencies = exports.checkNotInstalledPlugins = void 0;
-const tslib_1 = require("tslib");
-const util_1 = require("util");
-const child_process_1 = require("child_process");
-const exec = util_1.promisify(child_process_1.exec);
-const cli_ux_1 = require("cli-ux");
-const console_1 = require("./console");
-exports.checkNotInstalledPlugins = async (exercises, installedPlugins, command) => {
-    var e_1, _a;
-    console_1.default.info("Checking needed plugins...");
-    const usefulExtensions = new Set(["py", "js", "jsx", "html"]);
-    const foundExtensions = [];
-    const testingExtensions = [];
-    const neededPlugins = [];
-    let someExerciseWithOnlyTestFile = false; // I will suppose that there are not exercises with only readme and test files
-    // See the extensions of the files that are not tests files
-    for (const e of exercises) {
-        const notReadmeFiles = e.files.filter(f => !f.name.toLowerCase().includes("readme"));
-        if (!someExerciseWithOnlyTestFile && notReadmeFiles.length > 0) {
-            someExerciseWithOnlyTestFile = notReadmeFiles.every(f => {
-                return f.name.includes("test");
-            });
-            if (someExerciseWithOnlyTestFile) {
-                console_1.default.debug("Some exercises have only test files, I will install the @learnpack/node plugin to run the tests.");
-            }
-        }
-        for (const f of notReadmeFiles) {
-            const ext = f.name.split(".").pop();
-            if (!ext)
-                continue;
-            if (f.name.includes("test")) {
-                !testingExtensions.includes(ext) && testingExtensions.push(ext);
-                continue;
-            }
-            if (usefulExtensions.has(ext) && !foundExtensions.includes(ext)) {
-                foundExtensions.push(ext);
-            }
-        }
-    }
-    console_1.default.debug("foundExtensions", foundExtensions);
-    console_1.default.debug("testingExtensions", testingExtensions);
-    if (foundExtensions.length === 0 && testingExtensions.length === 0)
-        return {
-            needed: [],
-            notInstalled: [],
-        };
-    if (foundExtensions.includes("html") && foundExtensions.includes("js")) {
-        neededPlugins.push("@learnpack/dom");
-    }
-    if (foundExtensions.includes("html") && !foundExtensions.includes("js")) {
-        neededPlugins.push("@learnpack/html");
-    }
-    if (foundExtensions.includes("jsx")) {
-        neededPlugins.push("@learnpack/react");
-    }
-    if (foundExtensions.includes("py") || testingExtensions.includes("py")) {
-        neededPlugins.push("@learnpack/python");
-    }
-    if ((foundExtensions.includes("js") && !foundExtensions.includes("html")) ||
-        (testingExtensions.includes("js") && someExerciseWithOnlyTestFile)) {
-        neededPlugins.push("@learnpack/node");
-    }
-    const notInstalled = neededPlugins.filter(item => !installedPlugins.includes(item));
-    if (notInstalled.length > 0) {
-        console_1.default.error("These plugins are not installed but required: ", notInstalled);
-        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed plugins? (y/n)");
-        if (confirmInstall) {
-            console_1.default.info("Installing the needed plugins...");
-            try {
-                for (var notInstalled_1 = tslib_1.__asyncValues(notInstalled), notInstalled_1_1; notInstalled_1_1 = await notInstalled_1.next(), !notInstalled_1_1.done;) {
-                    const p = notInstalled_1_1.value;
-                    await command.config.runCommand(`plugins:install`, [p]);
-                    console_1.default.log(`Plugin ${p} installed`);
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (notInstalled_1_1 && !notInstalled_1_1.done && (_a = notInstalled_1.return)) await _a.call(notInstalled_1);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            console_1.default.log("All needed plugins installed, please restart LearnPack to load them.");
-            console_1.default.info("Run: $ learnpack start");
-            command.exit(0);
-        }
-        else {
-            console_1.default.error("You need to install the plugins to complete this exercise");
-            console_1.default.info("To install the plugins run each of the following commands: ");
-            for (const p of notInstalled) {
-                console_1.default.log(`learnpack plugins:install ${p}`);
-            }
-            command.exit(1);
-        }
-    }
-    return {
-        needed: neededPlugins,
-        notInstalled,
-    };
-};
-function includesAll(baseString, elementsArray) {
-    return elementsArray.every(element => baseString.includes(element));
-}
-const installDependencies = async (deps, packageManager) => {
-    let command = "";
-    if (packageManager === "npm") {
-        command = `npm install -g ${deps.join(" ")}`;
-    }
-    else if (packageManager === "pip") {
-        command = `pip install ${deps.join(" ")}`;
-    }
-    const { stdout, stderr } = await exec(command);
-    if (stderr && (stderr.includes("npm ERR!") || stderr.includes("Traceback"))) {
-        console_1.default.error(`Error executing ${command}.`);
-        console_1.default.error(stderr);
-        return;
-    }
-    console_1.default.info(`Dependencies ${deps.join(" ")} installed...`);
-    return true;
-};
-exports.checkNotInstalledDependencies = async (neededPlugins) => {
-    console_1.default.info("Checking needed dependencies...");
-    const jsPluginsDependencies = [
-        "jest@29.7.0",
-        "jest-environment-jsdom@29.7.0",
-    ];
-    const pyPluginsDependencies = ["pytest==6.2.5", "pytest-testdox", "mock"];
-    const npmLsCommand = "npm ls jest jest-environment-jsdom -g";
-    let pytestNeeded = false;
-    let jestNeeded = false;
-    if (neededPlugins.includes("@learnpack/dom") ||
-        neededPlugins.includes("@learnpack/html") ||
-        neededPlugins.includes("@learnpack/react") ||
-        neededPlugins.includes("@learnpack/node")) {
-        jestNeeded = true;
-    }
-    if ("@learnpack/python" in neededPlugins) {
-        pytestNeeded = true;
-    }
-    if (jestNeeded) {
-        const { stdout, stderr } = await exec("npm ls -g");
-        if (stderr) {
-            console_1.default.error(`Error executing ${npmLsCommand}. Use debug for more info`);
-            console_1.default.debug(stderr);
-            return false;
-        }
-        if (includesAll(stdout, jsPluginsDependencies))
-            return true;
-        console_1.default.error("The jest dependencies are not installed");
-        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed dependencies? (y/n)");
-        if (!confirmInstall) {
-            console_1.default.error(`The exercises can't be tested without the following dependencies: ${jsPluginsDependencies.join(", ")}`);
-            console_1.default.info(`Please install them and try again. Run the following command to install them: \nnpm install -g ${jsPluginsDependencies.join(" ")}`);
-            return false;
-        }
-        console_1.default.log("Installing jest dependencies...");
-        await installDependencies(jsPluginsDependencies, "npm");
-    }
-    if (pytestNeeded) {
-        const { stdout, stderr } = await exec("pip list");
-        if (stderr) {
-            console_1.default.error(`Error executing pip list. Use debug for more info`);
-            console_1.default.debug(stderr);
-            return;
-        }
-        if (includesAll(stdout, pyPluginsDependencies))
-            return true;
-        console_1.default.error("The pytest dependencies are not installed");
-        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed dependencies? (y/n)");
-        if (!confirmInstall) {
-            console_1.default.error(`The exercises can't be tested without the following dependencies: ${pyPluginsDependencies.join(", ")}`);
-            console_1.default.info(`Please install them and try again. Run the following command to install them: \npip install ${pyPluginsDependencies.join(" ")}`);
-            return false;
-        }
-        console_1.default.log("Installing pytest dependencies...");
-        await installDependencies(pyPluginsDependencies, "pip");
-    }
-    return true;
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkNotInstalledDependencies = exports.checkNotInstalledPlugins = void 0;
+const tslib_1 = require("tslib");
+const util_1 = require("util");
+const child_process_1 = require("child_process");
+const exec = (0, util_1.promisify)(child_process_1.exec);
+const cli_ux_1 = require("cli-ux");
+const console_1 = require("./console");
+const checkNotInstalledPlugins = async (exercises, installedPlugins, command) => {
+    var _a, e_1, _b, _c;
+    console_1.default.info("Checking needed plugins...");
+    const usefulExtensions = new Set(["py", "js", "jsx", "html"]);
+    const foundExtensions = [];
+    const testingExtensions = [];
+    const neededPlugins = [];
+    let someExerciseWithOnlyTestFile = false; // I will suppose that there are not exercises with only readme and test files
+    // See the extensions of the files that are not tests files
+    for (const e of exercises) {
+        const notReadmeFiles = e.files.filter(f => !f.name.toLowerCase().includes("readme"));
+        if (!someExerciseWithOnlyTestFile && notReadmeFiles.length > 0) {
+            someExerciseWithOnlyTestFile = notReadmeFiles.every(f => {
+                return f.name.includes("test");
+            });
+            if (someExerciseWithOnlyTestFile) {
+                console_1.default.debug("Some exercises have only test files, I will install the @learnpack/node plugin to run the tests.");
+            }
+        }
+        for (const f of notReadmeFiles) {
+            const ext = f.name.split(".").pop();
+            if (!ext)
+                continue;
+            if (f.name.includes("test")) {
+                !testingExtensions.includes(ext) && testingExtensions.push(ext);
+                continue;
+            }
+            if (usefulExtensions.has(ext) && !foundExtensions.includes(ext)) {
+                foundExtensions.push(ext);
+            }
+        }
+    }
+    console_1.default.debug("foundExtensions", foundExtensions);
+    console_1.default.debug("testingExtensions", testingExtensions);
+    if (foundExtensions.length === 0 && testingExtensions.length === 0)
+        return {
+            needed: [],
+            notInstalled: [],
+        };
+    if (foundExtensions.includes("html") && foundExtensions.includes("js")) {
+        neededPlugins.push("@learnpack/dom");
+    }
+    if (foundExtensions.includes("html") && !foundExtensions.includes("js")) {
+        neededPlugins.push("@learnpack/html");
+    }
+    if (foundExtensions.includes("jsx")) {
+        neededPlugins.push("@learnpack/react");
+    }
+    if (foundExtensions.includes("py") || testingExtensions.includes("py")) {
+        neededPlugins.push("@learnpack/python");
+    }
+    if ((foundExtensions.includes("js") && !foundExtensions.includes("html")) ||
+        (testingExtensions.includes("js") && someExerciseWithOnlyTestFile)) {
+        neededPlugins.push("@learnpack/node");
+    }
+    const notInstalled = neededPlugins.filter(item => !installedPlugins.includes(item));
+    if (notInstalled.length > 0) {
+        console_1.default.error("These plugins are not installed but required: ", notInstalled);
+        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed plugins? (y/n)");
+        if (confirmInstall) {
+            console_1.default.info("Installing the needed plugins...");
+            try {
+                for (var _d = true, notInstalled_1 = tslib_1.__asyncValues(notInstalled), notInstalled_1_1; notInstalled_1_1 = await notInstalled_1.next(), _a = notInstalled_1_1.done, !_a; _d = true) {
+                    _c = notInstalled_1_1.value;
+                    _d = false;
+                    const p = _c;
+                    await command.config.runCommand(`plugins:install`, [p]);
+                    console_1.default.log(`Plugin ${p} installed`);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = notInstalled_1.return)) await _b.call(notInstalled_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            console_1.default.log("All needed plugins installed, please restart LearnPack to load them.");
+            console_1.default.info("Run: $ learnpack start");
+            command.exit(0);
+        }
+        else {
+            console_1.default.error("You need to install the plugins to complete this exercise");
+            console_1.default.info("To install the plugins run each of the following commands: ");
+            for (const p of notInstalled) {
+                console_1.default.log(`learnpack plugins:install ${p}`);
+            }
+            command.exit(1);
+        }
+    }
+    return {
+        needed: neededPlugins,
+        notInstalled,
+    };
+};
+exports.checkNotInstalledPlugins = checkNotInstalledPlugins;
+function includesAll(baseString, elementsArray) {
+    return elementsArray.every(element => baseString.includes(element));
+}
+const installDependencies = async (deps, packageManager) => {
+    let command = "";
+    if (packageManager === "npm") {
+        command = `npm install -g ${deps.join(" ")}`;
+    }
+    else if (packageManager === "pip") {
+        command = `pip install ${deps.join(" ")}`;
+    }
+    const { stdout, stderr } = await exec(command);
+    if (stderr && (stderr.includes("npm ERR!") || stderr.includes("Traceback"))) {
+        console_1.default.error(`Error executing ${command}.`);
+        console_1.default.error(stderr);
+        return;
+    }
+    console_1.default.info(`Dependencies ${deps.join(" ")} installed...`);
+    return true;
+};
+const checkNotInstalledDependencies = async (neededPlugins) => {
+    console_1.default.info("Checking needed dependencies...");
+    const jsPluginsDependencies = [
+        "jest@29.7.0",
+        "jest-environment-jsdom@29.7.0",
+    ];
+    const pyPluginsDependencies = ["pytest==6.2.5", "pytest-testdox", "mock"];
+    const npmLsCommand = "npm ls jest jest-environment-jsdom -g";
+    let pytestNeeded = false;
+    let jestNeeded = false;
+    if (neededPlugins.includes("@learnpack/dom") ||
+        neededPlugins.includes("@learnpack/html") ||
+        neededPlugins.includes("@learnpack/react") ||
+        neededPlugins.includes("@learnpack/node")) {
+        jestNeeded = true;
+    }
+    if ("@learnpack/python" in neededPlugins) {
+        pytestNeeded = true;
+    }
+    if (jestNeeded) {
+        const { stdout, stderr } = await exec("npm ls -g");
+        if (stderr) {
+            console_1.default.error(`Error executing ${npmLsCommand}. Use debug for more info`);
+            console_1.default.debug(stderr);
+            return false;
+        }
+        if (includesAll(stdout, jsPluginsDependencies))
+            return true;
+        console_1.default.error("The jest dependencies are not installed");
+        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed dependencies? (y/n)");
+        if (!confirmInstall) {
+            console_1.default.error(`The exercises can't be tested without the following dependencies: ${jsPluginsDependencies.join(", ")}`);
+            console_1.default.info(`Please install them and try again. Run the following command to install them: \nnpm install -g ${jsPluginsDependencies.join(" ")}`);
+            return false;
+        }
+        console_1.default.log("Installing jest dependencies...");
+        await installDependencies(jsPluginsDependencies, "npm");
+    }
+    if (pytestNeeded) {
+        const { stdout, stderr } = await exec("pip list");
+        if (stderr) {
+            console_1.default.error(`Error executing pip list. Use debug for more info`);
+            console_1.default.debug(stderr);
+            return;
+        }
+        if (includesAll(stdout, pyPluginsDependencies))
+            return true;
+        console_1.default.error("The pytest dependencies are not installed");
+        const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed dependencies? (y/n)");
+        if (!confirmInstall) {
+            console_1.default.error(`The exercises can't be tested without the following dependencies: ${pyPluginsDependencies.join(", ")}`);
+            console_1.default.info(`Please install them and try again. Run the following command to install them: \npip install ${pyPluginsDependencies.join(" ")}`);
+            return false;
+        }
+        console_1.default.log("Installing pytest dependencies...");
+        await installDependencies(pyPluginsDependencies, "pip");
+    }
+    return true;
+};
+exports.checkNotInstalledDependencies = checkNotInstalledDependencies;

package/lib/utils/console.d.ts

@@ -1,12 +1,12 @@
-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: any, ...args: Array<any>) => void;
-    help: (msg: string) => void;
-    debug(...args: Array<any>): void;
-    warning: (msg: string) => void;
-};
-export default _default;
+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: any, ...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 +1,19 @@
-"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)}`),
-};
+"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 +1,17 @@
-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;
+import { ISolution, IError } from '../models/errors';
+export declare const getSolution: (slug?: string) => 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: IError | string) => IError;
+    CompilerError: (error: IError | string) => IError;
+    TestingError: (error: IError | string) => IError;
+    NotFoundError: (error: IError | string) => IError;
+    InternalError: (error: IError | string) => IError;
+    AuthError: (error: IError | string) => IError;
+};
+export default _default;