@learnpack/learnpack 2.1.24 → 2.1.26

package/lib/plugin/command/compile.d.ts

@@ -1,6 +1,6 @@
-import { IError } from "../../models/errors";
-declare const _default: {
-    CompilationError: (messages: string) => IError;
-    default: ({ action, ...rest }: any) => Promise<any>;
-};
-export default _default;
+import { IError } from "../../models/errors";
+declare const _default: {
+    CompilationError: (messages: string) => IError;
+    default: ({ action, ...rest }: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/command/compile.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const CompilationError = (messages) => {
-    const _err = new Error(messages);
-    _err.status = 400;
-    _err.stdout = messages;
-    _err.type = "compiler-error";
-    return _err;
-};
-exports.default = {
-    CompilationError,
-    default: async (_a) => {
-        var { action } = _a, rest = tslib_1.__rest(_a, ["action"]);
-        const stdout = await action.run(rest);
-        return stdout;
-    },
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const CompilationError = (messages) => {
+    const _err = new Error(messages);
+    _err.status = 400;
+    _err.stdout = messages;
+    _err.type = "compiler-error";
+    return _err;
+};
+exports.default = {
+    CompilationError,
+    default: async (_a) => {
+        var { action } = _a, rest = tslib_1.__rest(_a, ["action"]);
+        const stdout = await action.run(rest);
+        return stdout;
+    },
+};

package/lib/plugin/command/test.d.ts

@@ -1,6 +1,6 @@
-import { IError } from "../../models/errors";
-declare const _default: {
-    TestingError: (messages: string) => IError;
-    default: (args: any) => Promise<any>;
-};
-export default _default;
+import { IError } from "../../models/errors";
+declare const _default: {
+    TestingError: (messages: string) => IError;
+    default: (args: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/command/test.js

@@ -1,25 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const TestingError = (messages) => {
-    const _err = new Error(messages);
-    _err.status = 400;
-    _err.stdout = messages;
-    _err.type = "testing-error";
-    return _err;
-};
-exports.default = {
-    TestingError,
-    default: async function (args) {
-        const { action, configuration, socket, exercise } = args;
-        if (!fs.existsSync(`${configuration.dirPath}/reports`)) {
-            // reports directory
-            fs.mkdirSync(`${configuration.dirPath}/reports`);
-        }
-        // compile
-        const stdout = await action.run(args);
-        // mark exercise as done
-        exercise.done = true;
-        return stdout;
-    },
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const TestingError = (messages) => {
+    const _err = new Error(messages);
+    _err.status = 400;
+    _err.stdout = messages;
+    _err.type = "testing-error";
+    return _err;
+};
+exports.default = {
+    TestingError,
+    default: async function (args) {
+        const { action, configuration, socket, exercise } = args;
+        if (!fs.existsSync(`${configuration.dirPath}/reports`)) {
+            // reports directory
+            fs.mkdirSync(`${configuration.dirPath}/reports`);
+        }
+        // compile
+        const stdout = await action.run(args);
+        // mark exercise as done
+        exercise.done = true;
+        return stdout;
+    },
+};

package/lib/plugin/index.d.ts

@@ -1,27 +1,27 @@
-declare const _default: {
-    CompilationError: {
-        CompilationError: (messages: string) => import("../models/errors").IError;
-        default: ({ action, ...rest }: any) => Promise<any>;
-    };
-    TestingError: {
-        TestingError: (messages: string) => import("../models/errors").IError;
-        default: (args: any) => Promise<any>;
-    };
-    Utils: {
-        getMatches: (reg: RegExp, content: string) => (string | null)[];
-        cleanStdout: (buffer: string, inputs: string[]) => string;
-        indent: (string: string, options: any, count?: number) => string;
-        Console: {
-            _debug: boolean;
-            startDebug: () => void;
-            log: (msg: string, ...args: any[]) => void;
-            error: (msg: string, ...args: any[]) => void;
-            success: (msg: string, ...args: any[]) => void;
-            info: (msg: string, ...args: any[]) => void;
-            help: (msg: string) => void;
-            debug(...args: any[]): void;
-        };
-    };
-    plugin: (pluginConfig: import("../models/plugin-config").IPluginConfig) => (args: any) => Promise<any>;
-};
-export default _default;
+declare const _default: {
+    CompilationError: {
+        CompilationError: (messages: string) => import("../models/errors").IError;
+        default: ({ action, ...rest }: any) => Promise<any>;
+    };
+    TestingError: {
+        TestingError: (messages: string) => import("../models/errors").IError;
+        default: (args: any) => Promise<any>;
+    };
+    Utils: {
+        getMatches: (reg: RegExp, content: string) => (string | null)[];
+        cleanStdout: (buffer: string, inputs: string[]) => string;
+        indent: (string: string, options: any, count?: number) => string;
+        Console: {
+            _debug: boolean;
+            startDebug: () => void;
+            log: (msg: string, ...args: any[]) => void;
+            error: (msg: string, ...args: any[]) => void;
+            success: (msg: string, ...args: any[]) => void;
+            info: (msg: string, ...args: any[]) => void;
+            help: (msg: string) => void;
+            debug(...args: any[]): void;
+        };
+    };
+    plugin: (pluginConfig: import("../models/plugin-config").IPluginConfig) => (args: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/index.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const compile_1 = require("./command/compile");
-const test_1 = require("./command/test");
-const utils_1 = require("./utils");
-const plugin_1 = require("./plugin");
-exports.default = { CompilationError: compile_1.default, TestingError: test_1.default, Utils: utils_1.default, plugin: plugin_1.default };
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const compile_1 = require("./command/compile");
+const test_1 = require("./command/test");
+const utils_1 = require("./utils");
+const plugin_1 = require("./plugin");
+exports.default = { CompilationError: compile_1.default, TestingError: test_1.default, Utils: utils_1.default, plugin: plugin_1.default };

package/lib/plugin/plugin.d.ts

@@ -1,8 +1,8 @@
-import { IPluginConfig } from "../models/plugin-config";
-declare const _default: (pluginConfig: IPluginConfig) => (args: any) => Promise<any>;
-/**
- * Main Plugin Runner, it defines the behavior of a learnpack plugin
- * dividing it in "actions" like: Compile, test, etc.
- * @param {object} pluginConfig Configuration object that must defined language and each possible action.
- */
-export default _default;
+import { IPluginConfig } from "../models/plugin-config";
+declare const _default: (pluginConfig: IPluginConfig) => (args: any) => Promise<any>;
+/**
+ * Main Plugin Runner, it defines the behavior of a learnpack plugin
+ * dividing it in "actions" like: Compile, test, etc.
+ * @param {object} pluginConfig Configuration object that must defined language and each possible action.
+ */
+export default _default;

package/lib/plugin/plugin.js

@@ -1,68 +1,68 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const shell = require("shelljs");
-/**
- * Main Plugin Runner, it defines the behavior of a learnpack plugin
- * dividing it in "actions" like: Compile, test, etc.
- * @param {object} pluginConfig Configuration object that must defined language and each possible action.
- */
-exports.default = (pluginConfig) => {
-    return async (args) => {
-        const { action, exercise, socket, configuration } = args;
-        if (pluginConfig.language === undefined)
-            throw new Error(`Missing language on the plugin configuration object`);
-        if (typeof action !== "string") {
-            throw new TypeError("Missing action property on hook details");
-        }
-        if (!exercise || exercise === undefined) {
-            throw new Error("Missing exercise information");
-        }
-        // if the action does not exist I don't do anything
-        if (pluginConfig[action] === undefined) {
-            console.log(`Ignoring ${action}`);
-            return () => null;
-        }
-        // ignore if the plugin language its not the same as the exercise language
-        if (exercise.language !== pluginConfig.language) {
-            return () => null;
-        }
-        if (!exercise.files || exercise.files.length === 0) {
-            throw new Error(`No files to process`);
-        }
-        try {
-            const _action = pluginConfig[action];
-            if (_action === null || typeof _action !== "object")
-                throw new Error(`The ${pluginConfig.language} ${action} module must export an object configuration`);
-            if (_action.validate === undefined)
-                throw new Error(`Missing validate method for ${pluginConfig.language} ${action}`);
-            if (_action.run === undefined)
-                throw new Error(`Missing run method for ${pluginConfig.language} ${action}`);
-            if (_action.dependencies !== undefined) {
-                if (!Array.isArray(_action.dependencies))
-                    throw new Error(`${action}.dependencies must be an array of package names`);
-                for (const packageName of _action.dependencies) {
-                    if (!shell.which(packageName)) {
-                        throw new Error(`🚫 You need to have ${packageName} installed to run test the exercises`);
-                    }
-                }
-            }
-            const valid = await _action.validate({ exercise, configuration });
-            if (valid) {
-                // look for the command standard implementation and execute it
-                const execute = require("./command/" + action + ".js").default;
-                // no matter the command, the response must always be a stdout
-                const stdout = await execute(Object.assign(Object.assign({}, args), { action: _action, configuration }));
-                // Map the action names to socket messaging standards
-                const actionToSuccessMapper = { compile: "compiler", test: "testing" };
-                socket.success(actionToSuccessMapper[action], stdout);
-                return stdout;
-            }
-        }
-        catch (error) {
-            if (error.type === undefined)
-                socket.fatal(error);
-            else
-                socket.error(error.type, error.stdout);
-        }
-    };
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const shell = require("shelljs");
+/**
+ * Main Plugin Runner, it defines the behavior of a learnpack plugin
+ * dividing it in "actions" like: Compile, test, etc.
+ * @param {object} pluginConfig Configuration object that must defined language and each possible action.
+ */
+exports.default = (pluginConfig) => {
+    return async (args) => {
+        const { action, exercise, socket, configuration } = args;
+        if (pluginConfig.language === undefined)
+            throw new Error(`Missing language on the plugin configuration object`);
+        if (typeof action !== "string") {
+            throw new TypeError("Missing action property on hook details");
+        }
+        if (!exercise || exercise === undefined) {
+            throw new Error("Missing exercise information");
+        }
+        // if the action does not exist I don't do anything
+        if (pluginConfig[action] === undefined) {
+            console.log(`Ignoring ${action}`);
+            return () => null;
+        }
+        // ignore if the plugin language its not the same as the exercise language
+        if (exercise.language !== pluginConfig.language) {
+            return () => null;
+        }
+        if (!exercise.files || exercise.files.length === 0) {
+            throw new Error(`No files to process`);
+        }
+        try {
+            const _action = pluginConfig[action];
+            if (_action === null || typeof _action !== "object")
+                throw new Error(`The ${pluginConfig.language} ${action} module must export an object configuration`);
+            if (_action.validate === undefined)
+                throw new Error(`Missing validate method for ${pluginConfig.language} ${action}`);
+            if (_action.run === undefined)
+                throw new Error(`Missing run method for ${pluginConfig.language} ${action}`);
+            if (_action.dependencies !== undefined) {
+                if (!Array.isArray(_action.dependencies))
+                    throw new Error(`${action}.dependencies must be an array of package names`);
+                for (const packageName of _action.dependencies) {
+                    if (!shell.which(packageName)) {
+                        throw new Error(`🚫 You need to have ${packageName} installed to run test the exercises`);
+                    }
+                }
+            }
+            const valid = await _action.validate({ exercise, configuration });
+            if (valid) {
+                // look for the command standard implementation and execute it
+                const execute = require("./command/" + action + ".js").default;
+                // no matter the command, the response must always be a stdout
+                const stdout = await execute(Object.assign(Object.assign({}, args), { action: _action, configuration }));
+                // Map the action names to socket messaging standards
+                const actionToSuccessMapper = { compile: "compiler", test: "testing" };
+                socket.success(actionToSuccessMapper[action], stdout);
+                return stdout;
+            }
+        }
+        catch (error) {
+            if (error.type === undefined)
+                socket.fatal(error);
+            else
+                socket.error(error.type, error.stdout);
+        }
+    };
+};

package/lib/plugin/utils.d.ts

@@ -1,16 +1,16 @@
-declare const _default: {
-    getMatches: (reg: RegExp, content: string) => (string | null)[];
-    cleanStdout: (buffer: string, inputs: string[]) => string;
-    indent: (string: string, options: any, count?: number) => string;
-    Console: {
-        _debug: boolean;
-        startDebug: () => void;
-        log: (msg: string, ...args: any[]) => void;
-        error: (msg: string, ...args: any[]) => void;
-        success: (msg: string, ...args: any[]) => void;
-        info: (msg: string, ...args: any[]) => void;
-        help: (msg: string) => void;
-        debug(...args: any[]): void;
-    };
-};
-export default _default;
+declare const _default: {
+    getMatches: (reg: RegExp, content: string) => (string | null)[];
+    cleanStdout: (buffer: string, inputs: string[]) => string;
+    indent: (string: string, options: any, count?: number) => string;
+    Console: {
+        _debug: boolean;
+        startDebug: () => void;
+        log: (msg: string, ...args: any[]) => void;
+        error: (msg: string, ...args: any[]) => void;
+        success: (msg: string, ...args: any[]) => void;
+        info: (msg: string, ...args: any[]) => void;
+        help: (msg: string) => void;
+        debug(...args: any[]): void;
+    };
+};
+export default _default;

package/lib/plugin/utils.js

@@ -1,58 +1,58 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const getMatches = (reg, content) => {
-    const inputs = [];
-    let m;
-    while ((m = reg.exec(content)) !== null) {
-        // This is necessary to avoid infinite loops with zero-width matches
-        if (m.index === reg.lastIndex)
-            reg.lastIndex++;
-        // The result can be accessed through the `m`-variable.
-        inputs.push(m[1] || null);
-    }
-    return inputs;
-};
-const cleanStdout = (buffer, inputs) => {
-    if (Array.isArray(inputs))
-        for (let i = 0; i < inputs.length; i++)
-            if (inputs[i])
-                buffer = buffer.replace(inputs[i], "");
-    return buffer;
-};
-const indent = (string, options, count = 1) => {
-    options = Object.assign({ indent: " ", includeEmptyLines: false }, options);
-    if (typeof string !== "string") {
-        throw new TypeError(`Expected \`input\` to be a \`string\`, got \`${typeof string}\``);
-    }
-    if (typeof count !== "number") {
-        throw new TypeError(`Expected \`count\` to be a \`number\`, got \`${typeof count}\``);
-    }
-    if (count < 0) {
-        throw new RangeError(`Expected \`count\` to be at least 0, got \`${count}\``);
-    }
-    if (typeof options.indent !== "string") {
-        throw new TypeError(`Expected \`options.indent\` to be a \`string\`, got \`${typeof options.indent}\``);
-    }
-    if (count === 0) {
-        return string;
-    }
-    const regex = options.includeEmptyLines ? /^/gm : /^(?!\s*$)/gm;
-    return string.replace(regex, options.indent.repeat(count));
-};
-const Console = {
-    // _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);
-    },
-};
-exports.default = { getMatches, cleanStdout, indent, Console };
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk = require("chalk");
+const getMatches = (reg, content) => {
+    const inputs = [];
+    let m;
+    while ((m = reg.exec(content)) !== null) {
+        // This is necessary to avoid infinite loops with zero-width matches
+        if (m.index === reg.lastIndex)
+            reg.lastIndex++;
+        // The result can be accessed through the `m`-variable.
+        inputs.push(m[1] || null);
+    }
+    return inputs;
+};
+const cleanStdout = (buffer, inputs) => {
+    if (Array.isArray(inputs))
+        for (let i = 0; i < inputs.length; i++)
+            if (inputs[i])
+                buffer = buffer.replace(inputs[i], "");
+    return buffer;
+};
+const indent = (string, options, count = 1) => {
+    options = Object.assign({ indent: " ", includeEmptyLines: false }, options);
+    if (typeof string !== "string") {
+        throw new TypeError(`Expected \`input\` to be a \`string\`, got \`${typeof string}\``);
+    }
+    if (typeof count !== "number") {
+        throw new TypeError(`Expected \`count\` to be a \`number\`, got \`${typeof count}\``);
+    }
+    if (count < 0) {
+        throw new RangeError(`Expected \`count\` to be at least 0, got \`${count}\``);
+    }
+    if (typeof options.indent !== "string") {
+        throw new TypeError(`Expected \`options.indent\` to be a \`string\`, got \`${typeof options.indent}\``);
+    }
+    if (count === 0) {
+        return string;
+    }
+    const regex = options.includeEmptyLines ? /^/gm : /^(?!\s*$)/gm;
+    return string.replace(regex, options.indent.repeat(count));
+};
+const Console = {
+    // _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);
+    },
+};
+exports.default = { getMatches, cleanStdout, indent, Console };

package/lib/ui/download.d.ts

@@ -1,5 +1,5 @@
-export declare const askPackage: () => Promise<unknown>;
-declare const _default: {
-    askPackage: () => Promise<unknown>;
-};
-export default _default;
+export declare const askPackage: () => Promise<unknown>;
+declare const _default: {
+    askPackage: () => Promise<unknown>;
+};
+export default _default;

package/lib/ui/download.js

@@ -1,61 +1,61 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.askPackage = void 0;
-const enquirer_1 = require("enquirer");
-const console_1 = require("../utils/console");
-const api_1 = require("../utils/api");
-exports.askPackage = async () => {
-    console_1.default.info('No package was specified');
-    const languages = await api_1.default.getLangs();
-    return new Promise((resolve, reject) => {
-        if (languages.length === 0) {
-            // reject(new Error('No categories available'))
-            reject('No categories available');
-            // return null;
-        }
-        // let packages = []
-        enquirer_1.prompt([
-            {
-                type: 'select',
-                name: 'lang',
-                message: 'What language do you want to practice?',
-                choices: languages.map((l) => ({
-                    message: l.title,
-                    name: l.slug,
-                })),
-            },
-        ])
-            .then(({ lang }) => {
-            return (async () => {
-                const response = await api_1.default.getAllPackages({ lang });
-                const packages = response.results;
-                if (packages.length === 0) {
-                    const error = new Error(`No packages found for language ${lang}`);
-                    console_1.default.error(error.message); // TODO: Look this
-                    return error;
-                }
-                return enquirer_1.prompt([
-                    {
-                        type: 'select',
-                        name: 'pack',
-                        message: 'Choose one of the packages available',
-                        choices: packages.map((l) => ({
-                            message: `${l.title}, difficulty: ${l.difficulty}, downloads: ${l.downloads} ${l.skills.length > 0 ? `(Skills: ${l.skills.join(',')})` : ''}`,
-                            name: l.slug,
-                        })),
-                    },
-                ]);
-            })();
-        })
-            .then((resp) => {
-            if (!resp)
-                reject(resp.message || resp);
-            else
-                resolve(resp.pack);
-        })
-            .catch(error => {
-            console_1.default.error(error.message || error);
-        });
-    });
-};
-exports.default = { askPackage: exports.askPackage };
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askPackage = void 0;
+const enquirer_1 = require("enquirer");
+const console_1 = require("../utils/console");
+const api_1 = require("../utils/api");
+exports.askPackage = async () => {
+    console_1.default.info('No package was specified');
+    const languages = await api_1.default.getLangs();
+    return new Promise((resolve, reject) => {
+        if (languages.length === 0) {
+            // reject(new Error('No categories available'))
+            reject('No categories available');
+            // return null;
+        }
+        // let packages = []
+        enquirer_1.prompt([
+            {
+                type: 'select',
+                name: 'lang',
+                message: 'What language do you want to practice?',
+                choices: languages.map((l) => ({
+                    message: l.title,
+                    name: l.slug,
+                })),
+            },
+        ])
+            .then(({ lang }) => {
+            return (async () => {
+                const response = await api_1.default.getAllPackages({ lang });
+                const packages = response.results;
+                if (packages.length === 0) {
+                    const error = new Error(`No packages found for language ${lang}`);
+                    console_1.default.error(error.message); // TODO: Look this
+                    return error;
+                }
+                return enquirer_1.prompt([
+                    {
+                        type: 'select',
+                        name: 'pack',
+                        message: 'Choose one of the packages available',
+                        choices: packages.map((l) => ({
+                            message: `${l.title}, difficulty: ${l.difficulty}, downloads: ${l.downloads} ${l.skills.length > 0 ? `(Skills: ${l.skills.join(',')})` : ''}`,
+                            name: l.slug,
+                        })),
+                    },
+                ]);
+            })();
+        })
+            .then((resp) => {
+            if (!resp)
+                reject(resp.message || resp);
+            else
+                resolve(resp.pack);
+        })
+            .catch(error => {
+            console_1.default.error(error.message || error);
+        });
+    });
+};
+exports.default = { askPackage: exports.askPackage };

package/lib/utils/BaseCommand.d.ts

@@ -1,8 +1,8 @@
-import { Command } from "@oclif/command";
-declare class BaseCommand extends Command {
-    catch(err: any): Promise<void>;
-    init(): Promise<void>;
-    finally(): Promise<void>;
-    run(): Promise<void>;
-}
-export default BaseCommand;
+import { Command } from "@oclif/command";
+declare class BaseCommand extends Command {
+    catch(err: any): Promise<void>;
+    init(): Promise<void>;
+    finally(): Promise<void>;
+    run(): Promise<void>;
+}
+export default BaseCommand;