@learnpack/learnpack 2.0.16 → 2.0.19

package/lib/plugin/command/compile.js

@@ -1,18 +0,0 @@
-"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 +0,0 @@
-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 +0,0 @@
-"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 +0,0 @@
-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 +0,0 @@
-"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 +0,0 @@
-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 +0,0 @@
-"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 +0,0 @@
-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 +0,0 @@
-"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 +0,0 @@
-export declare const askPackage: () => Promise<unknown>;
-declare const _default: {
-    askPackage: () => Promise<unknown>;
-};
-export default _default;

package/lib/ui/download.js

@@ -1,61 +0,0 @@
-"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 +0,0 @@
-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;

package/lib/utils/BaseCommand.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const console_1 = require("./console");
-const readline_1 = require("readline");
-// import SessionManager from '../managers/session'
-class BaseCommand extends command_1.Command {
-    async catch(err) {
-        console_1.default.debug("COMMAND CATCH", err);
-        throw err;
-    }
-    async init() {
-        const { flags, args } = this.parse(BaseCommand);
-        console_1.default.debug("COMMAND INIT");
-        console_1.default.debug("These are your flags: ", flags);
-        console_1.default.debug("These are your args: ", args);
-        // quick fix for listening to the process termination on windows
-        if (process.platform === "win32") {
-            const rl = readline_1.createInterface({
-                input: process.stdin,
-                output: process.stdout,
-            });
-            rl.on("SIGINT", function () {
-                // process.emit('SIGINT')
-                // process.emit('SIGINT')
-            });
-        }
-        process.on("SIGINT", function () {
-            console_1.default.debug("Terminated (SIGINT)");
-            process.exit();
-        });
-    }
-    async finally() {
-        console_1.default.debug("COMMAND FINALLY");
-        // called after run and catch regardless of whether or not the command errored
-    }
-    async run() {
-        // console.log('running my command')
-    }
-}
-exports.default = BaseCommand;

package/lib/utils/SessionCommand.d.ts

@@ -1,10 +0,0 @@
-import BaseCommand from './BaseCommand';
-import { IConfigManager } from '../models/config-manager';
-export default class SessionCommand extends BaseCommand {
-    session: any;
-    configManager: IConfigManager | null;
-    static flags: any;
-    initSession(flags: any, _private?: boolean): Promise<void>;
-    buildConfig(flags: any): Promise<void>;
-    catch(err: any): Promise<void>;
-}

package/lib/utils/SessionCommand.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// import { flags } from "@oclif/command";
-const BaseCommand_1 = require("./BaseCommand");
-const console_1 = require("./console");
-const session_1 = require("../managers/session");
-const index_1 = require("../managers/config/index");
-const errors_1 = require("./errors");
-class SessionCommand extends BaseCommand_1.default {
-    constructor() {
-        super(...arguments);
-        this.session = null;
-        this.configManager = null;
-    }
-    async initSession(flags, _private = false) {
-        var _a;
-        try {
-            if (!this.configManager) {
-                await this.buildConfig(flags);
-            }
-            this.session = await session_1.default.get((_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get());
-            if (this.session) {
-                console_1.default.debug(`Session open for ${this.session.payload.email}.`);
-            }
-            else {
-                if (_private)
-                    throw errors_1.AuthError('You need to log in, run the following command to continue: $ learnpack login');
-                console_1.default.debug('No active session available', _private);
-            }
-        }
-        catch (error) {
-            console_1.default.error(error.message);
-        }
-    }
-    async buildConfig(flags) {
-        this.configManager = await index_1.default(flags);
-    }
-    async catch(err) {
-        console_1.default.debug('COMMAND CATCH', err);
-        throw err;
-    }
-}
-exports.default = SessionCommand;
-// SessionCommand.description = `Describe the command here
-// ...
-// Extra documentation goes here
-// `

package/lib/utils/api.d.ts

@@ -1,12 +0,0 @@
-declare const _default: {
-    login: (identification: string, password: string) => Promise<any>;
-    publish: (config: any) => Promise<any>;
-    update: (config: any) => Promise<any>;
-    getPackage: (slug: string) => Promise<any>;
-    getLangs: () => Promise<any>;
-    getAllPackages: ({ lang, slug, }: {
-        lang?: string | undefined;
-        slug?: string | undefined;
-    }) => Promise<any>;
-};
-export default _default;

package/lib/utils/api.js

@@ -1,173 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const storage = require("node-persist");
-const cli_ux_1 = require("cli-ux");
-const HOST = "https://learnpack.herokuapp.com";
-// eslint-disable-next-line
-const _fetch = require("node-fetch");
-const fetch = async (url, options = {}) => {
-    const headers = { "Content-Type": "application/json" };
-    let session = null;
-    try {
-        session = await storage.getItem("bc-payload");
-        if (session.token && session.token !== "" && !url.includes("/token"))
-            headers.Authorization = "Token " + session.token;
-    }
-    catch (_a) { }
-    try {
-        const resp = await _fetch(url, Object.assign(Object.assign({}, options), { headers: Object.assign(Object.assign({}, headers), options.headers) }));
-        if (resp.status >= 200 && resp.status < 300)
-            return await resp.json();
-        if (resp.status === 401)
-            throw APIError("Invalid authentication credentials", 401);
-        else if (resp.status === 404)
-            throw APIError("Package not found", 404);
-        else if (resp.status >= 500)
-            throw APIError("Impossible to connect with the server", 500);
-        else if (resp.status >= 400) {
-            const error = await resp.json();
-            if (error.detail || error.error) {
-                throw APIError(error.detail || error.error);
-            }
-            else if (error.nonFieldErrors) {
-                throw APIError(error.nonFieldErrors[0], error);
-            }
-            else if (typeof error === "object") {
-                if (Object.keys(error).length > 0) {
-                    const key = error[Object.keys(error)[0]];
-                    throw APIError(`${key}: ${error[key][0]}`, error);
-                }
-            }
-            else {
-                throw APIError("Uknown error");
-            }
-        }
-        else
-            throw APIError("Uknown error");
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        throw error;
-    }
-};
-const login = async (identification, password) => {
-    try {
-        cli_ux_1.default.action.start("Looking for credentials...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/auth/token/`, {
-            body: JSON.stringify({ identification, password }),
-            method: "post",
-        });
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-    }
-};
-const publish = async (config) => {
-    const keys = [
-        "difficulty",
-        "language",
-        "skills",
-        "technologies",
-        "slug",
-        "repository",
-        "author",
-        "title",
-    ];
-    const payload = {};
-    for (const k of keys)
-        config[k] ? (payload[k] = config[k]) : null;
-    try {
-        console.log("Package to publish:", payload);
-        cli_ux_1.default.action.start("Updating package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/${config.slug}`, {
-            method: "PUT",
-            body: JSON.stringify(payload),
-        });
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console.log("payload", payload);
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const update = async (config) => {
-    try {
-        cli_ux_1.default.action.start("Updating package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/`, {
-            method: "POST",
-            body: JSON.stringify(config),
-        });
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(error.message);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getPackage = async (slug) => {
-    try {
-        cli_ux_1.default.action.start("Downloading package information...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/${slug}`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        if (error.status === 404)
-            console_1.default.error(`Package ${slug} does not exist`);
-        else
-            console_1.default.error(`Package ${slug} does not exist`);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getLangs = async () => {
-    try {
-        cli_ux_1.default.action.start("Downloading language options...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/language`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        if (error.status === 404)
-            console_1.default.error("Package slug does not exist");
-        else
-            console_1.default.error("Package slug does not exist");
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const getAllPackages = async ({ lang = "", slug = "", }) => {
-    try {
-        cli_ux_1.default.action.start("Downloading packages...");
-        await cli_ux_1.default.wait(1000);
-        const data = await fetch(`${HOST}/v1/package/all?limit=100&language=${lang}&slug=${slug}`);
-        cli_ux_1.default.action.stop("ready");
-        return data;
-    }
-    catch (error) {
-        console_1.default.error(`Package ${slug} does not exist`);
-        console_1.default.debug(error);
-        throw error;
-    }
-};
-const APIError = (error, code) => {
-    const message = error.message || error;
-    const _err = new Error(message);
-    _err.status = code || 400;
-    return _err;
-};
-exports.default = { login, publish, update, getPackage, getLangs, getAllPackages };

package/lib/utils/audit.d.ts

@@ -1,13 +0,0 @@
-import { IAuditErrors } from '../models/audit-errors';
-import { IConfigObj } from '../models/config';
-import { ICounter } from '../models/counter';
-import { IFindings } from '../models/findings';
-declare const _default: {
-    isUrl: (url: string, errors: IAuditErrors[], counter: ICounter) => Promise<boolean>;
-    checkForEmptySpaces: (str: string) => boolean;
-    checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
-    findInFile: (types: string[], content: string) => IFindings;
-    showErrors: (errors: IAuditErrors[], counter: ICounter) => Promise<unknown>;
-    showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
-};
-export default _default;